Create Batch API
This API is used to create a new batch in LMS.
Request URL: (Blended Learning Course)
https://people.zoho.com/api/v1/courses/<courseId>/batches/<batchId>?batchData={"name" : <batchName>, "startDate" : <startDate>, "endDate" : <endDate>, "locations" : <locations>, "minimumCapacity" : <minimumCapacity>, "maximumCapacity":<maximumCapacity>, "allowWaitlisting" : <allowWaitlisting>, "cancelBatchWhenMinimumCapacityIsNotMet" : <cancelBatchWhenMinimumCapacityIsNotMet>, "waitingTimeForCancellation" : <waitingTimeForCancellation>, "waitingTimeUnitForCancellation" : <waitingTimeUnitForCancellation>}
Scope:
ZOHOPEOPLE.training.ALL
OR
ZOHOPEOPLE.training.CREATE
Possible Operation Types:
ALL - Complete access to data
CREATE - Only to create data
Method:
POST
Request Parameters
Parameters | Values Allowed | Default Value | Description |
*batchData | <parameters in JSON Object> | JSON Input |
Parameters | Values Allowed | Default Value | Description |
*name | <Batch name> | <Mandatory> | Specify the batch name |
*startDate | <startDate date in DD-MM-YYYY format> | <Mandatory> | Specify the start date |
*endDate | <endDate date in DD-MM-YYYY format> | <Mandatory> | Specify the end date |
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 |
allowWaitlisting | true|false | - | Specify if wait-listing should be allowed or not |
cancelBatchWhenMinimumCapacityIsNotMet | true|false | - | - |
waitingTimeForCancellation | integer values | - | Specify waiting time to cancel batch |
waitingTimeUnitForCancellation | "day" | - |
*mandatory parameters
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.