POST api/VesselsByName

Returns any records matching the search criteria provided.

Request Information

URI Parameters

None.

Body Parameters

The parameters for the search

VesselsByNamePostParameters
NameDescriptionTypeAdditional information
Name

The string to search the Name field for. * wildcards allowed. Case insensitive.

string

Required

Min length: 3

Request Formats

application/json, text/json

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

application/xml, text/xml

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

Response Information

Resource Description

VesselsByName
NameDescriptionTypeAdditional information
AISNameResults

The results of the search on the name last transmitted by AIS

Collection of Vessel

None.

CorrectedNameResults

The results of the search on the name as per AIS corrections

Collection of Vessel

None.

Response Formats

application/json, text/json

Sample:
{
  "AISNameResults": [
    {
      "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
    }
  ],
  "CorrectedNameResults": [
    {
      "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:
<VesselsByName xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AISNameResults>
    <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>
  </AISNameResults>
  <CorrectedNameResults>
    <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>
  </CorrectedNameResults>
</VesselsByName>