GET api/Pickup/SelectActive/{auth}/{ShipmentGUID}
Used to provide a list of active pickups relative to shipment parameters
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
auth |
The authorization GUID for this user session |
string |
Required |
ShipmentGUID |
The shipment(entity) GUID for which you want matching pickups |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
List of active pickups
Collection of ActivePickupItemName | Description | Type | Additional information |
---|---|---|---|
PickupGUID | string |
None. |
|
Description | string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "PickupGUID": "sample string 1", "Description": "sample string 2" }, { "PickupGUID": "sample string 1", "Description": "sample string 2" } ]
application/xml, text/xml
Sample:
<ArrayOfActivePickupItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models"> <ActivePickupItem> <Description>sample string 2</Description> <PickupGUID>sample string 1</PickupGUID> </ActivePickupItem> <ActivePickupItem> <Description>sample string 2</Description> <PickupGUID>sample string 1</PickupGUID> </ActivePickupItem> </ArrayOfActivePickupItem>