Base URL: /api/watchdog, Version: 0.1.1
AIS system for monitoring vessel traffic
This API will be superseded by a newer API.
| Operation | Description |
|---|---|
| POST /definition | Define a watchdog |
| GET /definition | Return all watchdog definitions. |
| GET /definition/{id} | Return watchdog definition. |
| PUT /definition/{id} | Update a watchdog |
| DELETE /definition/{id} | Delete a watchdog definition. |
| GET /event | Get list of watchdog events |
| POST /event | Reset time of call |
| GET /wait | Wait for watchdog event |
This call will only change in a release.
| Operation | Description |
|---|
Watchdog operations
| Operation | Description |
|---|---|
| POST /definition | Define a watchdog |
| GET /definition | Return all watchdog definitions. |
| GET /definition/{id} | Return watchdog definition. |
| PUT /definition/{id} | Update a watchdog |
| DELETE /definition/{id} | Delete a watchdog definition. |
| GET /event | Get list of watchdog events |
| POST /event | Reset time of call |
| GET /wait | Wait for watchdog event |
Define watchdogs
| Operation | Description |
|---|---|
| POST /definition | Define a watchdog |
| GET /definition | Return all watchdog definitions. |
| GET /definition/{id} | Return watchdog definition. |
| PUT /definition/{id} | Update a watchdog |
| DELETE /definition/{id} | Delete a watchdog definition. |
Query events produced by a watchdog
| Operation | Description |
|---|---|
| GET /event | Get list of watchdog events |
| POST /event | Reset time of call |
| GET /wait | Wait for watchdog event |
Return the definitions of all watchdogs.
application/json
successful operation
| id | id of the watchdog |
path | integer (int64) |
application/json
successful operation
Return the definition of the specified watchdog.
| id | id of the watchdog |
path | integer (int64) |
application/json
successful operation
Watchdog definition
| id | id of the watchdog |
path | integer (int64) |
application/json
successful operation
Get a list of the watchdog events triggered since the last call.
successful operation
Reset the 'last call' timestamp for the current user to the specified value.
Time
application/json
successful operation
Wait until either a watchdog triggers, or a timeout occurs.
successful operation
Object containing a position, linestring (track) or polygon. 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, \"2016-01-15T12:00:00Z\", 120.1, 8.4]\"} {\"type\":\"LineString\", \"extensions\" : [\"time\", \"cog\", \"sog\"], \"coordinates\":[ [10.1, 55.2, \"2016-01-15T12:00:00Z\", 120.1, 8.4] [10.3, 55.1, \"2016-01-15T12:30:00Z\", 118.2, 8.3]]\"} "Draught of the ship [m]
The name of watchdog
"My own watchdog"The type of watchdog: line, polygon, port, cable or fishing. The request must include a valid object of the defined type.
"line, polygon, port, cable or fishing"Watchdog configuration parameters
ID of the port
Locode of the port, 5 digit alphanumeric code
"GBFXT""FELIXSTOWE"Access Control list
Optional filter string
"destination=\"*nuuk*\""Specify whether a shiplist shall be created for the watchdog. Optional, if not specified no shiplist will be created.
Specify how long ships shall be included in shiplist. Only valid for watchdogs of type line. Optional, if no value is specified the timeout is 30 minutes "00:30:00". The value is specified in [HHH:MM:SS].
The template used for generating the message sent by mail and/or SMS when an event is activated. The default depends on the type of event definition. You can use various keywords (surrounded by percent signs) that will be replaced before the message is sent. See the aisWeb online help for a list of keywords.
The template used for generating the message sent by mail and/or SMS when an event is activated. The default depends on the type of event definition. You can use various keywords (surrounded by percent signs) that will be replaced before the message is sent. See the aisWeb online help for a list of keywords.
If this is enabled, you can specify minimum and maximum values for Course Over Ground (COG). Only vessels with a COG inside the specified interval will generate events.
See check_direction.
See check_direction.
How many position reports must be received within the area (or on the other side of the line) before an event is activated. The default is 1; higher values are useful in avoiding spurious activation due to GPS errors. On the other hand, a too high value may result in missing or delayed events.
How many position reports must be received within the area (or on the other side of the line) before an event is deactivated. The default is 1; higher values are useful in avoiding spurious deactivation due to GPS errors. On the other hand, a too high value may result in missing or delayed events.
How many position reports must be received between successive activation events. The default is zero; higher values are useful for avoiding spurious deactivation due to GPS errors. On the other hand, a too high value may result in missing or delayed events.
Similar to samples_between_trigger, but based on time (seconds) instead of received AIS reports.
If a vessel has activated an event, and the system has not received any reports from the vessel for this long, the event will automatically be deactivated (it is assumed that the vessel is no longer in AIS range). The default is never.
This determines the severity of the generated events. Valid values are "note", "warning", "alert".
If this box is checked, you must also specify a value for ship_notification_text. When an event is activated, the system will send a Safety Related message to the vessel in question.
See send_ship_notification. Note that due to technical limitations in AIS, you can only use certain characters.