Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Request: GET \course/{id}/modules

info
Panel
bgColor#eaf4fd

Note:

  • With this method, you can retrieve a list of modules (both content and trainings) belonging to a single course.

...

The Account Owner, Account Administrators, Department Administrators, users with custom roles, or Course Author with the 'Can edit' access to the content item. 

Request Headers

Header

Description

Authorization (required)Access token. You can obtain a token by making a request.

Response Parameters

ParametersDescription
modulesAn array containing a list of course modules
moduleAn array containing information about a course module
moduleIdThe course module ID
itemId

The ID of the content item or a training belonging to the course.

This parameter indicates the ID of a content item or a training assigned to it in the account, outside the course, and doesn't coincide with the module Id parameter

courseIdThe ID of the course to which the module belongs
titleThe name of the course module
descriptionThe description of the course module
authorIdThe ID of the content item’s author (appears in the response only if the type parameter = material)
addedDateThe creation date of a content item or a training included in a course
viewUrlThe link to view a course content (appears in the response only if the type parameter = material)
typeThe course module type. 
The possible values are:
  • material
  • training
sequentialNumberSequential number of the module in the course

...