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": "2024-10-04T03:53:02.2731245+00:00", "DestinationPort": { "guid": "77f0225a-fa1c-4060-a374-2c29de6d2911", "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" }, "DistanceToDestination": 1.0, "Vessel": { "vessel_identifier": "65d7b8c3-e27a-4bbc-92d7-2db0e8c123d0", "name": "sample string 2", "imo": "sample string 3", "mmsi": "sample string 4", "callsign": "sample string 5", "flag": { "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" }, "ais_type": "sample string 6", "type": "sample string 7", "sub_type": "sample string 8", "dwt": 1, "length": 1.0, "breadth": 1.0, "commercial_owner": "sample string 9", "effective_controller": "sample string 10", "technical_manager": "sample string 11", "financial_owner": "sample string 12", "gt": 1, "year_of_build": 1 } }, { "DestinationETA": "2024-10-04T03:53:02.2731245+00:00", "DestinationPort": { "guid": "77f0225a-fa1c-4060-a374-2c29de6d2911", "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" }, "DistanceToDestination": 1.0, "Vessel": { "vessel_identifier": "65d7b8c3-e27a-4bbc-92d7-2db0e8c123d0", "name": "sample string 2", "imo": "sample string 3", "mmsi": "sample string 4", "callsign": "sample string 5", "flag": { "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" }, "ais_type": "sample string 6", "type": "sample string 7", "sub_type": "sample string 8", "dwt": 1, "length": 1.0, "breadth": 1.0, "commercial_owner": "sample string 9", "effective_controller": "sample string 10", "technical_manager": "sample string 11", "financial_owner": "sample string 12", "gt": 1, "year_of_build": 1 } } ]
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>2024-10-04T03:53:02.2731245+00:00</DestinationETA> <DestinationPort> <guid>77f0225a-fa1c-4060-a374-2c29de6d2911</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> <DistanceToDestination>1</DistanceToDestination> <Vessel> <vessel_identifier>65d7b8c3-e27a-4bbc-92d7-2db0e8c123d0</vessel_identifier> <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> <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> </flag> <ais_type>sample string 6</ais_type> <type>sample string 7</type> <sub_type>sample string 8</sub_type> <dwt>1</dwt> <length>1</length> <breadth>1</breadth> <commercial_owner>sample string 9</commercial_owner> <effective_controller>sample string 10</effective_controller> <technical_manager>sample string 11</technical_manager> <financial_owner>sample string 12</financial_owner> <gt>1</gt> <year_of_build>1</year_of_build> </Vessel> </VesselDestination> <VesselDestination> <DestinationETA>2024-10-04T03:53:02.2731245+00:00</DestinationETA> <DestinationPort> <guid>77f0225a-fa1c-4060-a374-2c29de6d2911</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> <DistanceToDestination>1</DistanceToDestination> <Vessel> <vessel_identifier>65d7b8c3-e27a-4bbc-92d7-2db0e8c123d0</vessel_identifier> <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> <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> </flag> <ais_type>sample string 6</ais_type> <type>sample string 7</type> <sub_type>sample string 8</sub_type> <dwt>1</dwt> <length>1</length> <breadth>1</breadth> <commercial_owner>sample string 9</commercial_owner> <effective_controller>sample string 10</effective_controller> <technical_manager>sample string 11</technical_manager> <financial_owner>sample string 12</financial_owner> <gt>1</gt> <year_of_build>1</year_of_build> </Vessel> </VesselDestination> </ArrayOfVesselDestination>