Changelogs

Released on 2022-05-17

Breaking Changes:

  1. Removed: The POST /student_sessions/:id/end_exam endpoint was removed, because it contained a critical bug. The endpoint will be reintroduced in a future version.

Known Issues:

  1. When using the PUT/PATCH exam endpoints to update restrictions, all restriction parameters have to be passed in. Otherwise the remaining restriction properties are reset to their default values. This will be fixed in a future version.

Released on 2022-03-27

Notice

We decided against a timely release of the previously announced version 1.3.0 because it would have introduced quite a few breaking changes. We will instead release the important changes of 1.3.0 over the next couple weeks and move most of the breaking changes to version 2.0. We plan to make version 2.0 available along side version 1.x.x.


Changes:

  1. New: The student session POST/PUT/PATCH endpoints can now also set the close_time of the student session. The close_time determines the point in time after which the student may no longer start an exam. It's the student sessions equivalent of the end_time of an exam.

  2. New: Added the level_of_suspicion property to the student session resource. It indicates how suspicious the student is on a scale of 1 to 3 (very suspicious). A value of 0 indicates that the students behavior was not rated yet. This property may not be changed via the API.

  3. Changed: The email property of the student session resource is now optional and no longer required by its POST endpoints.

  4. Fixed: An issue that prevented changes to the open_time property of a student resource via the PUT/PATCH student endpoints was fixed.

  5. Fixed: An issue that prevented the skip_requirements property of a student resource to be set to true via the POST endpoints was fixed.


Breaking Changes:

  1. Fixed: A typo in the status property of the student session resource was fixed. It's value mail_send was renamed to mail_sent.

Known Issues:

  1. When using the PUT/PATCH exam endpoints to update restrictions, all restriction parameters have to be passed in. Otherwise the remaining restriction properties are reset to their default values. This will be fixed in a future version.

Released on 2022-02-20


Changes:

  1. Added: The optional save_recording boolean property to the exam resource. It determines whether video streams of students are saved. It may be set via the POST/PUT/PATCH exam endpoints. It's default value is true.

  2. Added: Three boolean restrictions to the exam resource. They may be set via the POST/PUT/PATCH exam endpoints:

  • allow_headphones
  • allow_whiteboard
  • allow_leave_room
  1. Fixed: The allow_pen_paper restriction is now returned by all endpoints that return an exam resource.

Breaking Changes:

There were no breaking changes introduced in this version.


Known Issues:

  1. When using the PUT/PATCH exam endpoints to update restrictions, all restriction parameters have to be passed in. Otherwise the remaining restriction properties are reset to their default values. This will be fixed in version 1.3.0.

Released on 2022-02-10


Changes:

  1. Fixed: An issue that prevented the DELETE endpoints of the student session and exam resources from working correctly was fixed.

Breaking Changes:

There were no breaking changes introduced in this version.


Released on 2021-12-28


Changes:

  1. Fixed: The POST /exams/:id/send_emails endpoint sent too many emails in an edge case.

Breaking Changes:

There were no breaking changes introduced in this version.


Changes:

  1. Fixed: Slow processing of endpoints that process student sessions.
  2. Fixed: Fixed an issue that prevented emails from being sent via the POST /exams/:id/send_emails endpoint.
  3. Fixed: Fixed an issue that prevented the PUT /exams/:id and PATCH /exams/:id endpoints from updating start_time and end_time of an exam.

Breaking Changes:

There were no breaking changes introduced in this version.