POST api/pushnotification

This method implements the push notification payload data receival.

Request Information

URI Parameters

None.

Body Parameters

payload

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

Sample:

<PushNotificationData>
  <ack>1</ack>
  <ctoken />
  <exceptions />
  <cbl>ONEYAARD05774700</cbl>
  <cnt />
  <cref />
  <msgid />
  <msgkey />
  <type>UPDATE</type>
</PushNotificationData>

application/json, text/json

Sample:

{
  "msgkey": null,
  "msgid": null,
  "cbl": "ONEYAARD05774700",
  "cnt": null,
  "cref": null,
  "type": "UPDATE",
  "ack": 1,
  "exceptions": null,
  "ctoken": null
}

application/x-www-form-urlencoded

Sample:

ack=1&cbl=ONEYAARD05774700&type=UPDATE

text/xml

Sample:

<PushNotificationData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalRestService.Models">
  <ack>0</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>
      <validationdetails i:nil="true" />
    </ResponseExceptionDto>
    <ResponseExceptionDto>
      <errorcode>sample string 1</errorcode>
      <msg>sample string 2</msg>
      <suggestion>sample string 4</suggestion>
      <validationcodes>sample string 3</validationcodes>
      <validationdetails i:nil="true" />
    </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>

Response Information

Resource Description

HTTP RESPONSE MESSAGE

HttpResponseMessage

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

Response Formats

application/xml

Sample:

<HttpResponseMessage xmlns="http://schemas.datacontract.org/2004/07/System.Net.Http">
  <Content />
  <ReasonPhrase>OK</ReasonPhrase>
  <RequestMessage />
  <StatusCode>OK</StatusCode>
  <Version>
    <_Build xmlns="http://schemas.datacontract.org/2004/07/System">-1</_Build>
    <_Major xmlns="http://schemas.datacontract.org/2004/07/System">1</_Major>
    <_Minor xmlns="http://schemas.datacontract.org/2004/07/System">1</_Minor>
    <_Revision xmlns="http://schemas.datacontract.org/2004/07/System">-1</_Revision>
  </Version>
</HttpResponseMessage>

application/json, text/json

Sample:

{
  "Version": {
    "Major": 1,
    "Minor": 1,
    "Build": -1,
    "Revision": -1,
    "MajorRevision": -1,
    "MinorRevision": -1
  },
  "Content": null,
  "StatusCode": 200,
  "ReasonPhrase": "OK",
  "Headers": [],
  "RequestMessage": null,
  "IsSuccessStatusCode": true
}