Fetch Batch Scheduler List API
This API is used to fetch batch schedulers list in LMS.
Request URL:
https://people.zoho.com/api/v1/courses/<courseId>/batches/schedulers
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> | 0 | Specify from which record the response should be fetched |
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?startIndex=0";
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?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/588882000001018001/batches/schedulers?startIndex=0" \
-H "Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN"Copiedurl = "https://people.zoho.com/api/v1/courses/588882000001018001/batches/schedulers?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/588882000001018001/batches/schedulers?startIndex=0"
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{
"batchScheduler": {
"batchName": "Batch Scheduler One",
"frequencyUnit": "week",
"cloneType": 0,
"schedulerId": "219225000000658013",
"publishBatchAutomatically": false,
"batchNameSuffixSeparator": 0,
"waitingTimeUnitForCancellation": "day",
"sourceBatch": null,
"frequency": 1,
"offsetUnit": "day",
"minimumCapacity": 1,
"maximumCapacity": 100,
"notifyClonedMembers": false,
"notifyApplicaleUsers": false,
"courseId": "219225000000645203",
"monthsOfTheYear": [],
"batchNameSuffix": "number",
"daysOfTheMonth": [],
"startDateAsDisplayString": "28-Dec-2021",
"offset": -1,
"endDateAsDisplayString": "28-Feb-2022",
"cancelBatchWhenMinimumCapacityIsNotMet": true,
"waitingTimeForCancellation": 3,
"allowWaitlisting": true,
"daysOfTheWeek": [
"2",
"6"
],
"totalNumberOfBatchesCreated": 0,
"weeksOfTheMonth": [],
"locations": []
},
"code": "200",
"message": "success"
}Show full
Show less