Skip to content

Instructions

Maxwell Carter edited this page Jul 18, 2017 · 1 revision

Attendance

Attendance is associated with a classroom. The teacher must activate the attendance, then students can mark themselves as present by signing in. Then the teacher must stop the attendance.

Process:

  1. Teacher creates and starts the attendance by using the POST /classrooms/:id/attendances endpoint
  2. Students mark themselves as present by using the POST /classrooms/:id/students/:studentId/signIn endpoint
  3. Teacher stops attendance by using the POST /classrooms/:id/attendances/:attendanceId/stop endpoint.

Students who try and sign in when no attendance is active will receive a 404 error response.

If more than one attendance is active, it will pick the one matching the current date.

If a teacher does not stop the attendance, it will remain active forever and students can sign in. It is important the teacher stops attendance!

When the teacher stops the attendance, the response will contain a list of students who are present.

If the teacher wishes to activate the attendance again use the POST /classrooms/:id/attendances/:attendanceId/start endpoint.

To receive a list of attendances use the GET /classrooms/:id/attendances endpoint.

Clone this wiki locally