POST api/VesselsByName

Returns any records matching the search criteria provided.

Request Information

URI Parameters

None.

Body Parameters

The parameters for the search

VesselsByNamePostParameters

Name	Description	Type	Additional information
Name	The string to search the Name field for. * wildcards allowed. Case insensitive.	string	Required Min length: 3

Name

Description

Type

Additional 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

Name	Description	Type	Additional information
AISNameResults	The results of the search on the name last transmitted by AIS	Collection of VesselsAPIVessel	None.
CorrectedNameResults	The results of the search on the name as per AIS corrections	Collection of VesselsAPIVessel	None.

Response Formats

application/json, text/json

Sample:

{
  "AISNameResults": [
    {
      "Gt": 1,
      "VesselIdentifier": "sample string 1",
      "Name": "sample string 2",
      "IMO": "sample string 3",
      "MMSI": "sample string 4",
      "CallSign": "sample string 5",
      "Flag": {
        "Name": "sample string 1",
        "Alpha2Code": "sample string 2",
        "Alpha3Code": "sample string 3",
        "NumericCode": "sample string 4",
        "Region": "sample string 5",
        "Continent": "sample string 6"
      },
      "AISType": "sample string 6",
      "Type": "sample string 7",
      "SubType": "sample string 8",
      "Dwt": 1,
      "Length": 1.0,
      "Breadth": 1.0,
      "CommercialOwner": "sample string 9",
      "EffectiveController": "sample string 10",
      "TechnicalManager": "sample string 11",
      "FinancialOwner": "sample string 12"
    },
    {
      "Gt": 1,
      "VesselIdentifier": "sample string 1",
      "Name": "sample string 2",
      "IMO": "sample string 3",
      "MMSI": "sample string 4",
      "CallSign": "sample string 5",
      "Flag": {
        "Name": "sample string 1",
        "Alpha2Code": "sample string 2",
        "Alpha3Code": "sample string 3",
        "NumericCode": "sample string 4",
        "Region": "sample string 5",
        "Continent": "sample string 6"
      },
      "AISType": "sample string 6",
      "Type": "sample string 7",
      "SubType": "sample string 8",
      "Dwt": 1,
      "Length": 1.0,
      "Breadth": 1.0,
      "CommercialOwner": "sample string 9",
      "EffectiveController": "sample string 10",
      "TechnicalManager": "sample string 11",
      "FinancialOwner": "sample string 12"
    }
  ],
  "CorrectedNameResults": [
    {
      "Gt": 1,
      "VesselIdentifier": "sample string 1",
      "Name": "sample string 2",
      "IMO": "sample string 3",
      "MMSI": "sample string 4",
      "CallSign": "sample string 5",
      "Flag": {
        "Name": "sample string 1",
        "Alpha2Code": "sample string 2",
        "Alpha3Code": "sample string 3",
        "NumericCode": "sample string 4",
        "Region": "sample string 5",
        "Continent": "sample string 6"
      },
      "AISType": "sample string 6",
      "Type": "sample string 7",
      "SubType": "sample string 8",
      "Dwt": 1,
      "Length": 1.0,
      "Breadth": 1.0,
      "CommercialOwner": "sample string 9",
      "EffectiveController": "sample string 10",
      "TechnicalManager": "sample string 11",
      "FinancialOwner": "sample string 12"
    },
    {
      "Gt": 1,
      "VesselIdentifier": "sample string 1",
      "Name": "sample string 2",
      "IMO": "sample string 3",
      "MMSI": "sample string 4",
      "CallSign": "sample string 5",
      "Flag": {
        "Name": "sample string 1",
        "Alpha2Code": "sample string 2",
        "Alpha3Code": "sample string 3",
        "NumericCode": "sample string 4",
        "Region": "sample string 5",
        "Continent": "sample string 6"
      },
      "AISType": "sample string 6",
      "Type": "sample string 7",
      "SubType": "sample string 8",
      "Dwt": 1,
      "Length": 1.0,
      "Breadth": 1.0,
      "CommercialOwner": "sample string 9",
      "EffectiveController": "sample string 10",
      "TechnicalManager": "sample string 11",
      "FinancialOwner": "sample string 12"
    }
  ]
}

application/xml, text/xml

Sample:

<VesselsByName xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AISNameResults>
    <VesselsAPIVessel>
      <VesselIdentifier>sample string 1</VesselIdentifier>
      <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>
        <Alpha2Code>sample string 2</Alpha2Code>
        <Alpha3Code>sample string 3</Alpha3Code>
        <NumericCode>sample string 4</NumericCode>
        <Region>sample string 5</Region>
        <Continent>sample string 6</Continent>
      </Flag>
      <AISType>sample string 6</AISType>
      <Type>sample string 7</Type>
      <SubType>sample string 8</SubType>
      <Dwt>1</Dwt>
      <Length>1</Length>
      <Breadth>1</Breadth>
      <CommercialOwner>sample string 9</CommercialOwner>
      <EffectiveController>sample string 10</EffectiveController>
      <TechnicalManager>sample string 11</TechnicalManager>
      <FinancialOwner>sample string 12</FinancialOwner>
      <Gt>1</Gt>
    </VesselsAPIVessel>
    <VesselsAPIVessel>
      <VesselIdentifier>sample string 1</VesselIdentifier>
      <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>
        <Alpha2Code>sample string 2</Alpha2Code>
        <Alpha3Code>sample string 3</Alpha3Code>
        <NumericCode>sample string 4</NumericCode>
        <Region>sample string 5</Region>
        <Continent>sample string 6</Continent>
      </Flag>
      <AISType>sample string 6</AISType>
      <Type>sample string 7</Type>
      <SubType>sample string 8</SubType>
      <Dwt>1</Dwt>
      <Length>1</Length>
      <Breadth>1</Breadth>
      <CommercialOwner>sample string 9</CommercialOwner>
      <EffectiveController>sample string 10</EffectiveController>
      <TechnicalManager>sample string 11</TechnicalManager>
      <FinancialOwner>sample string 12</FinancialOwner>
      <Gt>1</Gt>
    </VesselsAPIVessel>
  </AISNameResults>
  <CorrectedNameResults>
    <VesselsAPIVessel>
      <VesselIdentifier>sample string 1</VesselIdentifier>
      <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>
        <Alpha2Code>sample string 2</Alpha2Code>
        <Alpha3Code>sample string 3</Alpha3Code>
        <NumericCode>sample string 4</NumericCode>
        <Region>sample string 5</Region>
        <Continent>sample string 6</Continent>
      </Flag>
      <AISType>sample string 6</AISType>
      <Type>sample string 7</Type>
      <SubType>sample string 8</SubType>
      <Dwt>1</Dwt>
      <Length>1</Length>
      <Breadth>1</Breadth>
      <CommercialOwner>sample string 9</CommercialOwner>
      <EffectiveController>sample string 10</EffectiveController>
      <TechnicalManager>sample string 11</TechnicalManager>
      <FinancialOwner>sample string 12</FinancialOwner>
      <Gt>1</Gt>
    </VesselsAPIVessel>
    <VesselsAPIVessel>
      <VesselIdentifier>sample string 1</VesselIdentifier>
      <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>
        <Alpha2Code>sample string 2</Alpha2Code>
        <Alpha3Code>sample string 3</Alpha3Code>
        <NumericCode>sample string 4</NumericCode>
        <Region>sample string 5</Region>
        <Continent>sample string 6</Continent>
      </Flag>
      <AISType>sample string 6</AISType>
      <Type>sample string 7</Type>
      <SubType>sample string 8</SubType>
      <Dwt>1</Dwt>
      <Length>1</Length>
      <Breadth>1</Breadth>
      <CommercialOwner>sample string 9</CommercialOwner>
      <EffectiveController>sample string 10</EffectiveController>
      <TechnicalManager>sample string 11</TechnicalManager>
      <FinancialOwner>sample string 12</FinancialOwner>
      <Gt>1</Gt>
    </VesselsAPIVessel>
  </CorrectedNameResults>
</VesselsByName>