Request: GET \course/{id}/modules

Note:

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

Permissions to Run the Request

The Account Owner, Account Administrators, Department Administrators, users with custom roles, or Course Author with access to the project containing this course.

Request Headers

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

Header	Description
modules	An array containing a list of course modules.
module	An array containing information about a course module.
moduleId	The course module ID.
itemId	The ID of the material or a training belonging to the course. This parameter indicates the ID of a material or a training assigned to it in the account, outside the course, and doesn't coincide with the moduleId parameter.
courseId	The ID of the course to which the module belongs.
title	The name of the course module.
description	The description of the course module.
authorId	The ID of the material’s author (appears in the response only if the type parameter = material).
addedDate	The creation date of a material or a training included in a course.
viewUrl	The link to view a course material (appears in the response only if the type parameter = material).
type	The course module type. The possible values are: material training

Response Codes

Code	Text	Description
200	OK	The request has been successfully processed.
404	Unknown content item	The course with the indicated ID is not found.
403	Permission denied	The user doesn't have enough permissions to run the request.

Sample Request

GET /course/2a06bb18-41a1-11ea-b641-0a580af40727/modules https/1.1
Host: api-learn.ispringlearn.com
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE

XML

Sample Response

https/1.1 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <modules>
        <module>
            <moduleId>37cb8634-41a1-11ea-9240-0a580af40727</moduleId>
            <itemId>c74a3bc3-f593-11e9-a66a-0a580af40186</itemId>
            <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>
            <type>material</type>
            <viewUrl>https://myaccount.ispringlearn.com/view/12-FGwkM-0toYx-GP6Fz</viewUrl>
        </module>
        <module>
            <moduleId>4772dd8a-41a1-11ea-bfc8-0a580af40727</moduleId>
            <itemId>f75a3bc3-f593-11e9-a66a-0a580af40197</itemId>
            <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>
            <type>material</type>
            <viewUrl>https://myaccount.ispringlearn.com/view/12-BJRXd-hbzrL-19ubg</viewUrl>
        </module>
        <module>
            <moduleId>47778f92-41a1-11ea-a4c8-0a580af40727</moduleId>
            <itemId>f75a3bc3-f584-11e9-a66a-0a580a1bf40197</itemId>
            <courseId>2a06bb18-41a1-11ea-b641-0a580af40727</courseId>
            <title>How to Quit Cold Calling and Smart Call Instead</title>
            <description></description>
            <addedDate>2020-01-28T07:39:13+00:00</addedDate>
            <type>training</type>
            <trainingType>
                <trainingTypeId>31ab90b9-1098-11ec-9c51-0242ac1d0008</trainingTypeId>
                <trainingTypeTitle>meeting</trainingTypeTitle>
             </trainingType>
        </module>
        ...   
    </modules>
</response>

XML