Sign in

v1

latestOpenAPI 3.0.32026-07-24434977.4 KB
CAD Events

Retrieving an Event by ExternalID

gets event for provided externalId

get/cad/events/{externalId}

Path parameters

externalIdstring uuid required

Response

Success

externalIdstring required

external id of event used for identification

groupingIdstring

optional id used to link multiple events together

displayIdstring

optional override of external id to be displayed in UI

eventTypestring required
priorityinteger required

1-indexed value representing priority of the event (lower is higher priority)

displayPrioritystring

optional override of priority value to be displayed in UI

timestampstring date-time

RFC3339 UTC datetime string of when event started (defaults to current time if not provided)

closedAtstring date-time

RFC3339 UTC datetime string of when event ended (event considered open if not set)

displayStatusstring

optional custom status of event to be displayed in UI

departmentstring

optional field for specifying department involved (fire, EMS, etc.)

areastring

optional field for specifying district/sector/beat involved in event

narrativesstring[]

Example response

{
  "involvedPersons": [
    {
      "dateOfBirth": "2017-01-20"
    }
  ]
}