For Developers

Meetings Overview

An Edlink Meeting represents an event for which attendance can be taken.

A meeting can either represent a district-level meeting (i.e., attendance for a school day) or a class-level meeting (i.e., attendance for a specific class session). This is indicated by the type property of the Meeting object, which can be either day or period.

Class-level meetings will have a class_id property set to indicate which class the meeting is associated with.

Additionally, class meetings may have a period_id to indicate the specific period for the relevant class on that day.

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.

JSON Example

{
    "id": "4cb963bf-d5cb-47c6-a3a5-1ddc28c65a71",
    "created_date": "2024-08-01T13:23:04.725Z",
    "updated_date": "2024-08-01T13:23:04.725Z",
    "class_id": null,
    "day_id": "ecfee75e-a1e6-405a-80a8-1c5692b94045",
    "period_id": null,
    "type": "day",
    "properties": {},
    "identifiers": []
}

Supported Providers

ProviderSupport
aeries✅
blackbaud✅
edfi✅
powerschool✅
skyward✅
veracross✅