<back to all web services
ListRecipientFilterQuery
The following routes are available for this service:| GET | /recipient/filter | Get All Filter Recipients | |
|---|
ListRecipientFilterQuery Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Name | query | string | No | |
| Nip | query | string | No | |
| Regon | query | string | No | |
| Krs | query | string | No | |
| StreetName | query | string | No | |
| Town | query | string | No | |
| Country | query | string | No | |
| CatId | query | List<uint> | No | |
| TypeId | query | List<uint> | No | |
| CountryId | query | List<int> | No | |
PaginatedOrderedRequestBase Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| OrderBy | form | string | No | |
| SortType | form | string | No | |
| Pages | form | int | No | |
| Amount | form | int | No | |
MultipleResultBaseResponse<T> Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| MultipleResult | form | IList<T> | No | |
| Amount | form | long | No | |
RecipientDto Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ShortName | form | string | No | |
| Name | form | string | No | |
| Nip | form | string | No | |
| Regon | form | string | No | |
| Krs | form | string | No | |
| CatId | form | uint | No | |
| TypeId | form | int | No | |
| RecipientCType | form | string | No | |
| Description | form | string | No | |
| StreetName | form | string | No | |
| StreetNumber | form | string | No | |
| StreetFlatNumber | form | string | No | |
| PostalCode | form | string | No | |
| Town | form | string | No | |
| CountryId | form | int | No | |
| IsoCountry | form | string | No | |
| Country | form | string | No | |
| Email | form | string | No | |
| WebSite | form | string | No | |
| PhoneNumber | form | string | No | |
| FaxNumber | form | string | No | |
| PhoneNumber1 | form | string | No | |
| MobileNumber | form | string | No | |
| BankAccName | form | string | No | |
| BankAccNumber | form | string | No | |
| DefaultPaymentType | form | string | No | |
| DefaultPaymentTerm | form | uint | No | |
| DefaultDiscount | form | decimal | No | |
| DefaultCurrencyId | form | uint | No | |
| DefaultCurrency | form | string | No | |
| CategoryId | form | uint | No | |
| CategoryName | form | string | No | |
BaseKeyDto Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| CreatedById | form | uint | No | |
| ModifiedById | form | uint | No | |
| CreatedDate | form | DateTime | No | |
| ModifiedDate | form | DateTime | No | |
| Id | form | uint | No | |
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 /recipient/filter HTTP/1.1
Host: api.chmuradokumentow.pl
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
amount: 0
}