POST api/Vendor/UpdateTaskRecover

Update information for Recover Task (RECOVER)

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
UserGUID	Unique system generated user identifier	string	None.
EntityGUID	Unique system generated entity identifier (ShipmentGUID)	string	None.
Comment	Comments regarding recovery	string	None.
LocationData	Geocoded location data from device	string	None.
IsOutForDelivery	Set to true if shipment is out for delivery, false if not	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "UserGUID": "sample string 1",
  "EntityGUID": "sample string 2",
  "Comment": "sample string 3",
  "LocationData": "sample string 4",
  "IsOutForDelivery": true
}

application/xml, text/xml

Sample:

<TaskRecoverParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Mobile.Models">
  <Comment>sample string 3</Comment>
  <EntityGUID>sample string 2</EntityGUID>
  <IsOutForDelivery>true</IsOutForDelivery>
  <LocationData>sample string 4</LocationData>
  <UserGUID>sample string 1</UserGUID>
</TaskRecoverParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseBase

Name	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

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:

<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>