A Class is an instance of a Course. Many People can be Enrolled in a Class.
In previous versions of the Edlink API, this concept was called a Course.
In v2.0, we've corrected some of our terminology to be more accurate and universal. Please review Migration from v1.0 for more information.
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 |
name | string | The name of the object. $filter operators: equals starts with contains in not in is known is unknown |
description | string | The description of the object. |
picture_url | string | The URL for the class' profile picture. |
subjects | Subject[] | DEPRECATED: The subjects this class is associated with. These are provided as plaintext and are not necessarily associated with the new subject_id property below. |
grade_levels | GradeLevel[] | The grade levels this class is associated with. |
periods | string[] | DEPRECATED: The periods this class is taught. These are provided as plaintext and are not necessarily associated with the new period_ids property below. |
state | Class State | The state of the class. $filter operators: equals in not in |
locale | string | The locale of the object. |
time_zone | Timezone | The tz database name of the object. |
properties | object | Non-standard properties that may be of interest to the developer. |
identifiers | Identifier[] | Additional IDs associated with the object. |
session_ids | string[] | The UUIDs of the associated Sessions. $filter operators: equals in not in |
course_id | string | The UUID of the associated Course. $filter operators: equals in not in |
school_id | string | The UUID of the associated School. |
department_id | string | The UUID of the associated Department. $filter operators: equals in not in |
subject_id | string | The UUID of the associated Subject. $filter operators: equals in not in |
period_ids | string[] | The UUIDs of the associated Periods. $filter operators: equals in not in |
room_ids | string[] | The UUIDs of the associated Rooms. $filter operators: equals in not in |
Notes
- The
subjectsandperiodsproperties have been deprecated in favor of the newSubjectandPeriodmodels.- The old properties will still be supported through the lifespan of API V2, but they may not be as accurate as the new models.
- The new
subject_idproperty is singular. - When you use the
$expandoperator onperiods, the result will clobber the deprecatedperiodsproperty.
JSON Example
{
"id": "00000000-0000-0000-0000-000000000000",
"created_date": "2021-07-13T17:45:27.685Z",
"updated_date": "2021-07-13T17:45:27.685Z",
"name": "Defense Against the Dark Arts",
"description": null,
"picture_url": null,
"grade_levels": ["06"],
"subjects": ["CEDS.08"],
"periods": ["1"],
"state": "active",
"locale": null,
"time_zone": null,
"properties": {},
"session_ids": ["00000000-0000-0000-0000-000000000000"],
"course_id": "00000000-0000-0000-0000-000000000000",
"school_id": "00000000-0000-0000-0000-000000000000",
"department_id": "00000000-0000-0000-0000-000000000000",
"subject_id": "00000000-0000-0000-0000-000000000000",
"period_ids": ["00000000-0000-0000-0000-000000000000"],
"room_ids": ["00000000-0000-0000-0000-000000000000"]
}