Fetch Batch Scheduler API
This API is used to fetch a batch scheduler in LMS.
Request URL:
https://people.zoho.com/api/v1/courses/<courseId>/batches/schedulers/<batchSchedulerId>
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();
String url = "https://people.zoho.com/api/v1/courses/588882000001018001/batches/schedulers/588882000001019015";
Request request = new Request.Builder()
.url(url)
.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/588882000001018001/batches/schedulers/588882000001019015";
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/588882000001018001/batches/schedulers/588882000001019015" \
-H "Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN"Copiedurl = "https://people.zoho.com/api/v1/courses/588882000001018001/batches/schedulers/588882000001019015";
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/588882000001018001/batches/schedulers/588882000001019015"
headers = {
"Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN"
}
response = requests.request("GET", url, headers=headers)
print(response.text)Show full
Show less
Header
CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxfResponse
Copied{
"batchSchedulers": [
{
"batches": [],
"totalNumberOfBatchesCreated": 0,
"name": "Testing Scheduler_update",
"schedulerId": "219225000000658013",
"courseId": 219225000000645203
},
{
"batches": [],
"totalNumberOfBatchesCreated": 0,
"name": "Testing_Dummy Scheduler",
"schedulerId": "219225000000658027",
"courseId": 219225000000645203
},
{
"batches": [],
"totalNumberOfBatchesCreated": 0,
"name": "Dummy",
"schedulerId": "219225000000659001",
"locations": [],
"courseId": 219225000000645203
}
],
"code": "200",
"message": "success",
"hasMoreRecords": false
}Show full
Show less