DocCloud API

<back to all web services

MyProfileQuery

Requires Authentication
The following routes are available for this service:
GET/myprofileGet user profile by it's id.
BaseSingleResponse<T> Parameters:
NameParameterData TypeRequiredDescription
ResultformTNo
ProfileUserDto Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
SurnameformstringNo
EmailformstringNo
PasswordformstringNo
DescriptionformstringNo
IsActivatedformboolNo
IsCompanyDbReadyformboolNo
CompanyformProfileCompanyDtoNo
BaseKeyDto Parameters:
NameParameterData TypeRequiredDescription
CreatedByIdformuintNo
ModifiedByIdformuintNo
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
IdformuintNo
ProfileCompanyDto Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
NipformstringNo
RegonformstringNo
KrsformstringNo
TypeIdformintNo
RecipientCTypeformstringNo
DescriptionformstringNo
StreetNameformstringNo
StreetNumberformstringNo
StreetFlatNumberformstringNo
PostalCodeformstringNo
TownformstringNo
CountryIdformuintNo
CountryformstringNo
EmailformstringNo
WebSiteformstringNo
PhoneNumberformstringNo
FaxNumberformstringNo
PhoneNumber1formstringNo
MobileNumberformstringNo
BankAccountformList<ProfileBankAccountDto>No
DefaultCurrencyIdformuintNo
DefaultCurrencyformstringNo
StorageSizeformulongNo
MaxFileSizeformulongNo
ProfileBankAccountDto Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
AccountNumberformstringNo
SwiftformstringNo
CurrencyIdformuintNo
CurrencyformstringNo
IsDefaultformboolNo
IsTaxAccountformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /myprofile HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		name: String,
		surname: String,
		email: String,
		password: String,
		description: String,
		isActivated: False,
		isCompanyDbReady: False,
		company: 
		{
			name: String,
			nip: String,
			regon: String,
			krs: String,
			typeId: 0,
			recipientCType: String,
			description: String,
			streetName: String,
			streetNumber: String,
			streetFlatNumber: String,
			postalCode: String,
			town: String,
			countryId: 0,
			country: String,
			email: String,
			webSite: String,
			phoneNumber: String,
			faxNumber: String,
			phoneNumber1: String,
			mobileNumber: String,
			bankAccount: 
			[
				{
					name: String,
					accountNumber: String,
					swift: String,
					currencyId: 0,
					currency: String,
					isDefault: False,
					isTaxAccount: False,
					createdById: 0,
					modifiedById: 0,
					createdDate: 0001-01-01,
					modifiedDate: 0001-01-01,
					id: 0
				}
			],
			defaultCurrencyId: 0,
			defaultCurrency: String,
			storageSize: 0,
			maxFileSize: 0,
			createdById: 0,
			modifiedById: 0,
			createdDate: 0001-01-01,
			modifiedDate: 0001-01-01,
			id: 0
		},
		createdById: 0,
		modifiedById: 0,
		createdDate: 0001-01-01,
		modifiedDate: 0001-01-01,
		id: 0
	}
}