POST api/Mobile/UpdatePickup

Update information for Pickup Task (PICKUP)

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
UserGUID	Unique system assigned user identifier	string	None.
ShipmentGUIDList	Comma separated list of shipment identifier to mark picked-up	string	None.
WaitingTime	Waiting time at pickup in minutes	string	None.
Attempts	Number of attempts at pickup	string	None.
Comment	Comment from the ground agent	string	None.
LocationData	Geolocation provided at time task is completed	string	None.
IsNextTask	true=driver is departed to airport(air) or out for delivery(ground), false=(default)	boolean	None.
Photos	Photos taken at time of pickup (base64 encoded, jpg)	Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "UserGUID": "sample string 1",
  "ShipmentGUIDList": "sample string 2",
  "WaitingTime": "sample string 3",
  "Attempts": "sample string 4",
  "Comment": "sample string 5",
  "LocationData": "sample string 6",
  "IsNextTask": true,
  "Photos": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<TaskPickupParmMobile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models.Mobile">
  <Attempts>sample string 4</Attempts>
  <Comment>sample string 5</Comment>
  <IsNextTask>true</IsNextTask>
  <LocationData>sample string 6</LocationData>
  <Photos xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Photos>
  <ShipmentGUIDList>sample string 2</ShipmentGUIDList>
  <UserGUID>sample string 1</UserGUID>
  <WaitingTime>sample string 3</WaitingTime>
</TaskPickupParmMobile>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

TaskUpdateResponse

Name	Description	Type	Additional 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>