POST api/OpsLog/UpdateTaskAlertInbound
Use this method to update the alert inbound task (ALERTINBOUND)
Request Information
URI Parameters
None.
Body Parameters
TaskAlertInboundParm| Name | Description | Type | Additional information |
|---|---|---|---|
| auth | string |
None. |
|
| EntityGUID | string |
None. |
|
| EntityType | string |
None. |
|
| CourierID | integer |
None. |
|
| CourierServiceID | integer |
None. |
|
| AlertHow | string |
None. |
|
| AlertVia | string |
None. |
|
| SpokeWith | string |
None. |
|
| RecoverAndReturnToBase | boolean |
None. |
|
| RecoverAndDeliver | boolean |
None. |
|
| AlertType |
SENDCONF=send and confirm button, SEND=send only button |
string |
None. |
Request Formats
application/json, text/json
Sample:
{
"auth": "sample string 1",
"EntityGUID": "sample string 2",
"EntityType": "sample string 3",
"CourierID": 1,
"CourierServiceID": 1,
"AlertHow": "sample string 4",
"AlertVia": "sample string 5",
"SpokeWith": "sample string 6",
"RecoverAndReturnToBase": true,
"RecoverAndDeliver": true,
"AlertType": "sample string 9"
}
application/xml, text/xml
Sample:
<TaskAlertInboundParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models"> <AlertHow>sample string 4</AlertHow> <AlertType>sample string 9</AlertType> <AlertVia>sample string 5</AlertVia> <CourierID>1</CourierID> <CourierServiceID>1</CourierServiceID> <EntityGUID>sample string 2</EntityGUID> <EntityType>sample string 3</EntityType> <RecoverAndDeliver>true</RecoverAndDeliver> <RecoverAndReturnToBase>true</RecoverAndReturnToBase> <SpokeWith>sample string 6</SpokeWith> <auth>sample string 1</auth> </TaskAlertInboundParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseBase| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccessful |
Set to true if method was successful |
boolean |
None. |
| 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/Mnx.WebApi.Transportation.Models"> <ErrorMessage>sample string 2</ErrorMessage> <IsSuccessful>true</IsSuccessful> </ResponseBase>