POST api/Vessels

Returns any records matching the search criteria provided.

Request Information

URI Parameters

None.

Body Parameters

The parameters for the search

VesselsPostParameters

Name	Description	Type	Additional information
Imo	The IMO number of the vessel	string	Required Max length: 7 Min length: 7

Name

Description

Type

Additional 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

Name	Type	Additional information
vessel_identifier	globally unique identifier	None.
name	string	None.
imo	string	None.
mmsi	string	None.
callsign	string	None.
flag	Country	None.
ais_type	string	None.
type	string	None.
sub_type	string	None.
dwt	integer	None.
length	decimal number	None.
breadth	decimal number	None.
commercial_owner	string	None.
effective_controller	string	None.
technical_manager	string	None.
financial_owner	string	None.
gt	integer	None.
year_of_build	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "vessel_identifier": "a8ef677f-7b34-43bd-a0a6-f5695ade3d77",
    "name": "sample string 2",
    "imo": "sample string 3",
    "mmsi": "sample string 4",
    "callsign": "sample string 5",
    "flag": {
      "name": "sample string 1",
      "alpha_2_code": "sample string 2",
      "alpha_3_code": "sample string 3",
      "numeric_code": "sample string 4",
      "region": "sample string 5",
      "continent": "sample string 6"
    },
    "ais_type": "sample string 6",
    "type": "sample string 7",
    "sub_type": "sample string 8",
    "dwt": 1,
    "length": 1.0,
    "breadth": 1.0,
    "commercial_owner": "sample string 9",
    "effective_controller": "sample string 10",
    "technical_manager": "sample string 11",
    "financial_owner": "sample string 12",
    "gt": 1,
    "year_of_build": 1
  },
  {
    "vessel_identifier": "a8ef677f-7b34-43bd-a0a6-f5695ade3d77",
    "name": "sample string 2",
    "imo": "sample string 3",
    "mmsi": "sample string 4",
    "callsign": "sample string 5",
    "flag": {
      "name": "sample string 1",
      "alpha_2_code": "sample string 2",
      "alpha_3_code": "sample string 3",
      "numeric_code": "sample string 4",
      "region": "sample string 5",
      "continent": "sample string 6"
    },
    "ais_type": "sample string 6",
    "type": "sample string 7",
    "sub_type": "sample string 8",
    "dwt": 1,
    "length": 1.0,
    "breadth": 1.0,
    "commercial_owner": "sample string 9",
    "effective_controller": "sample string 10",
    "technical_manager": "sample string 11",
    "financial_owner": "sample string 12",
    "gt": 1,
    "year_of_build": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfVessel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Vessel>
    <vessel_identifier>a8ef677f-7b34-43bd-a0a6-f5695ade3d77</vessel_identifier>
    <name>sample string 2</name>
    <imo>sample string 3</imo>
    <mmsi>sample string 4</mmsi>
    <callsign>sample string 5</callsign>
    <flag>
      <name>sample string 1</name>
      <alpha_2_code>sample string 2</alpha_2_code>
      <alpha_3_code>sample string 3</alpha_3_code>
      <numeric_code>sample string 4</numeric_code>
      <region>sample string 5</region>
      <continent>sample string 6</continent>
    </flag>
    <ais_type>sample string 6</ais_type>
    <type>sample string 7</type>
    <sub_type>sample string 8</sub_type>
    <dwt>1</dwt>
    <length>1</length>
    <breadth>1</breadth>
    <commercial_owner>sample string 9</commercial_owner>
    <effective_controller>sample string 10</effective_controller>
    <technical_manager>sample string 11</technical_manager>
    <financial_owner>sample string 12</financial_owner>
    <gt>1</gt>
    <year_of_build>1</year_of_build>
  </Vessel>
  <Vessel>
    <vessel_identifier>a8ef677f-7b34-43bd-a0a6-f5695ade3d77</vessel_identifier>
    <name>sample string 2</name>
    <imo>sample string 3</imo>
    <mmsi>sample string 4</mmsi>
    <callsign>sample string 5</callsign>
    <flag>
      <name>sample string 1</name>
      <alpha_2_code>sample string 2</alpha_2_code>
      <alpha_3_code>sample string 3</alpha_3_code>
      <numeric_code>sample string 4</numeric_code>
      <region>sample string 5</region>
      <continent>sample string 6</continent>
    </flag>
    <ais_type>sample string 6</ais_type>
    <type>sample string 7</type>
    <sub_type>sample string 8</sub_type>
    <dwt>1</dwt>
    <length>1</length>
    <breadth>1</breadth>
    <commercial_owner>sample string 9</commercial_owner>
    <effective_controller>sample string 10</effective_controller>
    <technical_manager>sample string 11</technical_manager>
    <financial_owner>sample string 12</financial_owner>
    <gt>1</gt>
    <year_of_build>1</year_of_build>
  </Vessel>
</ArrayOfVessel>