Skip to main content Skip to navigation

Fetch module students

Fetches students registered on a module. Allows additional filtering.

Permission requirements

The user must have Permissions.Profiles.Read.ModuleRegistration.Core ("View a student's module registrations") on the module.

Information about API permissions




URL substitution variables

:module The module code to look-up students for.
:academicYear Academic year to filter registrations by. Defaults to SITS academic year if unspecified.

Request parameters

occurrence Optional Narrows the list of students down to those registered on the specified occurrence. Valid values can be retrieved with GET /v1/module/:moduleCode/occurrences/:academicYear
endDate Optional Requires that any module registrations considered must have an endDate greater-than or equal to the provided date.
universityIds Optional A boolean value indicating whether this endpoint should return University IDs instead of usercodes. This is false by default. From version 2020.7.17

Example request


Response parameters

An unsuccessful response will be returned in the standard format. A successful response will return the HTTP code 200 OK and the following parameters:

success Boolean true
status The string "ok"
usercodes Array of usercodes if the universityIds request parameter is false or unspecified.
universityIds Array of University IDs if the universityIds request parameter is true.

Example response

"usercodes":[ "in-reynard-fox" ]

Tabula API Methods