POST api/VesselPosition_Json

Returns all available position (or latest position) for a vessel or array of vessels in Tab-delimited format

Request Information

URI Parameters

None.

Body Parameters

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

Name	Type	Additional information
Identifiers	Collection of string	None.
DateStartyyyyMMddHHmm	string	None.
DateEndyyyyMMddHHmm	string	None.

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<VesselDataExtractionParameters 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>
  <DateStartyyyyMMddHHmm>sample string 1</DateStartyyyyMMddHHmm>
  <DateEndyyyyMMddHHmm>sample string 2</DateEndyyyyMMddHHmm>
</VesselDataExtractionParameters>

Response Information

Resource Description

Collection of VesselPositionReport

Name	Type	Additional information
CallSign	string	None.
CourseOverGround	decimal number	None.
DateReceived	date	None.
Destination	string	None.
DimensionToBow	decimal number	None.
DimensionToPort	decimal number	None.
DimensionToStarboard	decimal number	None.
DimensionToStern	decimal number	None.
Draught	decimal number	None.
EtaDay	integer	None.
EtaHour	integer	None.
EtaMinute	integer	None.
EtaMonth	integer	None.
ImoNumber	string	None.
MessageType	string	None.
Mmsi	string	None.
NavigationStatus	string	None.
Position	CoordDec	None.
RateOfTurn	integer	None.
ShipType	string	None.
SpeedOverGround	Speed	None.
TrueHeading	integer	None.
VesselName	string	None.
CommercialOwner	string	None.
EffectiveContoller	string	None.
PositionSource	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CallSign": "sample string 1",
    "CourseOverGround": 1.1,
    "DateReceived": "2024-04-23T12:42:36.9758405+00:00",
    "Destination": "sample string 2",
    "DimensionToBow": 1.1,
    "DimensionToPort": 1.1,
    "DimensionToStarboard": 1.1,
    "DimensionToStern": 1.1,
    "Draught": 1.1,
    "EtaDay": 1,
    "EtaHour": 1,
    "EtaMinute": 1,
    "EtaMonth": 1,
    "ImoNumber": "sample string 3",
    "MessageType": "sample string 4",
    "Mmsi": "sample string 5",
    "NavigationStatus": "sample string 6",
    "Position": {
      "Lat": 1.1,
      "Lon": 2.1
    },
    "RateOfTurn": 1,
    "ShipType": "sample string 7",
    "SpeedOverGround": {
      "Knots": 7.9697624190064591,
      "Kph": 14.76,
      "Mph": 9.171438797423038,
      "Ms": 4.1
    },
    "TrueHeading": 1,
    "VesselName": "sample string 8",
    "CommercialOwner": "sample string 9",
    "EffectiveContoller": "sample string 10",
    "PositionSource": "sample string 11"
  },
  {
    "CallSign": "sample string 1",
    "CourseOverGround": 1.1,
    "DateReceived": "2024-04-23T12:42:36.9758405+00:00",
    "Destination": "sample string 2",
    "DimensionToBow": 1.1,
    "DimensionToPort": 1.1,
    "DimensionToStarboard": 1.1,
    "DimensionToStern": 1.1,
    "Draught": 1.1,
    "EtaDay": 1,
    "EtaHour": 1,
    "EtaMinute": 1,
    "EtaMonth": 1,
    "ImoNumber": "sample string 3",
    "MessageType": "sample string 4",
    "Mmsi": "sample string 5",
    "NavigationStatus": "sample string 6",
    "Position": {
      "Lat": 1.1,
      "Lon": 2.1
    },
    "RateOfTurn": 1,
    "ShipType": "sample string 7",
    "SpeedOverGround": {
      "Knots": 7.9697624190064591,
      "Kph": 14.76,
      "Mph": 9.171438797423038,
      "Ms": 4.1
    },
    "TrueHeading": 1,
    "VesselName": "sample string 8",
    "CommercialOwner": "sample string 9",
    "EffectiveContoller": "sample string 10",
    "PositionSource": "sample string 11"
  }
]

application/xml, text/xml

Sample:

<ArrayOfVesselPositionReport xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <VesselPositionReport>
    <CallSign>sample string 1</CallSign>
    <CourseOverGround>1.1</CourseOverGround>
    <DateReceived>2024-04-23T12:42:36.9758405+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>
    <EtaDay>1</EtaDay>
    <EtaHour>1</EtaHour>
    <EtaMinute>1</EtaMinute>
    <EtaMonth>1</EtaMonth>
    <ImoNumber>sample string 3</ImoNumber>
    <MessageType>sample string 4</MessageType>
    <Mmsi>sample string 5</Mmsi>
    <NavigationStatus>sample string 6</NavigationStatus>
    <Position>
      <Lat>1.1</Lat>
      <Lon>2.1</Lon>
    </Position>
    <RateOfTurn>1</RateOfTurn>
    <ShipType>sample string 7</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 8</VesselName>
    <CommercialOwner>sample string 9</CommercialOwner>
    <EffectiveContoller>sample string 10</EffectiveContoller>
    <PositionSource>sample string 11</PositionSource>
  </VesselPositionReport>
  <VesselPositionReport>
    <CallSign>sample string 1</CallSign>
    <CourseOverGround>1.1</CourseOverGround>
    <DateReceived>2024-04-23T12:42:36.9758405+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>
    <EtaDay>1</EtaDay>
    <EtaHour>1</EtaHour>
    <EtaMinute>1</EtaMinute>
    <EtaMonth>1</EtaMonth>
    <ImoNumber>sample string 3</ImoNumber>
    <MessageType>sample string 4</MessageType>
    <Mmsi>sample string 5</Mmsi>
    <NavigationStatus>sample string 6</NavigationStatus>
    <Position>
      <Lat>1.1</Lat>
      <Lon>2.1</Lon>
    </Position>
    <RateOfTurn>1</RateOfTurn>
    <ShipType>sample string 7</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 8</VesselName>
    <CommercialOwner>sample string 9</CommercialOwner>
    <EffectiveContoller>sample string 10</EffectiveContoller>
    <PositionSource>sample string 11</PositionSource>
  </VesselPositionReport>
</ArrayOfVesselPositionReport>