Skip to content

Course instance information

Source: infoCourseInstance.json

The specification file for a course instance.

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}$.
  • longName (string, required): The long name of this course instance (e.g., 'Spring 2015').
  • 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. If not specified, the timezone of the course will be used.
  • selfEnrollment (object): Default: {}.
    • enabled (boolean): If true, self-enrollment access is controlled by the beforeDate and useEnrollmentCode properties. If false, users can never enroll themselves, and must be either invited or added in the UI. You likely want to set this to true if you are configuring self-enrollment. Default: true.
    • restrictToInstitution (boolean): If true, self-enrollment is restricted to users from the same institution as the course. If false, any user can self-enroll. Default: true.
    • beforeDate (string): If specified, self-enrollment is allowed before this date and forbidden after this date. If not specified, self-enrollment depends on enabled property.
    • useEnrollmentCode (boolean): If true, self-enrollment requires an enrollment code to enroll. If false, any link to the course instance will allow self-enrollment. Default: false.
  • publishing (object)
    • startDate (string): When the course instance is published. If specified, endDate must also be specified.
    • endDate (string): When the course instance is unpublished. If specified, startDate must also be specified.
  • allowAccess (array): List of access rules for the course instance. Access is permitted if any access rule is satisfied.
    • Items (object): An access rule that permits people to access this course instance. All restrictions present in the rule must be satisfied for the rule to allow access. Cannot contain additional properties.
      • uids (array): A list of UIDs (like 'username@example.com'), one of which is required for access.
        • Items (string)
      • startDate (string): The earliest date on which access is permitted.
      • endDate (string): The latest date on which access is permitted.
      • institution (string): The institution from which access is permitted.
  • groupAssessmentsBy (string): Determines which assessment category will be used to group assessments on the student assessments page. Must be one of: "Set" or "Module". Default: "Set".
  • shareSourcePublicly (boolean): If true, the course instance's JSON configuration and all of its assessment's JSON configurations are available for others to view and copy. Default: false.
  • studentLabels (array): Student labels.
    • Items (object): A single student label, can represent a collection of students (e.g. "Section A"). Cannot contain additional 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 name of the student label. Length must be between 1 and 255 (inclusive).
      • color (required): Refer to #/definitions/ColorJsonSchema.

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", or "gray3".
  • CommentJsonSchema: Arbitrary comment for reference purposes.
    • Any of
      • string
      • array
      • object: