caccl-api/src/types/CanvasQuizSubmission.ts

A class that defines a set of smart Canvas endpoints that actually behave how you'd expect them to.

interface CanvasQuizSubmission {
  // The ID of the quiz submission.
  id: number,
  // The ID of the Quiz the quiz submission belongs to.
  quiz_id: number,
  // The ID of the Student that made the quiz submission.
  user_id: number,
  // The ID of the Submission the quiz submission represents.
  submission_id: number,
  // The time at which the student started the quiz submission.
  started_at: string,
  // The time at which the student submitted the quiz submission.
  finished_at?: string | null,
  // The time at which the quiz submission will be overdue, and be flagged as a
  // late submission.
  end_at?: string | null,
  // For quizzes that allow multiple attempts, this field specifies the quiz
  // submission attempt number.
  attempt?: number | null,
  // Number of times the student was allowed to re-take the quiz over the
  // multiple-attempt limit.
  extra_attempts?: number | null,
  // Amount of extra time allowed for the quiz submission, in minutes.
  extra_time?: number | null,
  // The student can take the quiz even if it's locked for everyone else
  manually_unlocked?: boolean | null,
  // Amount of time spent, in seconds.
  time_spent: number,
  // The score of the quiz submission, if graded.
  score?: number | null,
  // The original score of the quiz submission prior to any re-grading.
  score_before_regrade?: number | null,
  // For quizzes that allow multiple attempts, this is the score that will be
  // used, which might be the score of the latest, or the highest, quiz
  // submission.
  kept_score?: number | null,
  // Number of points the quiz submission's score was fudged by.
  fudge_points?: number | null,
  // Whether the student has viewed their results to the quiz.
  has_seen_results?: boolean | null,
  // The current state of the quiz submission. Possible values:
  // ['untaken'|'pending_review'|'complete'|'settings_only'|'preview'].
  workflow_state: (
    'untaken'
    | 'pending_review'
    | 'complete'
    | 'settings_only'
    | 'preview'
  ),
  // Indicates whether the quiz submission is overdue and needs submission
  overdue_and_needs_submission?: boolean | null,
};

export default CanvasQuizSubmission;