POST api/SATCAIS

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
IMONumbers	A list of IMO numbers for the vessels for which you want to receive the data	Collection of string	Required
NumPositions	The top X positions to retrive. Use 1 by default to get the latest position.	integer	Required
NumHours	The top x hours of history to retrieve from the request date/time. Use 1 by default to get the latest position.	integer	Required

Request Formats

application/json, text/json

Sample:

{
  "IMONumbers": [
    "sample string 1",
    "sample string 2"
  ],
  "NumPositions": 1,
  "NumHours": 2
}

application/xml, text/xml

Sample:

<SATCAISVesselPostParameters xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <IMONumbers>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </IMONumbers>
  <NumPositions>1</NumPositions>
  <NumHours>2</NumHours>
</SATCAISVesselPostParameters>

Response Information

Resource Description

Collection of SATCAISVessel

Name	Type	Additional information
Name	string	None.
IMONumber	string	None.
IMN	string	None.
SerialNumber	string	None.
SATCAISPositions	Collection of SATCAISPosition	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Name": "sample string 1",
    "IMONumber": "sample string 2",
    "IMN": "sample string 3",
    "SerialNumber": "sample string 4",
    "SATCAISPositions": [
      {
        "Location": {
          "lat": 1.1,
          "lon": 2.1
        },
        "DateReported": "2024-12-03T16:39:01.636754+00:00",
        "Course": 1.0,
        "Speed": {
          "Knots": 1.1,
          "Kph": 2.0372,
          "Mph": 1.2658573928,
          "Ms": 0.5658888889
        },
        "Source": "sample string 2"
      },
      {
        "Location": {
          "lat": 1.1,
          "lon": 2.1
        },
        "DateReported": "2024-12-03T16:39:01.636754+00:00",
        "Course": 1.0,
        "Speed": {
          "Knots": 1.1,
          "Kph": 2.0372,
          "Mph": 1.2658573928,
          "Ms": 0.5658888889
        },
        "Source": "sample string 2"
      }
    ]
  },
  {
    "Name": "sample string 1",
    "IMONumber": "sample string 2",
    "IMN": "sample string 3",
    "SerialNumber": "sample string 4",
    "SATCAISPositions": [
      {
        "Location": {
          "lat": 1.1,
          "lon": 2.1
        },
        "DateReported": "2024-12-03T16:39:01.636754+00:00",
        "Course": 1.0,
        "Speed": {
          "Knots": 1.1,
          "Kph": 2.0372,
          "Mph": 1.2658573928,
          "Ms": 0.5658888889
        },
        "Source": "sample string 2"
      },
      {
        "Location": {
          "lat": 1.1,
          "lon": 2.1
        },
        "DateReported": "2024-12-03T16:39:01.636754+00:00",
        "Course": 1.0,
        "Speed": {
          "Knots": 1.1,
          "Kph": 2.0372,
          "Mph": 1.2658573928,
          "Ms": 0.5658888889
        },
        "Source": "sample string 2"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfSATCAISVessel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <SATCAISVessel>
    <Name>sample string 1</Name>
    <IMONumber>sample string 2</IMONumber>
    <IMN>sample string 3</IMN>
    <SerialNumber>sample string 4</SerialNumber>
    <SATCAISPositions>
      <SATCAISPosition>
        <Location>
          <lat>1.1</lat>
          <lon>2.1</lon>
        </Location>
        <DateReported>2024-12-03T16:39:01.636754+00:00</DateReported>
        <Course>1</Course>
        <Speed>
          <Knots>1.1</Knots>
        </Speed>
        <Source>sample string 2</Source>
      </SATCAISPosition>
      <SATCAISPosition>
        <Location>
          <lat>1.1</lat>
          <lon>2.1</lon>
        </Location>
        <DateReported>2024-12-03T16:39:01.636754+00:00</DateReported>
        <Course>1</Course>
        <Speed>
          <Knots>1.1</Knots>
        </Speed>
        <Source>sample string 2</Source>
      </SATCAISPosition>
    </SATCAISPositions>
  </SATCAISVessel>
  <SATCAISVessel>
    <Name>sample string 1</Name>
    <IMONumber>sample string 2</IMONumber>
    <IMN>sample string 3</IMN>
    <SerialNumber>sample string 4</SerialNumber>
    <SATCAISPositions>
      <SATCAISPosition>
        <Location>
          <lat>1.1</lat>
          <lon>2.1</lon>
        </Location>
        <DateReported>2024-12-03T16:39:01.636754+00:00</DateReported>
        <Course>1</Course>
        <Speed>
          <Knots>1.1</Knots>
        </Speed>
        <Source>sample string 2</Source>
      </SATCAISPosition>
      <SATCAISPosition>
        <Location>
          <lat>1.1</lat>
          <lon>2.1</lon>
        </Location>
        <DateReported>2024-12-03T16:39:01.636754+00:00</DateReported>
        <Course>1</Course>
        <Speed>
          <Knots>1.1</Knots>
        </Speed>
        <Source>sample string 2</Source>
      </SATCAISPosition>
    </SATCAISPositions>
  </SATCAISVessel>
</ArrayOfSATCAISVessel>