Fetch Course or Batch Files API

This API is used for fetching files in course/batches in LMS

Request URL: (Self Paced Course)

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

Request URL: (Blended Learning Course)

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

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>0Specify from which record the response should be fetched

Note: Upto 25 records can be fetched in one API request

Request

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

Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Response

Copied{
    "code": 200,
    "files": [
        {
            "isMandatoryFile": true,
            "fileName": "File One",
            "previewURL": "https://downloadcc-accl.zoho.com/webdownload?x-service=people&event-id=104689001_ZPEOPLE_LMS_1641&x-cli-msg=%7B%22mode%22%3A%22LMS%22%2C%22portalId%22%3A%2226484356%22%2C%22isInline%22%3Atrue%2C%22isThumbnail%22%3Afalse%2C%22type%22%3A1%2C%22fileId%22%3A219225000000645181%7D",
            "canMarkAsComplete": 0,
            "description": "About the file",
            "resources": [
                {
                    "resourceURL": "https://downloadcc-accl.zoho.com/webdownload?x-service=people&event-id=104689001_ZPEOPLE_LMS_1642&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%3A219225000000645191%7D",
                    "resourceName": "resource.png"
                }
            ],
            "canUserDelete": true,
            "duration": "45 Mins",
            "lockUntil": "29-12-2021",
            "isDownloadable": true,
            "isIntroFile": true,
            "isLocked": true,
            "canUserEdit": true,
            "moduleId": "219225000000648001",
            "fileId": "219225000000645181"
        },
        {
            "isMandatoryFile": true,
            "fileName": "File Two",
            "previewURL": "https://downloadcc-accl.zoho.com/webdownload?x-service=people&event-id=104689001_ZPEOPLE_LMS_1643&x-cli-msg=%7B%22mode%22%3A%22LMS%22%2C%22portalId%22%3A%2226484356%22%2C%22isInline%22%3Atrue%2C%22isThumbnail%22%3Afalse%2C%22type%22%3A1%2C%22fileId%22%3A219225000000645195%7D",
            "canMarkAsComplete": 0,
            "description": "Description for File",
            "resources": [],
            "canUserDelete": true,
            "duration": "35 Mins",
            "lockUntil": "",
            "isDownloadable": true,
            "isIntroFile": true,
            "isLocked": false,
            "canUserEdit": true,
            "moduleId": "219225000000642014",
            "fileId": "219225000000645195"
        }
    ],
    "message": "success",
    "hasMoreRecords": false
}