POST api/PushNotification
This method implements the push notification payload data receival.
Request Information
URI Parameters
None.
Body Parameters
payload
PushNotificationDataName | Description | Type | Additional information |
---|---|---|---|
msgkey |
Optional but required for Functional Acknowledegment Usage Message Routing Key |
string |
None. |
msgid |
Optional but required for Functional Acknowledegment Usage Unique Message ID |
string |
None. |
cbl |
MVOCC Carrier Bill of Lading Number Format: SCAC plus Manifest Number/Booking Number |
string |
None. |
cnt |
Container Number Format: 11 Alpha Numeric Characters |
string |
None. |
cref |
Array of Client References Format: Alpha Numeric Characters |
Collection of string |
None. |
type |
Notification Type Possible Values: UPDATE|ERROR|NORESULTS|PENDING |
string |
None. |
ack |
A flag indicating success or failure of the web service response back to the client. Default is success. |
AcknowledgeType |
None. |
exceptions |
Message back to client. Mostly used when a web service failure occurs. |
Collection of ResponseExceptionDto |
None. |
ctoken |
Optional Client Token |
string |
None. |
Request Formats
application/json, text/json
{ "msgkey": "sample string 1", "msgid": "sample string 2", "cbl": "sample string 3", "cnt": "sample string 4", "cref": [ "sample string 1", "sample string 2" ], "type": "sample string 5", "ack": 0, "exceptions": [ { "errorcode": "sample string 1", "msg": "sample string 2", "validationcodes": "sample string 3", "suggestion": "sample string 4" }, { "errorcode": "sample string 1", "msg": "sample string 2", "validationcodes": "sample string 3", "suggestion": "sample string 4" } ], "ctoken": "sample string 6" }
application/xml, text/xml
<PushNotificationData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalRestService.Models"> <ack>Failure</ack> <ctoken>sample string 6</ctoken> <exceptions> <ResponseExceptionDto> <errorcode>sample string 1</errorcode> <msg>sample string 2</msg> <suggestion>sample string 4</suggestion> <validationcodes>sample string 3</validationcodes> </ResponseExceptionDto> <ResponseExceptionDto> <errorcode>sample string 1</errorcode> <msg>sample string 2</msg> <suggestion>sample string 4</suggestion> <validationcodes>sample string 3</validationcodes> </ResponseExceptionDto> </exceptions> <cbl>sample string 3</cbl> <cnt>sample string 4</cnt> <cref xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </cref> <msgid>sample string 2</msgid> <msgkey>sample string 1</msgkey> <type>sample string 5</type> </PushNotificationData>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
HTTP RESPONSE MESSAGE
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |