POST api/Integration/Status
Request Information
URI Parameters
None.
Body Parameters
IntegrationStatusItemName | Description | Type | Additional information |
---|---|---|---|
UserGUID | string |
None. |
|
ShipmentNumber | string |
None. |
|
Reference | string |
None. |
|
SenderID | string |
None. |
|
ReceiverID | string |
None. |
|
EventCode | string |
None. |
|
EventDateTime | string |
None. |
|
Latitude | decimal number |
None. |
|
Longitude | decimal number |
None. |
|
SignatureText | string |
None. |
|
Pieces | integer |
None. |
|
Weight | decimal number |
None. |
|
WeightUOM | string |
None. |
|
Length | integer |
None. |
|
Width | integer |
None. |
|
Height | integer |
None. |
|
SizeUOM | string |
None. |
|
Distance | integer |
None. |
|
DistanceUOM | string |
None. |
|
PickupWaitingTime | integer |
None. |
|
PickupAttemptCount | integer |
None. |
|
DeliveryWaitingTime | integer |
None. |
|
DeliveryAttemptCount | integer |
None. |
|
QuotedDeliveryDateTime | string |
None. |
|
UpdatedDeliveryDateTime | string |
None. |
|
Images | Collection of ImageItem |
None. |
|
AcknowledgeUserName | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "UserGUID": "sample string 1", "ShipmentNumber": "sample string 2", "Reference": "sample string 3", "SenderID": "sample string 4", "ReceiverID": "sample string 5", "EventCode": "sample string 6", "EventDateTime": "sample string 7", "Latitude": 1.0, "Longitude": 1.0, "SignatureText": "sample string 8", "Pieces": 9, "Weight": 1.0, "WeightUOM": "sample string 10", "Length": 1, "Width": 1, "Height": 1, "SizeUOM": "sample string 11", "Distance": 1, "DistanceUOM": "sample string 12", "PickupWaitingTime": 1, "PickupAttemptCount": 1, "DeliveryWaitingTime": 1, "DeliveryAttemptCount": 1, "QuotedDeliveryDateTime": "sample string 13", "UpdatedDeliveryDateTime": "sample string 14", "Images": [ { "FileName": "sample string 1", "ImageData": "sample string 2", "ImageType": "sample string 3" }, { "FileName": "sample string 1", "ImageData": "sample string 2", "ImageType": "sample string 3" } ], "AcknowledgeUserName": "sample string 15" }
application/xml, text/xml
Sample:
<IntegrationStatusItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <AcknowledgeUserName>sample string 15</AcknowledgeUserName> <DeliveryAttemptCount>1</DeliveryAttemptCount> <DeliveryWaitingTime>1</DeliveryWaitingTime> <Distance>1</Distance> <DistanceUOM>sample string 12</DistanceUOM> <EventCode>sample string 6</EventCode> <EventDateTime>sample string 7</EventDateTime> <Height>1</Height> <Images> <ImageItem> <FileName>sample string 1</FileName> <ImageData>sample string 2</ImageData> <ImageType>sample string 3</ImageType> </ImageItem> <ImageItem> <FileName>sample string 1</FileName> <ImageData>sample string 2</ImageData> <ImageType>sample string 3</ImageType> </ImageItem> </Images> <Latitude>1</Latitude> <Length>1</Length> <Longitude>1</Longitude> <PickupAttemptCount>1</PickupAttemptCount> <PickupWaitingTime>1</PickupWaitingTime> <Pieces>9</Pieces> <QuotedDeliveryDateTime>sample string 13</QuotedDeliveryDateTime> <ReceiverID>sample string 5</ReceiverID> <Reference>sample string 3</Reference> <SenderID>sample string 4</SenderID> <ShipmentNumber>sample string 2</ShipmentNumber> <SignatureText>sample string 8</SignatureText> <SizeUOM>sample string 11</SizeUOM> <UpdatedDeliveryDateTime>sample string 14</UpdatedDeliveryDateTime> <UserGUID>sample string 1</UserGUID> <Weight>1</Weight> <WeightUOM>sample string 10</WeightUOM> <Width>1</Width> </IntegrationStatusItem>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseBaseName | Description | Type | Additional information |
---|---|---|---|
IsSuccessful | boolean |
None. |
|
ErrorMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "IsSuccessful": true, "ErrorMessage": "sample string 2" }
application/xml, text/xml
Sample:
<ResponseBase 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> </ResponseBase>