POST api/VesselDestinationVerbatimTranslation

Takes a vessel's IMO number, or a series of IMO numbers, and converts the vessel's destination according to its latest AIS transmission to a most-likely port.

Request Information

URI Parameters

None.

Body Parameters

VesselDestinationVerbatimTranslationPostParameters
NameDescriptionTypeAdditional information
VesselIMO

Allows filtering for specific vessels using their IMO number(s)

Collection of string

Required

Max length: 7

Min length: 7

Request Formats

application/json, text/json

Sample: 
{
  "VesselIMO": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

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

Response Information

Resource Description

Collection of VesselDestinationVerbatimTranslationResult
NameDescriptionTypeAdditional information
VerbatimDestination

The latest verbatim destination as transmitted by the vessel on AIS

string

None.
DestinationPort

The most likely destination port

Port

None.
Likelihood

The estimatied likelihood of that destination port being correct (scale 0 for unlikely to 100 for likely)

decimal number

None.
VesselImoNumber

The original IMO number provided to the query

string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "VerbatimDestination": "sample string 1",
    "DestinationPort": {
      "guid": "b63db654-675a-49b7-9e1b-6e22ed574e0f",
      "name": "sample string 2",
      "locode": "sample string 3",
      "wpi_number": "sample string 4",
      "country": {
        "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"
      },
      "risk_rating": "sample string 5",
      "risk_assessment_link": "sample string 6",
      "risk_notes": "sample string 7"
    },
    "Likelihood": 2.0,
    "VesselImoNumber": "sample string 3"
  },
  {
    "VerbatimDestination": "sample string 1",
    "DestinationPort": {
      "guid": "b63db654-675a-49b7-9e1b-6e22ed574e0f",
      "name": "sample string 2",
      "locode": "sample string 3",
      "wpi_number": "sample string 4",
      "country": {
        "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"
      },
      "risk_rating": "sample string 5",
      "risk_assessment_link": "sample string 6",
      "risk_notes": "sample string 7"
    },
    "Likelihood": 2.0,
    "VesselImoNumber": "sample string 3"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfVesselDestinationVerbatimTranslationResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <VesselDestinationVerbatimTranslationResult>
    <VerbatimDestination>sample string 1</VerbatimDestination>
    <DestinationPort>
      <guid>b63db654-675a-49b7-9e1b-6e22ed574e0f</guid>
      <name>sample string 2</name>
      <locode>sample string 3</locode>
      <wpi_number>sample string 4</wpi_number>
      <country>
        <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>
      </country>
      <risk_rating>sample string 5</risk_rating>
      <risk_assessment_link>sample string 6</risk_assessment_link>
      <risk_notes>sample string 7</risk_notes>
    </DestinationPort>
    <Likelihood>2</Likelihood>
    <VesselImoNumber>sample string 3</VesselImoNumber>
  </VesselDestinationVerbatimTranslationResult>
  <VesselDestinationVerbatimTranslationResult>
    <VerbatimDestination>sample string 1</VerbatimDestination>
    <DestinationPort>
      <guid>b63db654-675a-49b7-9e1b-6e22ed574e0f</guid>
      <name>sample string 2</name>
      <locode>sample string 3</locode>
      <wpi_number>sample string 4</wpi_number>
      <country>
        <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>
      </country>
      <risk_rating>sample string 5</risk_rating>
      <risk_assessment_link>sample string 6</risk_assessment_link>
      <risk_notes>sample string 7</risk_notes>
    </DestinationPort>
    <Likelihood>2</Likelihood>
    <VesselImoNumber>sample string 3</VesselImoNumber>
  </VesselDestinationVerbatimTranslationResult>
</ArrayOfVesselDestinationVerbatimTranslationResult>