You're not reading the latest revision of this page, which is here.

Courses and tasks json

This site is for you if you are a course creator.

If you want a course to be available for external LMS, the Server needs to have the course and tasks listed in the course-and-tasks.json file.

Course JSON Definition

The course JSON File contains a list of courses. If your course has a lms-include parameter value other than none, then the course will be listed in the list.

1
2
3 {
  "courses": []
}

Course

Each course looks like so

1
2
3
4
5
6
7
8
9
10
11
12 {
  "name": [
    {
      "name": "[localized course name]",
      "language": "langcode for localized name"
    },
    ... other local names of the course 
  ],
  "pathToCourseFile": "[path to course file]"
  "tasks": [list of tasks],
  "link": "[permalink to course overview page]"
}

Tasks

Course Parameters

1. lms-include

With this parameter you can control whether or not and what elements of the course should be included as tasks in the automatic generated course json.
Possible values:

none: the course will not be included
all: the course will be included, and all elements will appear as tasks
comma separated combination of course,worksheet,lecture: ex. if lms-include = course,worksheet then the course and worksheet will appear as tasks.
(worksheet|lecture):[role] - use this to include worksheets and lectures with the specific role

News