The Sections API has been formally deprecated. Read more in the Deprecating Sections document.
A Section describes a group of students within a Class. Please note, it is very unlikely that this is the model you are looking for. You are probably looking for Classes, which represent groups of students that are taught a particular subject by a teacher.
The reason that the Sections model exists is to smooth over our abstraction of certain learning management systems - in particular, Schoology and Canvas. These systems allow teachers to "merge" multiple classes into a single larger entity in order to more effectively manage course materials. The existence of these Sections allows developers to identify which students belonged to which original Classes in their LMS. They also come in handy when creating assignments that aren't meant for the whole combined group of students.
Another case where sections may pop up is when there is a need to represent smaller subgroups of students within a class. For example, within a college-level calculus class, you may see various groups of students who all sit in the same lecture hall in a given time slot, but then break up into groups, each taught by a different teaching assistant (TA). These "sections" may take place at different times and in different locations than the parent Class, taught by a single professor.
This model has been formally deprecated. Read more in the Deprecating Sections document.
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. |
state | SectionState | The state of the section. $filter operators: equals in not in |
locale | string | The locale of the object. |
time_zone | Timezone | The tz database name of the object. |
periods | string[] | DEPRECATED: The periods this section is taught. |
properties | object | Non-standard properties that may be of interest to the developer. |
identifiers | Identifier[] | Additional IDs associated with the object. |
class_id | string | The UUID of the associated Class. |
period_ids | string[] | The UUIDs of the Periods when this section meets. |
room_ids | string[] | The UUIDs of the Rooms where this section meets. |
Notes
- The
periodsproperty is now deprecated in favor of theperiod_idsproperty.- The old property will still be supported through the lifespan of API V2, but it may not be as accurate as the new model.
JSON Example
{
"id": "00000000-0000-0000-0000-000000000000",
"created_date": "2021-07-13T17:45:27.645Z",
"updated_date": "2021-07-13T17:45:27.645Z",
"name": "Section 3",
"description": null,
"picture_url": null,
"state": "active",
"locale": "en",
"time_zone": "America/Chicago",
"properties": {},
"periods": ["06"],
"class_id": "00000000-0000-0000-0000-000000000000",
"period_ids": ["00000000-0000-0000-0000-000000000000"],
"room_ids": ["00000000-0000-0000-0000-000000000000"]
}