For Developers

School Enrollments Overview

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

School Enrollments define the time period that staff members and students are associated with a particular 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.
person_idstringThe UUID of the associated Person.
track_idstringThe UUID of the associated Track.
school_enrollment_role_idstringThe UUID of the associated School Enrollment Role.
start_dateDateThe start timestamp of the enrollment (when they entered the school).
end_dateDateThe end timestamp of the enrollment (when they withdrew from the school). 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",
    "school_id": "00000000-0000-0000-0000-000000000001",
    "person_id": "00000000-0000-0000-0000-000000000002",
    "track_id": "00000000-0000-0000-0000-000000000003",
    "school_enrollment_role_id": "00000000-0000-0000-0000-000000000004",
    "start_date": "2021-04-02T10:00:00.000Z",
    "end_date": null
}