Sign in
course-credit-registrations

GET `/api/v0/main-frontend/course-credit-registrations/courses/{course_id}/actions` - The manual actions taken on this course's credit registrations, newest first.

Changed on
get/api/v0/main-frontend/course-credit-registrations/courses/{course_id}/actions

Request

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

Path parameters

course_idstring uuid required

Course id

Response

The course's manual actions

action'retry_item' | 'retry_failed_for_course' | 'force_recheck' | 'mark_resolved' | 'requeue_batch' | 'transition_item' | 'cancel_registration' | 'pause_course_module' | 'resume_course_module' | 'pause_phase' | 'resume_phase' | 'run_phase_now' | 'resend_link_email' | 'unlink_student_number' | 'manual_link_student_number' | 'override_rate_cap' | 'request_enrolment_list_fetch' | 'dismiss_study_registry_conflict' | 'dismiss_attention' required
actor_first_namestring nullable
actor_last_namestring nullable
actor_rolestring required

global_admin or course_teacher; support acting on the course looks different from a colleague acting on it.

actor_user_idstring uuid required
affected_row_countinteger nullable
after_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'

What the pipeline does next with a ledger row.

before_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'

What the pipeline does next with a ledger row.

created_atstring date-time required
idstring uuid required
reasonstring nullable
target_idstring uuid nullable
target_kind'credit_registration' | 'course_module' | 'course' | 'phase' | 'verified_student_number' | 'student_number_verification_token' | 'roster_schedule' | 'study_registry_student_number_conflict' required

Changes

  • 823106662fdeRevision changes
    • ●

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

  • cc863b62beebRevision changes
    • ●

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

    • ●

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

    • ●

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

    • ●

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