For Developers

School Years Overview

This model is part of the v2.5 API update which is currently in beta and therefore subject to change.

School Years define the time periods that instruction is offered for an academic year for a School.

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
school_idstringThe UUID of the associated School.
namestringThe name of the school year.
numbernumberThe numeric value of the school year.
start_dateDateThe start timestamp of the school year.
end_dateDateThe end timestamp of the school year.

JSON Example

{
    "id": "00000000-0000-0000-0000-000000000000",
    "created_date": "2021-07-05T20:32:40.454Z",
    "updated_date": "2021-07-12T21:44:23.126Z",
    "school_id": "00000000-0000-0000-0000-000000000001",
    "name": "2020-2021",
    "number": 2020,
    "start_date": "2020-08-06T00:00:00.000Z",
    "end_date": "2021-05-25T00:00:00.000Z"
}