For Developers

Schools Overview

An Edlink School represents a school within a data source. There will always be at least one school.

If no schools are present within a data source, we will create a district office placeholder school. For example, Edlink University (District Office). In some cases, this school will be generated to store any classes that are not associated with a school within the data source.

Properties

PropertyTypeDescription
idstringThe UUID for the object.
$filter operators: equals in not in
created_dateDateWhen the object was first seen by Edlink.
updated_dateDateWhen the object was last changed in Edlink.
$filter operators: equals gt lt gte lte
namestringThe name of the object.
$filter operators: equals starts with contains in not in is known is unknown
grade_levelsGradeLevel[]The grade levels this school is associated with.
localestringThe locale of the object.
time_zoneTimezoneThe tz database name of the object.
addressAddressThe address location of the object.
propertiesobjectNon-standard properties that may be of interest to the developer.
identifiersIdentifier[]Additional IDs associated with the object.
district_idstringThe UUID of the associated District.

JSON Example

{
    "id": "00000000-0000-0000-0000-000000000000",
    "created_date": "2021-07-05T20:32:40.454Z",
    "updated_date": "2021-07-12T21:44:23.126Z",
    "name": "Springfield Elementary School",
    "grade_levels": ["01", "02", "03", "04", "05"],
    "locale": "en",
    "time_zone": "America/Chicago",
    "address": {},
    "properties": {},
    "district_id": "00000000-0000-0000-0000-000000000000"
}

Supported Providers

ProviderSupport