POST api/dashboard/courier/{courierId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| courierId | integer |
Required |
Body Parameters
CourierDashboardRequestDto| Name | Description | Type | Additional information |
|---|---|---|---|
| AWB | string |
None. |
|
| Ref | string |
None. |
|
| Shipper | string |
None. |
|
| Customer | string |
None. |
|
| Address | string |
None. |
|
| Contact | string |
None. |
|
| CODAmount | string |
None. |
|
| Status | string |
None. |
|
| HideDelivered | boolean |
None. |
|
| WildCard | string |
None. |
|
| StatusIds | Collection of integer |
None. |
|
| SkipCount | integer |
None. |
|
| MaxResultCount | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"AWB": "sample string 1",
"Ref": "sample string 2",
"Shipper": "sample string 3",
"Customer": "sample string 4",
"Address": "sample string 5",
"Contact": "sample string 6",
"CODAmount": "sample string 7",
"Status": "sample string 8",
"HideDelivered": true,
"WildCard": "sample string 9",
"StatusIds": [
1,
2
],
"SkipCount": 1,
"MaxResultCount": 1
}
application/xml, text/xml
Sample:
<CourierDashboardRequestDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MayaserSolutions.Domain">
<MaxResultCount>1</MaxResultCount>
<SkipCount>1</SkipCount>
<AWB>sample string 1</AWB>
<Address>sample string 5</Address>
<CODAmount>sample string 7</CODAmount>
<Contact>sample string 6</Contact>
<Customer>sample string 4</Customer>
<HideDelivered>true</HideDelivered>
<Ref>sample string 2</Ref>
<Shipper>sample string 3</Shipper>
<Status>sample string 8</Status>
<StatusIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</StatusIds>
<WildCard>sample string 9</WildCard>
</CourierDashboardRequestDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CourierDashboardDto| Name | Description | Type | Additional information |
|---|---|---|---|
| ToBeDelivered | integer |
None. |
|
| Delivered | integer |
None. |
|
| Failed | integer |
None. |
|
| Manifests | PagedResultDtoOfManifestDto |
None. |
|
| Others | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"ToBeDelivered": 1,
"Delivered": 2,
"Failed": 3,
"Manifests": null,
"Others": 4
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.