Skip to content

Course information

Source: infoCourse.json

The specification file for a course.

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}$.
  • name (string, required): The course name (e.g., 'TAM 212').
  • title (string, required): The course title (e.g., 'Introductory Dynamics').
  • timezone (string): The timezone for all date input and display (e.g., "America/Chicago"). Must be an official timezone identifier, as listed at https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. A canonical identifier is preferred.
  • options (object): Options for this course. Cannot contain additional properties.
    • useNewQuestionRenderer (boolean): Feature flag to enable the new question renderer. Default: false.
    • devModeFeatures: Feature flags to enable/disable in development mode.
      • Any of
        • array: Legacy format; use an object instead.
          • Items (string): A single feature flag.
        • object:
          • Additional properties (boolean)
  • assessmentSets (array): Assessment sets.
    • Items (object): A single assessment set description.
      • abbreviation (string, required): Abbreviation (preferably 1 to 3 characters), e.g., 'HW', 'Q', 'PQ', etc.
      • name (string, required): Full singular name (preferably 1 to 3 words), e.g., 'Homework', 'Quiz', 'Practice Quiz'.
      • heading (string, required): Plural heading for a group of assessments (preferably 1 to 3 words), e.g., 'Homeworks', 'Quizzes'.
      • color: Refer to #/definitions/ColorJsonSchema.
  • assessmentModules (array): Course modules.
    • Items (object): A single course module description.
      • name (string, required): Short name for a module (preferably 1 to 3 words), e.g., 'Introduction'.
      • heading (string, required): Full name of the module (visible to students).
  • topics (array, required): Question topics (visible to students).
    • Items (object): A single topic, can represent a unit of learning (e.g. 'vectors').
      • name (string, required): Long descriptive name (preferably less than 10 words).
      • color: Refer to #/definitions/ColorJsonSchema.
      • description (string): Description of the topic.
  • tags (array): Question tags (not visible to students).
    • Items (object): A single tag description.
      • shortName (string): Short name (preferably 2 to 7 characters).
      • name (string, required): Long descriptive name (preferably less than 10 words).
      • color: Refer to #/definitions/ColorJsonSchema.
      • description (string): Description of the tag.
  • sharingSets (array): Sharing sets.
    • Items (object): A sharing set description.
      • name (string, required): Name of the sharing set.
      • description (string): Description of the sharing set.

Definitions

  • ColorJsonSchema (string): A color name. Must be one of: ["red1", "red2", "red3", "pink1", "pink2", "pink3", "purple1", "purple2", "purple3", "blue1", "blue2", "blue3", "turquoise1", "turquoise2", "turquoise3", "green1", "green2", "green3", "yellow1", "yellow2", "yellow3", "orange1", "orange2", "orange3", "brown1", "brown2", "brown3", "gray1", "gray2", "gray3"].
  • CommentJsonSchema: Arbitrary comment for reference purposes.
    • Any of
      • string
      • array
      • object: Cannot contain additional properties.
        • Additional properties