POST api/Mobile/UpdateOutForDelivery

Update information for Out for Delivery Task (OUTFORDEL).

Request Information

URI Parameters

None.

Body Parameters

TaskOutForDeliveryParmMobile
NameDescriptionTypeAdditional information
UserGUID

Unique user global identifier

 string

None.
EntityGUID

Unique entity global identifier (ShipmentGUID)

 string

None.
LocationData

Geolocation provided at time task is completed

 string

None.
Comment

Notes for the courier to be sent to operations.

 string

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

TaskUpdateResponse
NameDescriptionTypeAdditional information
IsSuccessful

Task update was successful (true) or failure (false)

 boolean

None.
ErrorMessage

Error message if failure

 string

None.

Response Formats

application/json, text/json

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

application/xml, text/xml

Sample: 
<TaskUpdateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models.Mobile">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</TaskUpdateResponse>