API Documentation

Exams

The following requests relate to getting information regarding the academy's exams via the Schoox Academy API. Note: All requests must be Authenticated.

Get a List of Exams

Returns a list of all academy exams with extended details.

GET /exams

Query parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 226581108
apikey Your academy's API key Yes String 9d3419535b0c8d76f7f6f72800f62f92
start Starting Position No Integer 0
limit Max size of retrieved courses No Integer 100
Example Request

https://api.schoox.com/v1/exams?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Response Object
Show All
[{"id":2744992,"name":"Exam 1","image":"https:\/\/www.schoox.com\/theme\/schoox\/assets\/exams\/images\/Exam_default_image.png","time_published":"2021-12-01T09:08:53+00:00"}]

Get a List of all Enrolled Users in an Exam

Returns a list of all users that are enrolled in an exam with their best performance statistics (e.g. date of best attempt, full score and score, passing or failure status).

GET /exams/:examid/students

Query parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 226581108
apikey Your academy's API key Yes String 9d3419535b0c8d76f7f6f72800f62f92
start Starting Position No Integer 0
limit Number of users to return per request, up to maximum of 1,000. Default to 100 No Integer 100
Example Request

https://api.schoox.com/v1/exams/2744992/students?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Response Object
Show All
[{"id":2099521483,"firstname":"John","preferred_name":null,"lastname":"Doe","image":"https:\/\/www.schoox.com\/user\/images\/no-user-image_small.gif","attempts":1,"best_attempt":{"date":"2022-01-26 15:11:11","full_score":"100","score":"100","passed":true}}]

Get Exam Performance for a specific User

Returns detailed performance statistics of an exam for a specific user.

GET /exams/:examid/students/:userid

Query parameters
Name Description Required Type Sample Value
acadId Your academy ID Yes Integer 226581108
apikey Your academy's API key Yes String 9d3419535b0c8d76f7f6f72800f62f92
Example Request

https://api.schoox.com/v1/exams/2744992/students/2099521483?apikey=9d3419535b0c8d76f7f6f72800f62f92&acadId=226581108

Response Object
Show All
{"score":100,"points":100,"passing_score":50,"passing_points":50,"passed":true,"questions":[{"title":"True?\n","correct":true},{"title":"False?\n","correct":true}]}