For Developers

Departments Overview

A Department is a unit within a school or group of Subjects. It can be associated with a School.

Properties

PropertyTypeDescription
idstringThe UUID for the department.
$filter operators: equals in not in
created_dateDateWhen the department was first seen by Edlink.
updated_dateDateWhen the department was last changed in Edlink.
$filter operators: equals gt lt gte lte
propertiesobjectNon-standard properties that may be of interest to the developer.
namestringThe name of the department.
descriptionstringA description of the department.
identifiersIdentifier[]Additional IDs associated with the object.
school_idsstring[]An array of UUIDs of the associated Schools.

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": {},
    "name": "Department of Mathematics",
    "description": "A description of the department.",
    "school_ids": []
}

Supported Providers

ProviderSupport