GET api/OpsLog/SelectTaskDepartToAirport/{auth}/{EntityGUID}/{EntityType}
Use this method retrieve the Depart To Airport 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 "M") |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
TaskDepartToAirportRespName | Description | Type | Additional information |
---|---|---|---|
EntityGUID |
Unique internally assigned identifier for entity (ManifestGUID or ShipmentGUID) |
string |
None. |
EntityType |
Entity type represented in task (M=manifest, S=shipment) |
string |
None. |
EntityNumber |
Unique system assigned user visible entity number (ManifestNumber or ShipmentNumber) |
integer |
None. |
CarrierID |
System assigned carrier identifier |
integer |
None. |
CarrierKey |
User visible carrier identifier key |
string |
None. |
CarrierName |
Name of the carrier |
string |
None. |
CarrierServiceID |
System assigned carrier service identifier |
integer |
None. |
CarrierServiceName |
Name of the carrier service to use |
string |
None. |
CarrierAccountID |
System assigned carrier account identifier |
integer |
None. |
CarrierAccountNumber |
The carrier account number |
string |
None. |
WaybillNumber |
The carriers waybill number |
string |
None. |
Instructions |
Pickup and/or drop instructions |
string |
None. |
CourierID |
System assigned courier identifier |
integer |
None. |
CourierName |
Name of the courier |
string |
None. |
CourierKey |
User assigned courier identifier key |
string |
None. |
CourierServiceID |
System assigned courier service identifier |
integer |
None. |
CourierServiceName |
Couriers service name |
string |
None. |
SpokeWith |
Who we spoke with at courier to confirm alert |
string |
None. |
CourierPhoneNumber |
The couriers phone number |
string |
None. |
CourierEmailAddress |
The courier email address |
string |
None. |
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
{ "EntityGUID": "sample string 1", "EntityType": "sample string 2", "EntityNumber": 3, "CarrierID": 1, "CarrierKey": "sample string 4", "CarrierName": "sample string 5", "CarrierServiceID": 1, "CarrierServiceName": "sample string 6", "CarrierAccountID": 1, "CarrierAccountNumber": "sample string 7", "WaybillNumber": "sample string 8", "Instructions": "sample string 9", "CourierID": 1, "CourierName": "sample string 10", "CourierKey": "sample string 11", "CourierServiceID": 1, "CourierServiceName": "sample string 12", "SpokeWith": "sample string 13", "CourierPhoneNumber": "sample string 14", "CourierEmailAddress": "sample string 15", "IsSuccessful": true, "ErrorMessage": "sample string 17" }
application/xml, text/xml
<TaskDepartToAirportResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models"> <ErrorMessage>sample string 17</ErrorMessage> <IsSuccessful>true</IsSuccessful> <CarrierAccountID>1</CarrierAccountID> <CarrierAccountNumber>sample string 7</CarrierAccountNumber> <CarrierID>1</CarrierID> <CarrierKey>sample string 4</CarrierKey> <CarrierName>sample string 5</CarrierName> <CarrierServiceID>1</CarrierServiceID> <CarrierServiceName>sample string 6</CarrierServiceName> <CourierEmailAddress>sample string 15</CourierEmailAddress> <CourierID>1</CourierID> <CourierKey>sample string 11</CourierKey> <CourierName>sample string 10</CourierName> <CourierPhoneNumber>sample string 14</CourierPhoneNumber> <CourierServiceID>1</CourierServiceID> <CourierServiceName>sample string 12</CourierServiceName> <EntityGUID>sample string 1</EntityGUID> <EntityNumber>3</EntityNumber> <EntityType>sample string 2</EntityType> <Instructions>sample string 9</Instructions> <SpokeWith>sample string 13</SpokeWith> <WaybillNumber>sample string 8</WaybillNumber> </TaskDepartToAirportResp>