For Developers

Student Period Attendance Virtual Metadata Overview

This model is part of the v2.5 API update which is currently in beta and therefore subject to change.

Student Period Attendance Virtual Metadata includes supporting evidence/metadata for virtual Student Period Attendance participation.

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
student_period_attendance_idstringThe UUID of the associated Student Period Attendance.
devicesDigitalDevice[]Device types used for participation.
participationVirtualParticipationType[]Captured Participation signals.
network_identifierstringUsually an IP address (IPv4 or IPv6), but can be a hostname, ASN, bluetooth address, etc.
participation_dateDateThe timestamp associated with the participation event (usually a login or submission timestamp).
chat_logstringA chat log.
interaction_secondsnumberHow long the combination of interactions lasted, in seconds.
interaction_countnumberHow many interactions occurred.

JSON Example

{
    "id": "00000000-0000-0000-0000-000000000000",
    "created_date": "2021-07-05T20:32:40.454Z",
    "updated_date": "2021-07-12T21:44:23.126Z",
    "student_period_attendance_id": "00000000-0000-0000-0000-000000000001",
    "devices": ["home_pc", "microphone"],
    "participation": ["logged_in"],
    "network_identifier": "192.168.1.100",
    "participation_date": "2021-05-01T10:00:00.000Z",
    "chat_log": "[User]: Hello\n[Teacher]: Hello",
    "interaction_seconds": 123.45,
    "interaction_count": 3
}