API Docs

Core

/api/core

Upload

PUT /upload Takes in a supported file type in a supported format, then parses and saves questions from it

Parameters

multipart/form-data

name	type	data type	description
course.code	required	String	The code of the course to upload the questions to (CHEM 1AA3, COMPSCI 2C03, etc.)
course.year	required	Integer	The year the course is offered in
course.semester	required	String	The semester the course is offered in: WINTER, SPRING, SUMMER, FALL, MULTI-TERM
create_requried	not required	Boolean	Whether or not to insert units and subtopics for questions if they do not already exist.

Responses

http code	content-type	response
201	text/plain;charset=UTF-8	{"message": "File uploaded successfully"}
400	application/json	...

Adaptive Test

Next question

POST /adaptive-test/next-question Returns a question for the student based on the adaptive test algorithm

Parameters

multipart/form-data

name	type	data type	description
course.code	not required	String	The course the unit belongs to
course.year	not required	Integer	The course the unit belongs to
course.semester	not required	String	The course the unit belongs to
unit_name	not required	String	The unit the subtopic belongs to
subtopic_name	not required	String	The subtopic the question belongs to
resume	not required	Boolean	If true, will return a question from the last subtopic the user requested a question from

Responses

http code	content-type	response
201	application/json	{"message": "File uploaded successfully"}
400	application/json	...