POST api/PushTrackingV2
This method implements the push tracking payload data receival.
Request Information
URI Parameters
None.
Body Parameters
payload
PushTrackingDataV2Name | 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. |
cnt |
Required Container Number If the value is null, the response will return all Containers manifested under the MVOCC Carrier Bill of Lading Number. |
string |
None. |
carrier |
Optional but preferred Carrier Code e.g.: MSC |
string |
None. |
blref |
Optional but preferred Carrier Bill's Manifest Reference or Booking Number without SCAC prefix. This must be accompanied with a Carrier Code. |
string |
None. |
cref |
Array of Client References Format: Alpha Numeric Characters |
Collection of string |
None. |
result |
Tracking Results Version 2 for the CNT (Container) |
ContainerTrackingResult |
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", "cnt": "sample string 3", "carrier": "sample string 4", "blref": "sample string 5", "cref": [ "sample string 1", "sample string 2" ], "result": { "UNIQUEID": "sample string 1", "CNT": "sample string 2", "TYPE": { "Tag": "sample string 1", "ShortName": "sample string 2", "LongName": "sample string 3", "AlternativeNamesText": "sample string 4", "LengthInFeet": 1.1, "WidthInFeet": 1.1, "HeightInFeet": 1.1, "CapacityInCubicFeet": 1.1, "Description": "sample string 5" }, "EVENTS": [ { "Sequence": 1, "EventCode": "sample string 1", "Description": "sample string 2", "CarrierCode": "sample string 3", "BOL": "sample string 4", "VesselName": "sample string 5", "VoyageNumber": "sample string 6", "IMO": "sample string 7", "MMSI": "sample string 8", "RailCar": "sample string 9", "Mode": "sample string 10", "IsEstimate": true, "EventDate": "2022-05-18T07:24:05.1154089+00:00", "TimeZone": "sample string 11", "IANATZ": "sample string 12", "EventLocation": { "LocationText": "sample string 1", "UnLocode": "sample string 2", "City": "sample string 3", "Province": "sample string 4", "CountryCode": "sample string 5", "GeoWayPoints": "sample string 6", "OLSENTZ": "sample string 7", "MSTZ": "sample string 8" }, "Facility": "sample string 13", "FacilityCode": "sample string 14", "Reference": "sample string 15" }, { "Sequence": 1, "EventCode": "sample string 1", "Description": "sample string 2", "CarrierCode": "sample string 3", "BOL": "sample string 4", "VesselName": "sample string 5", "VoyageNumber": "sample string 6", "IMO": "sample string 7", "MMSI": "sample string 8", "RailCar": "sample string 9", "Mode": "sample string 10", "IsEstimate": true, "EventDate": "2022-05-18T07:24:05.1154089+00:00", "TimeZone": "sample string 11", "IANATZ": "sample string 12", "EventLocation": { "LocationText": "sample string 1", "UnLocode": "sample string 2", "City": "sample string 3", "Province": "sample string 4", "CountryCode": "sample string 5", "GeoWayPoints": "sample string 6", "OLSENTZ": "sample string 7", "MSTZ": "sample string 8" }, "Facility": "sample string 13", "FacilityCode": "sample string 14", "Reference": "sample string 15" } ], "BOLS": [ { "BOL": "sample string 1", "CARRIER": { "SCAC": "sample string 1", "Name": "sample string 2", "CommonName": "sample string 3", "Type": 1 }, "POR": { "LocationText": "sample string 1", "UnLocode": "sample string 2", "City": "sample string 3", "Province": "sample string 4", "CountryCode": "sample string 5", "GeoWayPoints": "sample string 6", "OLSENTZ": "sample string 7", "MSTZ": "sample string 8" }, "POL": { "LocationText": "sample string 1", "UnLocode": "sample string 2", "City": "sample string 3", "Province": "sample string 4", "CountryCode": "sample string 5", "GeoWayPoints": "sample string 6", "OLSENTZ": "sample string 7", "MSTZ": "sample string 8" }, "POD": { "LocationText": "sample string 1", "UnLocode": "sample string 2", "City": "sample string 3", "Province": "sample string 4", "CountryCode": "sample string 5", "GeoWayPoints": "sample string 6", "OLSENTZ": "sample string 7", "MSTZ": "sample string 8" }, "DEL": { "LocationText": "sample string 1", "UnLocode": "sample string 2", "City": "sample string 3", "Province": "sample string 4", "CountryCode": "sample string 5", "GeoWayPoints": "sample string 6", "OLSENTZ": "sample string 7", "MSTZ": "sample string 8" }, "EVENTS": [ { "Sequence": 1, "EventCode": "sample string 1", "Description": "sample string 2", "CarrierCode": "sample string 3", "BOL": "sample string 4", "VesselName": "sample string 5", "VoyageNumber": "sample string 6", "IMO": "sample string 7", "MMSI": "sample string 8", "RailCar": "sample string 9", "Mode": "sample string 10", "IsEstimate": true, "EventDate": "2022-05-18T07:24:05.1154089+00:00", "TimeZone": "sample string 11", "IANATZ": "sample string 12", "EventLocation": { "LocationText": "sample string 1", "UnLocode": "sample string 2", "City": "sample string 3", "Province": "sample string 4", "CountryCode": "sample string 5", "GeoWayPoints": "sample string 6", "OLSENTZ": "sample string 7", "MSTZ": "sample string 8" }, "Facility": "sample string 13", "FacilityCode": "sample string 14", "Reference": "sample string 15" }, { "Sequence": 1, "EventCode": "sample string 1", "Description": "sample string 2", "CarrierCode": "sample string 3", "BOL": "sample string 4", "VesselName": "sample string 5", "VoyageNumber": "sample string 6", "IMO": "sample string 7", "MMSI": "sample string 8", "RailCar": "sample string 9", "Mode": "sample string 10", "IsEstimate": true, "EventDate": "2022-05-18T07:24:05.1154089+00:00", "TimeZone": "sample string 11", "IANATZ": "sample string 12", "EventLocation": { "LocationText": "sample string 1", "UnLocode": "sample string 2", "City": "sample string 3", "Province": "sample string 4", "CountryCode": "sample string 5", "GeoWayPoints": "sample string 6", "OLSENTZ": "sample string 7", "MSTZ": "sample string 8" }, "Facility": "sample string 13", "FacilityCode": "sample string 14", "Reference": "sample string 15" } ] }, { "BOL": "sample string 1", "CARRIER": { "SCAC": "sample string 1", "Name": "sample string 2", "CommonName": "sample string 3", "Type": 1 }, "POR": { "LocationText": "sample string 1", "UnLocode": "sample string 2", "City": "sample string 3", "Province": "sample string 4", "CountryCode": "sample string 5", "GeoWayPoints": "sample string 6", "OLSENTZ": "sample string 7", "MSTZ": "sample string 8" }, "POL": { "LocationText": "sample string 1", "UnLocode": "sample string 2", "City": "sample string 3", "Province": "sample string 4", "CountryCode": "sample string 5", "GeoWayPoints": "sample string 6", "OLSENTZ": "sample string 7", "MSTZ": "sample string 8" }, "POD": { "LocationText": "sample string 1", "UnLocode": "sample string 2", "City": "sample string 3", "Province": "sample string 4", "CountryCode": "sample string 5", "GeoWayPoints": "sample string 6", "OLSENTZ": "sample string 7", "MSTZ": "sample string 8" }, "DEL": { "LocationText": "sample string 1", "UnLocode": "sample string 2", "City": "sample string 3", "Province": "sample string 4", "CountryCode": "sample string 5", "GeoWayPoints": "sample string 6", "OLSENTZ": "sample string 7", "MSTZ": "sample string 8" }, "EVENTS": [ { "Sequence": 1, "EventCode": "sample string 1", "Description": "sample string 2", "CarrierCode": "sample string 3", "BOL": "sample string 4", "VesselName": "sample string 5", "VoyageNumber": "sample string 6", "IMO": "sample string 7", "MMSI": "sample string 8", "RailCar": "sample string 9", "Mode": "sample string 10", "IsEstimate": true, "EventDate": "2022-05-18T07:24:05.1154089+00:00", "TimeZone": "sample string 11", "IANATZ": "sample string 12", "EventLocation": { "LocationText": "sample string 1", "UnLocode": "sample string 2", "City": "sample string 3", "Province": "sample string 4", "CountryCode": "sample string 5", "GeoWayPoints": "sample string 6", "OLSENTZ": "sample string 7", "MSTZ": "sample string 8" }, "Facility": "sample string 13", "FacilityCode": "sample string 14", "Reference": "sample string 15" }, { "Sequence": 1, "EventCode": "sample string 1", "Description": "sample string 2", "CarrierCode": "sample string 3", "BOL": "sample string 4", "VesselName": "sample string 5", "VoyageNumber": "sample string 6", "IMO": "sample string 7", "MMSI": "sample string 8", "RailCar": "sample string 9", "Mode": "sample string 10", "IsEstimate": true, "EventDate": "2022-05-18T07:24:05.1154089+00:00", "TimeZone": "sample string 11", "IANATZ": "sample string 12", "EventLocation": { "LocationText": "sample string 1", "UnLocode": "sample string 2", "City": "sample string 3", "Province": "sample string 4", "CountryCode": "sample string 5", "GeoWayPoints": "sample string 6", "OLSENTZ": "sample string 7", "MSTZ": "sample string 8" }, "Facility": "sample string 13", "FacilityCode": "sample string 14", "Reference": "sample string 15" } ] } ] }, "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
<PushTrackingDataV2 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> <blref>sample string 5</blref> <carrier>sample string 4</carrier> <cnt>sample string 3</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> <result> <BOLS> <ContainerBLResult> <BOL>sample string 1</BOL> <CARRIER> <CommonName>sample string 3</CommonName> <Name>sample string 2</Name> <SCAC>sample string 1</SCAC> <Type>Ocean</Type> </CARRIER> <DEL> <City>sample string 3</City> <CountryCode>sample string 5</CountryCode> <GeoWayPoints>sample string 6</GeoWayPoints> <LocationText>sample string 1</LocationText> <MSTZ>sample string 8</MSTZ> <OLSENTZ>sample string 7</OLSENTZ> <Province>sample string 4</Province> <UnLocode>sample string 2</UnLocode> </DEL> <EVENTS> <ContainerEvent> <BOL>sample string 4</BOL> <CarrierCode>sample string 3</CarrierCode> <Description>sample string 2</Description> <EventCode>sample string 1</EventCode> <EventDate>2022-05-18T07:24:05.1154089+00:00</EventDate> <EventLocation> <City>sample string 3</City> <CountryCode>sample string 5</CountryCode> <GeoWayPoints>sample string 6</GeoWayPoints> <LocationText>sample string 1</LocationText> <MSTZ>sample string 8</MSTZ> <OLSENTZ>sample string 7</OLSENTZ> <Province>sample string 4</Province> <UnLocode>sample string 2</UnLocode> </EventLocation> <Facility>sample string 13</Facility> <FacilityCode>sample string 14</FacilityCode> <IANATZ>sample string 12</IANATZ> <IMO>sample string 7</IMO> <IsEstimate>true</IsEstimate> <MMSI>sample string 8</MMSI> <Mode>sample string 10</Mode> <RailCar>sample string 9</RailCar> <Reference>sample string 15</Reference> <Sequence>1</Sequence> <TimeZone>sample string 11</TimeZone> <VesselName>sample string 5</VesselName> <VoyageNumber>sample string 6</VoyageNumber> </ContainerEvent> <ContainerEvent> <BOL>sample string 4</BOL> <CarrierCode>sample string 3</CarrierCode> <Description>sample string 2</Description> <EventCode>sample string 1</EventCode> <EventDate>2022-05-18T07:24:05.1154089+00:00</EventDate> <EventLocation> <City>sample string 3</City> <CountryCode>sample string 5</CountryCode> <GeoWayPoints>sample string 6</GeoWayPoints> <LocationText>sample string 1</LocationText> <MSTZ>sample string 8</MSTZ> <OLSENTZ>sample string 7</OLSENTZ> <Province>sample string 4</Province> <UnLocode>sample string 2</UnLocode> </EventLocation> <Facility>sample string 13</Facility> <FacilityCode>sample string 14</FacilityCode> <IANATZ>sample string 12</IANATZ> <IMO>sample string 7</IMO> <IsEstimate>true</IsEstimate> <MMSI>sample string 8</MMSI> <Mode>sample string 10</Mode> <RailCar>sample string 9</RailCar> <Reference>sample string 15</Reference> <Sequence>1</Sequence> <TimeZone>sample string 11</TimeZone> <VesselName>sample string 5</VesselName> <VoyageNumber>sample string 6</VoyageNumber> </ContainerEvent> </EVENTS> <POD> <City>sample string 3</City> <CountryCode>sample string 5</CountryCode> <GeoWayPoints>sample string 6</GeoWayPoints> <LocationText>sample string 1</LocationText> <MSTZ>sample string 8</MSTZ> <OLSENTZ>sample string 7</OLSENTZ> <Province>sample string 4</Province> <UnLocode>sample string 2</UnLocode> </POD> <POL> <City>sample string 3</City> <CountryCode>sample string 5</CountryCode> <GeoWayPoints>sample string 6</GeoWayPoints> <LocationText>sample string 1</LocationText> <MSTZ>sample string 8</MSTZ> <OLSENTZ>sample string 7</OLSENTZ> <Province>sample string 4</Province> <UnLocode>sample string 2</UnLocode> </POL> <POR> <City>sample string 3</City> <CountryCode>sample string 5</CountryCode> <GeoWayPoints>sample string 6</GeoWayPoints> <LocationText>sample string 1</LocationText> <MSTZ>sample string 8</MSTZ> <OLSENTZ>sample string 7</OLSENTZ> <Province>sample string 4</Province> <UnLocode>sample string 2</UnLocode> </POR> </ContainerBLResult> <ContainerBLResult> <BOL>sample string 1</BOL> <CARRIER> <CommonName>sample string 3</CommonName> <Name>sample string 2</Name> <SCAC>sample string 1</SCAC> <Type>Ocean</Type> </CARRIER> <DEL> <City>sample string 3</City> <CountryCode>sample string 5</CountryCode> <GeoWayPoints>sample string 6</GeoWayPoints> <LocationText>sample string 1</LocationText> <MSTZ>sample string 8</MSTZ> <OLSENTZ>sample string 7</OLSENTZ> <Province>sample string 4</Province> <UnLocode>sample string 2</UnLocode> </DEL> <EVENTS> <ContainerEvent> <BOL>sample string 4</BOL> <CarrierCode>sample string 3</CarrierCode> <Description>sample string 2</Description> <EventCode>sample string 1</EventCode> <EventDate>2022-05-18T07:24:05.1154089+00:00</EventDate> <EventLocation> <City>sample string 3</City> <CountryCode>sample string 5</CountryCode> <GeoWayPoints>sample string 6</GeoWayPoints> <LocationText>sample string 1</LocationText> <MSTZ>sample string 8</MSTZ> <OLSENTZ>sample string 7</OLSENTZ> <Province>sample string 4</Province> <UnLocode>sample string 2</UnLocode> </EventLocation> <Facility>sample string 13</Facility> <FacilityCode>sample string 14</FacilityCode> <IANATZ>sample string 12</IANATZ> <IMO>sample string 7</IMO> <IsEstimate>true</IsEstimate> <MMSI>sample string 8</MMSI> <Mode>sample string 10</Mode> <RailCar>sample string 9</RailCar> <Reference>sample string 15</Reference> <Sequence>1</Sequence> <TimeZone>sample string 11</TimeZone> <VesselName>sample string 5</VesselName> <VoyageNumber>sample string 6</VoyageNumber> </ContainerEvent> <ContainerEvent> <BOL>sample string 4</BOL> <CarrierCode>sample string 3</CarrierCode> <Description>sample string 2</Description> <EventCode>sample string 1</EventCode> <EventDate>2022-05-18T07:24:05.1154089+00:00</EventDate> <EventLocation> <City>sample string 3</City> <CountryCode>sample string 5</CountryCode> <GeoWayPoints>sample string 6</GeoWayPoints> <LocationText>sample string 1</LocationText> <MSTZ>sample string 8</MSTZ> <OLSENTZ>sample string 7</OLSENTZ> <Province>sample string 4</Province> <UnLocode>sample string 2</UnLocode> </EventLocation> <Facility>sample string 13</Facility> <FacilityCode>sample string 14</FacilityCode> <IANATZ>sample string 12</IANATZ> <IMO>sample string 7</IMO> <IsEstimate>true</IsEstimate> <MMSI>sample string 8</MMSI> <Mode>sample string 10</Mode> <RailCar>sample string 9</RailCar> <Reference>sample string 15</Reference> <Sequence>1</Sequence> <TimeZone>sample string 11</TimeZone> <VesselName>sample string 5</VesselName> <VoyageNumber>sample string 6</VoyageNumber> </ContainerEvent> </EVENTS> <POD> <City>sample string 3</City> <CountryCode>sample string 5</CountryCode> <GeoWayPoints>sample string 6</GeoWayPoints> <LocationText>sample string 1</LocationText> <MSTZ>sample string 8</MSTZ> <OLSENTZ>sample string 7</OLSENTZ> <Province>sample string 4</Province> <UnLocode>sample string 2</UnLocode> </POD> <POL> <City>sample string 3</City> <CountryCode>sample string 5</CountryCode> <GeoWayPoints>sample string 6</GeoWayPoints> <LocationText>sample string 1</LocationText> <MSTZ>sample string 8</MSTZ> <OLSENTZ>sample string 7</OLSENTZ> <Province>sample string 4</Province> <UnLocode>sample string 2</UnLocode> </POL> <POR> <City>sample string 3</City> <CountryCode>sample string 5</CountryCode> <GeoWayPoints>sample string 6</GeoWayPoints> <LocationText>sample string 1</LocationText> <MSTZ>sample string 8</MSTZ> <OLSENTZ>sample string 7</OLSENTZ> <Province>sample string 4</Province> <UnLocode>sample string 2</UnLocode> </POR> </ContainerBLResult> </BOLS> <CNT>sample string 2</CNT> <EVENTS> <ContainerEvent> <BOL>sample string 4</BOL> <CarrierCode>sample string 3</CarrierCode> <Description>sample string 2</Description> <EventCode>sample string 1</EventCode> <EventDate>2022-05-18T07:24:05.1154089+00:00</EventDate> <EventLocation> <City>sample string 3</City> <CountryCode>sample string 5</CountryCode> <GeoWayPoints>sample string 6</GeoWayPoints> <LocationText>sample string 1</LocationText> <MSTZ>sample string 8</MSTZ> <OLSENTZ>sample string 7</OLSENTZ> <Province>sample string 4</Province> <UnLocode>sample string 2</UnLocode> </EventLocation> <Facility>sample string 13</Facility> <FacilityCode>sample string 14</FacilityCode> <IANATZ>sample string 12</IANATZ> <IMO>sample string 7</IMO> <IsEstimate>true</IsEstimate> <MMSI>sample string 8</MMSI> <Mode>sample string 10</Mode> <RailCar>sample string 9</RailCar> <Reference>sample string 15</Reference> <Sequence>1</Sequence> <TimeZone>sample string 11</TimeZone> <VesselName>sample string 5</VesselName> <VoyageNumber>sample string 6</VoyageNumber> </ContainerEvent> <ContainerEvent> <BOL>sample string 4</BOL> <CarrierCode>sample string 3</CarrierCode> <Description>sample string 2</Description> <EventCode>sample string 1</EventCode> <EventDate>2022-05-18T07:24:05.1154089+00:00</EventDate> <EventLocation> <City>sample string 3</City> <CountryCode>sample string 5</CountryCode> <GeoWayPoints>sample string 6</GeoWayPoints> <LocationText>sample string 1</LocationText> <MSTZ>sample string 8</MSTZ> <OLSENTZ>sample string 7</OLSENTZ> <Province>sample string 4</Province> <UnLocode>sample string 2</UnLocode> </EventLocation> <Facility>sample string 13</Facility> <FacilityCode>sample string 14</FacilityCode> <IANATZ>sample string 12</IANATZ> <IMO>sample string 7</IMO> <IsEstimate>true</IsEstimate> <MMSI>sample string 8</MMSI> <Mode>sample string 10</Mode> <RailCar>sample string 9</RailCar> <Reference>sample string 15</Reference> <Sequence>1</Sequence> <TimeZone>sample string 11</TimeZone> <VesselName>sample string 5</VesselName> <VoyageNumber>sample string 6</VoyageNumber> </ContainerEvent> </EVENTS> <TYPE> <AlternativeNamesText>sample string 4</AlternativeNamesText> <CapacityInCubicFeet>1.1</CapacityInCubicFeet> <Description>sample string 5</Description> <HeightInFeet>1.1</HeightInFeet> <LengthInFeet>1.1</LengthInFeet> <LongName>sample string 3</LongName> <ShortName>sample string 2</ShortName> <Tag>sample string 1</Tag> <WidthInFeet>1.1</WidthInFeet> </TYPE> <UNIQUEID>sample string 1</UNIQUEID> </result> </PushTrackingDataV2>
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. |