For Developers

Staff Period Attendance Intervals Overview

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

Staff Period Attendance Intervals define segments of time where staff were present for Staff Period Attendance records.

Not all providers supply the same granularity of information, so these records may contain the following configurations:

  • The start_date, end_date and seconds are all populated. This will happen if the provider supplies a date range, or if they supply the start date and seconds present.
  • Only the start_date is populated. This will happen if the provider only supplies the start date for an attendance record.
  • Only the seconds is populated. This will happen if the provider only supplies the seconds present for an attendance record.

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
staff_period_attendance_idstringThe UUID of the associated Staff Period Attendance.
start_dateDateThe start timestamp of when a staff member was present. Can be null.
end_dateDateThe end timestamp of when a staff member was present. Can be null.
secondsnumberThe amount of seconds that the staff member was present. Can be null.

JSON Examples

{
    "id": "00000000-0000-0000-0000-000000000000",
    "created_date": "2021-07-05T20:32:40.454Z",
    "updated_date": "2021-07-12T21:44:23.126Z",
    "staff_period_attendance_id": "00000000-0000-0000-0000-000000000001",
    "start_date": "2021-05-01T10:00:00.000Z",
    "end_date": "2021-05-01T10:30:00.500Z",
    "seconds": 1800.5
}
{
    "id": "00000000-0000-0000-0000-000000000000",
    "created_date": "2021-07-05T20:32:40.454Z",
    "updated_date": "2021-07-12T21:44:23.126Z",
    "staff_period_attendance_id": "00000000-0000-0000-0000-000000000001",
    "start_date": "2021-05-01T10:00:00.000Z",
    "end_date": null,
    "seconds": null
}
{
    "id": "00000000-0000-0000-0000-000000000000",
    "created_date": "2021-07-05T20:32:40.454Z",
    "updated_date": "2021-07-12T21:44:23.126Z",
    "staff_period_attendance_id": "00000000-0000-0000-0000-000000000001",
    "start_date": null,
    "end_date": null,
    "seconds": 1800.5
}