Wrong Way Driver API
The Wrong Way Driver API uses Basic Authentication. Each partner is provided with a unique username and password that must be provided in the Authorization Header of each request.
API Definition
Methods
| Resource | Url | Data Payload | Description | Returns |
|---|---|---|---|---|
| POST WrongWayDriverAlert | /api/WrongWayDriverAlert | Wrong Way Driver Alert | Receives Wrong Way Driver alerts from external systems | None |
| POST ApiStatus | /api/ApiStatus | HeartbeatFrequency (integer) | This method is used by the Wrong Way Driver detection system to notify inSIGHT ATMS that it is still available and communicating. The HeartbeatFrequency indicates the interval after which inSIGHT ATMS should expect to receive the next communication. |
Data Formats
Wrong Way Driver Alert
| Name | Description | Type | Required | Additional Information |
|---|---|---|---|---|
| AlertId | A unique identifier of the alert | int | Yes | If multiple alerts are received with the same ID, inSIGHT ATMS will assume later are alerts are an update to the previously received alert, and overwrite previously received data |
| ReportedDateUtc | The datetime the alert was raised/reported | string | Yes | None |
| Images | A collection of Base64 encoded images that can be used to verify the Alert represents a wrong way driver on the road Array | [string] | No | Images should are expected to be provided as Base64 encoded strings |
| VideoStreamUrls | A collection of URLs that can be used to view video clips related to the alert | Array[string] | No | Video must be provided in one of the following formats: - MP4 - HLS - WebRTC |
| SystemId | The identifier of the Wrong Way Driver detection station that raised the alert | int | Yes | None |
| CallBackUrl | The URL to which to send resolutions to the alert, if alert responses are required | string | No | None |
| AlertDetailUrl | A URL which can be used to view more detail about an alert if provided by the source | string | No | None |
| ResolutionTypes | The set of possible alert resolutions that will be accepted by the system generating the alert if responses to the alert are required | Array[ResolutionType] | No | Required if CallBackUrl provided |
Resolution Type
| Name | Description | Type | Required | Additional Information |
|---|---|---|---|---|
| Id | An id for the resolution type | integer | Yes | None |
| Description | A text description of the resolution type | string | Yes | None |