Versions Compared

Old Version 1

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.

Method: listCoursesModules

info
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 items, 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 items.

...

Department Administrators, Course Authors, and users with a custom role can only retrieve info regarding users belonging to the departments they manage and their sub-departments.

Request Parameters

Parameter

Type

Description

token (required)stringAccess token. You can obtain a token by making a request.
contentItemId (required)stringThe course ID.
pageSize (optional)string

The number of entries per page. If not indicated, equal to 1000.

pageToken (optional)stringThe token needed to continue to the next page.

Return Values

After the request is successfully processed, the system returns an object with the following properties:

ParameterTypeDescription
modulesarrayAn array containing a list of all content items of all account courses or of certain courses.  
modulearrayAn array containing information about the content item.
moduleIdstringThe content item ID. 
contentItemIdstringThe content item ID. 
courseIdstringThe ID of the course to which the content item belongs.
titlestringThe name of the content item.
descriptionstringThe description of the content item.
authorIdstringThe ID of the content’s author.
addedDatedateTimeThe creation date of the content item.
viewUrlstringThe link to view the content.
nextPageTokenstringThe key needed to continue to the next page.

Possible Errors

ErrorDescription
Unknown content itemThe course with the indicated ID was not found.
Permission deniedThe user doesn't have permission to complete the request or can't edit the content item. 

Sample Request

Code Block
languagexml
<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
                   xmlns="https://ispringlearn.com/go/services/api/soap">
  <SOAP-ENV:Body>
   <Header/>
   <Body>
      <ListCoursesModulesRequest>
         <credentials>
           <token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token>
         </credentials>
         <courseIds>
                   <id>296773a6-4196-11ea-bc3a-0a580af40727</id>
         </courseIds>
          <pageToken>YTQ3NmQ4ZTQtNDE5YS0xMWVhLTkwYmMtMGE1ODBhZjQwNzI3</pageToken>
          <pageSize>5</pageSize>
      </ListCoursesModulesRequest>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

...