User

Timezone List

Use this API to get the list of all timezones.

 GET /user/timezone-list

Response

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "America/Adak": "(GMT-10:00) America/Adak (Hawaii-Aleutian Standard Time)",
                "America/Atka": "(GMT-10:00) America/Atka (Hawaii-Aleutian Standard Time)",
                "America/Anchorage": "(GMT-9:00) America/Anchorage (Alaska Standard Time)"
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Field	Type	Description
data	JSON Array	Timezone object

Error Codes

For general error details, click here.

Language List

Use this API to list all availale languages.

 GET /user/language-list

Response

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": [
                {
                    "langId": "en-US",
                    "name": "English (US)",
                    "localizationFileUrl": null
                },
                {
                    "langId": "hi-IN",
                    "name": "हिन्दी",
                    "localizationFileUrl": "https://lms.example.com/language/hi-IN.json"
                }
            ],
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Field	Type	Description
data	JSON Array	Language object

Error Codes

For general error details, click here.

User List

Use this API to list all Users. This end point is only accessible by Admin or Manager role.

 GET /user/user-list

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
q	string	Filter data by firstName, lastName, email.

Response

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "userList": [
                    {
                        "userId": 2,
                        "firstName": "Rajesh",
                        "lastName": "Kumar",
                        "email": "rajesh.kumar@example.com",
                        "countryCode": "+91",
                        "mobile": "9876543210",
                        "uniqueId": "100001",
                        "role": "Admin"
                    }
                ],
                "totalRecords": 1
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Field	Type	Description
userId	number	ID of the user.
firstName	string	First name of the user.
lastName	string	Last name of the user.
email	string	Email of the user.
countryCode	string	Country code for the user's mobile number.
mobile	string	Mobile number of the user.
uniqueId	string	Unique identifier of the user.
role	string	Role of the user (Admin, Trainee, etc.).
totalRecords	number	Total number of users.

Error Codes

Code	Description
1003	"Invalid firstRecord"
1004	"Invalid count"

For general error details, click here.

User Details

Use this API to get details of an individual user.

 GET /user/{userId}/detail

Response

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "userDetail": {
                    "firstName": "John",
                    "lastName": "Doe",
                    "email": "john.doe@example.com",
                    "countryCode": "+91",
                    "mobile": "9876543210",
                    "timezone": "Asia/Kolkata",
                    "department": "Marketing",
                    "designation": "Manager",
                    "branch": null,
                    "companyName": "",
                    "workPhone": "",
                    "address": "",
                    "country": "India",
                    "state": "Maharashtra",
                    "city": "Mumbai",
                    "zip": "",
                    "zone": null,
                    "lang": "en-US",
                    "role": "Trainee"
                }
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Field	Type	Description
firstName	string	First name of the user.
lastName	string	Last name of the user.
email	string	Email of the user.
countryCode	string	Country code for the user's mobile number.
mobile	string	Mobile number of the user.
timezone	string	Timezone of the user.
department	string	Department of the user.
designation	string	Designation of the user.
branch	string	Branch information of the user.
companyName	string	Company name of the user.
workPhone	string	Work phone number of the user.
address	string	Address of the user.
country	string	Country of the user.
state	string	State of the user.
city	string	City of the user.
zip	string	Zip code of the user.
zone	string	Zone information of the user.
lang	string	Language of the user.
role	string	Role of the user.

Error Codes

For general error details, click here.

User Custom Fields

Use this API to get details of a user custom feilds.

 GET /user/{userId}/custom-fields

Path parameters

Field	Type	Description
userId required	integer	A single user ID

Response

 {
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "showCustomField": true,
                "customFieldList": [
                    {
                        "fieldId": 26,
                        "label": "Alternate No",
                        "fieldType": {
                            "type": "Textbox",
                            "option": null
                        },
                        "userValue": "9869*****3",
                        "required": true,
                        "unique": false,
                        "hide": false,
                        "readOnly": false
                    },
                    {
                        "fieldId": 27,
                        "label": "Hobby",
                        "fieldType": {
                            "type": "Dropdown",
                            "option": {
                                "1": "Cricket",
                                "2": "Reading",
                                "3": "Internet Surfing"
                            }
                        },
                        "userValue": "2",
                        "required": true,
                        "unique": false,
                        "hide": false,
                        "readOnly": false
                    }
                ]
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Error Codes

For general error details, click here.

User Create

Use this API to create a user in the LMS. This end point is only accessible by Admin or Manager role.

 POST /user/create

Request body parameters

Field	Type	Description
title	string	Title. e.g.: Mr, Mrs, Ms, Dr, Prof
firstName required	string	First Name
lastName required	string	Last Name
email required	string	Email Address
countryCode	string	Country code e.g.: +91
mobile	string	Mobile Number e.g.: 9876543210
userCanChoosePassword required	integer	0-No, 1-Yes
password	string	If userCanChoosePassword = 0 than set password.
uniqueId	string	EmployeeID OR Roll no
roleId required	integer	3-Trainee, 4-Trainer, 6-Manager, 9-Reporting
reportingTo	integer	ID of the reporting person
companyName	string	Company Name
department	integer	Department ID
designation	integer	Designation ID
branch	integer	Branch ID
zipcode	string	Pincode
city	integer	City ID
state	integer	State ID
country	integer	Country ID
timezone	string	e.g.: Asia/Kolkata
language	string	e.g.: en-US
sendEmailNotification required	integer	0–No, 1–Yes

Response

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

Schema

Field	Type	Description
userId	integer	user ID

Error Codes

Code	Description
1007	"Missing firstName"
1008	"Invalid firstName"
1009	"Missing lastName"
1010	"Invalid lastName"
1015	"Invalid mobile"
1016	"Missing city/state/country"
1017	"Invalid city/state/country"
1018	"Missing password"
1019	"Password does not meet the requirements! It must be alphanumeric and atleast 8 characters long"
1020	"Missing email"
1021	"Invalid email"
1022	"Missing mobile"
1023	"Email address provided already exist. Please provide another email address"
1024	"Invalid title. It should be Mr, Mrs, Ms, Dr, Prof"
1028	"Missing sendEmailNotification"
1029	"Invalid sendEmailNotification"
1036	"Missing countryCode"
1037	"Invalid countryCode"
1038	"Missing timezone"
1039	"Invalid timezone"
1040	"Missing language"
1041	"Invalid language"
1044	"Missing userCanChoosePassword"
1045	"Invalid userCanChoosePassword"
1046	"Missing uniqueId"
1047	"Invalid uniqueId"
1048	"Missing roleId"
1049	"Invalid roleId"
1052	"Missing reportingTo"
1053	"Invalid reportingTo"
1054	"Missing companyName"
1055	"Invalid companyName"
1055	"Missing zipCode"
1056	"Invalid zipCode"
1079	"Missing branch"
1080	"Invalid branch"

For general error details, click here.

User Update

Use this API to update details of a user.

 PUT /user/{userId}/update

Path parameters

Field	Type	Description
userId required	integer	A single user ID

Query string parameters

Field	Type	Description
firstName	string	First Name
lastName	string	Last Name
companyName	string	CompanyName
department	integer	Department ID
designation	integer	Designation ID
branch	integer	Branch ID
mobile	string	Contact Number
city	integer	City ID
state	integer	State ID
country	integer	Country ID
customFieldID_{fieldId}	string	You can get the fieldId using the User Custom Fields endpoint: /user/{userId}/custom-fields e.g.: if 26 is the fieldId then enter customFieldID_26
timezone	string	Timezone
language	string	Language eg: en-US
status	integer	1 – Enable, 0 – Disable, 2 – Delete

Response

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

Schema

Error Codes

Code	Description
1001	"Missing userId"
1002	"Invalid userId"
1008	"Invalid firstName"
1010	"Invalid lastName"
1012	"Invalid department"
1014	"Invalid designation"
1015	"Invalid mobile"
1016	"Missing city/state/country"
1017	"Invalid city/state/country"
1022	"Missing mobile"
1038	"Missing timezone"
1039	"Invalid timezone"
1040	"Missing language"
1041	"Invalid language"
1042	"Missing status"
1043	"Invalid status"
1079	"Missing branch"
1080	"Invalid branch"

For general error details, click here.

Frontend Signup

Use this API to register a new Trainee from a frontend website. Note: Trainee will only get registered after they have verified their email. This end point is only accessible by Admin or Manager role.

 POST /user/signup

Request body parameters

Field	Type	Description
title	string	Title. It should be Mr, Mrs, Ms, Dr, Prof
firstName required	string	First Name
lastName required	string	Last Name
email required	string	Email Address
countryCode required	string	Country code e.g.: +91
mobile required	string	Mobile Number e.g.: 9876543210
ipAddress required	string	IP Address
sendEmailNotification required	integer	1 – Yes (Send email to Trainee), 0 – No (Do not send email to Trainee)
overrideEmailUrl	string	Use this to redirect to your frontend domain for email verification. {token} is required e.g.: https://www.example.com/verify-token/{token}
receiveVerificationEmailOn	string	e.g.: manager@example.com (Post verification by Trainee, get CC of the confirmation email sent to Trainee)
password	string	Password
timezone	string	Timezone of the user.
city	integer	City ID
state	integer	State ID
country	integer	Country ID

Response

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

Schema

Field	Type	Description
userId	string	Token

Error Codes

Code	Description
1007	"Missing firstName"
1008	"Invalid firstName"
1009	"Missing lastName"
1010	"Invalid lastName"
1015	"Invalid mobile"
1016	"Missing city/state/country"
1017	"Invalid city/state/country"
1020	"Missing email"
1021	"Invalid email"
1022	"Missing mobile"
1023	"Email address provided already exist. Please provide another email address"
1024	"Invalid title. It should be Mr, Mrs, Ms, Dr, Prof"
1025	"Missing ipAddress"
1026	"Invalid ipAddress"
1039	"Invalid timezone"
1028	"Missing sendEmailNotification"
1029	"Invalid sendEmailNotification"
1030	"Signup email template was not found"
1034	"Missing receiveVerificationEmailOn"
1035	"Invalid receiveVerificationEmailOn"
1036	"Missing countryCode"
1037	"Invalid countryCode"

For general error details, click here.

Frontend Signup Verification

Use this API to verify Trainee registeration done via frontend website.

 POST /user/signup-verify

Request body parameters

Field	Type	Description
token required	string	Token
password required	string	Password

Response

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

Schema

Field	Type	Description
userId	integer	user ID

Error Codes

Code	Description
1018	"Missing password"
1019	"Password does not meet the requirements! It must be alphanumeric and atleast 8 characters long"
1030	"Signup email template was not found"
1031	"Missing token"
1032	"Invalid token"
1033	"Token expired. Please singup again and use the new token"

For general error details, click here.

Trainee Calender Events

Use this API to get the list of calender events of a Trainee.

 GET /user/{userId}/trainee-calendar

Path parameters

Field	Type	Description
userId required	integer	User ID

Query string parameters

Field	Type	Description
fromDate required	string	From Date
toDate required	string	To Date

Response

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": [
                {
                    "id": 1,
                    "type": "Course",
                    "title": "Social Entrepreneurship - SE1",
                    "backgroundColor": "#0168FA",
                    "start": "2022-06-15 00:00:00",
                    "end": "2023-07-10 23:59:59"
                },
                {
                    "id": 2,
                    "type": "Course",
                    "title": "Wonderchef Product Training - WT001",
                    "backgroundColor": "#0168FA",
                    "start": "2018-06-01 00:00:00",
                    "end": "2023-12-31 23:59:59"
                }
            ],
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Field	Type	Description
id	Number	The unique identifier of the event
type	String	The type of the event (e.g., Course)
title	String	The title of the event
backgroundColor	String	The background color of the event
start	Date/Time	The start date and time of the event
end	Date/Time	The end date and time of the event

Error Codes

Code	Description
1066	"Missing from date"
1067	"Invalid from date"
1068	"Missing to date"
1069	"Invalid to date"

For general error details, click here.

Team Member Details

Use this API to get enrollment details of a team member.

 GET /user/{userId}/team-member

Path parameters

Field	Type	Description
userId required	integer	To get team member list, pass the logged in Trainee's userId. If you want to get details of a team member, pass team member's userId

Query string parameters

Field	Type	Description
type	integer	1 - to get all details of a individual team member

Response

Team Member List
{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "learningPath": null,
                "concludedLearningObject": null,
                "learningObject": null,
                "courseConcluded": null,
                "course": null,
                "member": {
                    "totalRecords": 1,
                    "list": [
                        {
                            "userId": 12,
                            "firstName": "John",
                            "lastName": "Doe",
                            "email": "john.doe@example.com",
                            "countryCode": "+91",
                            "mobile": "987654321",
                            "uniqueId": "10106",
                            "role": "Trainee"
                        }
                    ]
                }
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Details of a individual team member

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "learningPath": {
                    "totalRecords": 4,
                    "list": {
                        "learningPath": [
                            {
                                "title": "Mobile app - MALP2",
                                "data": [
                                    {
                                        "enrollmentId": 21573,
                                        "courseId": 1413,
                                        "title": "Mobile App Course",
                                        "courseCode": "MAC6",
                                        "description": "<p>This is a course about Mobile App Development</p>",
                                        "trainerId": 2,
                                        "trainer": "Rajesh Kumar",
                                        "startDate": "2023-06-12",
                                        "endDate": "2023-06-17",
                                        "progress": "100",
                                        "status": "Completed",
                                        "isForumEnabled": true,
                                        "courseType": "SINGLE_SUBJECT",
                                        "thumbnail": "https://lms.example.com/thumbnails/xxxxx.png",
                                        "checkRequestEligibility": true,
                                        "isEligibleForExtention": false
                                    }
                                ]
                            }
                        ]
                    }
                },
                "concludedLearningObject": {
                    "totalRecords": 27,
                    "list": [
                        {
                            "enrollmentId": 20270,
                            "learningObjectId": 1348,
                            "title": "HRM",
                            "learningObjectCode": "LO2803",
                            "description": "LO2803",
                            "startDate": "2023-05-17",
                            "endDate": "2023-05-18",
                            "firstTimeViewedDate": "2023-05-17 07:56:45",
                            "status": "Expired",
                            "objectType": {
                                "label": "PDF",
                                "documentTypeId": 2
                            },
                            "thumbnail": "https://lms.example.com/thumbnails/xxxxx.png"
                        }
                    ]
                },
                "learningObject": null,
                "courseConcluded": {
                    "totalRecords": 43,
                    "list": [
                        {
                            "enrollmentId": 21783,
                            "courseId": 1422,
                            "title": "Marketing Learning Path",
                            "courseCode": "210723",
                            "trainerId": 2,
                            "trainer": "Rajesh Kumar",
                            "startDate": "2023-08-04",
                            "endDate": "2023-08-19",
                            "progress": "100",
                            "status": "Completed",
                            "courseType": "SINGLE_SUBJECT",
                            "thumbnail": "https://lms.example.com/thumbnails/xxxxx.png",
                            "checkRequestEligibility": true
                        }
                    ]
                },
                "course": {
                    "totalRecords": 40,
                    "list": [
                        {
                            "enrollmentId": 22084,
                            "courseId": 1490,
                            "title": "Principles of an Effective ",
                            "courseCode": "10118",
                            "trainerId": 2,
                            "trainer": "Rajesh Kumar",
                            "startDate": "2023-08-11",
                            "endDate": "2023-08-26",
                            "progress": "0",
                            "status": "Ongoing",
                            "courseType": "SINGLE_SUBJECT",
                            "thumbnail": "https://lms.example.com/thumbnails/xxxxx.png"
                        }
                    ]
                },
                "member": {
                    "totalRecords": 1,
                    "list": [
                        {
                            "userId": 12,
                            "firstName": "John",
                            "lastName": "Doe",
                            "email": "john.doe@example.com",
                            "countryCode": "+91",
                            "mobile": "987654321",
                            "uniqueId": "10106",
                            "role": "Trainee"
                        }
                    ]
                }
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Team Member List

Field	Type	Description
learningPath	Null	Null value for learning path data.
concludedLearningObject	Null	Null value for concluded learning object data.
learningObject	Null	Null value for learning object data.
courseConcluded	Null	Null value for concluded course data.
course	Null	Null value for course data.
member	Object	Contains data about a member.
totalRecords	Number	Total number of members.
list	Array	Array of member objects.
userId	Number	ID of the user/member.
firstName	String	First name of the user/member.
lastName	String	Last name of the user/member.
email	String	Email of the user/member.
countryCode	String	Country code of the user/member.
mobile	String	Mobile number of the user/member.
uniqueId	String	Unique ID of the user/member.
role	String	Role of the user/member.

Details of a individual team member

Field	Type	Description
learningPath	Object	Represents the learning path data.
totalRecords	Number	Total number of records in the learning path.
list	Object	Contains the list of learning paths.
learningPath	Array	Array of learning path objects.
title	String	Title of the learning path.
data	Array	Array of data objects within the learning path.
enrollmentId	Number	ID of the enrollment.
courseId	Number	ID of the course.
title	String	Title of the course.
courseCode	String	Code of the course.
description	String	Description of the course.
trainerId	Number	ID of the trainer.
trainer	String	Name of the trainer.
startDate	String	Start date of the course.
endDate	String	End date of the course.
progress	String	Progress of the course.
status	String	Status of the course.
isForumEnabled	Boolean	Indicates if the forum is enabled for the course.
courseType	String	Type of the course.
thumbnail	String	URL of the course thumbnail.
checkRequestEligibility	Boolean	Indicates eligibility to check requests.
isEligibleForExtention	Boolean	Indicates eligibility for extension.
concludedLearningObject	Object	Contains data about concluded learning objects.
totalRecords	Number	Total number of concluded learning objects.
list	Array	Array of concluded learning object objects.
enrollmentId	Number	ID of the enrollment.
learningObjectId	Number	ID of the learning object.
title	String	Title of the learning object.
learningObjectCode	String	Code of the learning object.
description	String	Description of the learning object.
startDate	String	Start date of the learning object.
endDate	String	End date of the learning object.
firstTimeViewedDate	String	Date of first viewing the learning object.
status	String	Status of the learning object.
objectType	Object	Type of the learning object.
label	String	Label of the object type.
documentTypeId	Number	ID of the document type.
thumbnail	String	URL of the learning object thumbnail.
courseConcluded	Object	Contains data about concluded courses.
totalRecords	Number	Total number of concluded courses.
list	Array	Array of concluded course objects.
enrollmentId	Number	ID of the enrollment.
courseId	Number	ID of the course.
title	String	Title of the course.
courseCode	String	Code of the course.
trainerId	Number	ID of the trainer.
trainer	String	Name of the trainer.
startDate	String	Start date of the course.
endDate	String	End date of the course.
progress	String	Progress of the course.
status	String	Status of the course.
courseType	String	Type of the course.
thumbnail	String	URL of the course thumbnail.
checkRequestEligibility	Boolean	Indicates eligibility to check requests.
member	Object	Contains data about a member.
totalRecords	Number	Total number of members.
list	Array	Array of member objects.
userId	Number	ID of the user/member.
firstName	String	First name of the user/member.
lastName	String	Last name of the user/member.
email	String	Email of the user/member.
countryCode	String	Country code of the user/member.
mobile	String	Mobile number of the user/member.
uniqueId	String	Unique ID of the user/member.
role	String	Role of the user/member.

Error Codes

Code	Description
1064	"Missing type"
1065	"Invalid type"

For general error details, click here.

Trainee Dashboard Details

Use this API to get dashoboard details of a trainee.

 GET /user/{userId}/trainee-dashboard

Path parameters

Field	Type	Description
userId required	integer	User ID

Response

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "webSocket": {
                    "url": "https://lms.example.com",
                    "userId": "xxxxxxxx"
                },
                "showRecommendedCourseOnTop": false,
                "forceToUpdateProfile": false,
                "termsconditions": null,
                "banner": [
                    {
                        "title": "The only way to do great work, is to love what you do",
                        "url": "https://lms.example.com/xxxxxx/banner1.jpg",
                        "link": "https://lms.example.com"
                    },
                ],
                "courseStatistics": [
                    {
                        "name": "Ongoing",
                        "percentage": 18.82
                    },
                    {
                        "name": "Expired",
                        "percentage": 22.35
                    },
                    {
                        "name": "Completed",
                        "percentage": 50.59
                    }
                ],
                "customizeData": {
                    "courses": {
                        "label": "Courses",
                        "count": 42,
                        "avgProgress": 38,
                        "linkTo": "ongoingCourse"
                    },
                    "courseStarted": {
                        "label": "Started",
                        "count": 19,
                        "linkTo": "ongoingCourse"
                    },
                    "learningPath": {
                        "label": "Learning Path",
                        "count": 2,
                        "linkTo": "learningPath"
                    },
                    "learningObject": {
                        "label": "Learning Objects",
                        "count": null,
                        "linkTo": "learningObject"
                    },
                    "courseLibrary": {
                        "label": "Course Library",
                        "count": 18,
                        "linkTo": "courseLibrary"
                    },
                    "upcomingWebinarMeeting": {
                        "label": "Webinars or Meetings",
                        "count": 6,
                        "linkTo": "upcomingWebinar"
                    },
                    "upcomingClassroom": {
                        "label": "Classroom Sessions",
                        "count": 0,
                        "linkTo": "upcomingClassroomSession"
                    },
                    "courseAchived": {
                        "label": "Achievements",
                        "count": 50,
                        "linkTo": "concludedCourse"
                    },
                    "leaderBoard": {
                        "label": "Leaderboard",
                        "rank": 1,
                        "points": 8484,
                        "linkTo": "leaderboard"
                    },
                    "announcement": {
                        "label": "Announcements",
                        "count": 17,
                        "linkTo": "announcement"
                    },
                    "notification": {
                        "label": "Notification",
                        "count": 92,
                        "linkTo": "notification"
                    },
                    "lastLogin": {
                        "label": "Last Login",
                        "dateTime": "16-Aug-2023 12:51PM",
                        "linkTo": null
                    },
                    "queries": {
                        "label": "Queries",
                        "count": 0,
                        "linkTo": "query"
                    },
                    "teamMember": {
                        "label": "My Team",
                        "count": 1,
                        "linkTo": "teamMember"
                    }
                },
                "rating": null,
                "upcomingExam": {
                    "examScheduleId": 5125,
                    "examTitle": "Principles of an Effective ",
                    "examDuration": 120,
                    "fromDate": "2023-08-11",
                    "toDate": "2023-08-26",
                    "totalQuestion": 10,
                    "totalMarks": 10,
                    "passingMarks": 5,
                    "note": null
                },
                "accountCustomizeData": {
                    "logoUrl": "https://lms.example.com/logo.png",
                    "breadcrumbBgColor": "#1c4587",
                    "breadcrumbFontColor": "#ffffff",
                    "menubarFontColor": "#000000"
                }
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Field	Type	Description
webSocket	Object	Contains data about the WebSocket.
url	String	URL of the WebSocket.
userId	String	User ID for the WebSocket.
showRecommendedCourseOnTop	Boolean	Indicates whether to show recommended courses on top.
forceToUpdateProfile	Boolean	Indicates whether to force updating the profile.
termsconditions	Null	Null value for terms and conditions.
banner	Array	Array of banner objects.
title	String	Title of the banner.
url	String	URL of the banner image.
link	String	Link associated with the banner.
courseStatistics	Array	Array of course statistics objects.
name	String	Name of the course status.
percentage	Number	Percentage value of the course status.
customizeData	Object	Contains custom data.
courses	Object	Contains data about courses.
label	String	Label for courses.
count	Number	Total count of courses.
avgProgress	Number	Average progress of courses.
linkTo	String	Link to navigate to.
courseStarted	Object	Contains data about started courses.
learningPath	Object	Contains data about learning paths.
learningObject	Object	Contains data about learning objects.
courseLibrary	Object	Contains data about course library.
upcomingWebinarMeeting	Object	Contains data about upcoming webinars or meetings.
upcomingClassroom	Object	Contains data about upcoming classroom sessions.
courseAchived	Object	Contains data about achieved courses.
leaderBoard	Object	Contains data about the leaderboard.
announcement	Object	Contains data about announcements.
notification	Object	Contains data about notifications.
lastLogin	Object	Contains data about the last login.
dateTime	String	Date and time of the last login.
queries	Object	Contains data about queries.
teamMember	Object	Contains data about team members.
rating	Null	Null value for rating.
upcomingExam	Object	Contains data about upcoming exams.
examScheduleId	Number	ID of the exam schedule.
examTitle	String	Title of the upcoming exam.
examDuration	Number	Duration of the upcoming exam (in minutes).
fromDate	String	Start date of the upcoming exam.
toDate	String	End date of the upcoming exam.
totalQuestion	Number	Total number of questions in the upcoming exam.
totalMarks	Number	Total marks of the upcoming exam.
passingMarks	Number	Passing marks for the upcoming exam.
note	Null	Null value for exam note.
accountCustomizeData	Object	Contains data for customizing account appearance.
logoUrl	String	URL of the logo image.
breadcrumbBgColor	String	Background color of breadcrumbs.
breadcrumbFontColor	String	Font color of breadcrumbs.
menubarFontColor	String	Font color of the menubar.

Error Codes

Code	Description
1072	"Missing userId"
1073	"Invalid userId"

For general error details, click here.

Trainee Commom Action

Use this API to submit rating, disable exam notification, submit terms and conditions.

 POST /user/{userId}/trainee-common-action

Path parameters

Field	Type	Description
userId required	integer	User ID

Request body parameters

Field	Type	Description
type required	integer	1 - course rating, 2 - exam don't remind, 3 - accept terms and conditons
actionData required	JSON Array	EnrollmentData: 1. If type = 1 than actionData = {"enrollmentId": 21411, "rating": 3} 2. If type = 1 than actionData = {"examScheduleId": 21411} 3. If type = 3 than actionData = {"accept": 1}

Response

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

Schema

Field	Type	Description
data	boolean	True OR False

Error Codes

Code	Description
1064	"Missing type"
1065	"Invalid type"
1070	"Missing actionData"
1071	"Invalid actionData"

For general error details, click here.

Trainee Menu Details

Use this API to get list of menu items visible to Trainee

 GET /user/trainee-menu

Query string parameters

Field	Type	Description
type	string	e.g Query, Gamificaion

Response

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "Dashboard": {
                    "label": "Dashboard",
                    "visible": true
                },
                "Courses": {
                    "label": "Courses",
                    "visible": true
                },
                "LearningObject": {
                    "label": "Learning Objects",
                    "visible": true
                },
                "ClassroomSessions": {
                    "label": "Classroom Sessions",
                    "visible": true
                },
                "WebinarOrMeeting": {
                    "label": "Webinars or Meetings",
                    "visible": true
                },
                "CourseLibrary": {
                    "label": "Course Library",
                    "visible": true
                },
                "Assignments": {
                    "label": "Assignments",
                    "visible": true
                },
                "Exam": {
                    "label": "Exam",
                    "visible": true
                },
                "Achivements": {
                    "label": "Achivements",
                    "visible": true
                },
                "Gamification": {
                    "label": "Gamification",
                    "visible": true,
                    "subMenu": {
                        "Leaderboard": {
                            "label": "Leaderboard",
                            "visible": true
                        },
                        "Badges": {
                            "label": "Badges",
                            "visible": true
                        }
                    }
                },
                "Query": {
                    "label": "Query",
                    "visible": true
                },
                "Announcements": {
                    "label": "Announcements",
                    "visible": true
                },
                "Notifications": {
                    "label": "Notifications",
                    "visible": true
                },
                "Profile": {
                    "label": "Profile",
                    "visible": true
                },
                "ChangePassword": {
                    "label": "Change Password",
                    "visible": true
                },
                "RateTheApp": {
                    "label": "Rate the app",
                    "visible": true
                },
                "Logout": {
                    "label": "Logout",
                    "visible": true
                }
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Field	Type	Description
Dashboard	Object	Contains data about the Dashboard menu item.
label	String	Label for the Dashboard menu item.
visible	Boolean	Indicates whether the Dashboard menu item is visible.
Courses	Object	Contains data about the Courses menu item.
LearningObject	Object	Contains data about the Learning Objects menu item.
ClassroomSessions	Object	Contains data about the Classroom Sessions menu item.
WebinarOrMeeting	Object	Contains data about the Webinars or Meetings menu item.
CourseLibrary	Object	Contains data about the Course Library menu item.
Assignments	Object	Contains data about the Assignments menu item.
Exam	Object	Contains data about the Exam menu item.
Achivements	Object	Contains data about the Achivements menu item.
Gamification	Object	Contains data about the Gamification menu item.
Leaderboard	Object	Contains data about the Leaderboard submenu item.
Badges	Object	Contains data about the Badges submenu item.
Query	Object	Contains data about the Query menu item.
Announcements	Object	Contains data about the Announcements menu item.
Notifications	Object	Contains data about the Notifications menu item.
Profile	Object	Contains data about the Profile menu item.
ChangePassword	Object	Contains data about the Change Password menu item.
RateTheApp	Object	Contains data about the Rate the app menu item.
Logout	Object	Contains data about the Logout menu item.

Error Codes

Code	Description
1064	"Missing type"
1065	"Invalid type"

For general error details, click here.