Skip to main content

User

Timezone List

Use this API to get the list of all timezones.

 GET /user/timezone-list

{
"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": []
}
}
}
}

Language List

Use this API to list all availale languages.

 GET /user/language-list

{
"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": []
}
}
}
}

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

FieldTypeDescription
firstRecord
required
integerFirst record to return. Default: 1
count
required
integerNumber of records to be returned starting from the first record. Default: 20, Max count limit: 50
qstringFilter data by firstName, lastName, email.
{
"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": []
}
}
}
}

User Details

Use this API to get details of an individual user.

 GET /user/{userId}/detail

Query string parameters

FieldTypeDescription
firstRecord
required
integerFirst record to return. Default: 1
count
required
integerNumber of records to be returned starting from the first record. Default: 20, Max count limit: 50
{
"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": []
}
}
}
}

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

FieldTypeDescription
titlestringTitle. It should be Mr, Mrs, Ms, Dr, Prof
firstName
required
stringFirst Name
lastName
required
stringLast Name
email
required
stringEmail Address
countryCodestringCountry code
mobilestringMobile Number
userCanChoosePassword
required
integer0-No, 1-Yes
passwordstringIf userCanChoosePassword = 0 than set password.
uniqueIdstringEmployeeID OR Roll no
roleId
required
integer3-Trainee, 4-Trainer, 6-Manager, 9-Reporting
reportingTointegerID of the reporting person
companyNamestringCompany Name
departmentintegerDepartment ID
designationintegerDesignation ID
zipcodestringPincode
cityintegerCity ID
stateintegerState ID
countryintegerCountry ID
timezonestringe.g.: Asia/Kolkata
languagestringe.g.: en-US
sendEmailNotification
required
integer0–No, 1–Yes
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": {
"userId": 126
},
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}

User Update

Use this API to update details of a user.

 PUT /user/{userId}/update

Path parameters

FieldTypeDescription
userId
required
integerA single user ID

Query string parameters

FieldTypeDescription
firstNamestringFirst Name
lastNamestringLast Name
companyNamestringCompanyName
departmentintegerDepartment ID
designationintegerDesignation ID
mobilestringContact Number
cityintegerCity ID
stateintegerState ID
countryintegerCountry ID
timezonestringTimezone
languagestringLanguage eg: en-US
statusinteger1 – Enable, 0 – Disable, 2 – Delete
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": null,
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}

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

FieldTypeDescription
titlestringTitle. It should be Mr, Mrs, Ms, Dr, Prof
firstName
required
stringFirst Name
lastName
required
stringLast Name
email
required
stringEmail Address
countryCode
required
stringCountry code
mobile
required
stringMobile Number
ipAddress
required
stringIP Address
sendEmailNotification
required
integer1 – Yes (Send email to Trainee), 0 – No (Do not send email to Trainee)
receiveVerificationEmailOnstringe.g.: manager@example.com (Post verification by Trainee, get CC of the confirmation email sent to Trainee)
passwordstringPassword
cityintegerCity ID
stateintegerState ID
countryintegerCountry ID
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": {
"userId": "xxxxxxxxxxxxxxxxxxxx"
},
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}

Frontend Signup Verification

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

 POST /user/signup-verify

Request body parameters

FieldTypeDescription
token
required
stringToken
password
required
stringPassword
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": {
"userId": 126
},
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}

Trainee Calender Events

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

 GET /user/{userId}/trainee-calendar

Path parameters

FieldTypeDescription
userId requiredintegerUser ID

Query string parameters

FieldTypeDescription
fromDate
required
stringFrom Date
toDate
required
stringTo Date
{
"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": []
}
}
}
}

Team Member Details

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

 GET /user/{userId}/team-member

Path parameters

FieldTypeDescription
userId requiredintegerTo 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

FieldTypeDescription
typeinteger1 - to get all details of a individual team member
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": []
}
}
}
}

Trainee Dashboard Details

Use this API to get dashoboard details of a trainee.

 GET /user/{userId}/trainee-dashboard

Path parameters

FieldTypeDescription
userId requiredintegerUser ID
{
"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": []
}
}
}
}

Trainee Commom Action

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

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

Path parameters

FieldTypeDescription
userId requiredintegerUser ID

Request body parameters

FieldTypeDescription
type
required
integer1 - course rating, 2 - exam don't remind, 3 - accept terms and conditons
actionData
required
JSON ArrayEnrollmentData:
  1. 1. If type = 1 than actionData = {"enrollmentId": 21411, "rating": 3}
  2. 2. If type = 1 than actionData = {"examScheduleId": 21411}
  3. 3. If type = 3 than actionData = {"accept": 1}
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": true,
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}

Trainee Menu Details

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

 GET /user/trainee-menu

Query string parameters

FieldTypeDescription
typestringe.g Query, Gamificaion
{
"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": []
}
}
}
}