POST api/order-status/GetAllOrderStatusWithFilter
Request Information
URI Parameters
None.
Body Parameters
FilterRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Filters | Dictionary of string [key] and Object [value] |
None. |
|
| PageNumber | integer |
None. |
|
| PageSize | integer |
None. |
|
| SortField | string |
None. |
|
| SortDirection | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Filters": {
"sample string 1": {},
"sample string 3": {}
},
"PageNumber": 1,
"PageSize": 2,
"SortField": "sample string 3",
"SortDirection": "sample string 4"
}
application/xml, text/xml
Sample:
<FilterRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/cbox_api.Models">
<PageNumber>1</PageNumber>
<PageSize>2</PageSize>
<SortDirection>sample string 4</SortDirection>
<SortField>sample string 3</SortField>
<Filters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringanyType>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value />
</d2p1:KeyValueOfstringanyType>
<d2p1:KeyValueOfstringanyType>
<d2p1:Key>sample string 3</d2p1:Key>
<d2p1:Value />
</d2p1:KeyValueOfstringanyType>
</Filters>
</FilterRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseModelOfListOfOrderStatusDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Collection of OrderStatusDTO |
None. |
|
| Success | boolean |
None. |
|
| StatusCode | integer |
None. |
|
| Message | string |
None. |
|
| ErrorMessage | string |
None. |
|
| Metadata | Object |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": [
{
"id": 1,
"name": "sample string 2",
"statuscode": "sample string 3"
},
{
"id": 1,
"name": "sample string 2",
"statuscode": "sample string 3"
}
],
"Success": true,
"StatusCode": 2,
"Message": "sample string 3",
"ErrorMessage": "sample string 4",
"Metadata": {}
}
application/xml, text/xml
Sample:
<ResponseModelOfArrayOfOrderStatusDTOb1afPy6h xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/cbox_api.Models.Response">
<ErrorMessage>sample string 4</ErrorMessage>
<Message>sample string 3</Message>
<Metadata />
<StatusCode>2</StatusCode>
<Success>true</Success>
<Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/cbox_api.Models.DTOs">
<d2p1:OrderStatusDTO>
<d2p1:ID>1</d2p1:ID>
<d2p1:Name>sample string 2</d2p1:Name>
<d2p1:StatusCode>sample string 3</d2p1:StatusCode>
</d2p1:OrderStatusDTO>
<d2p1:OrderStatusDTO>
<d2p1:ID>1</d2p1:ID>
<d2p1:Name>sample string 2</d2p1:Name>
<d2p1:StatusCode>sample string 3</d2p1:StatusCode>
</d2p1:OrderStatusDTO>
</Data>
</ResponseModelOfArrayOfOrderStatusDTOb1afPy6h>