Create Modules API
This API is used to create modules in courses or batches in LMS
Request URL: (Self Paced Course)
https://people.zoho.com/api/v1/courses/<courseId>/modules?moduleData={"name" : <name>, "duration" :<duration>, "description" : <description>, "lockType" : <lockType>, "lockUntil" : <lockUntil>}
Request URL: (Blended Learning Course)
https://people.zoho.com/api/v1/courses/<courseId>/batches/<batchId>/modules?moduleData={"name" : <name>, "duration" :<duration>, "description" : <description>, "lockType" : <lockType>, "lockUntil" : <lockUntil>}
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 |
*moduleData | <parameters in JSON Object> | JSON Input |
Parameters | Values Allowed | Default Value | Description |
*name | <file name> | <Mandatory> | Specify the module name |
duration | <Duration in minutes> | - | Specify the duration |
description | <Description> | - | Specify the description |
lockType | <0|1|2> | 0 | 0 -> Unlock 1 -> Locked until date 2 -> Locked until previous module completed |
lockUntil | <lockUntil date in DD-MM-YYYY format> | - | Specify the lockUntil date |
*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.