Create Session API

This API is used to create sessions in modules of a batch in LMS

Request URL: (Blended Learning Course)

https://people.zoho.com/api/v1/courses/<courseId>/batches/<batchId>/modules/<moduleId>/sessions?sessionData={"name" : <name> , "trainerErecno" : <trainerErecno>, "type" : <type> , "date" : <date>, "startTime" : <startTime>, "endTime" : <endTime>,"description" : <description>, "roomId": <roomId> , "lockUntil" : <lockUntil>, "gradeCategoryId" : <gradeCategoryId>}

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

ParametersValues AllowedDefault ValueDescription
*sessionData <parameters in JSON Object> JSON Input

 

ParametersValues AllowedDefault ValueDescription
*name<File name><Mandatory>Specify the file name
*trainerErecno<Trainer erecno><Mandatory>

Specify the trainer erecno

*type<0|1><Mandatory>Specify the session type 
0 -> Classroom
1-> E-learning
*datedate in DD_MM_YYYY format<Mandatory>Specify the session date
*startTimeTime in 12 Hour clock format<Mandatory>Specify the session start time
*endTimeTime in 12 Hour clock format<Mandatory>Specify the session end time
description<Description>-Specify the description
roomId<Room >-Specify the room id
resources

<lockUntil date in DD-MM-YYYY format>

-Specify the lockUntil date
gradeCategoryId<Grade category id>-Specify the Grade category id

*mandatory parameters

Request

Copiedhttps://people.zoho.com/api/v1/courses/219225000000645203/batches/219225000000645215/modules/219225000000645219/sessions?sessionData={"name":"Session API Testing", "trainerErecno" :219225000000036453 , "type" : "0", "date" : "31-12-2021", "startTime" : "10:00 AM", "endTime" : "11:00 AM","description" : "API testing", "roomId": 219225000000645249 , "lockUntil" : "29-12-2021", "gradeCategoryId" : ""}

Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Response

Copied{
    "code": 200,
    "session": {
        "totalLearnersCount": 0,
        "sessionName": "Session One",
        "sessionEndTime": "11:00 AM",
        "sessionStartTime": "10:00 AM",
        "description": "Description for Session",
        "resources": [],
        "sessionId": "219225000000648145",
        "roomId": "219225000000645249",
        "canUserDelete": false,
        "sessionStartDate": "30-12-2021",
        "lockUntil": "28-12-2021",
        "presentLeanersCount": 0,
        "gradeCategoryName": "",
        "isLocked": true,
        "gradeCategoryId": "",
        "sessionType": "Classroom",
        "sessionRoom": "Room One",
        "sessionTrainer": "Henry",
        "isSessionCompleted": false,
        "trainerErecno": "219225000000036453",
        "canUserEdit": false,
        "moduleId": "219225000000645219"
    },
    "message": "success"
}