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

PropertyTypeDescription
idstringThe UUID for the object.
$filter operators: equals in not in
created_dateDateWhen the object was first seen by Edlink.
updated_dateDateWhen the object was last changed in Edlink.
$filter operators: equals gt lt gte lte
typestringThe type of meeting that we're taking attendance for. This is either day or period.
propertiesobjectNon-standard properties that may be of interest to the developer.
identifiersIdentifier[]Additional IDs associated with the object.
class_idstringThe UUID of the associated Class. Only set when type = period.
day_idDayThe calendar day associated on which the meeting takes place.
period_idPeriodThe period for which this meeting took place. Only set when type = period.

Notes

  • If type is day, then period_id and class_id will be null.
  • If type is period, then class_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.

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"
}