POST api/SATCAIS
Request Information
URI Parameters
None.
Body Parameters
SATCAISVesselPostParametersName | 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 SATCAISVesselName | Description | 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": "2023-03-31T08:57:05.1540722+00:00", "Course": 1.0, "Speed": { "Knots": 7.9697624190064591, "Kph": 14.76, "Mph": 9.171438797423038, "Ms": 4.1 }, "Source": "sample string 2" }, { "Location": { "Lat": 1.1, "Lon": 2.1 }, "DateReported": "2023-03-31T08:57:05.1540722+00:00", "Course": 1.0, "Speed": { "Knots": 7.9697624190064591, "Kph": 14.76, "Mph": 9.171438797423038, "Ms": 4.1 }, "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": "2023-03-31T08:57:05.1540722+00:00", "Course": 1.0, "Speed": { "Knots": 7.9697624190064591, "Kph": 14.76, "Mph": 9.171438797423038, "Ms": 4.1 }, "Source": "sample string 2" }, { "Location": { "Lat": 1.1, "Lon": 2.1 }, "DateReported": "2023-03-31T08:57:05.1540722+00:00", "Course": 1.0, "Speed": { "Knots": 7.9697624190064591, "Kph": 14.76, "Mph": 9.171438797423038, "Ms": 4.1 }, "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>2023-03-31T08:57:05.1540722+00:00</DateReported> <Course>1</Course> <Speed> <Knots>7.9697624190064591</Knots> <Kph>14.76</Kph> <Mph>9.171438797423038</Mph> <Ms>4.1</Ms> </Speed> <Source>sample string 2</Source> </SATCAISPosition> <SATCAISPosition> <Location> <Lat>1.1</Lat> <Lon>2.1</Lon> </Location> <DateReported>2023-03-31T08:57:05.1540722+00:00</DateReported> <Course>1</Course> <Speed> <Knots>7.9697624190064591</Knots> <Kph>14.76</Kph> <Mph>9.171438797423038</Mph> <Ms>4.1</Ms> </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>2023-03-31T08:57:05.1540722+00:00</DateReported> <Course>1</Course> <Speed> <Knots>7.9697624190064591</Knots> <Kph>14.76</Kph> <Mph>9.171438797423038</Mph> <Ms>4.1</Ms> </Speed> <Source>sample string 2</Source> </SATCAISPosition> <SATCAISPosition> <Location> <Lat>1.1</Lat> <Lon>2.1</Lon> </Location> <DateReported>2023-03-31T08:57:05.1540722+00:00</DateReported> <Course>1</Course> <Speed> <Knots>7.9697624190064591</Knots> <Kph>14.76</Kph> <Mph>9.171438797423038</Mph> <Ms>4.1</Ms> </Speed> <Source>sample string 2</Source> </SATCAISPosition> </SATCAISPositions> </SATCAISVessel> </ArrayOfSATCAISVessel>