POST api/RiskAssessmentRouteGeoJSON
Takes a vessel's route and returns a risk assessment for the given parameters.
Request Information
URI Parameters
None.
Body Parameters
The parameters for the route
RiskAssessmentRouteGeoJSONParametersName | Description | Type | Additional information |
---|---|---|---|
VesselName | string |
None. |
|
VesselIMO | string |
None. |
|
VesselMMSI | string |
None. |
|
VesselCallsign | string |
None. |
|
VesselType | string |
None. |
|
DepartureDate | date |
None. |
|
Waypoints | Collection of RiskAssessmentRouteParametersWaypoint |
None. |
Request Formats
application/json, text/json
Sample:
{ "VesselName": "sample string 1", "VesselIMO": "sample string 2", "VesselMMSI": "sample string 3", "VesselCallsign": "sample string 4", "VesselType": "sample string 5", "DepartureDate": "2023-12-09T20:45:36.4773109+00:00", "Waypoints": [ { "Waypointnumber": 1, "Coordinates": { "Lat": 1.1, "Lon": 2.1 }, "Speed": { "Knots": 7.9697624190064591, "Kph": 14.76, "Mph": 9.171438797423038, "Ms": 4.1 }, "Freeboard": 1.0, "Waittime": 1, "InPort": true, "Mitigations": 1 }, { "Waypointnumber": 1, "Coordinates": { "Lat": 1.1, "Lon": 2.1 }, "Speed": { "Knots": 7.9697624190064591, "Kph": 14.76, "Mph": 9.171438797423038, "Ms": 4.1 }, "Freeboard": 1.0, "Waittime": 1, "InPort": true, "Mitigations": 1 } ] }
application/xml, text/xml
Sample:
<RiskAssessmentRouteGeoJSONParameters xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <VesselName>sample string 1</VesselName> <VesselIMO>sample string 2</VesselIMO> <VesselMMSI>sample string 3</VesselMMSI> <VesselCallsign>sample string 4</VesselCallsign> <VesselType>sample string 5</VesselType> <DepartureDate>2023-12-09T20:45:36.4773109+00:00</DepartureDate> <Waypoints> <RiskAssessmentRouteParametersWaypoint> <Waypointnumber>1</Waypointnumber> <Coordinates> <Lat>1.1</Lat> <Lon>2.1</Lon> </Coordinates> <Speed> <Knots>7.9697624190064591</Knots> <Kph>14.76</Kph> <Mph>9.171438797423038</Mph> <Ms>4.1</Ms> </Speed> <Freeboard>1</Freeboard> <Waittime>1</Waittime> <InPort>true</InPort> <Mitigations>1</Mitigations> </RiskAssessmentRouteParametersWaypoint> <RiskAssessmentRouteParametersWaypoint> <Waypointnumber>1</Waypointnumber> <Coordinates> <Lat>1.1</Lat> <Lon>2.1</Lon> </Coordinates> <Speed> <Knots>7.9697624190064591</Knots> <Kph>14.76</Kph> <Mph>9.171438797423038</Mph> <Ms>4.1</Ms> </Speed> <Freeboard>1</Freeboard> <Waittime>1</Waittime> <InPort>true</InPort> <Mitigations>1</Mitigations> </RiskAssessmentRouteParametersWaypoint> </Waypoints> </RiskAssessmentRouteGeoJSONParameters>
Response Information
Resource Description
The API will return the route in GeoJSON format (see https://geojson.org/).
The unescaped GeoJSON string can be found in the Content of the HttpResponseMessage.
Name | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |