Webinars/Meetings

Webinars/Meetings List

Use this API to get the list of ongoing, concluded or open webinars/meetings.

 GET /webinar-meeting/{userId}/trainee-webinar-meeting-list

Path parameters

Field	Type	Description
userId required	integer	User ID

Query string parameters

Field	Type	Description
firstRecord required	integer	First record to return. Default: 1
count required	integer	Number of records to be returned starting from the first record. Default: 20, Max count limit: 50
type required	interger	1 - upcoming/ongoing 2 - concluded 3 - open
q	string	filter data by title

Response

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "count": {
                    "upcomingOngoingCount": 0,
                    "concludedCount": 182,
                    "availableCount": 1
                },
                "webinarMeetingList": [
                    {
                        "webinarMeetingId": 5052,
                        "webinarMeetingType": 3,
                        "recordingEnabled": false,
                        "title": "Patient-Centered Care 23/2/2023 (050)",
                        "startDateTime": "2023-08-31 15:15:00",
                        "durationInMin": 1,
                        "webinarconfigId": "20",
                        "occurrenceId": "1693475100000",
                        "webinarORmeetingId": "83941286706",
                        "timezone": "Asia/Kolkata",
                        "relatedCourseId": 7719,
                        "description": "Webinar on managing Patient-Centered Care",
                        "showRecording": false,
                        "enrollmentId": 0,
                        "registrant_id": null,
                        "joinUrl": null,
                        "canJoinNow": false,
                        "isAvailable": true,
                        "badgeTitle": "Available",
                        "badgeClass": "success"
                    }
                ],
                "totalRecords": 1
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Field	Type	Description
count	object	Count of different types of webinar meetings.
upcomingOngoingCount	number	Count of upcoming or ongoing webinar meetings.
concludedCount	number	Count of concluded webinar meetings.
availableCount	number	Count of available webinar meetings.
webinarMeetingList	array	Array of webinar meeting objects.
webinarMeetingId	number	ID of the webinar meeting.
webinarMeetingType	number	Type of the webinar meeting.
recordingEnabled	boolean	Indicates if recording is enabled for the meeting.
title	string	Title of the webinar meeting.
startDateTime	string	Start date and time of the meeting.
durationInMin	number	Duration of the meeting in minutes.
webinarconfigId	string	Configuration ID of the webinar.
occurrenceId	string	Occurrence ID of the webinar.
webinarORmeetingId	string	ID of the webinar or meeting.
timezone	string	Timezone of the meeting.
relatedCourseId	number	ID of the related course.
description	string	Description of the webinar meeting.
showRecording	boolean	Indicates if recording is shown for the meeting.
enrollmentId	number	ID of the enrollment.
registrant_id	null	ID of the registrant.
joinUrl	null	URL to join the meeting.
canJoinNow	boolean	Indicates if the user can join the meeting now.
isAvailable	boolean	Indicates if the meeting is available.
badgeTitle	string	Title for the availability badge.
badgeClass	string	CSS class for the availability badge.
totalRecords	number	Total number of records in the response.

Error Codes

Code	Description
1003	"Missing type"
1004	"Invalid type"
1005	"Invalid firstRecord"
1006	"Invalid count"

For general error details, click here.

Enroll to Open Webinar/Meeting

Use this API to enroll a Trainee to an open webinar/meeting.

 GET /webinar-meeting/{userId}/enroll-open-webinar

Path parameters

Field	Type	Description
userId required	integer	User ID

Query string parameters

Field	Type	Description
webinarMeetingId required	integer	webinar/meeting ID
webinarMeetingType required	integer	1 - Zoom Webinar 2 - GoToWebinar 3 - Zoom Meeting 4 - MS Teams 5 - Google Meet

Response

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": true,
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Field	Type	Description
data	boolean	It returns true when successfully enrolled

Error Codes

Code	Description
1007	"Missing webinarMeetingId"
1008	"Invalid webinarMeetingId"
1009	"Missing webinarMeetingType"
1010	"Invalid webinarMeetingType"

For general error details, click here.

Webinar/Meeting Recordings

Use this API to get recordings for a webinar or meeting.

 GET /webinar-meeting/{userId}/enroll-open-webinar

Path parameters

Field	Type	Description
userId required	integer	The user ID

Query string parameters

Field	Type	Description
webinarMeetingId required	integer	The webinar/meeting ID
webinarMeetingType required	integer	1 - Zoom Webinar 2 - GoToWebinar 3 - Zoom Meeting

Response

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "message": "There is no recording for this meeting",
                "recordings": [
                    {
                        "title": "Patient-Centered Care 23/2/2023 (050)",
                        "thumbnail": "https://example.com/thumbnail.jpg",
                        "duration": 60,
                        "file_size": 10,
                        "play_url": "https://example.com/video.mp4"
                    }
                ]
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Field	Type	Description
recordings	array	List of recording details, if available.
title	string	Title of the webinar recording.
thumbnail	string	Thumbnail image URL for the recording.
duration	number	Duration of the recording in minutes.
file_size	number	Size of the recording file in bytes.
play_url	string	URL to play the recording video.

Error Codes

Code	Description
1007	"Missing webinarMeetingId"
1008	"Invalid webinarMeetingId"
1009	"Missing webinarMeetingType"
1010	"Invalid webinarMeetingType"

For general error details, click here.