POST api/RiskAssessmentLive

Returns a risk assessment for a vessel with the given characteristics at a given point at this moment in time

Request Information

URI Parameters

None.

Body Parameters

The parameters for the query

RiskAssessmentLive_Parameters
NameDescriptionTypeAdditional information
VesselDetails

The fixed characteristics of the vessel

RiskAssessmentVessel_Parameters

None.

LivePosition

The non-fixed characteristics of the vessel and any mitigation measures

RiskAssessmentPosition_Parameters

None.

Request Formats

application/json, text/json

Sample:
{
  "VesselDetails": {
    "VesselIMO": "sample string 1",
    "VesselType": 0
  },
  "LivePosition": {
    "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:
<RiskAssessmentLive_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>
  <LivePosition>
    <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>
  </LivePosition>
</RiskAssessmentLive_Parameters>

Response Information

Resource Description

RiskAssessmentPosition_Result
NameDescriptionTypeAdditional information
DateTime

The UTC date and time

date

None.

RiskString

Text representing the risk rating

string

None.

RiskColourHex

The suggested colour for this risk rating

string

None.

Response Formats

application/json, text/json

Sample:
{
  "DateTime": "2019-11-15T05:15:41.7995363+00:00",
  "RiskString": "sample string 2",
  "RiskColourHex": "sample string 3"
}

application/xml, text/xml

Sample:
<RiskAssessmentPosition_Result xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <DateTime>2019-11-15T05:15:41.7995363+00:00</DateTime>
  <RiskString>sample string 2</RiskString>
  <RiskColourHex>sample string 3</RiskColourHex>
</RiskAssessmentPosition_Result>