API V2 Beta Documentation

Just want to give a heads up to anyone who uses the PUT /assignments/:id/start or POST /reviews endpoints.

Right now those two endpoints do not take into consideration of the user’s vacation status. Thus the endpoints are registering lesson starts and reviews even though the user is on vacation. It is not intended behavior. The intended behavior is to not allow registration of lessons and reviews while the user has an active vacation.

This has caused issue for these users when they get off of vacation. Basically assignments where lessons or reviews are registered during vacation time have their available_at fast forwarded to a time that is way outside SRS timings.

We are going to patch the endpoints up to respect vacation mode. The appropriate HTTP code and error object will return instead if an attempt is made to register on those endpoints when the API key owner is on vacation.

I recommend any users/scripts/applications who make use of the endpoints to check against the object returned in GET /user, specifically current_vacation_started_at before performing the actions…

We’ll have the API documentation updated once the change is live. We’ll also notify everyone here and on the API mailing list once the patch is active.

2 Likes