For Developers

District Enrollments Overview

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

District Enrollments define the time period that staff members are associated with a particular district. If the same staff are also associated with one or more schools then there will be additional School Enrollment records.

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
district_idstringThe UUID of the associated District.
person_idstringThe UUID of the associated Person.
district_enrollment_role_idstringThe UUID of the associated District Enrollment Role.
start_dateDateThe start timestamp of the enrollment.
end_dateDateThe end timestamp of the enrollment. Can be null.

JSON Example

{
    "id": "00000000-0000-0000-0000-000000000000",
    "created_date": "2021-07-05T20:32:40.454Z",
    "updated_date": "2021-07-12T21:44:23.126Z",
    "district_id": "00000000-0000-0000-0000-000000000001",
    "person_id": "00000000-0000-0000-0000-000000000002",
    "district_enrollment_role_id": "00000000-0000-0000-0000-000000000003",
    "start_date": "2021-04-02T10:00:00.000Z",
    "end_date": null
}