GateHouse AIS REST interface

Base URL: /api/jobserver, Version: 133.5

AIS system for monitoring vessel traffic

Schemes: https, http

Summary

Tag: multipassageline

Calculate a multi passageline statistic

Operation Description
POST /stat/multipassageline

Initiate a multi passageline statistics

GET /stat/multipassageline/{id}

Return the statistics definition.

GET /stat/multipassageline/result/{id}

Return the result of the statistics once it has been completed.

Tag: passageline

Calculate a passageline statistic

Operation Description
POST /stat/passageline

Initiate a passageline statistics

GET /stat/passageline/{id}

Return the statistics definition.

GET /stat/passageline/result/{id}

Return the result of the statistics once it has been completed.

Tag: sogdist

Operation Description
POST /stat/sogdist

Initiate a SOG Distribution Report

GET /stat/sogdist/{id}

Return the statistics definition.

GET /stat/sogdist/result/{id}

Return the result of the statistics once it has been completed.

Tag: nearmissshipship

Calculate a near miss ship ship statistic

Operation Description
POST /stat/nmss

Initiate a Near Miss Ship Ship statistics

GET /stat/nmss/{id}

Return the statistics definition.

GET /stat/nmss/result/{id}

Return the result of the statistics once it has been completed.

Tag: historicaltrack

Calculate a historical track statistic

Operation Description
POST /stat/historicaltrack

Initiate a Historical Track statistics

GET /stat/historicaltrack/{id}

Return the statistics definition.

GET /stat/historicaltrack/result/{id}

Return the result of the statistics once it has been completed.

Tag: area

Calculate an area statistic

Operation Description
POST /stat/area

Initiate an Area statistics

GET /stat/area/{id}

Return the statistics definition.

GET /stat/area/result/{id}

Return the result of the statistics once it has been completed.

Tag: statistic

General statistic functions. Works on all the statistics

Operation Description
GET /stat/statistic

Return status on all active statistics

GET /stat/statistic/{id}

Return status on one statistics

DELETE /stat/statistic/{id}

Delete a statistics. Will abort if currently executing.

Tag: pilot

Specialised statistics for pilot operations

Operation Description
POST /stat/transitpilot

Initiate a Transit Pilot statistics

GET /stat/transitpilot/{id}

Return the statistics definition.

GET /stat/transitpilot/result/{id}

Return the result of the statistics once it has been completed.

POST /stat/trip

Initiate a Historical Trip statistics

GET /stat/trip/{id}

Return the statistics definition.

GET /stat/trip/result/{id}

Return the result of the statistics once it has been completed.

POST /stat/pilotboat

Initiate a Historical Trip for Pilotboats statistics

GET /stat/pilotboat/{id}

Return the statistics definition.

GET /stat/pilotboat/result/{id}

Return the result of the statistics once it has been completed.

Tag: multiship

Multiple Ship Report

Operation Description
POST /stat/multiship

Initiate a Multiple Ship Report

GET /stat/multiship/{id}

Return the statistics definition.

GET /stat/multiship/result/{id}

Return the result of the statistics once it has been completed.

Tag: portcalls

Port Calls Report

Operation Description
POST /stat/portcalls

Initiate a Port calls Report

GET /stat/portcalls/{id}

Return the statistics definition.

GET /stat/portcalls/result/{id}

Return the result of the statistics once it has been completed.

Tag: nearmissshippoint

Operation Description
POST /stat/nmsp

Initiate a Near Miss Ship 2 Point statistics

GET /stat/nmsp/{id}

Return the statistics definition.

GET /stat/nmsp/result/{id}

Return the result of the statistics once it has been completed.

Security

basic_authentication

Type: basic

Paths

Initiate an Area statistics

POST /stat/area

Tags: area

Initiate an Area statistics.

application/json

202 Accepted

Successful operation. The job is queued for execution

Return the result of the statistics once it has been completed.

GET /stat/area/result/{id}

Tags: area

Return the result of the statistics once it has been completed.

id

id of the statistics

path integer (int64)
tracks

if set tracks=true then the "track" will be returned in geojson-X format in the result. Notice only valid for "group_by" : "ungrouped"

query string

application/json

200 OK

Successful operation. The result is returned

202 Accepted

The operation is in progress or queued

Return the statistics definition.

GET /stat/area/{id}

Tags: area

Return the statistics definition.

id

id of the statistics

path integer (int64)

application/json

200 OK

successful operation

Initiate a Historical Track statistics

POST /stat/historicaltrack

Tags: historicaltrack

Initiate a Historical Track statistics.
.

application/json

202 Accepted

Successful operation. The job is queued for execution

Return the result of the statistics once it has been completed.

GET /stat/historicaltrack/result/{id}

Tags: historicaltrack

Return the result of the statistics once it has been completed.

id

id of the statistics

path integer (int64)

application/json

200 OK

Successful operation. The result is returned

202 Accepted

The operation is in progress or queued

Return the statistics definition.

GET /stat/historicaltrack/{id}

Tags: historicaltrack

Return the statistics definition.

id

id of the statistics

path integer (int64)

application/json

200 OK

successful operation

Initiate a multi passageline statistics

POST /stat/multipassageline

Tags: multipassageline

Initiate an asynchronous multi passageline statistics.
Use the associated GET /stat/statistic/{id} call to retrieve the status and call GET /stat/multipassageline/{id} to get the result when done.
Calculate a multi passageline statistic. A passage is registered if a ship passes through all the passagelines within a specified duration. The result is delivered as a list of all passages including direction, enter and exit time and general ship information.

application/json

202 Accepted

Successful operation. The job is queued for execution

Return the result of the statistics once it has been completed.

GET /stat/multipassageline/result/{id}

Tags: multipassageline

Return the result of the statistics once it has been completed.

id

id of the statistics

path integer (int64)
tracks

if set tracks=true then the "track" will be returned in geojson-X format in the result.

query string

application/json

200 OK

Successful operation. The result is returned

202 Accepted

The operation is in progress or queued

Return the statistics definition.

GET /stat/multipassageline/{id}

Tags: multipassageline

Return the statistics definition. Notice prior to R133.5 the result for the ship information was returned in the root section. In R133.5 the result will be returned both in the root entry and in a "ship" entry. From R134 only the "ship" entry will be returned. This is to standardise on equal behaviour for the various statistic reports.

id

id of the statistics

path integer (int64)

application/json

200 OK

successful operation

Initiate a Multiple Ship Report

POST /stat/multiship

Tags: multiship

Initiate a Multiple Ship Report statistics.

application/json

202 Accepted

Successful operation. The job is queued for execution

Return the result of the statistics once it has been completed.

GET /stat/multiship/result/{id}

Tags: multiship

Return the result of the statistics once it has been completed.

id

id of the statistics

path integer (int64)

application/json

200 OK

Successful operation. The result is returned

202 Accepted

The operation is in progress or queued

Return the statistics definition.

GET /stat/multiship/{id}

Tags: multiship

Return the statistics definition.

id

id of the statistics

path integer (int64)

application/json

200 OK

Successful operation

Initiate a Near Miss Ship 2 Point statistics

POST /stat/nmsp

Tags: nearmissshippoint

Initiate a Near Miss Ship 2 Point statistics.
This statistics will calculate all CPA (Closes Point of Approach) for all ships in relation to a point position. Thus the shape input must be a position

application/json

202 Accepted

Successful operation. The job is queued for execution

Return the result of the statistics once it has been completed.

GET /stat/nmsp/result/{id}

Tags: nearmissshippoint

Return the result of the statistics once it has been completed.

id

id of the statistics

path integer (int64)

application/json

200 OK

Successful operation. The result is returned

202 Accepted

The operation is in progress or queued

Return the statistics definition.

GET /stat/nmsp/{id}

Tags: nearmissshippoint

Return the statistics definition.

id

id of the statistics

path integer (int64)

application/json

200 OK

successful operation

Initiate a Near Miss Ship Ship statistics

POST /stat/nmss

Tags: nearmissshipship

Initiate a Near Miss Ship Ship statistics.
This statistics will calculate all CPA (Closes Point of Approach) for all ships.

application/json

202 Accepted

Successful operation. The job is queued for execution

Return the result of the statistics once it has been completed.

GET /stat/nmss/result/{id}

Tags: nearmissshipship

Return the result of the statistics once it has been completed.

id

id of the statistics

path integer (int64)

application/json

200 OK

Successful operation. The result is returned

202 Accepted

The operation is in progress or queued

Return the statistics definition.

GET /stat/nmss/{id}

Tags: nearmissshipship

Return the statistics definition.

id

id of the statistics

path integer (int64)

application/json

200 OK

successful operation

Initiate a passageline statistics

POST /stat/passageline

Tags: passageline

Initiate an asynchronous passageline statistics.
Use the associated GET /stat/statistic/{id} call to retrieve the status and call GET /stat/passageline/{id} to get the result when done.
Calculate a passageline statistic. A passage is registered if a ship passes the passageline. The result is delivered as a list of all passages including direction and positon and timestamp and general ship information.

application/json

202 Accepted

Successful operation. The job is queued for execution

Return the result of the statistics once it has been completed.

GET /stat/passageline/result/{id}

Tags: passageline

Return the result of the statistics once it has been completed.

id

id of the statistics

path integer (int64)
tracks

if set tracks=true then the "track" will be returned in geojson-X format in the result.

query string

application/json

200 OK

Successful operation. The result is returned

202 Accepted

The operation is in progress or queued

Return the statistics definition.

GET /stat/passageline/{id}

Tags: passageline

Return the statistics definition.

id

id of the statistics

path integer (int64)

application/json

200 OK

successful operation

Initiate a Historical Trip for Pilotboats statistics

POST /stat/pilotboat

Tags: pilot

Initiate a Historical Trip for Pilotboats statistics. Use the polygon shape to define the ports used for the trip report. Thus all trips between any ports inside the polygon. Use the a_team to define a list of ships to perform a trip report for. If the a_team is used the shape polygon is ignored (however it must still be defined).

application/json

202 Accepted

Successful operation. The job is queued for execution

Return the result of the statistics once it has been completed.

GET /stat/pilotboat/result/{id}

Tags: pilot

Return the result of the statistics once it has been completed.

id

id of the statistics

path integer (int64)

application/json

200 OK

Successful operation. The result is returned

202 Accepted

The operation is in progress or queued

Return the statistics definition.

GET /stat/pilotboat/{id}

Tags: pilot

Return the statistics definition.

id

id of the statistics

path integer (int64)

application/json

200 OK

Successful operation

Initiate a Port calls Report

POST /stat/portcalls

Tags: portcalls

Initiate a Port Calls Report statistics. The Port Calls can be done for either the ports within a polygon or for the ships in the mmsi list.

application/json

202 Accepted

Successful operation. The job is queued for execution

Return the result of the statistics once it has been completed.

GET /stat/portcalls/result/{id}

Tags: portcalls

Return the result of the statistics once it has been completed.

id

id of the statistics

path integer (int64)

application/json

200 OK

Successful operation. The result is returned

202 Accepted

The operation is in progress or queued

Return the statistics definition.

GET /stat/portcalls/{id}

Tags: portcalls

Return the statistics definition.

id

id of the statistics

path integer (int64)

application/json

200 OK

Successful operation

Initiate a SOG Distribution Report

POST /stat/sogdist

Tags: sogdist

Initiate a SOG Distribution Report statistics. The report may be done for all ships within a polygon or for a set of ships on a world wide scale. Depending on the settings for the system it may also be possible to perform a report for all ships on a worldwide scale. The result set is two lists. Those with a result_id < 0 will contain all the valid static ship information for the ships in the report. Those with a result_id >= 0 will contain an array per ship per day. The array will contain the number of seconds at the speed indicated by the index with a 0.5 knot interval. Please notice that 0.2 knots is added before truncation. Thus index 0 = [0;0.2] knots, 1 = [0.3;0.7], 2 = [0.8;1.2], 3 = [1.3;1.7] etc. The size of the array is as big as the highest SOG found for the ship for the day. No zero padding is performed.

application/json

202 Accepted

Successful operation. The job is queued for execution

Return the result of the statistics once it has been completed.

GET /stat/sogdist/result/{id}

Tags: sogdist

Return the result of the statistics once it has been completed. The result will contain a list of static ship information with one per ship and a list of SOG distribution results with one entry per ship per day. The ship static information items will only contain a "ship" entry with as much details as is available. The SOG distribution entries will contain a "day" and a "sogs" entry but only the mmsi value in the "ship" entry.

id

id of the statistics

path integer (int64)

application/json

200 OK

Successful operation. The result is returned

202 Accepted

The operation is in progress or queued

Return the statistics definition.

GET /stat/sogdist/{id}

Tags: sogdist

Return the statistics definition.

id

id of the statistics

path integer (int64)

application/json

200 OK

Successful operation

Return status on all active statistics

GET /stat/statistic

Tags: statistic

Return status on all active statistics. By default all statistics generated via the REST interface is shared with users in the same group(s)

application/json

200 OK

successful operation

Delete a statistics. Will abort if currently executing.

DELETE /stat/statistic/{id}

Tags: statistic
id

id of the statistics

path integer (int64)

application/json

200 OK

successful operation

Return status on one statistics

GET /stat/statistic/{id}

Tags: statistic
id

id of the statistics

path integer (int64)

application/json

200 OK

Successful operation. The operations has completed and the result is ready.

202 Accepted

The operation is in progress or queued. More information in the result body

Initiate a Transit Pilot statistics

POST /stat/transitpilot

Tags: pilot

Initiate a TransitPilot operations statistics. The Transit Pilot operation statistics will detect events with a pilot boarding a ship in one area and departing the ship in another area. Multiple areas can be defined "shapes" and a matrix "durations" can be provided with maximum expected sailing time between the areas. A list of pilot boats is included in the "a_team" ship list. This list is checked against all other ships passing the area or optionally limited to the list of ships in the "b_team" parameter. The result is a list of pilot operations with the details of the ship being piloted and the mmsi of both pilot vessels involved (one for boarding and one for disembarking) and timestamps for the two pilot operations

application/json

202 Accepted

Successful operation. The job is queued for execution

Return the result of the statistics once it has been completed.

GET /stat/transitpilot/result/{id}

Tags: pilot

Return the result of the statistics once it has been completed.

id

id of the statistics

path integer (int64)

application/json

200 OK

Successful operation. The result is returned

202 Accepted

The operation is in progress or queued

Return the statistics definition.

GET /stat/transitpilot/{id}

Tags: pilot

Return the statistics definition.

id

id of the statistics

path integer (int64)

application/json

200 OK

Successful operation

Initiate a Historical Trip statistics

POST /stat/trip

Tags: pilot

Initiate a Historical Trip statistics. Use the polygon shape to define the ports used for the trip report. Thus all trips between any ports inside the polygon. Use the a_team to define a list of ships to perform a trip report for. If the a_team is used the shape polygon is ignored (however it must still be defined).

application/json

202 Accepted

Successful operation. The job is queued for execution

Return the result of the statistics once it has been completed.

GET /stat/trip/result/{id}

Tags: pilot

Return the result of the statistics once it has been completed.

id

id of the statistics

path integer (int64)

application/json

200 OK

Successful operation. The result is returned

202 Accepted

The operation is in progress or queued

Return the statistics definition.

GET /stat/trip/{id}

Tags: pilot

Return the statistics definition.

id

id of the statistics

path integer (int64)

application/json

200 OK

Successful operation

Schema definitions

AreaDefinition:

group_by: string

Define the type of grouping: Either "ungrouped" or "shiplist". "ungrouped" indicates that there is no grouping. The result is a list of ships entering or leaving the area. Group by "shiplist" indicates that a grouping by individual ship combined with "interval"

interval: string

Define the grouping interval. Valid values are: day, week, month, quarter and year. Defaults to day

AreaResult: object

records: object[]

Array of result items

AreaResultItem: object

incoming: integer

For group_by=shiplist. The number of times the ship entered the area.

outgoing: integer

For group_by=shiplist. The number of times the ship has left the area.

inside: integer

For group_by=shiplist. The number of times is inside the area.

distance: integer

The distance [m] covered by ship inside the area.

period: string

For group_by=shiplist. A textual representation of the period such the date, week, month, quarter or year.

enter: string

For group_by=ungrouped. Timestamp when ship enter the area.

exit: string

For group_by=ungrouped. Timestamp when ship exit the area.

track: GeoJson-X
ship: ShipDescription

ExtShipPositionReport:

imo: integer

The IMO assigned ship number.

name: string

name of the ship

GeoJson: object

https://en.wikipedia.org/wiki/GeoJSON

"{\"type\":\"Point\",\"coordinates\":[-10.4353, 55.2]}"
coordinates: string
type: string , x ∈ { Point , MultiPoint , LineString , MultiLineString , Polygon , MultiPolygon , GeometryCollection }

GeoJson-X: object

Extended GeoJson object. Object containing a position or linestring (track). Based on http://geojson.org/ and https://github.com/dret/GeoJSON-X. Extensions defined are time (timestamp in ISO format, cog (Course Over Ground in degrees 0..360), sog (Speed Over Ground in knots). Please notice extensions in coordinates can be both numbers and string (time)

"{\"type\":\"Point\", \"extensions\" : [\"time\", \"cog\", \"sog\"],  \"coordinates\":[10.1, 55.2, \"2018-01-15T12:00:00Z\", 120.1, 8.4]\"} {\"type\":\"LineString\", \"extensions\" : [\"time\", \"cog\", \"sog\"],  \"coordinates\":[ [10.1, 55.2, \"2018-01-15T12:00:00Z\", 120.1, 8.4] [10.3, 55.1, \"2018-01-15T12:30:00Z\", 118.2, 8.3]]\"} "
extensions: string[]
string
coordinates: number[]
number
type: string , x ∈ { Point , MultiPoint , LineString , MultiLineString , Polygon , MultiPolygon , GeometryCollection }

HistoricalTrackDefinition:

HistoricalTrackResult: object

records: object[]

Array of ship descriptions

HistoricalTripDefinition:

a_team: integer[]

List of ship MMSI numbers for the trip report

integer

HistoricalTripResult: object

records: object[]

Array of ship descriptions

JobId: object

id: integer (int64)

JobStatus: object

id: integer (int64)
status: string

idle: The job is queued waiting to start. running: The job is being executed. completed: The job has completed. Call /result to obtain the result data. aborted: The job has failed to complete due to an error.

message: string
percent: integer
name: string

MultiPassageLineDefinition:

max_duration: string (time)

Indicates the maximum duration for passing all passagelines in format HHH:MM:SS. Ships must have passed the first passageline within the begin/end time frame. Ships must have passed the last passageline within end + max_duration. For ships passing in the reverse direction the order the passagelines is simply reversed.

"110:00:00"
both: boolean

Indicate whether both directions should be calculated. If false only the direction from first to last passageline is calculated. If true the reverse direction is also calculated. The calculation takes about twice the amount of time.

shapes: object[]

A list of passage lines to pass through for multi passagelines. Should be at least 2 items. Each passageline should only consist of one segment, i.e. 2 points. If more than 2 points are supplied the first and last points are used.

MultiPassageLineResult: object

records: object[]

Array of result items

MultiPassageLineResultItem: object

direction: integer

0 for first direction. 1 for reverse direction

heading: string

A human readable direction indication, e.g. N, NW, SE etc.

enter: string (date-Time)

The time when passing the first passageline.

exit: string (date-Time)

The time when passing the last passageline.

ship: ExtShipPositionReport
track: GeoJson-X

MultiShipChangedItem: object

Items that have changed since last report. Notice items are only listed here when they change.

a: integer
b: integer
c: integer
d: integer
destination: string

Destination

eta: string (date-Time)

ETA at Destination

"2017-08-18T14:00:00Z"
imo: integer

IMO number of ship, if available

name: string

Name of ship, if available

callsign: string

Callsign of ship, if available

MultiShipDefinition:

ships: object[]

List of ships

MultiShipItem: object

type: integer

Indicates the type of change: 1 = lost signal, 2 = changed static data, 3 = changed voyage data, 4 = Got signal, 5 = Changed data source type

mmsi: integer

MMSI number of ship, if available

imo: integer

IMO number of ship, if available

name: string

Name of ship, if available

callsign: string

Callsign of ship, if available

time: string (date-Time)

Timestamp of update

"2017-08-18T14:00:00Z"
cog: number

Course Over Ground, if available

sog: number

Speed Over Ground, if available

lat: number

Latitude of position, if available

lon: number

Longitude of position, if available

description: MultiShipChangedItem

MultiShipResult: object

records: object[]

Array of result items

NearMissShipPointDefinition:

threshold: integer

Minimum distance [m] for triggering a response.

NearMissShipPointResult: object

records: object[]

Array of result items

NearMissShipPointResultItem: object

position: GeoJson
distance: integer

Distance for Closest Point of Approach (CPA) between the two ships [m]

timestamp: string (date-Time)

Timestamp for closest approach between the two ships

"2017-08-18T14:00:00Z"
ship: ExtShipPositionReport

NearMissShipShipDefinition:

dsog: object

Delta SOG in [knots]. The minimum and maximum difference in speed between the two ships. Use this to filter out ships overtaking each other. Default is "ignore"

min: number
max: number
dcog: object

Delta COG in [degree]. The minimum and maximum difference in course between the two ships. Use this to filter out ships overtaking each other or risk collision. Default is "ignore"

min: number
max: number
sog: object

SOG in [knots]. The minimum and maximum actual speed of the two ships. Default is "ignore"

min: number
max: number
duration: object

NOT YET SUPPORTED !!. The minimum and maximum time for which the near miss criteria should be true to qualify. Format is [HHH:MM:SS]. Default is "ignore"

min: string
max: string
a_team: integer[]

List of ship MMSI numbers for which one ship should be involved in the near miss in order to qualify. Use this to verify near miss for a known fleet of ships

integer

NearMissShipShipResult: object

records: object[]

Array of result items

NearMissShipShipResultItem: object

distance: integer

Distance for Closest Point of Approach (CPA) between the two ships [m]

timestamp: string (date-Time)

Timestamp for closest approach between the two ships

"2017-08-18T14:00:00Z"
ships: object[]

Array of 2 ship position reports

PassageLineDefinition:

PassageLineResult: object

records: object[]

Array of result items

PassageLineResultItem: object

left: boolean

Indicates sailing director relative to the passageline. False for moving from right to left, true for moving from right to left

distance: integer

Distance [m] of the passage from the first point in the passageline.

ship: ExtShipPositionReport
position: GeoJson-X

PilotArrayItem: object

ship: object
mmsi: integer (int64)
index: integer

Index of the polygon where the pilot operation happened

label: string

Label of the polygon where the pilot operation happened. Only if supplied on POST

timestamp: string (date-Time)

Timestamp for closest approach between the two ships

"2017-08-18T14:00:00Z"
position: GeoJson

PilotBoatItem: object

ship: ShipDescription
timestamp: string (date-Time)

Time of pilot operation.

PilotBoatResult:

pilot: object[]

Array of ship descriptions

PilotResult: object

records: object[]

Array of result items

PilotResultItem: object

ship: ShipDescription
pilot: object[]

Array of 2 pilot operations

Port: object

As input parameter, either id or locode or name can be used. Notice that id and locode is unique whereas name may not be unique. The Locode is not defined for all ports.

id: integer (int64)
7790
locode: string

5 alphanumeric characters: 2 for country and 3 for location. Notice that the Locode is not defined for all ports.

"USBAY"
name: string
"BAYONNE"

PortCallsDefinition:

mmsi: integer[]

List of ship mmsis

integer
ports: object[]

List of ports

shiplist: string

A Shiplist can be specified instead of a list of ship mmsis. If a shiplist is specified, then the list of mmsis shall be omitted

"My Shiplist"

PortCallsItem: object

ship: Ship
port: Port
ata: string (date-Time)

ATA at Port

"2017-08-18T14:00:00Z"
atd: string (date-Time)

ATA from port

"2017-08-18T14:00:00Z"
draught_a: number (float)

Draught before entering the port (one hour before)

6.6
draught_d: number (float)

Draught when exiting the port (one hour after)

7.2

PortCallsResult: object

records: object[]

Array of result items

Ship: object

Static information to identify a ship. To query a given ship provide any information available. Using more information will enhance the chance for identification.

mmsi: integer (int32)
219019139
imo: integer (int32)
9619971
name: string
"MARSTAL MAERSK"
callsign: string
"OWJK2"
length: integer (int32)
140
width: integer (int32)
22
draught: number

Draught of the ship in [m]. Notice this info may change for each voyage.

8.7
grt: integer (int32)

Displacement of the ship. Notice this info is not available in the AIS information.

10000
create: boolean

If true the system will create an entry with this ship if it cannot find any information on the ship. This can be useful for ships without an AIS transponder.

ShipDescription: object

Basic information about the ship as reported by the AIS transponder. Notice not all information will be available for all ships.

mmsi: integer (int64)

As reported by the ship AIS transponder

imo: integer

The IMO number. As reported by the ship AIS transponder

name: string

The name of the ship. As reported by the ship AIS transponder

callsign: string

The callsign of the ship. As reported by the ship AIS transponder

draught: number (float)

The draught of the ship in [m]. As reported by the ship AIS transponder

width: integer

The width of the ship in [m]. As reported by the ship AIS transponder

length: integer

The length of the ship in [m]. As reported by the ship AIS transponder

destination: string

The destination of the ship. As reported by the ship AIS transponder

shiptype: integer

The type of ship. As reported by the ship AIS transponder

ShipPositionReport: object

mmsi: integer (int64)
cog: number (float)

Course Over Ground in [degree] 0 .. 360

sog: number (float)

Speed Over Ground in [knots] 0 .. 100

position: GeoJson
timestamp: string (date-Time)
"2017-08-18T14:00:00Z"

SogDistDefinition:

mmsi: integer[]

List of ship mmsis

integer
shiplist: string

A Shiplist can be specified instead of a list of ship mmsis. If a shiplist is specified, then the list of mmsis shall be omitted

"My Shiplist"
stopped_sog: number (float)

SOG trigger for considering a ship moving. Below this threshold will set the value at speed index = 0 regardless of the actual SOG. The default value is 1.0

1.1

SogDistItem: object

ship: Ship
sogs: integer[]

Array of time [seconds] at given SOG at 0.5 knots interval starting from 0.0. The index formula is: 2*(sog+0.2). Ie. sog to index mapping: [0;0.3] = 0, [0.4;0.8] = 1, [0.9;1.3] = 2, [1.4;1.8] = 3. Notice all values below configured stopped value is set at index = 0

integer
day: string (date-Time)

Day for the calculation. Notice each ship will have one entry for each day of the report

"2018-03-18"

SogDistResult: object

records: object[]

Array of result items

StatisticDefinition: object

id: object

Identifier for the job. Created by the jobserver. Should not be included in POST message

begin: string (date-Time)

The begin/start time for the calculation will start at this time. begin <= calculation < end. Format ISO: 2017-08-15T14:00:00Z or date only 2017-08-15

"2017-08-15T14:00:00Z"
end: string (date-Time)

The end/stop time for the calculation will stop just short of end as begin <= calculation < end. Format ISO: 2017-08-15T14:00:00Z or date only 2017-08-15

"2017-08-18T14:00:00Z"
name: string

Optional name which will be returned in the status call

filter: string

Optional filter. The format is identical to aisWeb filters. NB! Remember to escape " like "

"mmsi = { \\\"259222000\\\", \\\"257182000\\\" } or draught > 7 or name = \\\"*maersk*\\\""
shape: GeoJson

TransitPilotDefinition:

intervals: string[]

List of max intervals between two areas to count as a pilotage operation. The list is a matrix of count(shapes) * count(shapes). Each element is from one area (shape) to another. Typically the same for the return value. This may be a little complex to get right. As an alternative the array can contain precisely one element which will be used between all areas.

string (date-Time)
"\"30:00:00\" for 30 hours"
shapes: object[]

A list of polygons for e.g. pilot operation. Should be at least 2 items.

TripItem: object

arrival_port: Port
arrival_ts: string (date-Time)

Arrival Time.

departure_port: Port
departure_ts: string (date-Time)

Depature Time.

ship: Ship

 

Generated on 2020-05-06T10:53:12+02:00