POST api/OpsLog/UpdateTaskPickupAlertConfirm/{auth}/{EntityGUID}/{EntityType}
Use this method to update information for the Pickup Alert Confirm 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)
TaskPickupAlertConfirmParm| Name | Description | Type | Additional information |
|---|---|---|---|
| CourierServiceID | integer |
None. |
|
| SpokeWith | string |
None. |
|
| Distance | integer |
None. |
|
| Weight | decimal number |
None. |
|
| WaitingTime | integer |
None. |
|
| AttemptCount | integer |
None. |
|
| DistanceUOM | string |
None. |
|
| WeightUOM | string |
None. |
|
| LockCost | boolean |
None. |
|
| Instructions | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"CourierServiceID": 1,
"SpokeWith": "sample string 2",
"Distance": 3,
"Weight": 1.0,
"WaitingTime": 1,
"AttemptCount": 1,
"DistanceUOM": "sample string 4",
"WeightUOM": "sample string 5",
"LockCost": true,
"Instructions": "sample string 7"
}
application/xml, text/xml
Sample:
<TaskPickupAlertConfirmParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models"> <AttemptCount>1</AttemptCount> <CourierServiceID>1</CourierServiceID> <Distance>3</Distance> <DistanceUOM>sample string 4</DistanceUOM> <Instructions>sample string 7</Instructions> <LockCost>true</LockCost> <SpokeWith>sample string 2</SpokeWith> <WaitingTime>1</WaitingTime> <Weight>1</Weight> <WeightUOM>sample string 5</WeightUOM> </TaskPickupAlertConfirmParm>
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>