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

Header:

Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

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

Request

Copiedhttps://people.zoho.com/api/v1/courses/219225000000645203/batches/schedulers/219225000000658013

Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Response

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"
}