Fetch Settings API
This API is used for fetching settings in LMS
Request URL:
https://people.zoho.com/api/v1/lmssettings
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/lmssettings")
.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/lmssettings";
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/lmssettings" \
-H "Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN"Copiedurl = "https://people.zoho.com/api/v1/lmssettings";
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/lmssettings"
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": {
"general": {
"allowCourseURLSharing": true,
"allowNotifications": true,
"allowedCourseTypes": {
"blendedlearning": true,
"selfpaced": true,
"ematerial": true
}
},
"grading": {
"allowGradingTypes": {
"NoGrading": false,
"LetterGrades": false,
"PassOrFail": false,
"TotalPoints": false
},
"grades": [
{
"name": "A+",
"range": "91-100",
"status": "pass"
},
{
"name": "A",
"range": "81-90",
"status": "pass"
},
{
"name": "B",
"range": "61-80",
"status": "pass"
},
{
"name": "C",
"range": "40-60",
"status": "pass"
},
{
"name": "Fail",
"range": "0-40",
"status": "pass"
}
],
"minimumPassPercentage": null
},
"featurePolicy": {
"whoCanStartDiscussion": [
"courseAdmin",
"learner"
],
"whoCanGiveFeedback": [
"learner"
],
"feedbackCanBeGivenFor": [
"trainer",
"course"
],
"whenCanBeGivenFeedback": 2,
"whoCanViewReports": [
"trainer",
"admin"
]
}
},
"code": "200",
"message": "success"
}Show full
Show less