An Enrollment describes a Person's relationship with a Class.
Optionally, in systems that support Sections, an Enrollment can also refer to a specific Section associated with the Class.
Properties
| Property | Type | Description |
|---|---|---|
id | string | The UUID for the object. $filter operators: equals in not in |
created_date | Date | When the object was first seen by Edlink. |
updated_date | Date | When the object was last changed in Edlink. $filter operators: equals gt lt gte lte |
start_date | Date | When the enrollment period is scheduled to start. |
end_date | Date | When the enrollment period is scheduled to end. |
role | Role | The 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 |
primary | boolean | If there are multiple teachers, this will indicate the primary teacher, if there is one. |
state | EnrollmentState | The state of the enrollment. |
properties | object | Non-standard properties that may be of interest to the developer. |
identifiers | Identifier[] | Additional IDs associated with the object. |
person_id | string | The UUID of the associated Person. $filter operators: equals in not in |
class_id | string | The UUID of the associated Class. $filter operators: equals in not in |
section_id | string | The UUID of the associated Section. $filter operators: equals in not in |
JSON Example
{
"id": "00000000-0000-0000-0000-000000000000",
"created_date": "2021-07-13T17:45:27.674Z",
"updated_date": "2021-07-13T17:45:27.674Z",
"start_date": null,
"end_date": null,
"role": "teacher",
"primary": null,
"state": "active",
"properties": {},
"person_id": "00000000-0000-0000-0000-000000000000",
"class_id": "00000000-0000-0000-0000-000000000000",
"section_id": "00000000-0000-0000-0000-000000000000"
}