course-credit-registrations

POST `/api/v0/main-frontend/course-credit-registrations/courses/{course_id}/by-user-ids` - The registrations of the named students, for the students tab's current page.

Changed on
post/api/v0/main-frontend/course-credit-registrations/courses/{course_id}/by-user-ids

Request

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

Path parameters

course_idstring uuid required

Course id

Request body

course_instance_idstring uuid nullable
user_idsstring[] required

Response

The named students' registrations

attempt_numberinteger required
can_request_enrolment_recheckboolean required

Whether the row's "check enrolment again" action is available now; it shares the student's button's allowance.

completion_datestring date-time required
course_idstring uuid required
course_instance_idstring uuid required
course_module_completion_idstring uuid required
course_module_idstring uuid required
course_module_namestring nullable
creditsnumber float nullable
emailstring nullable
enrolment_realisation_namestring nullable
error_code'person_not_found' | 'course_code_not_found' | 'enrolment_not_found' | 'enrolment_not_accepted' | 'invalid_grade_for_grade_scale' | 'grade_scale_mismatch' | 'course_not_allowed' | 'invalid_credits' | 'study_right_not_valid' | 'sisu_validation_failed' | 'sisu_timeout' | 'service_temporarily_unavailable' | 'misregistered' | 'not_registered' | 'unauthorized' | 'malformed_request' | 'transport_error' | 'unexpected_response' | 'no_grade_scale_mapping' | 'missing_uh_course_code' | 'missing_ects_credits' | 'retry_window_expired' | 'unknown'

Why a ledger row is where it is; state says what happens to it next.

first_namestring nullable
grade_idstring nullable
idstring uuid required
last_namestring nullable
needs_admin_attentionboolean required
next_attempt_atstring date-time required
registered_atstring date-time nullable
resubmission_refusal'superseded' | 'already_succeeded' | 'submission_uncertain' | 'submission_uncertain_too_recent' | 'not_failed_permanent' | 'still_in_pipeline' | 'submission_pending' | 'already_submitted' | 'awaiting_confirmation' | 'already_cancelled' | 'nothing_to_check'

Why [ResubmissionFacts] refuses a hand action on a row.

Rendered by the teacher and admin surfaces, which decide from it which buttons a row gets, so it travels to them as it is rather than being re-mapped per surface.

sisu_attainment_idstring nullable
state'pending' | 'ready_to_submit' | 'resolving_enrolment' | 'checking_enrolment' | 'no_usable_enrolment' | 'submitting' | 'submission_uncertain' | 'awaiting_verification' | 'partially_registered' | 'registered' | 'duplicate' | 'not_improved' | 'misregistered' | 'failed_retryable' | 'failed_permanent' | 'blocked' | 'cancelled' required

What the pipeline does next with a ledger row.

state_entered_atstring date-time required
student_facing_status'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.

student_numberstring nullable

In full: a masked number cannot be checked against a student card.

student_number_verified_atstring date-time nullable
student_number_verified_via'emailed_link' | 'admin_manual' | 'study_registry'

How a student number was proven to belong to an account.

supersededboolean required
user_idstring uuid required

Changes

    • ●

      added the new already_cancelled enum value to the ///// response property for the response status

    • ●

      added the new awaiting_confirmation enum value to the ///// response property for the response status

    • ●

      added the new nothing_to_check enum value to the ///// response property for the response status

    • ●

      added the new still_in_pipeline enum value to the ///// response property for the response status

    • ●

      added the new submission_uncertain_too_recent enum value to the ///// response property for the response status

    • ●

      added the new partially_registered enum value to the / response property for the response status