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>}
Header:
Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf
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
Request
Copiedhttps://people.zoho.com/api/v1/courses/219225000000642002/modules?moduleData={"name" : "DummyModule API testing ", "duration" : 100, "description" : "Module API description testing", "lockType" : 1, "lockUntil" : "28-12-2021"}
Header
CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf
Response
Copied{
"code": 200,
"module": {
"duration": "100 Mins",
"lockUntil": "27-12-2021",
"isLocked": true,
"moduleName": "Module One",
"description": "Description for module",
"lockType": "1",
"moduleId": "219225000000648015"
},
"message": "success"
}