Skip to content

Assessment info

Source: infoAssessment.json

Configuration data for an assessment.

Properties

  • uuid (string, required): Unique identifier (UUID v4). Must match pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$.
  • type (string, required): Type of the assessment. Must be one of: ["Homework", "Exam"].
  • title (string, required): The title of the assessment (e.g., 'Derivatives and anti-derivatives').
  • set (string, required): Which assessmentSet this one belongs to (e.g., 'Homework', 'Practice Quiz').
  • number (string, required): The number of this assessment within the set (e.g., '1', '2R', '3B').
  • allowIssueReporting (boolean): Whether to allow students to report issues for assessment questions. Default: true.
  • multipleInstance (boolean): Whether to allow students to create additional instances of the assessment. Default: false.
  • shuffleQuestions (boolean): Whether the questions will be shuffled in the student view of an assessment. Default: false.
  • allowAccess (array): List of access rules for the assessment. Access is permitted if any access rule is satisfied.
  • text (string): HTML text shown on the assessment overview page.
  • maxPoints (number): The number of points that must be earned in this assessment to achieve a score of 100%.
  • maxBonusPoints (number): The maximum number of additional points that can be earned beyond maxPoints.
  • allowPersonalNotes (boolean): Whether students are allowed to upload personal notes for this assessment.
  • autoClose (boolean): Whether to automatically close the assessment after a period of inactivity. Default: true.
  • zones (array): Array of "zones" in the assessment, each containing questions that can be randomized within the zone.
  • constantQuestionValue (boolean): Whether to keep the value of a question constant after a student solves it correctly. Default: false.
  • allowRealTimeGrading (boolean): Removes the student "Grade" buttons to prevent real-time grading while the assessment is being taken. Default: true.
  • requireHonorCode (boolean): Requires the student to accept an honor code before starting exam assessments. Default: true.
  • groupWork (boolean): Whether the assessment will support group work. Default: false.
  • groupMaxSize (number): Maximum number of students in a group.
  • groupMinSize (number): Minimum number of students in a group.
  • groupRoles (array): Array of custom user roles in a group.
  • canSubmit (array): A list of group role names matching those in groupRoles that can submit the question. Only applicable for group assessments. Items must be unique. Default: [].
    • Items (string)
  • canView (array): A list of group role names matching those in groupRoles that can view the question. Only applicable for group assessments. Items must be unique. Default: [].
    • Items (string)
  • studentGroupCreate (boolean): Whether students can create groups. Default: false.
  • studentGroupJoin (boolean): Whether students can join groups. Default: false.
  • studentGroupLeave (boolean): Whether students can leave groups. Default: false.
  • advanceScorePerc: Minimum score percentage to unlock access to subsequent questions. Refer to #/definitions/AdvanceScorePercJsonSchema.
  • gradeRateMinutes (number): Minimum amount of time (in minutes) between graded submissions to the same question. Minimum: 0.
  • module (string): Module that this assessment belongs to, as defined in infoCourse.json.
  • shareSourcePublicly (boolean): If true, the assessment's source code is shared publicly. Default: false.

Definitions

  • GroupRoleJsonSchema (object): A custom role for use in group assessments that allows control over certain permissions.
    • name (string, required): The group role's name (i.e. Manager, Reflector, Recorder).
    • minimum (number): The minimum number of users that should be in this role in a group. Default: 0.
    • maximum (number): The maximum number of users that should be in this role in a group.
    • canAssignRoles (boolean): Whether users with this role can assign other users' group roles. Default: false.
  • AssessmentAccessRuleJsonSchema (object): An access rule that permits people to access this assessment. All restrictions in the rule must be satisfied for the rule to allow access. Cannot contain additional properties.
    • mode (string): The server mode required for access. Must be one of: ["Public", "Exam"].
    • examUuid (string): The PrairieTest exam UUID for which a student must be registered. Implies mode: Exam. Must match pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$.
    • uids (array): A list of UIDs (like 'username@example.com'), one of which is required for access.
      • Items (string)
    • credit (integer): How much credit is awarded for doing the homework, as a percentage (100 means full credit). Minimum: 0.
    • startDate (string): The earliest date on which access is permitted.
    • endDate (string): The latest date on which access is permitted.
    • timeLimitMin (integer): The time limit to complete the assessment, in minutes (only for Exams). Minimum: 0.
    • password (string): Password to begin the assessment (only for Exams).
    • showClosedAssessment (boolean): Whether the student can view the assessment after it has been closed. Default: true.
    • showClosedAssessmentScore (boolean): Whether the student can view the assessment grade after it has been closed. Only works if showClosedAssessment is also set to false. Default: true.
    • active (boolean): Whether the student can create a new assessment instance and submit answers to questions. If set to false, the available credit must be 0. Default: true.
  • ZoneAssessmentJsonSchema (object)
    • title (string): Zone title, displayed to the students at the top of the question list for the zone.
    • maxPoints (number): Only this many of the points that are awarded for answering questions in this zone will count toward the total points.
    • numberChoose (integer): Number of questions to choose from this zone. Minimum: 0.
    • bestQuestions (integer): Only this many of the questions in this zone, with the highest number of awarded points, will count toward the total points. Minimum: 0.
    • questions (array, required): Array of questions in the zone. Length must be at least 1.
    • advanceScorePerc: Minimum score percentage to unlock access to subsequent questions. Refer to #/definitions/AdvanceScorePercJsonSchema.
    • gradeRateMinutes (number): Minimum amount of time (in minutes) between graded submissions to the same question. Minimum: 0.
    • canSubmit (array): A list of group role names that can submit questions in this zone. Only applicable for group assessments. Items must be unique. Default: [].
      • Items (string)
    • canView (array): A list of group role names that can view questions in this zone. Only applicable for group assessments. Items must be unique. Default: [].
      • Items (string)
  • ZoneQuestionJsonSchema (object)
  • PointsJsonSchema
  • PointsSingleJsonSchema (number): A single point value. Minimum: 0. Default: 0.
  • PointsListJsonSchema (array): An array of point values. Length must be at least 1.
  • QuestionIdJsonSchema (string): Question ID (directory name of the question).
  • ForceMaxPointsJsonSchema (boolean): Whether to force this question to be awarded maximum points on a regrade. Default: false.
  • AdvanceScorePercJsonSchema (number): Minimum score percentage to unlock access to subsequent questions. Minimum: 0. Maximum: 100.
  • CommentJsonSchema: Arbitrary comment for reference purposes.
    • Any of
      • string
      • array
      • object: Cannot contain additional properties.
        • Additional properties