Fetch a single incident

GET

/incidents/{id}

const url = 'https://app.bluelightmaps.com/api/incidents/1';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://app.bluelightmaps.com/api/incidents/1 \
  --header 'Authorization: Basic <credentials>'

Fetch a single incident by its database ID

Authorizations

BasicAuth
ApiKey

Parameters

Path Parameters

required

integer

Responses

200

The requested incident

application/json

object

integer format: int64

originId

required

Unique external identifier for the incident

string

type

required

Type of incident

string

timeOfOrigin

Time when the incident occurred

string format: date-time

timeReceived

Time when the incident was received by the system

string format: date-time

timeUpdated

Time when the incident was last updated

string format: date-time

status

Lifecycle state. Incidents are created OPEN; status in a create body is ignored. On an update, omit it to keep the stored value, send CLOSED to close (which stands every remaining callsign down and stamps timeClosed) or OPEN to reopen (which clears timeClosed). Any other value is a 400, and assigning resources while closed is a 409.

string

default: OPEN

Allowed values: OPEN CLOSED

timeClosed

When the incident was closed; absent (null) while it is open. Server-owned: set when status becomes CLOSED, cleared when it goes back to OPEN, and ignored if sent in a request body.

string format: date-time

latitude

required

Latitude of the incident location

number format: double

longitude

required

Longitude of the incident location

number format: double

priority

required

Priority of the incident

integer

description

Description of the incident

string

<= 255 characters

resources

Callsigns assigned to this incident. A callsign is matched against the names of the devices the caller can reach, and one callsign may map to several devices (a vehicle often carries more than one) - each of them receives the assignment / deassignment event and push. Always empty while the incident is closed.

Array<string>

Example

{
  "status": "OPEN"
}

404

Incident not found