Skip to main content

Module ledger

Expand description

Viewing and hand-transitioning rows of the credit registration ledger.

Structs§

AdminAttentionThresholds
The pipeline’s own limits for asking an admin to look, from library::credit_registration::backoff.
AdminBulkTransitionPayload
AdminBulkTransitionResult
AdminBulkTransitionSkipCount
AdminCreditRegistrationDetails
AdminCreditRegistrationEvent
AdminCreditRegistrationJourney
What the student did around the completion, with full timestamps, for the timeline.
AdminCreditRegistrationRow
AdminLinkingSchedule
For a student who pressed “I have enrolled” and has no linked student number: their course code’s enrolment list schedule, and what went out on the code since the press.
AdminNotificationEmail
One of the two student terminal-state mails, in full: send_status.failure_code is what drives the decision to look at the relay.
AdminRegistrationAttention
The row’s standing on the Needs attention queue.
AdminRequeueRetryablePayload
AdminRequeueRetryableResult
AdminSuotarApiCall
AdminTransitionCreditRegistrationPayload
AdminTransitionCreditRegistrationResult
AppliedHandAction 🔒
What one hand action did to its row.
AttentionLookup 🔒
The Needs attention queue as one request saw it, for marking rows of the ledger.
AttentionLookupRow 🔒
ListCreditRegistrationsQuery

Enums§

AdminCreditRegistrationAction
What one hand action does to a row: either a state move, or something that leaves the state alone. Kept apart because only the first is a transition, and only the first is refusable.
AdminCreditRegistrationStateMove
The states an admin may move a row to; everything else is the pipeline’s to decide.
AdminTransitionOutcome

Constants§

MAX_RELATED_ROWS 🔒
A detail view’s related-rows lookups (other attempts, calls, actions) never paginate; this just bounds them against a pathological completion.
MAX_ROWS_PER_BULK_TRANSITION 🔒
A fat-finger bound on one selection; a bigger one is taken in several passes.
MAX_ROWS_PER_REQUEUE 🔒

Functions§

_add_routes
admin_bulk_transition_credit_registrations
POST /api/v0/main-frontend/credit-registration-admin/registrations/bulk-transition - Moves a selection of rows by hand, one transaction for the lot.
admin_requeue_retryable_credit_registrations
POST /api/v0/main-frontend/credit-registration-admin/registrations/requeue-retryable - Makes every failed_retryable row waiting out a backoff due now.
admin_transition_credit_registration
POST /api/v0/main-frontend/credit-registration-admin/registrations/{credit_registration_id}/transition
apply_transition 🔒
Applies one hand action in the caller’s transaction.
get_credit_registration_for_admin
GET /api/v0/main-frontend/credit-registration-admin/registrations/{credit_registration_id} - One row with its timeline, the calls that timeline refers to, the other attempts for the same completion, the actions taken on it and its linking mails.
linking_schedule_for 🔒
The code’s schedule for a presser still waiting for a student number; None for anyone else.
list_credit_registrations_for_admin
GET /api/v0/main-frontend/credit-registration-admin/registrations - A page of the ledger, filtered and sorted.
one_admin_row 🔒
to_admin_api_call 🔒
to_admin_row 🔒