Get started
AlphaLearn LMS APIs provide the ability to view course details, user details, batch details, etc. This API is a server side implementation designed around REST. All the REST API calls should be POST HTTPS requests server-side.
Endpoint
https://api.alphalearn.com/v3
The AlphaLearn API endpoint is pretty straight forward.The base URL is api.alphalearn.com followed by the version number of the API, currently at version 3.
Authorization:
AlphaLearn API provides authorization token which can be passed in the HTTP Authorization Header using ‘Bearer’.
Header
Authorization: Bearer { Athorization Token }
How to get credentials
API user credentials will be provided. Use these credentials to generate the jwt token.
How to generate the jwt token
Pass these credentials (i.e email, password, and domain) in JSON format to authorize/login API which will return you the jwt token and refresh token and user basic details.
JWT token is valid for 60 min
Refresh token valid for 90 days
If the token expires use authorize/refreshtoken API using refreshToken as a post parameter to regenerate the token.
If the refresh token has expired please log out and call authorize/login API again.
Note: Pass reCaptchaToken where any insert/update operation is performed. To generate reCaptchaToken use the below mentioned Google Site Key 6LeeraIgAAAAACGmoqQ3upFj5ts3xK9V9grsjU4K
Login
Use this API to generate JWT token and refresh token.
HTTP REQUEST
POST /authorize/login
REQUEST BODY PARAMETERS
Field | Type | Description |
---|---|---|
email required | string | An Email Address |
password required | string | Password |
domain | string | Custom Domain. If a person belongs to 2 companies please specify domain. |
{ "success": true, "data": { "response": { "acknowledgement": "Success", "data": { "user": { "id": 2, "firstName": "Rajesh", "lastName": "Kumar", "email": "manish@horizzon.com", "mobile": "+919820000615", "uniqueId": "100001", "role": "Admin", "language": "en-US", "timezone": "Asia/Oral" }, "token": "eyJ0eXAiOiJKV1QiLCJhb", "refresh-token": "yfX8xSCTQszwBImLN4QKvPk-_" }, "error": { "code": "", "internal_message": "", "moreInfo": [] } } } }
Field | Type | Description |
user | JSON Array | User basic details |
id | integer | User Id |
fname | string | First Name |
lname | string | Last Name |
string | Email Address | |
mobile | string | Contact |
rollno | string | Contact |
timezone | string | Timezone |
token | string | JWT Token |
refresh-token | string | Refresh Token |
Code | Description |
1001 | “Missing email” |
1002 | “Invalid email” |
1003 | “Missing password” |
1004 | “Invalid password” |
1005 | “Missing domain” |
1006 | “Invalid domain” |
For general error details, click here.
Generate Token
Use this API to generate JWT token using refresh token.
HTTP REQUEST
POST /authorize/refreshtoken
REQUEST BODY PARAMETERS
Field | Type | Description |
---|---|---|
refreshToken required | string | Refresh Token |
{ "success": true, "data": { "response": { "acknowledgement": "Success", "data": { "status": "ok", "token": "eyJ0eXAiOiJKV1QiLCJhbGci" }, "error": { "code": "", "internal_message": "", "moreInfo": [] } } } }
Field | Type | Description |
token | string | JWT token |
Code | Description |
1016 | “Missing refreshToken” |
1017 | “Invalid refreshToken” |
For general error details, click here.
Timezone List
Use this API to list all timezones.
HTTP REQUEST
GET /user/timezone-list
QUERY STRING PARAMETERS
No Parameters |
{ "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)", }, "error": { "code": "", "internal_message": "", "moreInfo": [] } } } }
Field | Type | Description |
data | JSON Array | Timezone object |
For general error details, click here.
Language List
Use this API to list all languages.
HTTP REQUEST
GET /user/language-list
QUERY STRING PARAMETERS
No Parameters |
"success": true, "data": { "response": { "acknowledgement": "Success", "data": [ { "langId": "el-GR", "name": "Ελληνικά" }, "error": { "code": "", "internal_message": "", "moreInfo": [] } } } }
Field | Type | Description |
data | JSON Array | Language object |
For general error details, click here.
User List
Use this API to list all trainees.
HTTP REQUEST
GET /user/user-list
QUERY STRING PARAMETERS
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 user name, email. |
{ "success": true, "data": { "response": { "acknowledgement": "Success", "data": { "userList": [ { "userId": 2, "firstName": "Rajesh", "lastName": "Kumar", "email": "admin@horizzon.com", "countryCode": "+91", "mobile": "+919876543210", "uniqueId": "100001", "role": "Admin" } ], "totalRecords": 1 }, "error": { "code": "", "internal_message": "", "moreInfo": [] } } } }
Field | Type | Description |
userId | integer | user ID |
firstName | string | First Name |
lastName | string | Last Name |
string | Email Address | |
countryCode | string | geographical codes |
countryCode | string | geographical codes |
mobile | string | contact number |
uniqueId | string | roll number |
role | integer | the position |
totalRecords | integer | recourd count |
Code | Description |
1003 | ‘Invalid firstRecord’ |
1004 | ‘Invalid count’ |
For general error details, click here.
User Details
Use this API to get this individual user details.
HTTP REQUEST
GET /user/{userId}/detail
PATH PARAMETERS
userId required | integer | A single user ID |
{ "success": true, "data": { "response": { "acknowledgement": "Success", "data": { "userDetail": { "firstName": "pooja", "lastName": "gada", "email": "trainee@horizzon.com", "countryCode": "+91", "mobile": "9876543210", "timezone": "Asia/Kolkata", "department": "Test 123", "designation": "Senior Manager", "branch": null, "companyName": "Abc infotect", "workPhone": "", "address": "marin lines", "country": "Eshkashem", "state": "Badakhshan", "city": "Eshkashem", "zip": "400002", "zone": null, "lang": "en-US", "role": "Trainee" } }, "error": { "code": "", "internal_message": "", "moreInfo": [] } } } }
Field | Type | Description | firstName | string | First Name |
lastName | string | Last Name |
string | Email Address | |
countryCode | string | geographical codes | mobile | string | contact number |
timezone | string | Timezone |
department | string | Department name |
designation | string | Designation name |
branch | string | Branch name |
companyName | string | Company name |
workPhone | string | Work contact number |
address | string | Address details |
country | string | Country name |
state | string | State name |
city | string | City name |
zip | string | Zipcode |
zone | string | Zone name |
lang | string | Langugae |
role | string | Trainee |
Code | Description |
1001 | ‘Missing userId’ |
1002 | ‘Invalid userId’ |
For general error details, click here.
User Create
Use this API to get create individual user in LMS.
HTTP REQUEST
POST /user/create
REQUEST BODY PARAMETERS
title required | string | Title. It should be Mr, Mrs, Ms, Dr, Prof |
firstName required | string | First Name |
lastName required | string | Last Name |
string | Email Address | |
countryCode | string | Country code |
mobile | string | Contact Number |
userCanChoosePassword required | integer | 0-no, 1-Yes |
password | string | If userCanChoosePassword = 1 than set password. |
uniqueId | string | Roll no |
roleId required | integer | Role ID i.e Trainee – 3 |
reportingTo | integer | Id of the reporting person. |
companyName | string | Company Name |
department | integer | Department ID |
designation | integer | Designation ID |
zipcode | string | Pincode |
city | integer | City ID |
state | integer | State ID |
country | integer | Country ID |
timezone | string | Timezone |
language | string | Language e.g en-Us |
sendEmailNotification | integer | 1 – Yes, 0 – No |
{ "success": true, "data": { "response": { "acknowledgement": "Success", "data": { "userId": "126" }, "error": { "code": "", "internal_message": "", "moreInfo": [] } } } }
Field | Type | Description | userId | string | User Id |
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’ |
For general error details, click here.
Update User
Use this API to update details of an individual user.
HTTP REQUEST
PUT /user/{userId}/update
PATH PARAMETERS
userId required | string | A single user Id |
QUERY STRING PARAMETERS
firstName | string | First Name |
lastName | string | Last Name |
companyName | string | CompanyName |
department | integer | Department ID |
designation | integer | Designation ID |
mobile | string | Contact Number |
city | integer | City ID |
state | integer | State ID |
country | integer | Country ID |
timezone | string | Timezone |
language | string | Language eg: en-US |
status | int | 1 – Enable, 0 – Disable, 2 – Delete |
{ "success": true, "data": { "response": { "acknowledgement": "Success", "data": null, "error": { "code": "", "internal_message": "", "moreInfo": [] } } } }
Field | Type | Description | userId | string | Token |
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’ |
For general error details, click here.
Frontend SignUp
Use this API to register a new user from frontend website.
HTTP REQUEST
POST /user/signup
REQUEST BODY PARAMETERS
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 |
mobile required | string | Contact Number |
ipAddress required | string | IP Address |
sendEmailNotification required | integer | 1 – Yes, 0 – No |
receiveVerificationEmailOn required | integer | 1 – Yes, 0 – No |
password | string | If userCanChoosePassword = 1 than set password. |
city | integer | City ID |
state | integer | State ID |
country | integer | Country ID |
reCaptchaToken | string | Token |
{ "success": true, "data": { "response": { "acknowledgement": "Success", "data": { "userId": "126" }, "error": { "code": "", "internal_message": "", "moreInfo": [] } } } }
Field | Type | Description | userId | string | Token |
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’ |
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.
SignUp Verification
Use this API to verify user who registered from frontend website.
HTTP REQUEST
POST /user/signup-verify
REQUEST BODY PARAMETERS
token required | string | Token |
password required | string | Password |
{ "success": true, "data": { "response": { "acknowledgement": "Success", "data": { "userId": "126" }, "error": { "code": "", "internal_message": "", "moreInfo": [] } } } }
Field | Type | Description | userId | string | user ID |
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.
Course List
Use this API to list all courses.
HTTP REQUEST
GET /course/course-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: 100 |
filterData | JSON Array | Search record with following filter 1. courseId 2. courseCode 3. eligibleForSale (0 – no,1 – yes) 4.Status 5. courseType (1- single subject, 2 – multi subject) 6. Generic 7. sortByfield 8. sortType |
{ "success": true, "data": { "response": { "acknowledgement": "Success", "data": { "courseList": [ { "courseId": 12, "title": "Wonderchef Product Training", "courseType": "Multiple Subject", "durationInDays": 30, "courseCode": "WT001", "description": "Test", "thumbnail": null, "eligibleForSale": true, "status": true, "availableFrom": "01-01-2018", "availableTill": "31-12-2022", "currency": [] } ], "totalRecords": 1 }, "error": { "code": "", "internal_message": "", "moreInfo": [] } } } }
Field | Type | Description |
courseId | int | Course ID |
title | string | Course Title |
courseCode | string | Course Code |
description | string | Course Description |
duration | string | course duration |
startDate | date | Course Start date |
endDate | date | Course end date |
eligibleForSale | float | Course Price in INR |
status | bool | Course status |
thumbnail | string | Course thumbnail URL |
totalRecords | int | Count of total records returned |
Code | Description |
1003 | ‘Invalid firstRecord’ |
1004 | ‘Invalid count’ |
1005 | ‘Missing filterData’ |
1006 | ‘Invalid filterData’ |
1007 | ‘Missing filterData – field’ |
1008 | ‘Invalid filterData – field’ |
1009 | ‘Missing filterData – generic’ |
1010 | ‘Invalid filterData – generic’ |
1011 | ‘Missing filterData – sortByfield’ |
1012 | ‘Invalid filterData – sortByfield’ |
1013 | ‘Missing filterData – sortType’ |
1014 | ‘Invalid filterData – sortType’ |
For general error details, click here.
Course Details
Use this API to get individual course basic details.
HTTP REQUEST
GET /course/{courseId}/detail
PATH PARAMETER
Field | Type | Description |
---|---|---|
courseId required | integer | A single course ID |
{ "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": "Vicky Upadhyay", "tags": "test,123", "seoTitle": "anlndanlsd", "seoDescription": "asndfasd", "keywords": "abm,sdn,adsf", "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": [] } } } }
Field | Type | Description | ||||||
courseId | int | Course ID | ||||||
title | string | Course Title | ||||||
courseCode | string | Course Code | ||||||
description | string | Course Description | ||||||
duration | string | Course Duration | ||||||
startDate | date | Course Start date | ||||||
endDate | date | Course end date | ||||||
thumbnail | string | Course thumbnail URL | ||||||
department | JSON Array
| |||||||
designation | JSON Array
| |||||||
faq | string | Course Faq | ||||||
demovideo | string | Demo video URL | ||||||
features | string | Course feature as HTML | ||||||
trainerName | string | Display trainee name | ||||||
tags | string | Tags for search | ||||||
seoTitle | string | Course SEO | ||||||
seoDescription | string | Course SEO | ||||||
keywords | string | Course SEO | ||||||
currency | JSON Array
| |||||||
proficiency | JSON Array
| |||||||
competency | JSON Array
| |||||||
subject | JSON Array
|
Code | Description |
---|---|
1001 | ‘Missing courseId’ |
1002 | ‘Invalid courseId’ |
For general error details, click here.
User Enrollment Details
Use this API to get individual user enrollment details.
HTTP REQUEST
GET /enrollment/{userId}
PATH PARAMETERS
Field | Type | Description |
---|---|---|
userId required | integer | A single user ID |
QUERY STRING PARAMETERS
Field | Type | Description |
---|---|---|
type required | integer | Enrollment Type. 1-course, 2-learning object. |
status required | integer | Enrollment Status. 1-upcoming/ongoing, 2-concluded. |
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: 100 |
{ "success": true, "data": { "response": { "acknowledgement": "Success", "data": { "list": [ { "enrollmentId": 14633, "courseId": 1124, "title": "April 2020 - Test Course", "courseCode": "Apr/2020/IT", "description": "This course is exclusively designed for Testing Purpose", "trainer": "Trainer Horizzon", "startDate": "2022-09-29", "endDate": "2022-10-29", "progress": "0", "firstTimeViewedDate": null, "status": "Ongoing", "certificate": [] } ], "totalRecords": 11 }, "error": { "code": "", "internal_message": "", "moreInfo": [] } } } }
Field | Type | Description |
enrollmentId | integer | Enrollment ID |
courseId | integer | Course Id |
title | string | Mr, Mrs, Prof, Dr |
lname | string | Last Name |
courseCode | string | Course Code |
description | string | Course Description |
trainer | string | Trainer Name |
startDate | date | Course start date |
endDate | date | Course End Date |
progress | string | Course Progress |
firstTimeViewedDate | datetime | Date when trainee viewed course first time |
status | integer | enabled/disabled status |
date | string | certificate issued date |
url | string | certificate file url |
Code | Description |
1001 | ‘Missing userId’ |
1002 | ‘Invalid userId’ |
1003 | ‘Missing enrollment type’ |
1004 | ‘Invalid enrollment type’ |
1005 | ‘Invalid firstRecord’ |
1006 | ‘Invalid count’ |
1007 | ‘Missing enrollment status’ |
1008 | ‘Invalid enrollment status’ |
For general error details, click here.
Validate Details
Use this API to validate user and course details.
HTTP REQUEST
POST /transaction/validate
REQUEST BODY PARAMETER
Field | Type | Description |
---|---|---|
orderType required | integer | 1-course, 2-learning object, 3-learning-path etc. |
orderData required | JSON Array | Filter Parameter: 1. user ID 2. Course ID 3. CurrencyCode 4. Price 5. paymentProvider will be 1 |
{ "success": true, "data": { "response": { "acknowledgement": "Success", "data": null, "error": { "code": "", "internal_message": "", "moreInfo": [] } } } }
Field | Type | Description |
acknowledgement | string | Sucess/Failure |
Code | Description |
1001 | ‘Missing orderType’ |
1002 | ‘Invalid orderType’ |
1003 | ‘Missing orderData’ |
1004 | ‘Invalid orderData’ |
1005 | ‘Missing userId’ |
1006 | ‘Invalid userId’ |
1007 | ‘Missing courseId’ |
1008 | ‘Invalid courseId’ |
1009 | ‘Missing transactionRefNo’ |
1010 | ‘Invalid transactionRefNo’ |
1011 | ‘Missing paymentProvider’ |
1012 | ‘Invalid paymentProvider’ |
1017 | ‘Missing emailNotification’ |
1018 | ‘Invalid emailNotification’ |
1021 | ‘Missing currencyCode’ |
1022 | ‘Invalid currencyCode’ |
1023 | ‘Missing price’ |
1024 | ‘Invalid price’ |
1025 | ‘currencyCode not configured’ |
1026 | ‘Amount mismatch’ |
For general error details, click here.
Transaction Process
Use this API to generate Order ID.
HTTP REQUEST
POST /transaction/generate-order
REQUEST BODY PARAMETER
Field | Type | Description |
---|---|---|
paymentProvider required | integer | 1-RazorPay |
orderData required | JSON Array | Filter Parameter: 1. currencyCode 2. price |
{ "success": true, "data": { "response": { "acknowledgement": "Success", "data": "orderId": [ {abc123xyz}, "error": { "code": "", "internal_message": "", "moreInfo": [] } } } }
Field | Type | Description |
acknowledgement | string | Sucess/Failure |
data | integer | enrollment ID |
Code | Description |
1003 | ‘Missing orderData’ |
1004 | ‘Invalid orderData’ |
1021 | ‘Missing currencyCode’ |
1022 | ‘Invalid currencyCode’ |
1023 | ‘Missing price’ |
1024 | ‘Invalid price’ |
1025 | ‘currencyCode not configured’ |
1026 | ‘Amount mismatch’ |
1027 | ‘Missing orderId |
1028 | ‘Invalid orderId |
1029 | ‘Razorepay – orderId not found |
For general error details, click here.
Transaction Process
Use this API to capture payment details and enroll user in a course.
HTTP REQUEST
POST /transaction/process
REQUEST BODY PARAMETER
Field | Type | Description |
---|---|---|
orderType required | integer | 1-course, 2-learning object, 3-learning-path etc. |
orderData required | JSON Array | Filter Parameter: 1. user ID 2. Course ID 3. CurrencyCode 4. Price 5. paymentProvider will be 1 6. transactionRefNo |
{ "success": true, "data": { "response": { "acknowledgement": "Success", "data": 14634, "error": { "code": "", "internal_message": "", "moreInfo": [] } } } }
Field | Type | Description |
acknowledgement | string | Sucess/Failure |
data | integer | enrollment ID |
Code | Description |
1001 | ‘Missing orderType’ |
1002 | ‘Invalid orderType’ |
1003 | ‘Missing orderData’ |
1004 | ‘Invalid orderData’ |
1005 | ‘Missing userId’ |
1006 | ‘Invalid userId’ |
1007 | ‘Missing courseId’ |
1008 | ‘Invalid courseId’ |
1009 | ‘Missing transactionRefNo’ |
1010 | ‘Invalid transactionRefNo’ |
1011 | ‘Missing paymentProvider’ |
1012 | ‘Invalid paymentProvider’ |
1013 | ‘Not eligible for enrollment – Already enrolled’ |
1014 | ‘Razorepay not configured / Record not found’ |
1015 | ‘TransactionRefNo is already proceed’ |
1016 | ‘Transaction status is not allow for enrollment’ |
1017 | ‘Missing emailNotification’ |
1018 | ‘Invalid emailNotification’ |
1019 | ‘Course enrollment email template was not found’ |
1020 | ‘Course is not eligible for sale. Missing currency/show frontEnd setting’ |
1021 | ‘Missing currencyCode’ |
1022 | ‘Invalid currencyCode’ |
1023 | ‘Missing price’ |
1024 | ‘Invalid price’ |
1025 | ‘currencyCode not configured’ |
1026 | ‘Amount mismatch’ |
For general error details, click here.
Category List
Use this API to list a all courses categories.
HTTP REQUEST
GET /course-category/course-category-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 from the first record Default: 20, Max count limit: 100 |
q | string | filter data by category name |
{ "success": true, "data": { "response": { "acknowledgement": "Success", "data": { "courseCategoryList": [ { "courseCategoryId": 32, "name": "Test", "sortNo": 1, "courseCount": 1, "status": true } ], "totalRecords": 1 }, "error": { "code": "", "internal_message": "", "moreInfo": [] } } } }
Field | Type | Description |
courseCategoryId | int | Category ID |
name | string | Category Name |
courseCode | string | Course Code |
sortNo | integer | position |
courseCount | integer | number of courses |
status | boolean | Active/Inactive |
totalRecords | integer | Count of records returned |
Code | Description |
1003 | ‘Invalid firstRecord’ |
1004 | ‘Invalid count’ |
For general error details, click here.
Category Details
Use this API to list a get individual category details.
HTTP REQUEST
GET /course-category/{categoryId}/detail
PATH PARAMETER
Field | Type | Description |
---|---|---|
categoryId required | integer | A single category ID |
{ "success": true, "data": { "response": { "acknowledgement": "Success", "data": { "courseCategoryId": 32, "name": "Test", "courses": [ { "courseId": 6, "title": "Social Entrepreneurship", "courseCode": "SE1" } ] }, "error": { "code": "", "internal_message": "", "moreInfo": [] } } } }
Field | Type | Description |
courseCategoryId | int | Category ID |
name | string | Category Name |
courseCode | string | Course Code |
courses | JSON Array | course details |
courseId | integer | number of courses |
title | string | course name |
courseCode | string | course unique code |
Code | Description |
1001 | ‘Missing categoryId’ |
1003 | ‘Invalid categoryId’ |
For general error details, click here.
Department List
Use this API to get all departments.
HTTP REQUEST
GET /department/department-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: 100 |
q | string | filter data by department name |
{ "success": true, "data": { "response": { "acknowledgement": "Success", "data": { "departmentList": [ { "departmentId": 14, "name": "Marketing", "status": true } ], "totalRecords": 1 }, "error": { "code": "", "internal_message": "", "moreInfo": [] } } } }
Field | Type | Description |
departmentId | integer | Department ID |
name | string | Department Name |
status | integer | Enabled/Disabled |
totalRecords | integer | count of records returned |
Code | Description |
1002 | ‘Invalid firstRecord’ |
1003 | ‘Invalid count’ |
For general error details, click here.
Designation List
Use this API to get all designation
HTTP REQUEST
GET /designation/designation-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: 100 |
q | string | filter data by designation name |
{ "success": true, "data": { "response": { "acknowledgement": "Success", "data": { "departmentList": [ { "designationId": 14, "name": "Manager", "status": true } ], "totalRecords": 1 }, "error": { "code": "", "internal_message": "", "moreInfo": [] } } } }
Field | Type | Description |
designationId | integer | Designation ID |
name | string | Designation Name |
status | integer | Enabled/Disabled |
totalRecords | integer | count of records returned |
Code | Description |
1002 | ‘Invalid firstRecord’ |
1003 | ‘Invalid count’ |
For general error details, click here.
City List
Use this API to get all city based on state
HTTP REQUEST
GET /city/city-list
QUERY STRING PARAMETERS
Field | Type | Description |
---|---|---|
stateId required | integer | State ID |
q | string | Search by city name |
{ "success": true, "data": { "response": { "acknowledgement": "Success", "data": { "cityList": [ { "cityId": 1, "name": "Bombuflat" }, ], "totalRecords": 1 }, "error": { "code": "", "internal_message": "", "moreInfo": [] } } } }
Field | Type | Description |
cityId | integer | City ID |
name | string | City Name |
totalRecords | integer | count of records returned |
Code | Description |
1001 | ‘Missing stateId’ |
1002 | ‘Invalid stateId’ |
For general error details, click here.
Country List
Use this API to get all countries
HTTP REQUEST
GET /country/country-list
QUERY STRING PARAMETERS
Field | Type | Description |
---|---|---|
q | string | input search string |
{ "success": true, "data": { "response": { "acknowledgement": "Success", "data": { "countryList": [ { "countryId": 1, "countryCode": "AF", "name": "Afghanistan" }, ], "totalRecords": 1 }, "error": { "code": "", "internal_message": "", "moreInfo": [] } } } }
Field | Type | Description |
countryId | integer | Country ID |
countryCode | string | Country code |
name | string | Country Name |
totalRecords | integer | count of records returned |
For general error details, click here.
Blog List
Use this API to list all blogs.
HTTP REQUEST
GET /blog/blog-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 from the first record Default: 20, Max count limit: 100 |
q | string | filter data by blog title and description |
{ "success": true, "data": { "response": { "acknowledgement": "Success", "data": { "blogList": [ { "blogId": 6, "title": "Test Title", "description": "Test", "thumbnail": "", "status": true } ], "totalRecords": 1 }, "error": { "code": "", "internal_message": "", "moreInfo": [] } } } }
Field | Type | Description |
blogId | integer | Blog ID |
title | string | Blog Title |
description | string | Blog Description |
thumbnail | string | Blog Image |
status | boolean | Active/Inactive |
totalRecords | integer | Count of records returned |
Code | Description |
1003 | ‘Invalid firstRecord’ |
1004 | ‘Invalid count’ |
For general error details, click here.
Blog Details
Use this API to list a get individual blog details.
HTTP REQUEST
GET /blog/{blogId}/detail
PATH PARAMETER
Field | Type | Description |
---|---|---|
blogId required | integer | A single blog ID |
{ "success": true, "data": { "response": { "acknowledgement": "Success", "data": { "blogDetail": { "blogId": 6, "title": "Test Title", "description": "test", "thumbnail": "../image.jpg", "status": true } }, "error": { "code": "", "internal_message": "", "moreInfo": [] } } } }
Field | Type | Description |
blogId | integer | Blog ID |
title | string | Blog Title |
description | string | Blog Description |
thumbnail | string | Blog Image | status | boolean | Active/Inactive |
Code | Description |
1002 | ‘Invalid blogId’ |
1003 | ‘Missing blogId’ |
For general error details, click here.
State List
Use this API to get all state based on country
HTTP REQUEST
GET /state/state-list
QUERY STRING PARAMETERS
Field | Type | Description |
---|---|---|
countryId required | integer | Country ID |
q | string | Search by state name |
{ "success": true, "data": { "response": { "acknowledgement": "Success", "data": { "stateList": [ { "stateId": 42, "name": "Badakhshan" } ], "totalRecords": 1 }, "error": { "code": "", "internal_message": "", "moreInfo": [] } } } }
Field | Type | Description |
stateId | integer | State ID |
name | string | State Name |
totalRecords | integer | count of records returned |
Code | Description |
1001 | ‘Missing countryId’ |
1002 | ‘Invalid countryId’ |
For general error details, click here.