course_modules

GET `/api/v0/main-frontend/course-modules/{course_module_id}/user-completion` Gets active users's completion for the course, if it exists.

Changed on
get/api/v0/main-frontend/course-modules/{course_module_id}/user-completion

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

course_module_idstring uuid required

Course module id

Response

User completion information

certificate_configuration_idstring uuid nullable

Some only when the student can generate a certificate for this module right now, which is also the id /generate-certificate wants.

Read off the same completion as the rest of this object, the one [course_module_completions::select_registration_completion] picks. The course page's congratulations card reads off the best one instead, so a student whose registration completion is not their best can see a certificate there and none here.

course_module_completion_idstring uuid required
course_module_namestring nullable

The module's own name, None on a course's default module.

course_namestring required

The course's own name, never the module's; the module is named by course_module_name.

credit_justificationstring nullable

Why the student said they need the credits rather than a certificate, if they have been asked and answered. Advisory; it seeds the field when they come back to the page.

ects_creditsnumber float nullable
emailstring required
enable_credit_registration_via_suotarboolean required
enable_registering_completion_to_uh_open_universityboolean required
register_credits_via_suotarboolean required

Whether this completion in particular goes through the push path. Decides which flow the page shows: the module flag above only says the module takes part.

status_before_registration'waiting_for_completion' | 'needs_student_number' | 'looking_for_enrolment' | 'needs_enrolment' | 'waiting_for_course_setup' | 'sending' | 'waiting_for_sisu' | 'registered' | 'failed' | 'not_registering' required

The stage a student sees.

uh_course_codestring nullable

None only on a module registering through credit registration.

Changes

    • ○

      added the required property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status