Sign in
credit-registration-admin

GET `/api/v0/main-frontend/credit-registration-admin/registrations` - A page of the ledger, filtered and sorted.

Changed on
get/api/v0/main-frontend/credit-registration-admin/registrations

Request

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

Query parameters

pageinteger

Page number, from 1

limitinteger

Rows per page

stateCreditRegistrationState[]

Ledger states; repeat the parameter for several

error_codeCreditRegistrationErrorCode[]

Error codes; repeat the parameter for several

course_idstring uuid

Course filter

course_module_idstring uuid

Course module filter

user_idstring uuid

Student filter

student_numberstring

Exact student number, frozen on the row or linked to the account

stepTimelineStep[]

Timeline steps; repeat the parameter for several. A row waiting for a student number matches only if it completed since account linking began, as the overview counts it

engagementEngagement[]

Only rows at a step that waits on the student whose student did this; repeat for several

include_not_startedboolean

Include rows at a step that waits on the student whose student has not started; left out by default

needs_attentionboolean

Only rows counted in Needs attention

attention_reasonCreditRegistrationAttentionReason[]

Only rows the Needs attention queue picks for one of these reasons, whatever their section; repeat for several

submitted_afterstring date-time

Submitted at or after

submitted_beforestring date-time

Submitted at or before

searchstring

Name, email, student number, attainment id, stored error text, or a uuid

include_supersededboolean

Include replaced attempts

sortstring

last_activity (the default; rows counted in Needs attention first), created, time_in_state or attempts

Response

A page of the ledger

total_countinteger required
total_pagesinteger required

Changes

  • 823106662fdeRevision changes
    • ●

      deleted the query request parameter needs_admin_attention

    • ○

      added the new optional query request parameter attention_reason

    • ○

      added the new optional query request parameter engagement

    • ○

      added the new optional query request parameter include_not_started

    • ○

      added the new optional query request parameter needs_attention

    • ○

      added the new optional query request parameter step

    • ○

      added the optional 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

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

  • 8730d82eaf4bRevision changes
    • ●

      removed the optional property // from the response with the status

    • ○

      added the required property // to the response with the status