GET api/Pickup/Active/{auth}/{ShipmentGUID}/{ExcludeShipment}/{IncludeBlank}

Request Information

URI Parameters

Name	Type	Additional information
auth	string	Required
ShipmentGUID	string	Required
ExcludeShipment	boolean	Required
IncludeBlank	boolean	Required

Body Parameters

None.

Response Information

Resource Description

ActivePickupResp

Name	Type	Additional information
IsSuccessful	boolean	None.
ErrorMessage	string	None.
Pickups	Collection of ActivePickupItem	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "Pickups": [
    {
      "PickupGUID": "sample string 1",
      "Description": "sample string 2"
    },
    {
      "PickupGUID": "sample string 1",
      "Description": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<ActivePickupResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <Pickups>
    <ActivePickupItem>
      <Description>sample string 2</Description>
      <PickupGUID>sample string 1</PickupGUID>
    </ActivePickupItem>
    <ActivePickupItem>
      <Description>sample string 2</Description>
      <PickupGUID>sample string 1</PickupGUID>
    </ActivePickupItem>
  </Pickups>
</ActivePickupResp>