Skip to main content

Course

Course List

Use this API to get the list of all courses created in the LMS.

 GET /course/course-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: 100
filterDataJSON ArraySearch all records using the following filters:
  1. 1. title
  2. 2. courseId
  3. 3. categoryId
  4. 4. courseCode
  5. 5. eligibleForSale (0 – no, 1 – yes)
  6. 6. status
  7. 7. courseType (0 - single subject, 1 – multi subject)
  8. 8. generic
  9. 9. sortByfield (newest/popular/duration/rating)
  10. 10. sortType (asc/desc)
{
"field": {
"courseId": [],
"categoryId": [32, 33],
"title": "string",
"courseCode": "string",
"eligibleForSale": 0,
"status": 1,
"courseType": 1
},
"generic": "string",
"sortByfield": "string",
"sortType": "string"
}
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": {
"courseList": [
{
"courseId": 12,
"title": "Product Training",
"courseType": "Single Subject",
"durationInDays": 30,
"courseCode": "WT001",
"description": "Test",
"trainer": "Mr. Rajesh",
"thumbnail": null,
"eligibleForSale": true,
"status": true,
"availableFrom": "01-01-2018",
"availableTill": "31-12-2025",
"avgRating": 0,
"currency": [
{
"currencyCode": "INR",
"price": 750,
"isDefault": true
}
]
}
],
"totalRecords": 1
},
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}

Course Details

Use this API to get details of a specific course.

 GET /course/{courseId}/detail

Path parameter

FieldTypeDescription
courseId
required
integerCourse ID of the course
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": {
"courseDetail": {
"courseId": 3,
"title": "Human Resource Management",
"courseCode": "101",
"description": "Human Resource Management (HRM, or simply HR).",
"durationInDays": "180",
"startDate": "2017-09-20",
"endDate": "2022-12-31",
"thumbnail": null,
"department": [
{
"departmentId": 38,
"name": "Information Technology",
"status": true
}
],
"designation": [
{
"designationId": 6,
"name": "Senior Manager",
"status": true
}
],
"faq": "",
"demovideo": "",
"features": "",
"trainerName": "Rajesh Kumar",
"certificateIssue": null,
"tags": "HRM",
"seoTitle": "",
"seoDescription": "",
"keywords": "",
"proficiency": [
{
"proficiencyId": 1,
"name": "Level 1",
"status": true
}
],
"competency": [
{
"competencyId": 1,
"name": "Communication",
"status": true
}
],
"subject": [
{
"subjectId": 1,
"name": "Test"
}
],
"currency": [
{
"currencyCode": "INR",
"price": "500",
"isDefault": 1
}
]
}
},
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}

Trainee - Course Library

Use this API to get the list of all courses added to the library in which the Trainee is eligible for enrollment.

 GET /course/trainee-course-library

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: 100
filterData
required
JSON ArraySearch all records using the following filters:
  1. 1. courseId
  2. 2. courseCode
  3. 3. title
  4. 4. status
  5. 5. generic
  6. 6. sortByfield (newest/popular/duration/rating)
  7. 7. sortType (asc/desc)
{
"field": {
"courseId": [],
"title": "string",
"courseCode": "string",
"status": 1
},
"generic": "string",
"sortByfield": "string",
"sortType": "string"
}
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": {
"courseList": [
{
"courseId": 1490,
"title": "Principles of an Effective ",
"courseType": "Single Subject",
"durationInDays": 15,
"courseCode": "10118",
"description": "<p>Principles of Effective Managers talks about what it takes to be an effective manager. It tells you what are the characteristics and behaviours demonstrated by effective managers.</p>",
"thumbnail": "https://example.com/thumbnail.png",
"eligibleForSale": true,
"avgRating": 0,
"trainerName": "Rajesh Kumar",
"inLibrary": true,
"inLibraryApprovedBy": "Self",
"status": true,
"availableFrom": "04-10-2017",
"availableTill": "31-03-2025"
},
],
"totalRecords": 1
},
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}

Trainee - Enroll to a course in Course Library

Use this API to enroll a Trainee to a course that is added to the course library.

 GET /course/{courseId}/trainee-course-library-request

Path parameter

FieldTypeDescription
courseId
required
integerA single course ID
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": {
"enrollmentId": 22084
},
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}

Use this API to get the list of recommended courses for a Trainee.

 GET /course/trainee-course-recommended

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: 100
filterData
required
JSON ArraySearch record with following filters:
  1. 1. courseCode
  2. 2. title
  3. 3. status
  4. 4. generic
  5. 5. sortByfield (newest/popular/duration/rating)
  6. 6. sortType (asc/desc)
{
"field": {
"courseId": [],
"title": "string",
"courseCode": "string",
"status": 1
},
"generic": "string",
"sortByfield": "string",
"sortType": "string"
}
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": {
"courseList": [
{
"courseId": 1352,
"title": "Communications Skills",
"courseType": "Single Subject",
"durationInDays": 90,
"courseCode": "m23",
"description": "<p><strong>Lorem Ipsum</strong> is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum</p>",
"thumbnail": "https://example.com/thumbnail.png",
"eligibleForSale": true,
"avgRating": 4,
"trainerName": "Rajesh Kumar",
"status": true,
"availableFrom": "27-04-2020",
"availableTill": "20-11-2025",
"currency": []
}
],
"totalRecords": 1
},
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}

Use this API to enroll a Trainee to a recommended course or dismiss it from the list.

 GET /course/trainee-course-recommended-action

Query string parameters

FieldTypeDescription
actionType
required
integer1-dismiss, 2-enrollment
courseId
required
integerCourse ID of the Course
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": true,
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}

Trainee - Assignment List

Use this API to get the list of Assignments available to a Trainee.

 GET /course/{userId}/trainee-assignment-list

Path parameters

FieldTypeDescription
userId
required
integerUser ID

Query string parameters

FieldTypeDescription
subjectIdintegerSubject ID
qstringFilter based on courseTitle, documentName, etc.
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": [
{
"enrollmentId": 21783,
"documentId": 21730,
"courseId": 1422,
"subjectId": null,
"dueDate": "2023-08-06",
"courseTitle": "Communication Skills",
"documentName": "Assignment 1",
"submitedDate": "2023-08-04",
"message": null,
"status": "Submited",
"statusColor": "#DEFFEC",
"scored": "100%"
},
],
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}

Trainee - List of Modules and Documents in a Course

Use this API to get the list of course modules and documents for a specific enrollment.

 GET /course/{enrollmentId}/trainee-module-document-list

Path parameters

FieldTypeDescription
enrollmentId
required
integerEnrollment ID

Query string parameters

FieldTypeDescription
subjectIdintegerSubject ID
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": {
"onModuleCompletion": null,
"enrollmentId": 22084,
"avgPassingPercentage": "10",
"enrollmentStart": "2023-08-11",
"enrollmentEnd": "2023-08-26",
"progress": 0,
"accessCourseMaterialInSequence": false,
"hasAutoAssignment": false,
"completionCriteria": "ASSIGNMENT_EXAM",
"certificateIssue": null,
"trainerId": 2,
"chapterDetail": [
{
"chapter": {
"chapterId": 5337,
"chapterName": "Managerial Effectiveness in the Workplace",
"chapterDescription": null,
"chapterStartOn": null
},
"docuemnts": [
{
"chapterId": 5337,
"documentId": 22315,
"documentName": "Summary",
"documentDescription": "PDF",
"documentTypeId": 2,
"isCompleted": false,
"information": null,
"canView": true
},
{
"chapterId": 5337,
"documentId": 20698,
"documentName": "Survey",
"documentDescription": "Survey",
"documentTypeId": 15,
"isCompleted": false,
"information": null,
"canView": true
}
]
},

]
},
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}

Trainee - Course Content View

Use this API to get details of a individual course content (e.g.: HTML, PDF, PPT, Videos, Assessments, etc.). Mark content as Completed. Submit answers for Assignment, Assessment, Practice test, Survey, Poll questions.

 GET /course/{enrollmentId}/trainee-document-view

Path parameters

FieldTypeDescription
enrollmentId
required
integerEnrollment ID

Query string parameters

FieldTypeDescription
documentId
required
integerDocument ID
subjectIdintegerSubject ID
startAssignmentintegervalue = 1 to start time barred assignment
requestForExtentionintegervalue = 1
traineeResponsejsonArray
  1. 1. questionId
  2. 2. optionId
  3. 3. markComplete
  4. 4. clearAnswer
  5. 5. reAttempt
{
"questionId":23516,
"optionId":"1",
"markComplete":1,
"clearAnswer":0,
"reAttempt":0
}
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": {
"progress": 0,
"documentId": 22338,
"documentName": "Assessment - One question at a time",
"documentDescription": "<h2>Why do we use it?</h2>\n\n<p>It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using &#39;Content here, content here&#39;, making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for &#39;lorem ipsum&#39; will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like).</p>\n",
"multiAttemptTillCorrectAnswer": false,
"displayAllQuestion": true,
"passingPercentage": 60,
"isCompleted": false,
"eligibleToMarkComplete": false,
"totalQuestion": 3,
"attempted": 1,
"totalCorrect": 0,
"correctPercentage": 0,
"canReattempt": false,
"displayCorrectAns": true,
"mcqData": [
{
"questionId": 23516,
"questionMarks": 1,
"obtainMarks": 0,
"singleOrMultiple": "SINGLE",
"correctAns": "3",
"userAnswer": "1",
"questionBody": "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\" \"http://www.w3.org/TR/REC-html40/loose.dtd\">\n<?xml encoding=\"UTF-8\"><html><body><!--?xml encoding=\"UTF-8\"--><!--?xml encoding=\"UTF-8\"--></p><pre>Alphalearn is a Cloud based _____<br><br><a href=\"https://s3.ap-south-1.amazonaws.com/test.alphalearn.com/cElGbkQyUENEVk09/TXUzSG5GeFF6c289/M1pMWnE1c0ZCRmM9/a1ErSDBSNkY2SlU9/1688538929_alphalearn_sample.pdf\">1688538929_alphalearn_sample.pdf</a><br></body></html>\n",
"options": [
{
"optionId": 1,
"option": "CRM"
},
{
"optionId": 2,
"option": "ERP"
},
{
"optionId": 3,
"option": "LMS"
},
{
"optionId": 4,
"option": "All of the above"
}
]
}
]
},
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}