POST api/VesselDestinations
Returns any records matching the search criteria provided.
Request Information
URI Parameters
None.
Body Parameters
VesselDestinationsPostParametersName | 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:
<VesselDestinationsPostParameters 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> </VesselDestinationsPostParameters>
Response Information
Resource Description
Collection of VesselDestinationName | Description | Type | Additional information |
---|---|---|---|
DestinationETA | date |
None. |
|
DestinationPort | Port |
None. |
|
DistanceToDestination | decimal number |
None. |
|
Vessel | Vessel |
None. |
Response Formats
application/json, text/json
Sample:
[ { "DestinationETA": "2023-10-03T14:12:19.3059057+00:00", "DestinationPort": { "Guid": "88d7039c-ba22-4f58-847e-69f868dd2c00", "Name": "sample string 2", "Locode": "sample string 3", "WpiNumber": "sample string 4", "Country": { "Name": "sample string 1", "Alpha2Code": "sample string 2", "Alpha3Code": "sample string 3", "NumericCode": "sample string 4", "Region": "sample string 5", "Continent": "sample string 6" } }, "DistanceToDestination": 1.0, "Vessel": { "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" } }, { "DestinationETA": "2023-10-03T14:12:19.3059057+00:00", "DestinationPort": { "Guid": "88d7039c-ba22-4f58-847e-69f868dd2c00", "Name": "sample string 2", "Locode": "sample string 3", "WpiNumber": "sample string 4", "Country": { "Name": "sample string 1", "Alpha2Code": "sample string 2", "Alpha3Code": "sample string 3", "NumericCode": "sample string 4", "Region": "sample string 5", "Continent": "sample string 6" } }, "DistanceToDestination": 1.0, "Vessel": { "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:
<ArrayOfVesselDestination xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <VesselDestination> <DestinationETA>2023-10-03T14:12:19.3059057+00:00</DestinationETA> <DestinationPort> <Guid>88d7039c-ba22-4f58-847e-69f868dd2c00</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> <Alpha3Code>sample string 3</Alpha3Code> <NumericCode>sample string 4</NumericCode> <Region>sample string 5</Region> <Continent>sample string 6</Continent> </Country> </DestinationPort> <DistanceToDestination>1</DistanceToDestination> <Vessel> <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> </Vessel> </VesselDestination> <VesselDestination> <DestinationETA>2023-10-03T14:12:19.3059057+00:00</DestinationETA> <DestinationPort> <Guid>88d7039c-ba22-4f58-847e-69f868dd2c00</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> <Alpha3Code>sample string 3</Alpha3Code> <NumericCode>sample string 4</NumericCode> <Region>sample string 5</Region> <Continent>sample string 6</Continent> </Country> </DestinationPort> <DistanceToDestination>1</DistanceToDestination> <Vessel> <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> </Vessel> </VesselDestination> </ArrayOfVesselDestination>