POST api/Mobile/UpdateConfirmPickupAlert

Update information for Pickup Alert Task (CONFALERTPU)

Request Information

URI Parameters

None.

Body Parameters

ConfirmPickupAlertParm
NameDescriptionTypeAdditional information
UserGUID

string

None.

EntityGUID

string

None.

AcceptOrDecline

string

None.

Comment

string

None.

LocationData

string

None.

IsEnRouteToPickup

boolean

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

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

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>