A calendar is a collection of calendar days. Calendars are typically used to represent an academic year for a school or district, and may include important dates such as holidays, breaks, and other scheduling information.
Calendars can be associated with one or more schools, allowing for scheduling information to be shared across multiple institutions. Additionally, they can be used to determine an institution's operational days for attendance tracking, and other time-sensitive activities, so that only days when the institution is open are considered.
Properties
| Property | Type | Description |
|---|---|---|
id | string | The UUID for the calendar. $filter operators: equals in not in |
created_date | Date | When the calendar was first seen by Edlink. |
updated_date | Date | When the calendar 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 calendar. |
code | string | The code for the calendar. |
start_date | Date | The start date of the calendar. |
end_date | Date | The end date of the calendar. |
state | CalendarState | The operational state of the calendar. |
flags | CalendarFlag[] | The flags for the calendar. All, some, or none of the possible flags may be included. |
type | CalendarType | The type of the calendar. |
identifiers | Identifier[] | Additional IDs associated with the object. |
school_ids | string[] | An array of UUIDs of the associated Schools. |
JSON Example
{
"id": "123e4567-e89b-12d3-a456-426655440000",
"created_date": "2022-04-14T10:45:27.570Z",
"updated_date": "2022-04-14T10:45:27.570Z",
"properties": {},
"name": "School Calendar",
"code": "SCH-CALENDAR",
"start_date": "2022-08-01T00:00:00.000Z",
"end_date": "2023-07-31T23:59:59.999Z",
"state": "active",
"flags": ["attendance"],
"type": "standard",
"school_ids": ["11111111-1111-1111-1111-111111111111", "22222222-2222-2222-2222-222222222222"]
}
Supported Providers
| Provider | Support |
|---|---|
| aeries | ✅ |
| blackbaud | ✅ |
| edfi | ✅ |
| facts | ✅ |
| powerschool | ✅ |
| skyward | ✅ |
| infinitecampus | ✅ |