Versions Compared

Old Version 3

changes.mady.by.user Alina Levitskaya

Saved on

compared with

New Version Current

changes.mady.by.user sofia.grineva

Saved on

Key

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

...

Panel
bgColor#eaf4fd

Notes:

  1. Now courses in iSpring Learn LMS can not only contain content items, but trainings as well. To receive a list of all the content items and trainings of a course, use the Getting a List of Course Content and Trainings method.

  2. The Getting a List of Course Modules method should no longer be used at all, as the response will only contain course content, without trainings. This method might cease to exist in the future.

  3. With the Getting a List of Course Modules method, you can get a list of the content items of all the account’s courses or select courses from which you would like to retrieve the content.

...

Request Headers and Parameters

Header

Description

Authorization (required)Access token. You can obtain a token by making a request.
ParameterDescription
courseIds (optional)An array of IDs of the courses which results you want to retrieve.
pageSize (optional)The number of entries per page. If not indicated, equal to 1000.
pageToken (optional)The token to continue to the next page.

Response Headers

Header

Description

modulesAn array containing a list of all content items of all account courses or of certain courses. 
moduleAn array containing information about the content.
moduleIdThe module ID. 
contentItemIdThe content item ID. 
courseIdThe ID of the course to which the content item belongs.
titleThe name of the content item.
descriptionThe description of the content item.
authorIdThe ID of the content item’s author
addedDateThe creation date of the content item.
viewUrlThe link to view the content.
nextPageTokenThe token needed to continue to the next page.

Response Codes

Code

Text

Description

200OkThe request has been successfully processed. 
400Bad requestA request error.
401UnauthorizedAn authorization error.
403Permission deniedThe user doesn't have enough permissions to run the request or can't edit the content item. 

Sample Request

Code Block
languagexml
GET/courses/modules?courseIds[]=2a06bb18-41a1-11ea-b641-0a580af40727&pageSize=1000&pageToken=Mg https/1.1
Host: api-learn.ispringlearn.com
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE

...