POST api/VesselLatestPosition

Retrurns the latest position for a vessel or array of vessels

Request Information

URI Parameters

None.

Body Parameters

The IMO or MMSI number, or array of IMO or MMSI numbers, for the request

VesselIdentifiers

Name	Description	Type	Additional information
Identifiers	The IMO or MMSI number of a vessel	Collection of string	Max length: 9 Min length: 7

Name

Description

Type

Additional information

Identifiers

The IMO or MMSI number of a vessel

Collection of string

Max length: 9

Min length: 7

Request Formats

application/json, text/json

Sample:

{
  "Identifiers": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<VesselIdentifiers xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Identifiers>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Identifiers>
</VesselIdentifiers>

Response Information

Resource Description

Collection of AisReport

Name	Description	Type	Additional information
AisVersion	The AIS version	integer	None.
CallSign	The call sign	string	None.
CourseOverGround	The course over ground	decimal number	None.
DateReceived	The date that the position was received	date	None.
Destination	The destination	string	None.
DimensionToBow	The distance from the AIS transponder to the bow (m)	decimal number	None.
DimensionToPort	The distance from the AIS transponder to the port side (m)	decimal number	None.
DimensionToStarboard	The distance from the AIS transponder to the starboard side (m)	decimal number	None.
DimensionToStern	The distance from the AIS transponder to the stern (m)	decimal number	None.
Draught	The draught (m)	decimal number	None.
Dte	Data terminal equipment (DTE) ready 0 = available 1 = not available - default	boolean	None.
EtaDay	The day of month of the ETA	integer	None.
EtaHour	The hour of the ETA	integer	None.
EtaMinute	The minutes of the ETA	integer	None.
EtaMonth	The month of the ETA	integer	None.
ImoNumber	The IMO number	string	None.
ManeuverIndicator	0 = not available - default 1 = not engaged in special maneuver 2 = engaged in special maneuver (i.e.: regional passing arrangement on Inland Waterway)	string	None.
MessageType	The type of message transmitted	string	None.
Mmsi	The Mmsi number of the vessel	string	None.
NavigationStatus	The navigation status	string	None.
Position	The position	CoordDec	None.
PositionAccuracy	The accuracy of the position. 1 / true = high (<= 10 m) 0 / false = low(> 10 m) - default	boolean	None.
PositionFixType	The type of electronic position fixing device. 0 = undefined - default 1 = GPS 2 = GLONASS 3 = combined GPS/GLONASS 4 = Loran-C 5 = Chayka 6 = integrated navigation system 7 = surveyed 8 = Galileo, 9-14 = not used 15 = internal GNSS	string	None.
RaimFlag	Receiver autonomous integrity monitoring (RAIM) flag of electronic position fixing device; 0 = RAIM not in use = default; 1 = RAIM in use.	boolean	None.
RateOfTurn	The rate of turn	integer	None.
ShipType	The ship type	string	None.
SpeedOverGround	The speed over ground	Speed	None.
TrueHeading	The true heading	integer	None.
VesselName	The vessel name	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "AisVersion": 1,
    "CallSign": "sample string 1",
    "CourseOverGround": 1.1,
    "DateReceived": "2020-01-22T21:26:37.108998+00:00",
    "Destination": "sample string 2",
    "DimensionToBow": 1.1,
    "DimensionToPort": 1.1,
    "DimensionToStarboard": 1.1,
    "DimensionToStern": 1.1,
    "Draught": 1.1,
    "Dte": true,
    "EtaDay": 1,
    "EtaHour": 1,
    "EtaMinute": 1,
    "EtaMonth": 1,
    "ImoNumber": "sample string 3",
    "ManeuverIndicator": "sample string 4",
    "MessageType": "sample string 5",
    "Mmsi": "sample string 6",
    "NavigationStatus": "sample string 7",
    "Position": {
      "Lat": 1.1,
      "Lon": 2.1
    },
    "PositionAccuracy": true,
    "PositionFixType": "sample string 8",
    "RaimFlag": true,
    "RateOfTurn": 1,
    "ShipType": "sample string 9",
    "SpeedOverGround": {
      "Knots": 7.9697624190064591,
      "Kph": 14.76,
      "Mph": 9.171438797423038,
      "Ms": 4.1
    },
    "TrueHeading": 1,
    "VesselName": "sample string 10"
  },
  {
    "AisVersion": 1,
    "CallSign": "sample string 1",
    "CourseOverGround": 1.1,
    "DateReceived": "2020-01-22T21:26:37.108998+00:00",
    "Destination": "sample string 2",
    "DimensionToBow": 1.1,
    "DimensionToPort": 1.1,
    "DimensionToStarboard": 1.1,
    "DimensionToStern": 1.1,
    "Draught": 1.1,
    "Dte": true,
    "EtaDay": 1,
    "EtaHour": 1,
    "EtaMinute": 1,
    "EtaMonth": 1,
    "ImoNumber": "sample string 3",
    "ManeuverIndicator": "sample string 4",
    "MessageType": "sample string 5",
    "Mmsi": "sample string 6",
    "NavigationStatus": "sample string 7",
    "Position": {
      "Lat": 1.1,
      "Lon": 2.1
    },
    "PositionAccuracy": true,
    "PositionFixType": "sample string 8",
    "RaimFlag": true,
    "RateOfTurn": 1,
    "ShipType": "sample string 9",
    "SpeedOverGround": {
      "Knots": 7.9697624190064591,
      "Kph": 14.76,
      "Mph": 9.171438797423038,
      "Ms": 4.1
    },
    "TrueHeading": 1,
    "VesselName": "sample string 10"
  }
]

application/xml, text/xml

Sample:

<ArrayOfAisReport xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AisReport>
    <AisVersion>1</AisVersion>
    <CallSign>sample string 1</CallSign>
    <CourseOverGround>1.1</CourseOverGround>
    <DateReceived>2020-01-22T21:26:37.108998+00:00</DateReceived>
    <Destination>sample string 2</Destination>
    <DimensionToBow>1.1</DimensionToBow>
    <DimensionToPort>1.1</DimensionToPort>
    <DimensionToStarboard>1.1</DimensionToStarboard>
    <DimensionToStern>1.1</DimensionToStern>
    <Draught>1.1</Draught>
    <Dte>true</Dte>
    <EtaDay>1</EtaDay>
    <EtaHour>1</EtaHour>
    <EtaMinute>1</EtaMinute>
    <EtaMonth>1</EtaMonth>
    <ImoNumber>sample string 3</ImoNumber>
    <ManeuverIndicator>sample string 4</ManeuverIndicator>
    <MessageType>sample string 5</MessageType>
    <Mmsi>sample string 6</Mmsi>
    <NavigationStatus>sample string 7</NavigationStatus>
    <Position>
      <Lat>1.1</Lat>
      <Lon>2.1</Lon>
    </Position>
    <PositionAccuracy>true</PositionAccuracy>
    <PositionFixType>sample string 8</PositionFixType>
    <RaimFlag>true</RaimFlag>
    <RateOfTurn>1</RateOfTurn>
    <ShipType>sample string 9</ShipType>
    <SpeedOverGround>
      <Knots>7.9697624190064591</Knots>
      <Kph>14.76</Kph>
      <Mph>9.171438797423038</Mph>
      <Ms>4.1</Ms>
    </SpeedOverGround>
    <TrueHeading>1</TrueHeading>
    <VesselName>sample string 10</VesselName>
  </AisReport>
  <AisReport>
    <AisVersion>1</AisVersion>
    <CallSign>sample string 1</CallSign>
    <CourseOverGround>1.1</CourseOverGround>
    <DateReceived>2020-01-22T21:26:37.108998+00:00</DateReceived>
    <Destination>sample string 2</Destination>
    <DimensionToBow>1.1</DimensionToBow>
    <DimensionToPort>1.1</DimensionToPort>
    <DimensionToStarboard>1.1</DimensionToStarboard>
    <DimensionToStern>1.1</DimensionToStern>
    <Draught>1.1</Draught>
    <Dte>true</Dte>
    <EtaDay>1</EtaDay>
    <EtaHour>1</EtaHour>
    <EtaMinute>1</EtaMinute>
    <EtaMonth>1</EtaMonth>
    <ImoNumber>sample string 3</ImoNumber>
    <ManeuverIndicator>sample string 4</ManeuverIndicator>
    <MessageType>sample string 5</MessageType>
    <Mmsi>sample string 6</Mmsi>
    <NavigationStatus>sample string 7</NavigationStatus>
    <Position>
      <Lat>1.1</Lat>
      <Lon>2.1</Lon>
    </Position>
    <PositionAccuracy>true</PositionAccuracy>
    <PositionFixType>sample string 8</PositionFixType>
    <RaimFlag>true</RaimFlag>
    <RateOfTurn>1</RateOfTurn>
    <ShipType>sample string 9</ShipType>
    <SpeedOverGround>
      <Knots>7.9697624190064591</Knots>
      <Kph>14.76</Kph>
      <Mph>9.171438797423038</Mph>
      <Ms>4.1</Ms>
    </SpeedOverGround>
    <TrueHeading>1</TrueHeading>
    <VesselName>sample string 10</VesselName>
  </AisReport>
</ArrayOfAisReport>