Fetch Course Modules API

This API is used for fetching modules in courses or batches in LMS

Request URL: (Self Paced Course)

 https://people.zoho.com/api/v1/courses/<courseId>/modules

Request URL: (Blended Learning Course)

 https://people.zoho.com/api/v1/courses/<courseId>/batches/<batchId>/modules

Header:

Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Scope:

ZOHOPEOPLE.training.ALL
OR
ZOHOPEOPLE.training.READ

Possible Operation Types:

ALL - Complete access to data
READ - Only to fetch data

Method:

GET

Request Parameters

ParametersValues AllowedDefault ValueDescription
startIndex <integer> Specify from which record the response should be fetched

Note: Upto 25 records can be fetched in a single API call

Request

Copiedhttps://people.zoho.com/api/v1/courses/219225000000642002/modules

Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Response

Copied{
    "code": 200,
    "message": "success",
    "hasMoreRecords": false,
    "modules": [
        {
            "duration": "45 Mins",
            "lockUntil": "24-12-2021",
            "isLocked": true,
            "moduleName": "Module One",
            "description": "Description for Module",
            "lockType": "1",
            "moduleId": "219225000000642014",
            "entityData": [
                {
                    "isMandatoryLink": true,
                    "canMarkAsComplete": 0,
                    "link": "http://zoho.com/people",
                    "description": "Description for Link",
                    "resources": [
                        {
                            "resourceURL": "https://downloadcc-accl.zoho.com/webdownload?x-service=people&event-id=104689001_ZPEOPLE_LMS_243841&x-cli-msg=%7B%22mode%22%3A%22LMS%22%2C%22portalId%22%3A%2226484356%22%2C%22isInline%22%3Afalse%2C%22isThumbnail%22%3Afalse%2C%22type%22%3A2%2C%22fileId%22%3A219225000000645013%7D",
                            "resourceName": "resource.png"
                        }
                    ],
                    "type": "embedLink",
                    "linkName": "Link One",
                    "canUserDelete": true,
                    "lockUntil": "23-12-2021",
                    "linkId": "219225000000645001",
                    "isLocked": true,
                    "canUserEdit": true,
                    "moduleId": "219225000000642014"
                }
            ]
        },
        {
            "duration": "50 Mins",
            "lockUntil": "",
            "isLocked": false,
            "moduleName": "Module Two",
            "description": "Description for Module",
            "lockType": "0",
            "moduleId": "219225000000645017",
            "entityData": []
        },
        {
            "duration": "100 Mins",
            "lockUntil": "27-12-2021",
            "isLocked": true,
            "moduleName": "Module two",
            "description": "Description for Module",
            "lockType": "1",
            "moduleId": "219225000000648001",
            "entityData": []
        }
    ]
}