GET api/GetShipmentsForOutboundCall/shipmentIds/{auth}?StateFilter={StateFilter}&StatusFilter={StatusFilter}&ReportClass={ReportClass}&TimeSince={TimeSince}&TimeInterval={TimeInterval}
Used to provide a list of ShipmentGUID
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| auth |
The authorization GUID for this user session |
string |
Required |
| StateFilter |
The StateFilter for which you want matching shipment |
string |
Required |
| StatusFilter |
The StatusFilter for which you want matching shipment |
integer |
Required |
| ReportClass |
The ReportClass for which you want matching shipment |
string |
Required |
| TimeSince | integer |
Required |
|
| TimeInterval | TimeIntervalEnum |
Required |
Body Parameters
None.
Response Information
Resource Description
List of active pickups
ShipmentGuidList| Name | Description | Type | Additional information |
|---|---|---|---|
| shipmentGUIDs | Collection of string |
None. |
|
| IsSuccessful |
Set to true if method was successful |
boolean |
None. |
| ErrorMessage |
The error message if method call was not successful |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"shipmentGUIDs": [
"sample string 1",
"sample string 2"
],
"IsSuccessful": true,
"ErrorMessage": "sample string 2"
}
application/xml, text/xml
Sample:
<ShipmentGuidList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models.ShipmentsOutboundCall">
<ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models">sample string 2</ErrorMessage>
<IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models">true</IsSuccessful>
<shipmentGUIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</shipmentGUIDs>
</ShipmentGuidList>