Module users 

Structs

ChangePasswordData

ConsentData

EmailData

MainFrontendUsersApiDoc 🔒

MyCourse

MyStudies

MyStudiesCompletion

A completion as the student may see it. needs_to_be_reviewed ones are excluded so a student cannot infer that they are under suspicion.

MyStudiesCourse

MyStudiesCourseModule

A course module as the student’s own profile shows it, with their best visible completion.

MyStudiesTotals

Summarises the courses the profile lists, i.e. the non-hidden ones.

ResetPasswordData

ResetPasswordTokenPayload

Functions

_add_routes

change_user_password

get_all_research_form_answers_with_user_id 🔒

GET /api/v0/main-frontend/users/get-user-research-consents - Gets all users research consents for a course specific research form.

get_course_enrollments_for_user

GET /api/v0/main-frontend/users/:id/course-enrollments

get_my_courses 🔒

GET /api/v0/main-frontend/users/my-courses - Gets all the courses the user has either started or gotten a permission to.

get_my_studies 🔒

GET /api/v0/main-frontend/users/my-studies - The authenticated user’s own study record: every course they are enrolled in, its modules, and their completions.

get_research_consent_by_user_id

GET /api/v0/main-frontend/users/get-user-research-consent - Gets users research consent.

get_user

GET /api/v0/main-frontend/users/:id

get_user_course_submission_times

GET /api/v0/main-frontend/users/:id/courses/:course_id/submission-times - A user’s exercise submission times in a course, each tagged with its exercise and module. Teacher/admin (global) view.

get_user_reset_exercise_logs

GET /api/v0/main-frontend/users/:id/user-reset-exercise-logs - Get all logs of reset exercises for a user

get_user_roles

GET /api/v0/main-frontend/users/:id/roles - All roles held by a user, across scopes. Teacher/admin (global) view; used to label the account (e.g. staff/teacher) on the user-details page.

get_user_suspected_cheaters

GET /api/v0/main-frontend/users/:id/suspected-cheaters - Cross-course suspected-cheater records for a user, each paired with the course’s applicable duration threshold. Teacher/admin (global) view; read-only (confirm/dismiss happen on the per-course cheaters page).

hide_course_from_my_courses 🔒

POST /api/v0/main-frontend/users/my-courses/:course_id/hide - Hides a course from the authenticated user’s “My courses” list.

post_user_consents

POST /api/v0/main-frontend/users/user-research-consents - Adds a research consent for a student.

reset_password_token_status

reset_user_password

send_reset_password_email

unhide_course_from_my_courses 🔒

POST /api/v0/main-frontend/users/my-courses/:course_id/unhide - Puts a previously hidden course back into the authenticated user’s “My courses” list.