POST api/Vendor/UpdateTaskTransferRecover
Use this method to confirm transfer recover
Request Information
URI Parameters
None.
Body Parameters
UpdateTaskTransferRecoverParmName | Description | Type | Additional information |
---|---|---|---|
UserGUID |
Unique authenticated user identifier |
string |
None. |
EntityGUID |
The entity (manifest) identifier to marked transfer recover |
string |
None. |
RecoverType |
The recover type: T = Transfer is completed (default)(update the Drop time on the next manifest) R = Recover only, return to base (do nothing on the next manifest, realert will be required) A = Recover only, will drop later (update the agent on the next manifest, leave drop time null) |
string |
None. |
DropWaybillNumber |
If dropped on next flight, optionally provide waybill number for drop flight |
string |
None. |
Request Formats
application/json, text/json
{ "UserGUID": "sample string 1", "EntityGUID": "sample string 2", "RecoverType": "sample string 3", "DropWaybillNumber": "sample string 4" }
application/xml, text/xml
<UpdateTaskTransferRecoverParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Mobile.Models"> <DropWaybillNumber>sample string 4</DropWaybillNumber> <EntityGUID>sample string 2</EntityGUID> <RecoverType>sample string 3</RecoverType> <UserGUID>sample string 1</UserGUID> </UpdateTaskTransferRecoverParm>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
ResponseBaseName | Description | Type | Additional information |
---|---|---|---|
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
{ "IsSuccessful": true, "ErrorMessage": "sample string 2" }
application/xml, text/xml
<ResponseBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Mobile.Models"> <ErrorMessage>sample string 2</ErrorMessage> <IsSuccessful>true</IsSuccessful> </ResponseBase>