POST api/OpsLog/UpdateTaskPickupAlert/{auth}/{EntityGUID}/{EntityType}

Use this method to update information for the Pickup Alert task.

Request Information

URI Parameters

Name	Description	Type	Additional information
auth	The authorization GUID for this user session	string	Required
EntityGUID	The entity identifer of the task	string	Required
EntityType	The entity type of the task (should only be "P")	string	Required

Body Parameters

(see example below) AlertType=SEND,SENDCONF, AlertHow=PH,EM,FX,ED,APH,AEM,AFX,AED,SMS

TaskPickupAlertParm

Name	Type	Additional information
CourierID	integer	None.
CourierServiceID	integer	None.
AlertHow	string	None.
AlertVia	string	None.
SpokeWith	string	None.
Distance	integer	None.
Weight	decimal number	None.
WaitingTime	integer	None.
AttemptCount	integer	None.
DistanceUOM	string	None.
WeightUOM	string	None.
AlertType	string	None.
LockCost	boolean	None.
Instructions	string	None.

Request Formats

application/json, text/json

Sample:

{
  "CourierID": 1,
  "CourierServiceID": 2,
  "AlertHow": "sample string 3",
  "AlertVia": "sample string 4",
  "SpokeWith": "sample string 5",
  "Distance": 6,
  "Weight": 1.0,
  "WaitingTime": 1,
  "AttemptCount": 1,
  "DistanceUOM": "sample string 7",
  "WeightUOM": "sample string 8",
  "AlertType": "sample string 9",
  "LockCost": true,
  "Instructions": "sample string 11"
}

application/xml, text/xml

Sample:

<TaskPickupAlertParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models">
  <AlertHow>sample string 3</AlertHow>
  <AlertType>sample string 9</AlertType>
  <AlertVia>sample string 4</AlertVia>
  <AttemptCount>1</AttemptCount>
  <CourierID>1</CourierID>
  <CourierServiceID>2</CourierServiceID>
  <Distance>6</Distance>
  <DistanceUOM>sample string 7</DistanceUOM>
  <Instructions>sample string 11</Instructions>
  <LockCost>true</LockCost>
  <SpokeWith>sample string 5</SpokeWith>
  <WaitingTime>1</WaitingTime>
  <Weight>1</Weight>
  <WeightUOM>sample string 8</WeightUOM>
</TaskPickupAlertParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Success or failure and error detail

TaskUpdateResp

Name	Description	Type	Additional information
IsSuccessful		boolean	None.
ErrorMessage		string	None.

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

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