POST api/RiskAssessment24Hours
Returns a risk assessment for a vessel with the given characteristics at a given point 6, 12, 18, and 24 hours hence
Request Information
URI Parameters
None.
Body Parameters
The parameters for the query
RiskAssessment24Hours_Parameters| Name | Description | Type | Additional information |
|---|---|---|---|
| VesselDetails |
The fixed characteristics of the vessel |
RiskAssessmentVessel_Parameters |
Required |
| Position6Hours |
The non-fixed characteristics of the vessel and any mitigation measures for the vessel's position 6 hours from now |
RiskAssessmentPosition_Parameters |
Required |
| Position12Hours |
The non-fixed characteristics of the vessel and any mitigation measures for the vessel's position 12 hours from now |
RiskAssessmentPosition_Parameters |
Required |
| Position18Hours |
The non-fixed characteristics of the vessel and any mitigation measures for the vessel's position 18 hours from now |
RiskAssessmentPosition_Parameters |
Required |
| Position24Hours |
The non-fixed characteristics of the vessel and any mitigation measures for the vessel's position 24 hours from now |
RiskAssessmentPosition_Parameters |
Required |
Request Formats
application/json, text/json
Sample:
{
"VesselDetails": {
"VesselIMO": "sample string 1",
"VesselType": 0
},
"Position6Hours": {
"Coordinates": {
"Lat": 1.1,
"Lon": 2.1
},
"Speed": {
"Knots": 7.9697624190064591,
"Kph": 14.76,
"Mph": 9.171438797423038,
"Ms": 4.1
},
"InPort": true,
"Freeboard": 1.0,
"Mitigation": 0
},
"Position12Hours": {
"Coordinates": {
"Lat": 1.1,
"Lon": 2.1
},
"Speed": {
"Knots": 7.9697624190064591,
"Kph": 14.76,
"Mph": 9.171438797423038,
"Ms": 4.1
},
"InPort": true,
"Freeboard": 1.0,
"Mitigation": 0
},
"Position18Hours": {
"Coordinates": {
"Lat": 1.1,
"Lon": 2.1
},
"Speed": {
"Knots": 7.9697624190064591,
"Kph": 14.76,
"Mph": 9.171438797423038,
"Ms": 4.1
},
"InPort": true,
"Freeboard": 1.0,
"Mitigation": 0
},
"Position24Hours": {
"Coordinates": {
"Lat": 1.1,
"Lon": 2.1
},
"Speed": {
"Knots": 7.9697624190064591,
"Kph": 14.76,
"Mph": 9.171438797423038,
"Ms": 4.1
},
"InPort": true,
"Freeboard": 1.0,
"Mitigation": 0
}
}
application/xml, text/xml
Sample:
<RiskAssessment24Hours_Parameters xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<VesselDetails>
<VesselIMO>sample string 1</VesselIMO>
<VesselType>Commercial</VesselType>
</VesselDetails>
<Position6Hours>
<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>
<InPort>true</InPort>
<Freeboard>1</Freeboard>
<Mitigation>ArmedTeam</Mitigation>
</Position6Hours>
<Position12Hours>
<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>
<InPort>true</InPort>
<Freeboard>1</Freeboard>
<Mitigation>ArmedTeam</Mitigation>
</Position12Hours>
<Position18Hours>
<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>
<InPort>true</InPort>
<Freeboard>1</Freeboard>
<Mitigation>ArmedTeam</Mitigation>
</Position18Hours>
<Position24Hours>
<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>
<InPort>true</InPort>
<Freeboard>1</Freeboard>
<Mitigation>ArmedTeam</Mitigation>
</Position24Hours>
</RiskAssessment24Hours_Parameters>
Response Information
Resource Description
RiskAssessment24Hours_Result| Name | Description | Type | Additional information |
|---|---|---|---|
| Position6Hours |
The risk 6 hours from now |
RiskAssessmentPosition_Result |
None. |
| Position12Hours |
The risk 12 hours from now |
RiskAssessmentPosition_Result |
None. |
| Position18Hours |
The risk 18 hours from now |
RiskAssessmentPosition_Result |
None. |
| Position24Hours |
The risk 24 hours from now |
RiskAssessmentPosition_Result |
None. |
Response Formats
application/json, text/json
Sample:
{
"Position6Hours": {
"DateTime": "2023-03-31T10:06:04.4655669+00:00",
"RiskString": "sample string 2",
"RiskColourHex": "sample string 3"
},
"Position12Hours": {
"DateTime": "2023-03-31T10:06:04.4655669+00:00",
"RiskString": "sample string 2",
"RiskColourHex": "sample string 3"
},
"Position18Hours": {
"DateTime": "2023-03-31T10:06:04.4655669+00:00",
"RiskString": "sample string 2",
"RiskColourHex": "sample string 3"
},
"Position24Hours": {
"DateTime": "2023-03-31T10:06:04.4655669+00:00",
"RiskString": "sample string 2",
"RiskColourHex": "sample string 3"
}
}
application/xml, text/xml
Sample:
<RiskAssessment24Hours_Result xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Position6Hours>
<DateTime>2023-03-31T10:06:04.4655669+00:00</DateTime>
<RiskString>sample string 2</RiskString>
<RiskColourHex>sample string 3</RiskColourHex>
</Position6Hours>
<Position12Hours>
<DateTime>2023-03-31T10:06:04.4655669+00:00</DateTime>
<RiskString>sample string 2</RiskString>
<RiskColourHex>sample string 3</RiskColourHex>
</Position12Hours>
<Position18Hours>
<DateTime>2023-03-31T10:06:04.4655669+00:00</DateTime>
<RiskString>sample string 2</RiskString>
<RiskColourHex>sample string 3</RiskColourHex>
</Position18Hours>
<Position24Hours>
<DateTime>2023-03-31T10:06:04.4655669+00:00</DateTime>
<RiskString>sample string 2</RiskString>
<RiskColourHex>sample string 3</RiskColourHex>
</Position24Hours>
</RiskAssessment24Hours_Result>