Fetch Course Settings API
This API is used for fetching course settings in LMS
Request URL:
https://people.zoho.com/api/v1/courses/<courseId>/settings
Scope:
ZOHOPEOPLE.training.ALL
OR
ZOHOPEOPLE.training.READ
Possible Operation Types:
ALL - Complete access to data
READ - Only to read data
Method:
GET
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/478346000019582101/settings")
.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/478346000019582101/settings";
fetch(url, {
method: "GET",
headers: {
"Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN"
}
})
.then(response => response.json())
.then(result => console.log(result))
.catch(error => console.error("Error:", error));Copiedcurl -X GET "https://people.zoho.com/api/v1/courses/478346000019582101/settings" \
-H "Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN"Copiedurl = "https://people.zoho.com/api/v1/courses/478346000019582101/settings";
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/478346000019582101/settings"
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{
"settings": {
"postCourseActivities": {
"openTimeDelay": null,
"activities": [],
"openTimeDelayUnit": "day",
"courseId": "127540000001661259",
"gradeCategory": null,
"isMandatory": false,
"status": false,
"openTimeType": 0
},
"grading": {
"settings": {
"allowGradingTypes": {
"NoGrading": true,
"LetterGrades": true,
"PassOrFail": true,
"TotalPoints": true
},
"minimumPassPercentage": 60
},
"showGrades": 0,
"categories": [],
"type": 0
},
"permissions": {
"whenAModuleIsConsideredAsCompleted": "1",
"whoCanEnroll": [
"admin",
"courseAdmin",
"learner"
],
"whenAnEntityIsConsideredAsCompleted": "1",
"whenACourseIsConsideredAsCompleted": "1",
"whoCanUnenroll": [
"admin",
"courseAdmin",
"learner"
]
},
"courseSkills": {
"prerequisiteSkillName": "sample 1",
"acquireSkills": [
{
"acquireSkillName": "sample",
"acquireSkillLevel": 4,
"acquireSkillId": "127540000000931001"
}
],
"prerequisiteSkillLevel": 4,
"message": "success",
"prerequisiteSkillId": "127540000001696001"
},
"preCourseActivities": {
"activities": [],
"courseId": "127540000001661259",
"gradeCategory": null,
"isMandatory": false,
"status": false
}
},
"code": "200",
"message": "success"
}Show full
Show less