Login

Results

Get learner results for your courses.

Endpoints

Get results

GET /api/v1/results

Returns a list of course results.

Query parameters

FieldTypeDescriptionRequiredDefaultPattern
userstringUser IDNonull\d+
groupstringGroup IDNonull\d+
coursestringCourse IDNonull\d+
dateFilterstringDate filterNo"completed"(completed|commenced|updated)
startstringFrom dateNonull N/A
endstringuntil dateNonull N/A
commencedstringCommenced onlyNonull N/A
completedstringCompleted onlyNonull N/A
passedstringPass/Fail onlyNonull N/A
searchstringSearch by Group nameNo""[\w\-\s]+
sortstringSort byNo"updated"(user.firstname|user.lastname|group.name|course.code|course.title|updated|commenced|completed)
reversestringShould sort order be reversedNo"false" N/A
pagestringWhich page of items to display, starting with zeroNo"0"\d+
lengthstringItems per page (0-100)No"10"\d+

Responses

CodeDescription
200Returned when successful

Get module results

GET /api/v1/module/results

Returns a list of module results.

Query parameters

FieldTypeDescriptionRequiredDefaultPattern
userstringUser IDNonull\d+
groupstringGroup IDNonull\d+
coursestringCourse IDNonull\d+
resourcestringLesson/Quiz/etc IDNonull\d+
commencedstringCommenced onlyNonull0|1
completedstringCompleted onlyNonull0|1
passedstringPass/Fail onlyNonull N/A
pagestringWhich page of items to display, starting with zeroNo"0"\d+
lengthstringItems per page (0-100)No"10"\d+

Responses

CodeDescription
200Returned when successful