GET api/Vendor/SelectTaskDeliveryAlert/{UserGUID}/{EntityGUID}
Retreive information for Delivery Alert Task (CONFALERTDEL)
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| UserGUID |
Unique system defined user identifier |
string |
Required |
| EntityGUID |
Unique system defined entity identifier (ShipmentGUID) |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
TaskDeliveryAlertResp| Name | Description | Type | Additional information |
|---|---|---|---|
| EntityGUID |
Unique system generated entity identifier (ShipmentGUID) |
string |
None. |
| PickupFrom |
Pickup from address |
string |
None. |
| DeliverTo |
Deliver to address |
string |
None. |
| Instructions |
Delivery instructions |
string |
None. |
| NumberOfOrders |
Number of orders to deliver |
integer |
None. |
| NumberOfPieces |
Number of pieces to deliver |
integer |
None. |
| TotalWeight |
Total weight of delivery |
decimal number |
None. |
| WeightUOM |
Weight unit of measure (LB,KG) |
string |
None. |
| TrackingNumberDisplay |
Tracking nubmer to display |
string |
None. |
| 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:
{
"EntityGUID": "sample string 1",
"PickupFrom": "sample string 2",
"DeliverTo": "sample string 3",
"Instructions": "sample string 4",
"NumberOfOrders": 5,
"NumberOfPieces": 6,
"TotalWeight": 7.0,
"WeightUOM": "sample string 8",
"TrackingNumberDisplay": "sample string 9",
"IsSuccessful": true,
"ErrorMessage": "sample string 11"
}
application/xml, text/xml
Sample:
<TaskDeliveryAlertResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Mobile.Models"> <ErrorMessage>sample string 11</ErrorMessage> <IsSuccessful>true</IsSuccessful> <DeliverTo>sample string 3</DeliverTo> <EntityGUID>sample string 1</EntityGUID> <Instructions>sample string 4</Instructions> <NumberOfOrders>5</NumberOfOrders> <NumberOfPieces>6</NumberOfPieces> <PickupFrom>sample string 2</PickupFrom> <TotalWeight>7</TotalWeight> <TrackingNumberDisplay>sample string 9</TrackingNumberDisplay> <WeightUOM>sample string 8</WeightUOM> </TaskDeliveryAlertResp>