Attendances

The attendances endpoint can be used to retrieve AM or PM roll call attendance marks for a student or registration group.

Please note: by default, attendance data will not be provided for your test school due to the amount of data involved. If you would like to access attendance data on sandbox, please contact us on help@assembly.education.

Access: This is a read-only resource managed directly by the school.

Permissions: a school level access token with the attendances scope is required to access attendance information.

List Attendances

Returns a list of attendances. By default, attendances are returned from the start to the end of the current week.

Note the If-Modified-Since header is optional (see the page on Conditional Requests for more details).

Request

GET /attendances?start_date={start_date}&end_date={end_date}
Headers
Accept: application/vnd.assembly+json; version=1
Authorization: Bearer b2s7a9s8BQokikJOvBiI2HlWgH4olfQ2
If-Modified-Since: Fri, 19 May 2017 12:20:58 GMT
Parameter Default Example Description
start_date beginning of week 2017-06-05

start of period to return attendances for

end_date end of week 2017-06-05

end of period to return attendances for

per_page 100 25

number of results to return

page 1 2

page number to return

URI Template: /attendances?start_date={start_date}&end_date={end_date}

Response 200

Headers
Content-Type: application/json; charset=utf-8
Last-Modified: Fri, 19 May 2017 12:20:58 GMT
Payload
{
  "object": "list",
  "total_count": 3,
  "total_pages": 1,
  "current_page": 1,
  "prev_page": null,
  "next_page": null,
  "data": [
    {
      "object": "attendance",
      "id": 213897,
      "student_id": 108634,
      "registration_group_id": 4698,
      "session_date": "2017-06-05T13:00:00.000Z",
      "session_name": "PM",
      "attendance_mark": "\\",
      "minutes_late": null,
      "comments": null
    },
    {
      "object": "attendance",
      "id": 213896,
      "student_id": 108634,
      "registration_group_id": 4698,
      "session_date": "2017-06-05T09:00:00.000Z",
      "session_name": "AM",
      "attendance_mark": "/",
      "minutes_late": null,
      "comments": null
    },
    {
      "object": "attendance",
      "id": 213805,
      "student_id": 108601,
      "registration_group_id": 4698,
      "session_date": "2017-06-05T13:00:00.000Z",
      "session_name": "PM",
      "attendance_mark": "\\",
      "minutes_late": null,
      "comments": null
    }
  ]
}

View Attendances for a Student

Returns a list of attendances for a given student. By default, attendances are returned from the start to the end of the current week.

Note the If-Modified-Since header is optional (see the page on Conditional Requests for more details).

Request

GET /attendances?student_id={student_id}
Headers
Accept: application/vnd.assembly+json; version=1
Authorization: Bearer b2s7a9s8BQokikJOvBiI2HlWgH4olfQ2
If-Modified-Since: Fri, 19 May 2017 12:20:58 GMT
Parameter Default Example Description
student_id 108364

ID of the student as an integer

start_date beginning of week 2017-06-01

start of period to return attendances for

end_date end of week 2017-06-30

end of period to return attendances for

per_page 100 25

number of results to return

page 1 2

page number to return

URI Template: /attendances?student_id={student_id}

Response 200

Headers
Content-Type: application/json; charset=utf-8
Last-Modified: Fri, 19 May 2017 12:20:58 GMT
Payload
{
  "object": "list",
  "total_count": 3,
  "total_pages": 1,
  "current_page": 1,
  "prev_page": null,
  "next_page": null,
  "data": [
    {
      "object": "attendance",
      "id": 180263,
      "student_id": 108364,
      "registration_group_id": 4686,
      "session_date": "2017-06-30T13:00:00.000Z",
      "session_name": "PM",
      "attendance_mark": "\\",
      "minutes_late": null,
      "comments": null
    },
    {
      "object": "attendance",
      "id": 180262,
      "student_id": 108364,
      "registration_group_id": 4686,
      "session_date": "2017-06-30T09:00:00.000Z",
      "session_name": "AM",
      "attendance_mark": "/",
      "minutes_late": null,
      "comments": null
    },
    {
      "object": "attendance",
      "id": 180261,
      "student_id": 108364,
      "registration_group_id": 4686,
      "session_date": "2017-06-29T13:00:00.000Z",
      "session_name": "PM",
      "attendance_mark": "\\",
      "minutes_late": null,
      "comments": null
    }
  ]
}

View Attendances for a Registration Group

Returns a list of attendances for a given registration group. By default, attendances are returned from the start to the end of the current week.

Note the If-Modified-Since header is optional (see the page on Conditional Requests for more details).

Request

GET /attendances?registration_group_id={registration_group_id}
Headers
Accept: application/vnd.assembly+json; version=1
Authorization: Bearer b2s7a9s8BQokikJOvBiI2HlWgH4olfQ2
If-Modified-Since: Fri, 19 May 2017 12:20:58 GMT
Parameter Default Example Description
registration_group_id 108364

ID of the student as an integer

start_date beginning of week 2017-06-01

start of period to return attendances for

end_date end of week 2017-06-30

end of period to return attendances for

per_page 100 25

number of results to return

page 1 2

page number to return

URI Template: /attendances?registration_group_id={registration_group_id}

Response 200

Headers
Content-Type: application/json; charset=utf-8
Last-Modified: Fri, 19 May 2017 12:20:58 GMT
Payload
{
  "object": "list",
  "total_count": 3,
  "total_pages": 1,
  "current_page": 1,
  "prev_page": null,
  "next_page": null,
  "data": [
    {
      "object": "attendance",
      "id": 211769,
      "student_id": 108530,
      "registration_group_id": 4682,
      "session_date": "2017-05-19T13:00:00.000Z",
      "session_name": "PM",
      "attendance_mark": "\\",
      "minutes_late": null,
      "comments": null
    },
    {
      "object": "attendance",
      "id": 211768,
      "student_id": 108530,
      "registration_group_id": 4682,
      "session_date": "2017-05-19T09:00:00.000Z",
      "session_name": "AM",
      "attendance_mark": "/",
      "minutes_late": null,
      "comments": null
    },
    {
      "object": "attendance",
      "id": 211767,
      "student_id": 108530,
      "registration_group_id": 4682,
      "session_date": "2017-05-18T13:00:00.000Z",
      "session_name": "PM",
      "attendance_mark": "\\",
      "minutes_late": null,
      "comments": null
    }
  ]
}