For Developers

Incidents Overview

An Incident is a record of an incident that occurred at a district. It can be associated with a School. It requires a Reporter and can be associated with one or more People.

Properties

PropertyTypeDescription
idstringThe UUID for the incident.
$filter operators: equals in not in
created_dateDateWhen the incident was first seen by Edlink.
updated_dateDateWhen the incident was last changed in Edlink.
$filter operators: equals gt lt gte lte
propertiesobjectNon-standard properties that may be of interest to the developer.
titlestringA title for the incident.
descriptionstringA description of the incident.
updatesstring[]A list of updates to the incident.
dateDateThe date of the incident.
costnumberThe estimated cost of the incident.
identifiersIdentifier[]Additional IDs associated with the object.
school_idstringThe UUID of the associated School.
reporter_idstringThe UUID of the Person who reported the incident, typically a staff member or teacher.
person_idsstring[]An array of UUIDs representing the People involved in the incident.

JSON Example

{
    "id": "00000000-0000-0000-0000-000000000000",
    "created_date": "2021-07-13T17:45:27.570Z",
    "updated_date": "2021-07-13T17:45:27.570Z",
    "properties": {},
    "title": "Physical Altercation between Students in School Cafeteria",
    "description": "An altercation broke out between two students in the school cafeteria during lunchtime. The incident started with a verbal argument, which escalated quickly and turned physical. Witnesses reported seeing the students shoving each other and exchanging punches. School staff intervened and separated the students, who both sustained minor injuries. The school nurse provided first aid on site, but the parents of both students were contacted to take them to the hospital for further medical attention.",
    "updates": [],
    "date": "2021-07-13T17:45:27.570Z",
    "cost": 0,
    "school_id": "00000000-0000-0000-0000-000000000000",
    "reporter_id": "00000000-0000-0000-0000-000000000000",
    "person_ids": ["c18e29e6-95c1-4f17-b7db-56f1c02b9b9e", "a37cfc0d-7d1c-48ec-8b1c-12234f7e9f9a"]
}