For Developers

Enrollments Overview

An Enrollment describes a Person's relationship with a Class.

This tells you their role in the class (student, teacher, etc), the dates of their enrollment, and the state of that enrollment (active, completed, etc). And in some cases the final grade received.

This can help you track attendance, know a students current course load, or identify the teachers for a given class, etc.

The Sections model has been formally deprecated. Read more in the Deprecating Sections document.

Optionally, in systems that support Sections, an Enrollment can also refer to a specific Section that the person is enrolled in within that class.

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
start_dateDate, nullWhen the enrollment period is scheduled to start if known.
end_dateDate, nullWhen the enrollment period is scheduled to end if known.
roleRoleThe Person's role in this class. Note that this can differ from their Person.roles. For instance, a teacher could be listed as a student in a professional development course.
$filter operators: equals in not in is known is unknown
primarybooleanIf there are multiple teachers, this will indicate the primary teacher, if there is one.
stateEnrollmentStateThe state of the enrollment.
propertiesobjectNon-standard properties that may be of interest to the developer.
identifiersIdentifier[]Additional IDs associated with the object.
person_idstringThe UUID of the associated Person.
$filter operators: equals in not in
class_idstringThe UUID of the associated Class.
$filter operators: equals in not in
section_idstring, nullThe UUID of the associated Section.
$filter operators: equals in not in
final_letter_gradestring, nullThe rolled up overall letter grade for this enrollment. (A+, B, etc)
final_numeric_gradenumber, nullThe rolled up overall numeric grade for this enrollment.

JSON Example

{
    "final_letter_grade": "B",
    "final_numeric_grade": 85,
    "start_date": "2024-08-15T00:00:00.000Z",
    "end_date": "2025-05-30T23:59:59.999Z",
    "primary": false,
    "created_date": "2024-10-29T16:07:17.460Z",
    "updated_date": "2025-01-07T12:28:59.150Z",
    "properties": {},
    "identifiers": [
        {
            "type": "sis_id",
            "value": "12345"
        }
    ],
    "id": "a3872365-bdaa-46e0-8b5f-4b588cd5bac3",
    "state": "active",
    "role": "student",
    "person_id": "c19bafe2-f7a6-442e-b709-64dd83689566",
    "class_id": "fc8ba5f4-1b10-42a8-9929-75790d601912",
    "section_id": null
}

Supported Providers

ProviderSupport
aspen✅
classgather✅
classlink✅
oneroster✅
rapididentity✅
genesis✅
sapphire✅
rediker✅
renweb✅
synergy✅
frontline✅
banner✅
tyler✅
ascender✅
aeries✅
blackbaud✅
blackboard✅
brightspace✅
canvas✅
clever✅
edfi✅
eduplaces✅
facts✅
google✅
illuminate✅
microsoft✅
moodle✅
powerschool✅
schoology✅
bromcom✅
lti✅
skyward✅
qmlativ✅
toddle✅
managebac✅
infinitecampus✅
wonde✅