Base URL: /api/jobserver, Version: 133.5
AIS system for monitoring vessel traffic
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. |
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. |
| 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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
| 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. |
Initiate an Area statistics.
application/json
Successful operation. The job is queued for execution
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
Successful operation. The result is returned
The operation is in progress or queued
Return the statistics definition.
| id | id of the statistics |
path | integer (int64) |
application/json
successful operation
Initiate a Historical Track statistics.
.
application/json
Successful operation. The job is queued for execution
Return the result of the statistics once it has been completed.
| id | id of the statistics |
path | integer (int64) |
application/json
Successful operation. The result is returned
The operation is in progress or queued
Return the statistics definition.
| id | id of the statistics |
path | integer (int64) |
application/json
successful operation
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
Successful operation. The job is queued for execution
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
Successful operation. The result is returned
The operation is in progress or queued
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
successful operation
Initiate a Multiple Ship Report statistics.
application/json
Successful operation. The job is queued for execution
Return the result of the statistics once it has been completed.
| id | id of the statistics |
path | integer (int64) |
application/json
Successful operation. The result is returned
The operation is in progress or queued
Return the statistics definition.
| id | id of the statistics |
path | integer (int64) |
application/json
Successful operation
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
Successful operation. The job is queued for execution
Return the result of the statistics once it has been completed.
| id | id of the statistics |
path | integer (int64) |
application/json
Successful operation. The result is returned
The operation is in progress or queued
Return the statistics definition.
| id | id of the statistics |
path | integer (int64) |
application/json
successful operation
Initiate a Near Miss Ship Ship statistics.
This statistics will calculate all CPA (Closes Point of Approach) for all ships.
application/json
Successful operation. The job is queued for execution
Return the result of the statistics once it has been completed.
| id | id of the statistics |
path | integer (int64) |
application/json
Successful operation. The result is returned
The operation is in progress or queued
Return the statistics definition.
| id | id of the statistics |
path | integer (int64) |
application/json
successful operation
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
Successful operation. The job is queued for execution
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
Successful operation. The result is returned
The operation is in progress or queued
Return the statistics definition.
| id | id of the statistics |
path | integer (int64) |
application/json
successful operation
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
Successful operation. The job is queued for execution
Return the result of the statistics once it has been completed.
| id | id of the statistics |
path | integer (int64) |
application/json
Successful operation. The result is returned
The operation is in progress or queued
Return the statistics definition.
| id | id of the statistics |
path | integer (int64) |
application/json
Successful operation
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
Successful operation. The job is queued for execution
Return the result of the statistics once it has been completed.
| id | id of the statistics |
path | integer (int64) |
application/json
Successful operation. The result is returned
The operation is in progress or queued
Return the statistics definition.
| id | id of the statistics |
path | integer (int64) |
application/json
Successful operation
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
Successful operation. The job is queued for execution
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
Successful operation. The result is returned
The operation is in progress or queued
Return the statistics definition.
| id | id of the statistics |
path | integer (int64) |
application/json
Successful operation
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
successful operation
| id | id of the statistics |
path | integer (int64) |
application/json
successful operation
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
Successful operation. The job is queued for execution
Return the result of the statistics once it has been completed.
| id | id of the statistics |
path | integer (int64) |
application/json
Successful operation. The result is returned
The operation is in progress or queued
Return the statistics definition.
| id | id of the statistics |
path | integer (int64) |
application/json
Successful operation
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
Successful operation. The job is queued for execution
Return the result of the statistics once it has been completed.
| id | id of the statistics |
path | integer (int64) |
application/json
Successful operation. The result is returned
The operation is in progress or queued
Return the statistics definition.
| id | id of the statistics |
path | integer (int64) |
application/json
Successful operation
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"
Define the grouping interval. Valid values are: day, week, month, quarter and year. Defaults to day
Array of result items
For group_by=shiplist. The number of times the ship entered the area.
For group_by=shiplist. The number of times the ship has left the area.
For group_by=shiplist. The number of times is inside the area.
The distance [m] covered by ship inside the area.
For group_by=shiplist. A textual representation of the period such the date, week, month, quarter or year.
For group_by=ungrouped. Timestamp when ship enter the area.
For group_by=ungrouped. Timestamp when ship exit the area.
The IMO assigned ship number.
name of the ship
"{\"type\":\"Point\",\"coordinates\":[-10.4353, 55.2]}"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]]\"} "Array of ship descriptions
List of ship MMSI numbers for the trip report
Array of ship descriptions
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.
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"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.
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.
Array of result items
0 for first direction. 1 for reverse direction
A human readable direction indication, e.g. N, NW, SE etc.
The time when passing the first passageline.
The time when passing the last passageline.
Items that have changed since last report. Notice items are only listed here when they change.
Destination
ETA at Destination
"2017-08-18T14:00:00Z"IMO number of ship, if available
Name of ship, if available
Callsign of ship, if available
List of ships
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 number of ship, if available
IMO number of ship, if available
Name of ship, if available
Callsign of ship, if available
Timestamp of update
"2017-08-18T14:00:00Z"Course Over Ground, if available
Speed Over Ground, if available
Latitude of position, if available
Longitude of position, if available
Array of result items
Minimum distance [m] for triggering a response.
Array of result items
Distance for Closest Point of Approach (CPA) between the two ships [m]
Timestamp for closest approach between the two ships
"2017-08-18T14:00:00Z"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"
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"
SOG in [knots]. The minimum and maximum actual speed of the two ships. Default is "ignore"
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"
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
Array of result items
Distance for Closest Point of Approach (CPA) between the two ships [m]
Timestamp for closest approach between the two ships
"2017-08-18T14:00:00Z"Array of 2 ship position reports
Array of result items
Indicates sailing director relative to the passageline. False for moving from right to left, true for moving from right to left
Distance [m] of the passage from the first point in the passageline.
Index of the polygon where the pilot operation happened
Label of the polygon where the pilot operation happened. Only if supplied on POST
Timestamp for closest approach between the two ships
"2017-08-18T14:00:00Z"Time of pilot operation.
Array of ship descriptions
Array of result items
Array of 2 pilot operations
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.
77905 alphanumeric characters: 2 for country and 3 for location. Notice that the Locode is not defined for all ports.
"USBAY""BAYONNE"List of ship mmsis
List of ports
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"Array of result items
Static information to identify a ship. To query a given ship provide any information available. Using more information will enhance the chance for identification.
2190191399619971"MARSTAL MAERSK""OWJK2"14022Draught of the ship in [m]. Notice this info may change for each voyage.
8.7Displacement of the ship. Notice this info is not available in the AIS information.
10000If 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.
Basic information about the ship as reported by the AIS transponder. Notice not all information will be available for all ships.
As reported by the ship AIS transponder
The IMO number. As reported by the ship AIS transponder
The name of the ship. As reported by the ship AIS transponder
The callsign of the ship. As reported by the ship AIS transponder
The draught of the ship in [m]. As reported by the ship AIS transponder
The width of the ship in [m]. As reported by the ship AIS transponder
The length of the ship in [m]. As reported by the ship AIS transponder
The destination of the ship. As reported by the ship AIS transponder
The type of ship. As reported by the ship AIS transponder
Course Over Ground in [degree] 0 .. 360
Speed Over Ground in [knots] 0 .. 100
"2017-08-18T14:00:00Z"List of ship mmsis
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"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.1Array 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
Day for the calculation. Notice each ship will have one entry for each day of the report
"2018-03-18"Array of result items
Identifier for the job. Created by the jobserver. Should not be included in POST message
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"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"Optional name which will be returned in the status call
Optional filter. The format is identical to aisWeb filters. NB! Remember to escape " like "
"mmsi = { \\\"259222000\\\", \\\"257182000\\\" } or draught > 7 or name = \\\"*maersk*\\\""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.
"\"30:00:00\" for 30 hours"A list of polygons for e.g. pilot operation. Should be at least 2 items.