For Developers
Meetings Overview
An Edlink Meeting represents an event for which attendance can be taken.
A meeting can either belong to a class or district. If the class_id is null or missing, the meeting belongs to a district.
Schools use district meetings to track whether a student was present or absent for a day.
Meeting attendance with a class_id
is used to track whether a student was in that specific class that day. For example, a student may be present for the school day, but absent for a particular 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 |
type | string | The type of meeting that we're taking attendance for. This is either day or period . |
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. Only set when type = period . |
day_id | Day | The calendar day associated on which the meeting takes place. |
period_id | Period | The period for which this meeting took place. Only set when type = period . |
Notes
- If
type
isday
, thenperiod_id
andclass_id
will be null. - If
type
isperiod
, thenclass_id
will be set.- In this case,
period_id
is optional and depends on the system. - Period-level attendance may be taken more than once per day, so
period_id
is used to distinguish between them. - Attendance will not appear to be taken more than once per day if the
period_id
is not set.
- In this case,
JSON Example
{
"id": "00000000-0000-0000-0000-000000000000",
"created_date": "2021-07-05T20:32:40.454Z",
"updated_date": "2021-07-12T21:44:23.126Z",
"properties": {},
"type": "period",
"day_id": "00000000-0000-0000-0000-000000000000",
"class_id": "00000000-0000-0000-0000-000000000000",
"period_id": "00000000-0000-0000-0000-000000000000"
}