Modules are a collection of content assembled for students to work through in their LMS. They're used to organize course content by weeks, units, or a different organizational structure. Modules can be nested inside of other modules to create a folder-like tree structure.
Future Changes to the Modules API
These are some potential upcoming changes to the Modules API. We're sharing them with you now so that you can plan for them in your integration. To be completely clear, these features are not yet available and they are not in the short-term roadmap. We'll update this documentation when they are.
- Currently, you can only add pages to modules. This may change in the future if we choose to expand support to files, assignments, quizzes, and other learning materials for students to access in order.
- We may enhance the modules API to support visibility conditions. These conditions define when a student is able to access specific modules.
- An example is that modules may be locked until a specified date.
- Another is that modules may also be set as prerequisites for other modules.
- We do not currently support the creation of nested modules, although they may be returned via the API.
- We do not currently support the adding of existing content to modules, although various existing resources may be returned via the API.
Properties
| Property | Type | Description |
|---|---|---|
id | string | The UUID for the module. |
created_date | Date | When the module was created in the data source. |
updated_date | Date | When the module was last updated in the data source. |
properties | object | Non-standard properties that may be of interest to the developer. |
title | string | The title of the module. |
parent_module_id | string | The UUID of the associated Module. |