ScheduledQuizDetail

A request or response body; the type column links to the schemas it refers to.

ScheduledQuizDetail

FieldTypeRequiredDescription
idstring (uuid)yes—
quiz_idstring (uuid)yes—
labelstring | nullyes

Human label for the sitting, e.g. "2026 annual recertification".

opens_atstring (date-time)yes—
closes_atstring (date-time)yes—
audiencestringyes

assignees: open to everyone the quiz is assigned to. roster: open only to the trainees on this sitting's roster (see its participants), who must still be assignees of the quiz; a roster sitting with nobody on it is takeable by nobody.

one of "assignees" | "roster"

created_atstring (date-time)yes—
participantsarray of ScheduledQuizParticipantyes

The sitting's roster, oldest entry first. Decides who may sit a roster sitting; kept but ignored while the audience is assignees.

jsonExample
{
  "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "quiz_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "label": "string",
  "opens_at": "2026-01-01T00:00:00.000Z",
  "closes_at": "2026-01-01T00:00:00.000Z",
  "audience": "assignees",
  "created_at": "2026-01-01T00:00:00.000Z",
  "participants": [
    {
      "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "scheduled_quiz_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "user_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "user_display_name": "string",
      "user_email": "string",
      "created_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}