POST api/Vessels

Returns any records matching the search criteria provided.

Request Information

URI Parameters

None.

Body Parameters

The parameters for the search

VesselsPostParameters
NameDescriptionTypeAdditional information
Imo

The IMO number of the vessel

string

Required

Max length: 7

Min length: 7

Request Formats

application/json, text/json

Sample:
{
  "Imo": "sample string 1"
}

application/xml, text/xml

Sample:
<VesselsPostParameters xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Imo>sample string 1</Imo>
</VesselsPostParameters>

Response Information

Resource Description

Collection of Vessel
NameDescriptionTypeAdditional information
Name

The name

string

None.

IMO

The IMO number

string

None.

MMSI

The MMSI number

string

None.

CallSign

The call sign of the vessel as transmitted by AIS

string

None.

Flag

The flag-state

Country

None.

Type

The type of vessel

string

None.

Dwt

The DWT

integer

None.

Length

The length of the vessel (m) as transmissed by the dimensionToBow and dimensionToStern fields transmitted by AIS

decimal number

None.

Breadth

The breadth of the vessel (m) as transmissed by the dimensionToPort and dimensionToStarboard fields transmitted by AIS

decimal number

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Name": "sample string 1",
    "IMO": "sample string 2",
    "MMSI": "sample string 3",
    "CallSign": "sample string 4",
    "Flag": {
      "Name": "sample string 1",
      "Alpha2code": "sample string 2"
    },
    "Type": "sample string 5",
    "Dwt": 1,
    "Length": 1.0,
    "Breadth": 1.0
  },
  {
    "Name": "sample string 1",
    "IMO": "sample string 2",
    "MMSI": "sample string 3",
    "CallSign": "sample string 4",
    "Flag": {
      "Name": "sample string 1",
      "Alpha2code": "sample string 2"
    },
    "Type": "sample string 5",
    "Dwt": 1,
    "Length": 1.0,
    "Breadth": 1.0
  }
]

application/xml, text/xml

Sample:
<ArrayOfVessel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Vessel>
    <Name>sample string 1</Name>
    <IMO>sample string 2</IMO>
    <MMSI>sample string 3</MMSI>
    <CallSign>sample string 4</CallSign>
    <Flag>
      <Name>sample string 1</Name>
      <Alpha2code>sample string 2</Alpha2code>
    </Flag>
    <Type>sample string 5</Type>
    <Dwt>1</Dwt>
    <Length>1</Length>
    <Breadth>1</Breadth>
  </Vessel>
  <Vessel>
    <Name>sample string 1</Name>
    <IMO>sample string 2</IMO>
    <MMSI>sample string 3</MMSI>
    <CallSign>sample string 4</CallSign>
    <Flag>
      <Name>sample string 1</Name>
      <Alpha2code>sample string 2</Alpha2code>
    </Flag>
    <Type>sample string 5</Type>
    <Dwt>1</Dwt>
    <Length>1</Length>
    <Breadth>1</Breadth>
  </Vessel>
</ArrayOfVessel>