Skip to content

Assessment info

Source: infoAssessment.json

Configuration data for an assessment.

Properties

  • uuid (string, format: uuid, required): Unique identifier (UUID). 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" or "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. If the assessment type is Exam, this is true by default, and otherwise false.
  • allowAccess (array): (Legacy) List of access rules for the assessment. Access is permitted if any access rule is satisfied.
  • accessControl (array): Access control settings for the assessment.
  • 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%. Minimum: 0.
  • maxBonusPoints (number): The maximum number of additional points that can be earned beyond maxPoints. Minimum: 0.
  • allowPersonalNotes (boolean): Whether students are allowed to upload personal notes for this assessment. Default: true.
  • 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. Default: [].
  • 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. Real-time grading is allowed by default.
  • requireHonorCode (boolean): Requires the student to accept an honor code before starting the assessment. Set to true for Exam assessments by default. Only configurable for Exam assessments.
  • honorCode (string): Custom text for the honor code to be accepted before starting the assessment. Supports Markdown formatting; HTML is not supported. Only available for Exam assessments.
  • showQuestionTitles (boolean): Whether to show question titles in the student view.
  • groups (object): Configuration for group-based assessments. Cannot contain additional properties.
    • minMembers (number): Minimum number of students in a group.
    • maxMembers (number): Maximum number of students in a group.
    • roles (array): Array of custom user roles in a group. Items must be unique. Default: [].
    • studentPermissions (object): Student permissions for group management. Cannot contain additional properties. Default: {}.
      • canCreateGroup (boolean): Whether students can create groups. Default: true.
      • canJoinGroup (boolean): Whether students can join groups. Default: true.
      • canLeaveGroup (boolean): Whether students can leave groups. Default: true.
      • canNameGroup (boolean): Whether students can choose a group name when creating a group. Default: true.
    • rolePermissions (object): Role-based permissions for group assessments. Cannot contain additional properties. Default: {}.
      • canAssignRoles (array): Role names that can assign other users to roles. Items must be unique. Default: [].
        • Items (string)
      • canView (array): Role names that can view questions. Items must be unique. Default: [].
        • Items (string)
      • canSubmit (array): Role names that can submit questions. Items must be unique. Default: [].
        • Items (string)
  • advanceScorePerc: 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 JSON configuration and question list are available for others to view and copy. Default: false.
  • tools (object): Configuration for assessment tools.
    • Additional properties (object)
      • enabled (boolean, required): Whether this assessment tool is enabled.

Definitions

  • CommentJsonSchema: Arbitrary comment for reference purposes.
    • Any of
      • string
      • array
      • object:
  • 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" or "Exam".
    • examUuid (string, format: uuid): 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}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[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. Typically used for proctored 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.
  • AccessControlJsonSchema (object): Cannot contain additional properties.
    • uuid (string, format: uuid): Stable UUID for non-default access control override rules. 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})$.
    • labels (array): Array of student label names this set targets. Length must be at most 100.
      • Items (string): Length must be between 1 and 255 (inclusive).
    • beforeRelease (object): Only valid on the first entry (defaults). Controls assessment visibility before the release date. Cannot contain additional properties.
      • listed (boolean, required): Whether to list the assessment title before the release date. Students can see the title but cannot open the assessment.
    • dateControl (object): Cannot contain additional properties.
      • release (object): Controls when the assessment becomes available to students. Cannot contain additional properties.
      • due (object): Due date configuration. Overrides replace the entire due object atomically. Cannot contain additional properties.
        • date: Due date as ISO String, or null for no due date.
        • credit (integer): Custom credit percentage at the due date (0-200). Omitted means default 100% credit. Minimum: 0. Maximum: 200.
      • earlyDeadlines: Array of early deadlines with credit as percentages.
      • lateDeadlines: Array of late deadlines with credit as percentages.
      • afterLastDeadline: Controls whether submissions are allowed after the last deadline. Omitted on overrides inherits from the default rule. On the default rule, omitting means no submissions.

        • One of

          • object: Cannot contain additional properties.
            • allowSubmissions (boolean, required): Must be: false.
          • object: Cannot contain additional properties.
            • allowSubmissions (boolean, required): Must be: true.
            • credit (integer, required): Minimum: 0. Maximum: 99.
      • durationMinutes: Desired duration limit for assessment.
        • Any of
          • integer: Exclusive minimum: 0. Maximum: 525600.
          • null
      • password: Password for assessment.
        • Any of
          • string: Length must be between 1 and 128 (inclusive).
          • null
    • integrations (object): Cannot contain additional properties.
      • prairieTest (object): Cannot contain additional properties.
        • exams (array): Array of associated PrairieTest exam configs. Length must be at most 10.
          • Items (object): Cannot contain additional properties.
            • examUuid (string, format: uuid, required): UUID of associated PrairieTest exam. Must match pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$.
            • readOnly (boolean): Whether the exam is read-only for students.
            • afterComplete (object): Controls visibility after the student finishes the assessment during an active PrairieTest reservation. Only applies while a matching reservation is active; ignored otherwise. Cannot contain additional properties.
              • questions (object): Cannot contain additional properties.
                • hidden (boolean, required)
              • score (object): Cannot contain additional properties.
                • hidden (boolean, required)
  • DatetimeLocalStringSchema (string): Must match pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}(:\d{2})?$.
  • DeadlineEntryJsonSchema (object): Cannot contain additional properties.
    • date (required): Date as ISO String for additional deadline. Refer to #/definitions/DatetimeLocalStringSchema.
    • credit (integer, required): Integer credit percentage to allow. Minimum: 0. Maximum: 200.
  • 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. Minimum: 0.
    • 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.
    • lockpoint (boolean): If true, students must explicitly acknowledge advancing past this point. All questions in previous zones become read-only after crossing. Default: false.
    • questions (array, required): Array of questions in the zone. Length must be at least 1.
    • advanceScorePerc: Refer to #/definitions/AdvanceScorePercJsonSchema.
    • gradeRateMinutes (number): Minimum amount of time (in minutes) between graded submissions to the same question. Minimum: 0.
    • allowRealTimeGrading (boolean): Whether to allow real-time grading for questions in this zone. If not specified, inherits from the assessment level.
    • 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)
    • tools (object): Tools available for questions in this zone. Overrides assessment-level tools.
      • Additional properties (object)
        • enabled (boolean, required): Whether this assessment tool is enabled.
  • AdvanceScorePercJsonSchema (number): Minimum score percentage to unlock access to subsequent questions. Minimum: 0. Maximum: 100.
  • QuestionPreferencesJsonSchema (object):
    • Additional properties (string, number, or boolean)
  • LegacyGroupRoleJsonSchema (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.
  • GroupsRoleJsonSchema (object): A custom role for use in group assessments. Cannot contain additional properties.
    • name (string, required): The group role's name (e.g., Manager, Recorder).
    • minMembers (number): The minimum number of users that should be in this role. Default: 0.
    • maxMembers (number): The maximum number of users that should be in this role.