POST api/Vendor/UpdateTaskOutForDelivery

Update information for Out for Delivery Task (OUTFORDEL).

Request Information

URI Parameters

None.

Body Parameters

TaskOutForDeliveryParm
NameDescriptionTypeAdditional information
UserGUID

Unique user global identifier

string

None.

EntityGUID

Unique entity global identifier (ShipmentGUID)

string

None.

Comment

Comment entered by the courier regarding shipment/task

string

None.

Request Formats

application/json, text/json

Sample:
{
  "UserGUID": "sample string 1",
  "EntityGUID": "sample string 2",
  "Comment": "sample string 3"
}

application/xml, text/xml

Sample:
<TaskOutForDeliveryParm 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>
  <UserGUID>sample string 1</UserGUID>
</TaskOutForDeliveryParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

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