POST api/GetAISTracking

This method returns ais tracking feeds for a queried Carrier Bill of Lading and Container Number.

Request Information


URI Parameters

None.

Body Parameters

GetAISTrackingRequest
NameDescriptionTypeAdditional information
cbl

MVOCC Carrier Bill of Lading Number Format: SCAC plus Manifest Number/Booking Number

string

None.

cnt

Required Container Number Format: 11 Alpha Numeric Characters If the value is null, the response will return all Containers manifested under the MVOCC Carrier Bill of Lading Number.

string

None.

leqseq

Leg Sequence (Default is 1)

integer

None.

positiondatapageno

Positional Data Page Number (Default is 1)

integer

None.

crefs

Array of Client References Format: Alpha Numeric Characters

Collection of string

None.

apikey

Unique Value assigned by an administrator during account setup.

string

None.

username

Username Assigned by an administrator during account setup

string

None.

password

Password Assigned by an administrator during account setup

string

None.

ctoken

Optional Client Token

string

None.

Request Formats

application/json, text/json

Sample:
{
  "cbl": "TESTBL47649363",
  "cnt": "MSCU9070828",
  "leqseq": 1,
  "positiondatapageno": 1,
  "crefs": null,
  "apikey": "APIKEY",
  "username": null,
  "password": null,
  "ctoken": null
}

application/xml, text/xml

Sample:
<GetAISTrackingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalRestService.Models">
  <apikey>sample string 3</apikey>
  <ctoken>sample string 6</ctoken>
  <password>sample string 5</password>
  <username>sample string 4</username>
  <cbl>sample string 1</cbl>
  <cnt>sample string 2</cnt>
  <crefs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </crefs>
  <leqseq>1</leqseq>
  <positiondatapageno>1</positiondatapageno>
</GetAISTrackingRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information


Resource Description

response

GetAISTrackingResponse
NameDescriptionTypeAdditional 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

Required Container Number Format: 11 Alpha Numeric Characters If the value is null, the response will return all Containers manifested under the MVOCC Carrier Bill of Lading Number.

string

None.

crefs

Array of Client References Format: Alpha Numeric Characters

Collection of string

None.

result

Tracking Results

AISTrackingResultDto

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.

Response Formats

application/json, text/json

Sample:
{
  "msgkey": null,
  "msgid": null,
  "cbl": "TESTBL47649363",
  "cnt": "MSCU9070828",
  "crefs": null,
  "result": {
    "uniqueid": "d8d050f5-acb7-4b0e-925b-29c6caaff1d5",
    "cbl": "TESTBL47649363",
    "cnt": "MSCU9070828",
    "legs": [
      {
        "origin": {
          "code": null,
          "locode": null,
          "type": null
        },
        "vessel": {
          "name": null,
          "imo": null,
          "mmsi": null,
          "ein": null,
          "flag": null,
          "callsign": null,
          "type": null,
          "length": null
        },
        "destination": {
          "code": null,
          "locode": null,
          "type": null
        },
        "ata": null,
        "eta": null,
        "atd": null,
        "etd": null,
        "last": {
          "code": null,
          "descrip": null,
          "areacode": null,
          "area": null,
          "lat": null,
          "lng": null,
          "speed": null,
          "course": null,
          "draught": null,
          "date": null,
          "extradata": null
        },
        "seq": 1,
        "totallegs": 1,
        "callports": [
          {
            "port": null,
            "vsl": null,
            "voyin": null,
            "voyout": null,
            "mstz": null,
            "ianatz": null,
            "eta": null,
            "ata": null,
            "etd": null,
            "atd": null
          },
          {
            "port": null,
            "vsl": null,
            "voyin": null,
            "voyout": null,
            "mstz": null,
            "ianatz": null,
            "eta": null,
            "ata": null,
            "etd": null,
            "atd": null
          }
        ],
        "positiondatapage": {
          "count": 10,
          "next": 2,
          "previous": null
        },
        "positions": [
          {
            "code": null,
            "descrip": null,
            "areacode": null,
            "area": null,
            "lat": null,
            "lng": null,
            "speed": null,
            "course": null,
            "draught": null,
            "date": null,
            "extradata": null
          }
        ]
      }
    ]
  },
  "ack": 1,
  "exceptions": null,
  "ctoken": null
}

application/xml, text/xml

Sample:

Sample not available.