Skip to main content

Classroom Session

Classroom Session List​

Use this API to get a list of all classroom sessions for a trainee.

 GET /classroom-session/{userId}/trainee-detail

Path parameters​

FieldTypeDescription
userId
required
integerA single user ID

Query string parameters​

FieldTypeDescription
type
required
integer1 - upcoming, 2 - concluded, 3 - library, 4 - supervisor-enrollmentRequests, 5 - supervisor-nominate, 6 - nominated
firstRecord
required
integerFirst record to return. Default: 1
count
required
integerNumber of records to be returned from the first record Default: 20, Max count limit: 50
{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "classroomSessionList": [
                    {
                        "classroomSessionId": 52,
                        "title": "Time Management",
                        "description": "<p>Classroom session on Time Management</p>",
                        "code": "TM101",
                        "sessionName": "Session 1",
                        "facultyName": "Prabhakar Mistry",
                        "occurrenceType": "Once",
                        "enrollmentProcessKey": 4,
                        "enrollmentProcess": "Admin/Manager/Trainer Enrolls",
                        "timezone": "Asia/Calcutta",
                        "startDate": "2023-08-18",
                        "startTime": "04:30 PM",
                        "endTime": "05:30 PM",
                        "duration": 60,
                        "attendanceStatus": null,
                        "venue": {
                            "venueId": 2,
                            "title": "Hotel Lotus",
                            "description": "1st Floor, Headquarters, Mumbai"
                        },
                        "certificate": null
                    }
                ],
                "totalRecords": 1
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Enroll In Classroom Session​

Use this API to enroll a trainee into classroom session or send enrollment request.

 GET /classroom-session/{classroomSessionId}/request

Path parameters​

FieldTypeDescription
classroomSessionId
required
integerA classroom session ID

Query string parameters​

FieldTypeDescription
type
required
integer1 - enrollment request, 2 - enrollment
{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "message": "Enrollment request has been successfully sent"
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Classroom Session - Enrollment of Team Members​

Use this API to get list of your Team members, accept or reject enrollment request of Team members, nominate Team members, send enrollment request for nomination of Team members.

 POST /classroom-session/trainee-common-action

Query string parameters​

FieldTypeDescription
type
required
integer1 - requested list of user, 2 - approve/reject, 3 - team member for nominate, 4 - nominated members, 5 - send enrollment request for nomination
actionData
required
jsonArray
  1. 1. When type = 1 than actionData = {"classroomSessionId":8}
  2. 2. When type = 2 than actionData = {"classroomSessionId":53,"requestIds":[12],"action":"approve/reject"}, requestIds are enrollment request ids
  3. 3. When type = 3/4/5 actionData = {"classroomSessionId":8, "userIds":[5]}
{
    "classroomSessionId":53,
    "requestIds":[12],
    "action":"approve"
}
{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": [
                {
                    "requestId": 6,
                    "userName": "John Doe",
                    "email": "john.doe@example.com",
                    "status": "APPROVED"
                }
            ],
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}