POST api/Integration/Alert
Request Information
URI Parameters
None.
Body Parameters
AlertPUDParmName | 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. |
|
PuCompanyName | string |
None. |
|
PuAddress1 | string |
None. |
|
PuAddress2 | string |
None. |
|
PuAddress3 | string |
None. |
|
PuCityName | string |
None. |
|
PuStateProvID | string |
None. |
|
PuPostalCode | string |
None. |
|
PuCountryID | string |
None. |
|
PuPersonToSee | string |
None. |
|
PuPhoneNumber | string |
None. |
|
PuEmailAddress | string |
None. |
|
PuInstructions | 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. |
|
RequestedPickupDateTime | string |
None. |
|
RequestedDeliveryDateTime | string |
None. |
|
AlertType | 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", "PuCompanyName": "sample string 11", "PuAddress1": "sample string 12", "PuAddress2": "sample string 13", "PuAddress3": "sample string 14", "PuCityName": "sample string 15", "PuStateProvID": "sample string 16", "PuPostalCode": "sample string 17", "PuCountryID": "sample string 18", "PuPersonToSee": "sample string 19", "PuPhoneNumber": "sample string 20", "PuEmailAddress": "sample string 21", "PuInstructions": "sample string 22", "DelCompanyName": "sample string 23", "DelAddress1": "sample string 24", "DelAddress2": "sample string 25", "DelAddress3": "sample string 26", "DelCityName": "sample string 27", "DelStateProvID": "sample string 28", "DelPostalCode": "sample string 29", "DelCountryID": "sample string 30", "DelAttention": "sample string 31", "DelPhoneNumber": "sample string 32", "DelEmailAddress": "sample string 33", "DelInstructions": "sample string 34", "RequestedPickupDateTime": "sample string 35", "RequestedDeliveryDateTime": "sample string 36", "AlertType": "sample string 37" }
application/xml, text/xml
Sample:
<AlertPUDParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <AlertType>sample string 37</AlertType> <Contents>sample string 7</Contents> <DelAddress1>sample string 24</DelAddress1> <DelAddress2>sample string 25</DelAddress2> <DelAddress3>sample string 26</DelAddress3> <DelAttention>sample string 31</DelAttention> <DelCityName>sample string 27</DelCityName> <DelCompanyName>sample string 23</DelCompanyName> <DelCountryID>sample string 30</DelCountryID> <DelEmailAddress>sample string 33</DelEmailAddress> <DelInstructions>sample string 34</DelInstructions> <DelPhoneNumber>sample string 32</DelPhoneNumber> <DelPostalCode>sample string 29</DelPostalCode> <DelStateProvID>sample string 28</DelStateProvID> <Height>1</Height> <Length>1</Length> <Pieces>3</Pieces> <PuAddress1>sample string 12</PuAddress1> <PuAddress2>sample string 13</PuAddress2> <PuAddress3>sample string 14</PuAddress3> <PuCityName>sample string 15</PuCityName> <PuCompanyName>sample string 11</PuCompanyName> <PuCountryID>sample string 18</PuCountryID> <PuEmailAddress>sample string 21</PuEmailAddress> <PuInstructions>sample string 22</PuInstructions> <PuPersonToSee>sample string 19</PuPersonToSee> <PuPhoneNumber>sample string 20</PuPhoneNumber> <PuPostalCode>sample string 17</PuPostalCode> <PuStateProvID>sample string 16</PuStateProvID> <Reference>sample string 2</Reference> <RequestedDeliveryDateTime>sample string 36</RequestedDeliveryDateTime> <RequestedPickupDateTime>sample string 35</RequestedPickupDateTime> <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> </AlertPUDParm>
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>