GET api/Vendor/SelectTaskRecover/{UserGUID}/{EntityGUID}

Retrieve information for Recover Task (RECOVER)

Request Information

URI Parameters

Name	Description	Type	Additional information
UserGUID	Unique system generated user identifier	string	Required
EntityGUID	Unique system generated entity identifier (ShipmentGUID)	string	Required

Body Parameters

None.

Response Information

Resource Description

TaskRecoverResp

Name	Description	Type	Additional information
EntityGUID	Unique system generated entity identifier (ManifestGUID)	string	None.
PickupFrom	Pickup from address	string	None.
DeliverTo	Deliver to address	string	None.
Instructions	Instructions for recovery	string	None.
Shipments	List of shipment to recover	Collection of ShipmentToRecover	None.
IsSuccessful	Used to determine if method call was successful (true) or failure (false)	boolean	Required
ErrorMessage	The error message if method call was not successful	string	None.

Response Formats

application/json, text/json

Sample:

{
  "EntityGUID": "sample string 1",
  "PickupFrom": "sample string 2",
  "DeliverTo": "sample string 3",
  "Instructions": "sample string 4",
  "Shipments": [
    {
      "ShipmentGUID": "sample string 1",
      "ShipmentNumber": 2,
      "DeliverTo": "sample string 3",
      "WaybillNumber": "sample string 4"
    },
    {
      "ShipmentGUID": "sample string 1",
      "ShipmentNumber": 2,
      "DeliverTo": "sample string 3",
      "WaybillNumber": "sample string 4"
    }
  ],
  "IsSuccessful": true,
  "ErrorMessage": "sample string 6"
}

application/xml, text/xml

Sample:

<TaskRecoverResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Mobile.Models">
  <ErrorMessage>sample string 6</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <DeliverTo>sample string 3</DeliverTo>
  <EntityGUID>sample string 1</EntityGUID>
  <Instructions>sample string 4</Instructions>
  <PickupFrom>sample string 2</PickupFrom>
  <Shipments>
    <ShipmentToRecover>
      <DeliverTo>sample string 3</DeliverTo>
      <ShipmentGUID>sample string 1</ShipmentGUID>
      <ShipmentNumber>2</ShipmentNumber>
      <WaybillNumber>sample string 4</WaybillNumber>
    </ShipmentToRecover>
    <ShipmentToRecover>
      <DeliverTo>sample string 3</DeliverTo>
      <ShipmentGUID>sample string 1</ShipmentGUID>
      <ShipmentNumber>2</ShipmentNumber>
      <WaybillNumber>sample string 4</WaybillNumber>
    </ShipmentToRecover>
  </Shipments>
</TaskRecoverResp>