Skip to content
Blue Light Maps docs

Overview

Blue Light Maps CAD / Incident API 6.14.5-blm

Section titled “Blue Light Maps CAD / Incident API 6.14.5-blm”

HTTP API for pushing incidents from a Computer Aided Dispatch (CAD) or control-room system into Blue Light Maps, alerting the responder devices to them, and keeping the two systems in step.

Read the CAD integration guide first: it walks through authentication, the incident lifecycle and how acceptance events reach your system. This reference lists every field and response.

Authentication

Every request carries a bearer token minted for the integration user: Authorization: Bearer <token>. Tokens are created with POST /session/token while holding a session cookie from POST /session. HTTP Basic auth (the integration user’s email and password) is also accepted on every endpoint. Use a dedicated integration user that has access to the devices you intend to dispatch to.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “ Operations ”
GET
/session
POST
/session
DELETE
/session
GET
/session/{id}
POST
/session/token
POST
/session/token/revoke
GET
/incidents
POST
/incidents
PUT
/incidents/update
GET
/incidents/{id}
PUT
/incidents/{id}
DELETE
/incidents/{id}

Authentication

Section titled “ Authentication ”

BasicAuth

Section titled “BasicAuth ”

HTTP Basic auth with a Blue Light Maps user’s email (or login) and password.

Security scheme type: http

ApiKey

Section titled “ApiKey ”

Blue Light Maps API token, sent as a bearer token. This is the credential most endpoints use. Obtain one by generating a token in the web UI or by calling POST /session/token. Send as Authorization: Bearer <token>.

Security scheme type: http