Update Batch Scheduler API

This API is used to update batch scheduler in LMS.

Request URL:

https://people.zoho.com/api/v1/courses/<courseId>/batches/schedulers/<batchSchedulerId>?batchSchedulerData ={"batchName" : <batchName>, "batchNameSuffixSeparator" : <batchNameSuffixSeparator>, "batchNameSuffix" : <batchNameSuffix>, "startDate" : <startDate>, "endDate" : <endDate>, "locations" : <locations>, "minimumCapacity" : <minimumCapacity>, "maximumCapacity" : <maximumCapacity>, "frequency" : <frequency>, "frequencyUnit" : <frequencyUnit>, "offset" : <offset>, "offsetUnit" :<offsetUnit>, "daysOfTheWeek" : <daysOfTheWeek>, "datesOfTheMonth" : <datesOfTheMonth>, "weeksOfTheMonth" : <weeksOfTheMonth>, "monthsOfTheYear" : <monthsOfTheYear>, "allowWaitlisting" : <allowWaitlisting>, "cancelBatchWhenMinimumCapacityIsNotMet" : <cancelBatchWhenMinimumCapacityIsNotMet>,"waitingTimeForCancellation" : <waitingTimeForCancellation>,"waitingTimeUnitForCancellation" : <waitingTimeUnitForCancellation>, "cloneType" : <cloneType>, "sourceBatchId" : <sourceBatchId>, "notifyApplicableUsers" : <notifyApplicableUsers>, "publishBatchAutomatically" : <publishBatchAutomatically>, "notifyClonedMembers" : <notifyClonedMembers>}

Header:

Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Scope:

ZOHOPEOPLE.training.ALL
OR
ZOHOPEOPLE.training.UPDATE

Possible Operation Types:

ALL - Complete access to data
UPDATE - Only to edit data

Method:

PATCH

Request Parameters

Parameters	Values Allowed	Default Value	Description
*batchSchedulerData	<parameters in JSON Object>		JSON Input

Parameters	Values Allowed	Default Value	Description
batchName	<Batch name>	<Mandatory>	Specify the batch name
startDate	<startDate in DD-MM-YYYY format>	<Mandatory>	Specify the start date
endDate	<endDate in DD-MM-YYYY format>	<Mandatory>	Specify the end date
frequency	integer values	<Mandatory>	Specify the frequency
frequencyUnit	week\|month\|year	<Mandatory>	Specify the frequency unit
batchNameSuffixSeparator	_\|-	-	Specify the batch name suffix separator
batchNameSuffix	number\|dd/MM/yyyy\|dd/MM		Specify the batch name suffix
minimumCapacity	integer values	<Mandatory>	Specify the minimum capacity
maximumCapacity	integer values	<Mandatory>	Specify the maximum capacity
locations	Array of location ids	-	Specify the location ids
offset	-(1\|7\|14\|30)	-
offsetUnit	"day"	-
daysOfTheWeek	1-7	-	Specify the days of the week from 1- 7 which represents sunday to saturday
datesOfTheMonth	1-31	-	Specify the days of the month
weeksOfTheMonth	1-5		Specify the week of the month which represents the first to fifth week
monthsOfTheYear	1-12	-	Specify the month of the year which represents January to December
allowWaitlisting	true\|false	-	Specify if wait-listing should be allowed or not
cancelBatchWhenMinimumCapacityIsNotMet	true\|false	-	-
waitingtTimeForCancellation	integer values	-	Specify waiting time to cancel batch
waitingtTimeUnitForCancellation	day	-	Specify the value for waiting time unit for cancellation
cloneType	0\|1\|2		Specify the clone type
sourceBatchId	long	-	Specify the source batch id
notifyApplicableuUsers	true\|false	-	Specify the notify applicable users
publishBatchAutomatically	true\|false	-	Specify the publish batch automatically
notifyClonedMembers	true\|false	-	Specify the notify cloned members

*mandatory parameters

Request

Copiedhttps://people.zoho.com/api/v1/courses/219225000000645203/batches/schedulers/219225000000658013?batchSchedulerData={"batchName":"Batch Scheduler One_update","batchNameSuffixSeparator":"-","batchNameSuffix":"number","startDate":"28-12-2021","endDate":"28-02-2022","minimumCapacity":1,"maximumCapacity":100,"frequency":1,"frequencyUnit":"week","offset":-1,"offsetUnit":"day","daysOfTheWeek":[2,6],"allowWaitlisting":true,"cancelBatchWhenMinimumCapacityIsNotMet":true,"waitingTimeForCancellation":3,"waitingTimeUnitForCancellation":"day","cloneType":0,"notifyApplicableUsers":true,"publishBatchAutomatically":false,"notifyClonedMembers":false}

Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Response

Copied{
    "batchScheduler": {
        "batchName": "Batch Scheduler One_update",
        "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-12-2021",
        "offset": -1,
        "endDateAsDisplayString": "28-02-2022",
        "cancelBatchWhenMinimumCapacityIsNotMet": true,
        "waitingTimeForCancellation": 3,
        "allowWaitlisting": true,
        "daysOfTheWeek": [
            "2",
            "6"
        ],
        "totalNumberOfBatchesCreated": 0,
        "weeksOfTheMonth": [],
        "locations": []
    },
    "code": "200",
    "message": "success"
}