Request: GET /courses/modules

Notes:

  1. 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.

  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.

Permissions to Run the Request

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

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

Sample Request 2

GET/courses/modules?courseIds=2a06bb18-41a1-11ea-b641-0a580af40727,a1c8afde-0a37-11ec-b484-0242ac140033&pageSize=1000&pageToken=a1c8afde-0a37-11ec-b484-0242ac140033 https/1.1
Host: api-learn.ispringlearn.com
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE

Sample Response

https/1.1 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <modules>
        <module>
            <moduleId>37cb8634-41a1-11ea-9240-0a580af40727</moduleId>
            <contentItemId>c74a3bc3-f593-11e9-a66a-0a580af40186</contentItemId>
            <courseId>2a06bb18-41a1-11ea-b641-0a580af40727</courseId>
            <title>Starting Career in Car Sales</title>
            <description></description>
            <authorId>79e44d4a-0799-11ea-bb8f-0a580af405bb</authorId>
            <addedDate>2020-01-28T07:38:46+00:00</addedDate>
            <viewUrl>https://myaccount.ispringlearn.com/view/12-FGwkM-0toYx-GP6Fz</viewUrl>
        </module>
        <module>
            <moduleId>4772dd8a-41a1-11ea-bfc8-0a580af40727</moduleId>
            <contentItemId>f75a3bc3-f593-11e9-a66a-0a580af40197</contentItemId>
            <courseId>2a06bb18-41a1-11ea-b641-0a580af40727</courseId>
            <title>10 Tips to Improve Your Sales Performance</title>
            <description></description>
            <authorId>79e44d4a-0799-11ea-bb8f-0a580af405bb</authorId>
            <addedDate>2020-01-28T07:39:13+00:00</addedDate>
            <viewUrl>https://myaccount.ispringlearn.com/view/12-BJRXd-hbzrL-19ubg</viewUrl>
        </module>
        <module>
            <moduleId>47778f92-41a1-11ea-a4c8-0a580af40727</moduleId>
            <contentItemId>f75a3bc3-f584-11e9-a66a-0a580a1bf40197</contentItemId>
            <courseId>2a06bb18-41a1-11ea-b641-0a580af40727</courseId>
            <title>How to Quit Cold Calling and Smart Call Instead</title>
            <description></description>
            <authorId>79e44d4a-0799-11ea-bb8f-0a580af405bb</authorId>
            <addedDate>2020-01-28T07:39:13+00:00</addedDate>
            <viewUrl>https://myaccount.ispringlearn.com/12-uXDeH-byU30-yksZ6</viewUrl>
        </module>
        ...     
    </modules>
    <nextPageToken>NDc3NzhmOTItNDFhMS0xMWVhLWE0YzgtMGE1ODBhZjQwNzI3</nextPageToken>
</response>