A Period is a time period used to represent a portion of a day. A period can be a class period, a lunch period, a recess period, or any other time period. Periods are used to track the schedule of students, staff, and equipment. Periods are associated with Sessions.
Properties
| Property | Type | Description |
|---|---|---|
id | string | The UUID for the period. $filter operators: equals in not in |
created_date | Date | When the period was first seen by Edlink. |
updated_date | Date | When the period was last changed in Edlink. $filter operators: equals gt lt gte lte |
properties | object | Non-standard properties that may be of interest to the developer. |
name | string | The name of the period. |
description | string | A description of the period. |
start_time | Date | The start time of the period. Only the time will be used |
end_time | Date | The end time of the period. Only the time will be used |
type | PeriodType | The type of the period. |
flags | PeriodFlag[] | The flags for the period. All, some, or none of the possible flags may be included. |
identifiers | Identifier[] | Additional IDs associated with the object. |
school_ids | string[] | An array of UUIDs of the associated Schools. |
session_ids | string[] | An array of UUIDs of the associated Sessions. |
JSON Example
{
"id": "ae0a50a6-390f-4d1d-a963-00e7c865f40e",
"created_date": "2022-03-25T08:30:00.000Z",
"updated_date": "2022-03-25T08:30:00.000Z",
"properties": {},
"name": "Period 1",
"description": "First period of the day",
"start_time": "2022-03-25T08:30:00.000Z",
"end_time": "2022-03-25T09:20:00.000Z",
"type": "Class",
"flags": [],
"school_ids": ["5c5f9063-f2f2-4d47-9ce4-eb4a4d3f3bc3"],
"session_ids": ["9a17f029-85e4-481e-b1a6-9296d3c6f1d6"]
}