Fetch Module Links API

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

Request URL: (Self Paced Course)

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

Request URL: (Blended Learning Course)

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

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 <parameters in JSON Object> JSON Input

Request

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

Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Response

Copied{
    "code": 200,
    "links": [
        {
            "lockUntil": "22-12-2021",
            "linkId": "219225000000645025",
            "isMandatoryLink": true,
            "canMarkAsComplete": 0,
            "isLocked": true,
            "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_1302&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%3A219225000000645035%7D",
                    "resourceName": "Resource.png"
                }
            ],
            "canUserEdit": true,
            "moduleId": "219225000000648001",
            "linkName": "Link One",
            "canUserDelete": true
        }
    ],
    "message": "success",
    "hasMoreRecords": false
}