POST api/Integration/Alert/Transfer

Request Information

URI Parameters

None.

Body Parameters

Name	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.
RecoverArriveAirportID	string	None.
RecoverDepartAirportID	string	None.
RecoverCarrierIataID	string	None.
RecoverCarrierName	string	None.
RecoverRouteNumber	string	None.
RecoverCarrierServiceName	string	None.
RecoverWaybillNumber	string	None.
RecoverInstructions	string	None.
RecoverArriveDateTime	string	None.
DropDepartAirportID	string	None.
DropArriveAirportID	string	None.
DropCarrierIataID	string	None.
DropCarrierName	string	None.
DropRouteNumber	string	None.
DropCarrierServiceName	string	None.
DropWaybillNumber	string	None.
DropInstructions	string	None.
DropDepartDateTime	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",
  "RecoverArriveAirportID": "sample string 11",
  "RecoverDepartAirportID": "sample string 12",
  "RecoverCarrierIataID": "sample string 13",
  "RecoverCarrierName": "sample string 14",
  "RecoverRouteNumber": "sample string 15",
  "RecoverCarrierServiceName": "sample string 16",
  "RecoverWaybillNumber": "sample string 17",
  "RecoverInstructions": "sample string 18",
  "RecoverArriveDateTime": "sample string 19",
  "DropDepartAirportID": "sample string 20",
  "DropArriveAirportID": "sample string 21",
  "DropCarrierIataID": "sample string 22",
  "DropCarrierName": "sample string 23",
  "DropRouteNumber": "sample string 24",
  "DropCarrierServiceName": "sample string 25",
  "DropWaybillNumber": "sample string 26",
  "DropInstructions": "sample string 27",
  "DropDepartDateTime": "sample string 28"
}

application/xml, text/xml

Sample:

<AlertTRAParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <Contents>sample string 7</Contents>
  <DropArriveAirportID>sample string 21</DropArriveAirportID>
  <DropCarrierIataID>sample string 22</DropCarrierIataID>
  <DropCarrierName>sample string 23</DropCarrierName>
  <DropCarrierServiceName>sample string 25</DropCarrierServiceName>
  <DropDepartAirportID>sample string 20</DropDepartAirportID>
  <DropDepartDateTime>sample string 28</DropDepartDateTime>
  <DropInstructions>sample string 27</DropInstructions>
  <DropRouteNumber>sample string 24</DropRouteNumber>
  <DropWaybillNumber>sample string 26</DropWaybillNumber>
  <Height>1</Height>
  <Length>1</Length>
  <Pieces>3</Pieces>
  <RecoverArriveAirportID>sample string 11</RecoverArriveAirportID>
  <RecoverArriveDateTime>sample string 19</RecoverArriveDateTime>
  <RecoverCarrierIataID>sample string 13</RecoverCarrierIataID>
  <RecoverCarrierName>sample string 14</RecoverCarrierName>
  <RecoverCarrierServiceName>sample string 16</RecoverCarrierServiceName>
  <RecoverDepartAirportID>sample string 12</RecoverDepartAirportID>
  <RecoverInstructions>sample string 18</RecoverInstructions>
  <RecoverRouteNumber>sample string 15</RecoverRouteNumber>
  <RecoverWaybillNumber>sample string 17</RecoverWaybillNumber>
  <Reference>sample string 2</Reference>
  <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>
  <Weight>4</Weight>
  <WeightUOM>sample string 5</WeightUOM>
  <Width>1</Width>
</AlertTRAParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AlertResp

Name	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>