POST api/Vendor/UpdateTaskPickupAlert

Update information for Pickup Alert Task (CONFALERTPU)

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 (PickupGUID)	string	None.
AcceptOrDecline	Accept or Decline pickup alert	string	None.
Comment	Comments from courier regarding pickup	string	None.
LocationData	Geocoded location data from device	string	None.
IsEnRouteToPickup	Set to true if courier is en route to pickup	boolean	None.
IsEnRoutePickup	(TEMPOARY, REMOVE AFTER NEXT RELEASE, CHECK WITH MOBILE DEVELOPER TO MAKE SURE THEY ARE USING IsEnRouteToPickup) This is included only because of a typo in the production mobile apps parameters	boolean	None.
Photos	This is a list of photo's to be attached to the shipment(s)	Collection of string	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,
  "IsEnRoutePickup": true,
  "Photos": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<TaskPickupAlertParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Mobile.Models">
  <AcceptOrDecline>sample string 3</AcceptOrDecline>
  <Comment>sample string 4</Comment>
  <EntityGUID>sample string 2</EntityGUID>
  <IsEnRoutePickup>true</IsEnRoutePickup>
  <IsEnRouteToPickup>true</IsEnRouteToPickup>
  <LocationData>sample string 5</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>
  <UserGUID>sample string 1</UserGUID>
</TaskPickupAlertParm>

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>