Method: listCoursesModules

Notes:

Now courses in iSpring Learn 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.
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.
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.

Permissions to Run Request

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

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)	string	Access token. You can obtain a token by making a request.
contentItemId (required)	string	The course ID.
pageSize (optional)	string	The number of entries per page. If not indicated, equal to 1000.
pageToken (optional)	string	The 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:

Parameter	Type	Description
modules	array	An array containing a list of all content items of all account courses or of certain courses.
module	array	An array containing information about the content item.
moduleId	string	The content item ID.
contentItemId	string	The content item ID.
courseId	string	The ID of the course to which the content item belongs.
title	string	The name of the content item.
description	string	The description of the content item.
authorId	string	The ID of the content’s author.
addedDate	dateTime	The creation date of the content item.
viewUrl	string	The link to view the content.
nextPageToken	string	The key needed to continue to the next page.

Possible Errors

Error	Description
Unknown content item	The course with the indicated ID was not found.
Permission denied	The user doesn't have permission to complete the request or can't edit the content item.

Sample Request

<?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>

XML

Sample Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://ispringlearn.com/go/services/api/soap">
   <SOAP-ENV:Body>
      <ListCoursesModulesResult>
         <modules>
            <module>
               <moduleId>627313fa-4199-11ea-9802-0a580af40727</moduleId>
               <contentItemId>c74a3bc3-f593-11e9-a66a-0a580af40186</contentItemId>
               <courseId>296773a6-4196-11ea-bc3a-0a580af40727</courseId>
               <title>The 15 Best Sales Books That All Salespeople Should Own</title>
               <description/>
               <authorId>79e44d4a-0799-11ea-bb8f-0a580af405bb</authorId>
               <addedDate>2020-01-28T06:18:56+00:00</addedDate>
               <viewUrl>https://myaccount.ispringlearn.com/view/12-LBnDw-JYb9W-7RZCU</viewUrl>
            </module>
            <module>
               <moduleId>8d4a3c60-419a-11ea-8b48-0a580af40727</moduleId>
               <contentItemId>f75a3bc3-f593-11e9-a66a-0a580af40197</contentItemId>
               <courseId>296773a6-4196-11ea-bc3a-0a580af40727</courseId>
               <title>The 4 Steps to SPIN Selling</title>
               <description/>
               <authorId>79e44d4a-0799-11ea-bb8f-0a580af405bb</authorId>
               <addedDate>2020-01-28T06:51:05+00:00</addedDate>
               <viewUrl>https://myaccount.ispringlearn.com/view/12-FHLn3-9VcLv-ML2gM</viewUrl>
            </module>
            <module>
               <moduleId>9737a690-419a-11ea-89bd-0a580af40727</moduleId>
               <contentItemId>f75a3bc3-f584-11e9-a66a-0a580a1bf40197</contentItemId>
               <courseId>296773a6-4196-11ea-bc3a-0a580af40727</courseId>
               <title>Dialog Simulation: Selling a Car</title>
               <description/>
               <authorId>79e44d4a-0799-11ea-bb8f-0a580af405bb</authorId>
               <addedDate>2020-01-28T06:51:23+00:00</addedDate>
               <viewUrl>https://myaccount.ispringlearn.com/view/12-S47Wh-WPPYr-9ZBES</viewUrl>
            </module>
                 ....
         </modules>
         <nextPageToken>YTQ3NmQ4ZTQtNDE5YS0xMWVhLTkwYmMtMGE1ODBhZjQwNzI3</nextPageToken>
      </ListCoursesModulesResult>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

XML