DocCloud API

<back to all web services

SearchRecipientQuery

Requires Authentication
The following routes are available for this service:
GET/recipient/searchSearch All Recipients
SearchRecipientQuery Parameters:
NameParameterData TypeRequiredDescription
QueryquerystringNo
OrderByquerystringNo
SortTypequerystringNo
PagesqueryintNo
AmountqueryintNo
SearchRecipientResponse Parameters:
NameParameterData TypeRequiredDescription
AmountformintNo
MultipleResultBaseResponse<T> Parameters:
NameParameterData TypeRequiredDescription
MultipleResultformIList<T>No
AmountformlongNo
RecipientDto Parameters:
NameParameterData TypeRequiredDescription
ShortNameformstringNo
NameformstringNo
NipformstringNo
RegonformstringNo
KrsformstringNo
CatIdformuintNo
TypeIdformintNo
RecipientCTypeformstringNo
DescriptionformstringNo
StreetNameformstringNo
StreetNumberformstringNo
StreetFlatNumberformstringNo
PostalCodeformstringNo
TownformstringNo
CountryIdformintNo
IsoCountryformstringNo
CountryformstringNo
EmailformstringNo
WebSiteformstringNo
PhoneNumberformstringNo
FaxNumberformstringNo
PhoneNumber1formstringNo
MobileNumberformstringNo
BankAccNameformstringNo
BankAccNumberformstringNo
DefaultPaymentTypeformstringNo
DefaultPaymentTermformuintNo
DefaultDiscountformdecimalNo
DefaultCurrencyIdformuintNo
DefaultCurrencyformstringNo
CategoryIdformuintNo
CategoryNameformstringNo
BaseKeyDto Parameters:
NameParameterData TypeRequiredDescription
CreatedByIdformuintNo
ModifiedByIdformuintNo
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
IdformuintNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /recipient/search HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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