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
VesselDestinationVerbatimTranslationPostParametersName | Description | Type | Additional 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 VesselDestinationVerbatimTranslationResultName | Description | Type | Additional 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": "97369e92-77aa-481b-93fa-db3f55bf1378", "Name": "sample string 2", "Locode": "sample string 3", "WpiNumber": "sample string 4", "Country": { "Name": "sample string 1", "Alpha2code": "sample string 2" } }, "Likelihood": 2.0, "VesselImoNumber": "sample string 3" }, { "VerbatimDestination": "sample string 1", "DestinationPort": { "Guid": "97369e92-77aa-481b-93fa-db3f55bf1378", "Name": "sample string 2", "Locode": "sample string 3", "WpiNumber": "sample string 4", "Country": { "Name": "sample string 1", "Alpha2code": "sample string 2" } }, "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>97369e92-77aa-481b-93fa-db3f55bf1378</Guid> <Name>sample string 2</Name> <Locode>sample string 3</Locode> <WpiNumber>sample string 4</WpiNumber> <Country> <Name>sample string 1</Name> <Alpha2code>sample string 2</Alpha2code> </Country> </DestinationPort> <Likelihood>2</Likelihood> <VesselImoNumber>sample string 3</VesselImoNumber> </VesselDestinationVerbatimTranslationResult> <VesselDestinationVerbatimTranslationResult> <VerbatimDestination>sample string 1</VerbatimDestination> <DestinationPort> <Guid>97369e92-77aa-481b-93fa-db3f55bf1378</Guid> <Name>sample string 2</Name> <Locode>sample string 3</Locode> <WpiNumber>sample string 4</WpiNumber> <Country> <Name>sample string 1</Name> <Alpha2code>sample string 2</Alpha2code> </Country> </DestinationPort> <Likelihood>2</Likelihood> <VesselImoNumber>sample string 3</VesselImoNumber> </VesselDestinationVerbatimTranslationResult> </ArrayOfVesselDestinationVerbatimTranslationResult>