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
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
| Parameters | Values Allowed | Default Value | Description |
| startIndex | <integer> | Specify from which record the response should be fetched |
Note: Upto 25 records can be fetched in a single API call
Error Codes and Descriptions
| Status Codes | Description |
|---|---|
| 400 | Invalid parameter value/input parameter missing |
| 403 | Sorry! You are not authorized to do this operation |
| 404 | Not found |
| 422 | Maximum limit exceeded |
| 500 | Sorry! Server error occured |
View complete list of LMS API error codes
Threshold Limit: 30 requests | Lock period: 5 minutes
Threshold Limit - Number of API calls allowed within a minute.
Lock Period - Wait time before consecutive API requests.
Request
Copiedimport okhttp3.*;
public class Main {
public static void main(String[] args) throws Exception {
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://people.zoho.com/api/v1/courses/588882000000993105/modules?startIndex=0")
.get()
.addHeader("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN")
.build();
Response response = client.newCall(request).execute();
System.out.println(response.body().string());
}
}Copiedconst url = "https://people.zoho.com/api/v1/courses/588882000000993105/modules?startIndex=0";
fetch(url, {
method: "GET",
headers: {
"Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN"
}
})
.then(response => response.text())
.then(data => console.log(data))
.catch(error => console.error(error));Copiedcurl -X GET "https://people.zoho.com/api/v1/courses/588882000000993105/modules?startIndex=0" \
-H "Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN"Copiedurl = "https://people.zoho.com/api/v1/courses/588882000000993105/modules?startIndex=0";
headers = map();
headers.put("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN");
response = invokeurl
[
url : url
type : GET
headers: headers
];
info response;Copiedimport requests
url = "https://people.zoho.com/api/v1/courses/588882000000993105/modules?startIndex=0"
headers = {
"Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.text)Show full
Show less
Header
CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxfResponse
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": []
}
]
}Show full
Show less