POST api/Integration/Alert/RecoverAndDeliver
Request Information
URI Parameters
None.
Body Parameters
AlertRADParmName | Description | Type | Additional information |
---|---|---|---|
UserGUID | string |
None. |
|
Reference | string |
None. |
|
Pieces | integer |
None. |
|
Weight | decimal number |
None. |
|
WeightUOM | string |
None. |
|
Length | integer |
None. |
|
Width | integer |
None. |
|
Height | integer |
None. |
|
SizeUOM | string |
None. |
|
Contents | string |
None. |
|
ShipperName | string |
None. |
|
ShipperPhone | string |
None. |
|
ShipperEmail | string |
None. |
|
ArriveAirportID | string |
None. |
|
DepartAirportID | string |
None. |
|
CarrierIataID | string |
None. |
|
CarrierName | string |
None. |
|
RouteNumber | string |
None. |
|
CarrierServiceName | string |
None. |
|
WaybillNumber | string |
None. |
|
RecoverInstructions | string |
None. |
|
DelCompanyName | string |
None. |
|
DelAddress1 | string |
None. |
|
DelAddress2 | string |
None. |
|
DelAddress3 | string |
None. |
|
DelCityName | string |
None. |
|
DelStateProvID | string |
None. |
|
DelPostalCode | string |
None. |
|
DelCountryID | string |
None. |
|
DelAttention | string |
None. |
|
DelPhoneNumber | string |
None. |
|
DelEmailAddress | string |
None. |
|
DelInstructions | string |
None. |
|
ArriveDateTime | string |
None. |
|
RequestedDeliveryDateTime | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "UserGUID": "sample string 1", "Reference": "sample string 2", "Pieces": 3, "Weight": 4.0, "WeightUOM": "sample string 5", "Length": 1, "Width": 1, "Height": 1, "SizeUOM": "sample string 6", "Contents": "sample string 7", "ShipperName": "sample string 8", "ShipperPhone": "sample string 9", "ShipperEmail": "sample string 10", "ArriveAirportID": "sample string 11", "DepartAirportID": "sample string 12", "CarrierIataID": "sample string 13", "CarrierName": "sample string 14", "RouteNumber": "sample string 15", "CarrierServiceName": "sample string 16", "WaybillNumber": "sample string 17", "RecoverInstructions": "sample string 18", "DelCompanyName": "sample string 19", "DelAddress1": "sample string 20", "DelAddress2": "sample string 21", "DelAddress3": "sample string 22", "DelCityName": "sample string 23", "DelStateProvID": "sample string 24", "DelPostalCode": "sample string 25", "DelCountryID": "sample string 26", "DelAttention": "sample string 27", "DelPhoneNumber": "sample string 28", "DelEmailAddress": "sample string 29", "DelInstructions": "sample string 30", "ArriveDateTime": "sample string 31", "RequestedDeliveryDateTime": "sample string 32" }
application/xml, text/xml
Sample:
<AlertRADParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <ArriveAirportID>sample string 11</ArriveAirportID> <ArriveDateTime>sample string 31</ArriveDateTime> <CarrierIataID>sample string 13</CarrierIataID> <CarrierName>sample string 14</CarrierName> <CarrierServiceName>sample string 16</CarrierServiceName> <Contents>sample string 7</Contents> <DelAddress1>sample string 20</DelAddress1> <DelAddress2>sample string 21</DelAddress2> <DelAddress3>sample string 22</DelAddress3> <DelAttention>sample string 27</DelAttention> <DelCityName>sample string 23</DelCityName> <DelCompanyName>sample string 19</DelCompanyName> <DelCountryID>sample string 26</DelCountryID> <DelEmailAddress>sample string 29</DelEmailAddress> <DelInstructions>sample string 30</DelInstructions> <DelPhoneNumber>sample string 28</DelPhoneNumber> <DelPostalCode>sample string 25</DelPostalCode> <DelStateProvID>sample string 24</DelStateProvID> <DepartAirportID>sample string 12</DepartAirportID> <Height>1</Height> <Length>1</Length> <Pieces>3</Pieces> <RecoverInstructions>sample string 18</RecoverInstructions> <Reference>sample string 2</Reference> <RequestedDeliveryDateTime>sample string 32</RequestedDeliveryDateTime> <RouteNumber>sample string 15</RouteNumber> <ShipperEmail>sample string 10</ShipperEmail> <ShipperName>sample string 8</ShipperName> <ShipperPhone>sample string 9</ShipperPhone> <SizeUOM>sample string 6</SizeUOM> <UserGUID>sample string 1</UserGUID> <WaybillNumber>sample string 17</WaybillNumber> <Weight>4</Weight> <WeightUOM>sample string 5</WeightUOM> <Width>1</Width> </AlertRADParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
AlertRespName | Description | Type | Additional information |
---|---|---|---|
IsSuccessful | boolean |
None. |
|
ErrorMessage | string |
None. |
|
ShipmentNumber | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "IsSuccessful": true, "ErrorMessage": "sample string 2", "ShipmentNumber": 3 }
application/xml, text/xml
Sample:
<AlertResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <ErrorMessage>sample string 2</ErrorMessage> <IsSuccessful>true</IsSuccessful> <ShipmentNumber>3</ShipmentNumber> </AlertResp>