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.
  • hideInEnrollPage (boolean): If set to true, hides the course instance in the enrollment page, so that only direct links to the course can be used for enrollment. Default: false.
  • 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", "Module"]. Default: "Set".

Definitions

  • CommentJsonSchema: Arbitrary comment for reference purposes.
    • Any of
      • string
      • array
      • object: Cannot contain additional properties.
        • Additional properties