GET api/Vendor/SelectTaskTransferRecover/{UserGUID}/{EntityGUID}
Used to select data for the transfer recover task
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
UserGUID |
Unique user identifier |
string |
Required |
EntityGUID |
Unique entity (manifest) to recover |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
TaskTransferRecoverRespName | Description | Type | Additional information |
---|---|---|---|
IsSuccessful |
Used to determine if method call was successful (true) or failure (false) |
boolean |
None. |
ErrorMessage |
The error message if method call was not successful |
string |
None. |
ManifestGUID |
Unique internal manifest identifier to recover |
string |
None. |
ManifestNumber |
Unique manifest identifier |
integer |
None. |
RecoverFrom |
Recover from information |
string |
None. |
Shipments |
List of shipment to recover |
Collection of ShipmentToRecover |
None. |
BagCount |
Number of bags on recovery manifest |
integer |
None. |
TotalWeight |
Total weight of recovery manifest |
decimal number |
None. |
TotalWeightUOM |
Weight unit of measure (LB,KG) |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "IsSuccessful": true, "ErrorMessage": "sample string 2", "ManifestGUID": "sample string 3", "ManifestNumber": 4, "RecoverFrom": "sample string 5", "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" } ], "BagCount": 6, "TotalWeight": 1.0, "TotalWeightUOM": "sample string 7" }
application/xml, text/xml
Sample:
<TaskTransferRecoverResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Mobile.Models"> <BagCount>6</BagCount> <ErrorMessage>sample string 2</ErrorMessage> <IsSuccessful>true</IsSuccessful> <ManifestGUID>sample string 3</ManifestGUID> <ManifestNumber>4</ManifestNumber> <RecoverFrom>sample string 5</RecoverFrom> <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> <TotalWeight>1</TotalWeight> <TotalWeightUOM>sample string 7</TotalWeightUOM> </TaskTransferRecoverResp>