DocCloud API

<back to all web services

ListProfileUserQuery

Requires Authentication
ListProfileUserQuery Parameters:
NameParameterData TypeRequiredDescription
OrderByquerystringNo
SortTypequerystringNo
PagesqueryintNo
AmountqueryintNo
ListProfileUserResponse Parameters:
NameParameterData TypeRequiredDescription
AmountformintNo
MultipleResultBaseResponse<T> Parameters:
NameParameterData TypeRequiredDescription
MultipleResultformIList<T>No
AmountformlongNo
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 .csv suffix or ?format=csv

HTTP + CSV

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

POST /csv/reply/ListProfileUserQuery HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"orderBy":"String","sortType":"String","pages":0,"amount":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"amount":0,"amount":0}