Coronavirus (Covid-19): Latest updates and information
Skip to main content Skip to navigation

The SmallGroupAttendance object

The small group attendance object returned by Tabula has the following properties:

events An object mapping unique identifiers of small group events to the corresponding small group event objects.
instances An object mapping unique identifiers of small group events to arrays containing the week numbers in which a given event occurs. For example, if an event runs in weeks 1-10, the array for that event will contain the numbers from 1 through 10.
attendance An array of objects containing attendance information about each student associated with this small group. Each element has two keys: student contains the student's 7-digit university ID and events contains an array of SmallGroupEventAttendanceStatus objects.

The SmallGroupEventAttendanceStatus object

The small group event attendance status object returned by Tabula has the following properties:

event Contains a SmallGroupEventReference object for the event occurence to which this object relates to.
state A textual description of the student's attendance at this event. Possible values are Attended, AttendedRemotely, MissedAuthorised, MissedUnauthorised, NotRecorded, Late, NotExpected, and NotExpectedPast.
details A SmallGroupEventAttendance object.
note Optional A SmallGroupEventAttendanceNote object if an attendance note has been entered. This will be null if no note has been entered.

The SmallGroupEventAttendance object

The small group event attendance object returned by Tabula contains details about a student's attendance at a small group event. It has the following properties:

updatedBy The user code of the user who registered the attendance.
updatedDate The date when the attendance was last updated in ISO date-time format.
joinedOn Optional The date when this student joined the group in ISO date-time format, not null only if the student joined the group after the event this attendance record relates to took place.
expectedToAttend A boolean value indicating whether the student was expected to attend the event this record relates to. This is only false if joinedOn is not null.
addedManually A boolean value indicating whether the student was added manually to this event occurrence.
replacesAttendance Optional If the student's attendance at this event occurrence replaces their attendance at another event occurrence, this field contains a SmallGroupEventReference object for the other event occurrence. Otherwise null.
replacedBy An array (possibly empty) of SmallGroupEventAttendance objects for event occurrences which replace the student's attendance at this event occurrence.

The SmallGroupEventAttendanceNote object

The small group event attendance note object returned by Tabula contains information about an attendance note. It has the following properties:

contents The text content of the attendance note.
absenceType The type of absence. Possible values for this field are academic, medical, personal, cosl, self, cancel, unknown, and other.
absenceTypeDescription A description of the type of absence. Possible values for this field are Academic, Medical, Personal, Change of study location, Self certification, Event cancelled, Unknown, and Other.
updatedBy The user code of the user who entered the attendance note.
updatedDate The date and time when the attendance note was last updated in ISO date-time format.
attachment Optional A FileAttachment object describing an attachment that was uploaded for this attendance note. If no attachment was uploaded, this key is not present.

The SmallGroupEventReference object

The small group event reference object returned by Tabula references a particular occurence of a small group event. It has the following properties:

id The unique identifier of the small group event that is referenced.
week The week number of the event's occurrence that is referenced.

Tabula API Methods