Version: v2Version: v3

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

FieldTypeDescription
email
required
integerAn Email Address
password
required
integerPassword
domainintegerCustom 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": []
            }
        }
    }
}
FieldTypeDescription
userJSON ArrayUser basic details
idintegerUser Id
fnamestringFirst Name
lnamestringLast Name
emailstringEmail Address
mobilestringContact
rollnostringContact
timezonestringTimezone
tokenstringJWT Token
refresh-tokenstringRefresh Token
CodeDescription
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

FieldTypeDescription
refreshToken
required
integerRefresh Token
{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "status": "ok",
                "token": "eyJ0eXAiOiJKV1QiLCJhbGci"
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}
FieldTypeDescription
tokenstringJWT token
CodeDescription
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": []
            }
        }
    }
}
FieldTypeDescription
dataJSON ArrayTimezone 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": []
            }
        }
    }
}
FieldTypeDescription
dataJSON ArrayLanguage 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
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 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": []
            }
        }
    }
}
FieldTypeDescription
userIdintegeruser ID
firstNamestringFirst Name
lastNamestringLast Name
emailstringEmail Address
countryCodestringgeographical codes
countryCodestringgeographical codes
mobilestringcontact number
uniqueIdstringroll number
roleintegerthe position
totalRecordsintegerrecourd count
CodeDescription
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
integerA 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": []
            }
        }
    }
}
FieldTypeDescription
firstNamestringFirst Name
lastNamestringLast Name
emailstringEmail Address
countryCodestringgeographical codes
mobilestringcontact number
timezonestringTimezone
departmentstringDepartment name
designationstringDesignation name
branchstringBranch name
companyNamestringCompany name
workPhonestringWork contact number
addressstringAddress details
countrystringCountry name
statestringState name
citystringCity name
zipstringZipcode
zonestringZone name
langstringLangugae
rolestringTrainee
CodeDescription
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
integerTitle. It should be Mr, Mrs, Ms, Dr, Prof
firstName
required
integerFirst Name
lastName
required
integerLast Name
emailintegerEmail Address
countryCodeintegerCountry code
mobileintegerContact Number
userCanChoosePassword
required
integer0-no, 1-Yes
password

integerIf userCanChoosePassword = 1 than set password.
uniqueIdintegerRoll no
roleId
required
integerRole ID i.e Trainee – 3
reportingTointegerId of the reporting person.
companyNamestringCompany Name
departmentintegerDepartment ID
designationintegerDesignation ID
zipcodestringPincode
cityintegerCity ID
stateintegerState ID
countryintegerCountry ID
timezonestringTimezone
languagestringLanguage e.g en-Us
sendEmailNotificationinteger1 – Yes, 0 – No
{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "userId": "126"
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}
FieldTypeDescription
userIdstringUser Id
CodeDescription
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
stringA single user Id

QUERY STRING PARAMETERS

firstNamestringFirst Name
lastNamestringLast Name
companyNamestringCompanyName
departmentintegerDepartment ID
designationintegerDesignation ID
mobilestringContact Number
cityintegerCity ID
stateintegerState ID
countryintegerCountry ID
timezonestringTimezone
languagestringLanguage eg: en-US
statusint1 – Enable, 0 – Disable, 2 – Delete
{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": null,
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}
FieldTypeDescription
userIdstringToken
CodeDescription
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

titleintegerTitle. It should be Mr, Mrs, Ms, Dr, Prof
firstName
required
integerFirst Name
lastName
required
integerLast Name
email
required
integerEmail Address
countryCode
required
integerCountry code
mobile
required
integerContact Number
ipAddress
required
integerIP Address
sendEmailNotification
required
integer1 – Yes, 0 – No
receiveVerificationEmailOn
required
integer1 – Yes, 0 – No
password

integerIf userCanChoosePassword = 1 than set password.
cityintegerCity ID
stateintegerState ID
countryintegerCountry ID
reCaptchaTokenstringToken
{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "userId": "126"
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}
FieldTypeDescription
userIdstringToken
CodeDescription
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
stringToken
password
required
stringPassword
{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "userId": "126"
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}
FieldTypeDescription
userIdstringuser ID
CodeDescription
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

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 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
{
	"field": {
		"courseId": [],
		"title": "",
		"courseCode": "",
		"eligibleForSale": 0,
		"status": 1,
		"courseType": 1
	},
	"generic": "marketing",
	"sortByfield": "title",
	"sortType": "desc"
}
{
    "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": []
            }
        }
    }
}
FieldTypeDescription
courseIdintCourse ID
titlestringCourse Title
courseCodestringCourse Code
descriptionstringCourse Description
durationstringcourse duration
startDatedateCourse Start date
endDatedateCourse end date
eligibleForSalefloatCourse Price in INR
statusboolCourse status
thumbnailstringCourse thumbnail URL
totalRecordsintCount of total records returned
CodeDescription
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

FieldTypeDescription
courseId
required
integerA 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": []
            }
        }
    }
}
FieldTypeDescription
courseIdintCourse ID
titlestringCourse Title
courseCodestringCourse Code
descriptionstringCourse Description
durationstringCourse Duration
startDatedateCourse Start date
endDatedateCourse end date
thumbnailstringCourse thumbnail URL
departmentJSON Array

departmentIdinteger
namestring
designationJSON Array

designationIdinteger
namestring
faqstringCourse Faq
demovideostringDemo video URL
featuresstringCourse feature as HTML
trainerNamestringDisplay trainee name
tagsstringTags for search
seoTitlestringCourse SEO
seoDescriptionstringCourse SEO
keywordsstringCourse SEO
currencyJSON Array

currencyCodestring
pricefloat
isDefaultinteger
proficiencyJSON Array

proficiencyIdinteger
namestring
statusinteger
competencyJSON Array

competencyIdinteger
namestring
statusinteger
subjectJSON Array

subjectIdinteger
namestring
CodeDescription
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

FieldTypeDescription
userId
required
integerA single user ID

QUERY STRING PARAMETERS

FieldTypeDescription
type
required
integerEnrollment Type. 1-course, 2-learning object.
status
required
integerEnrollment Status. 1-upcoming/ongoing, 2-concluded.
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
{
    "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": []
            }
        }
    }
}
FieldTypeDescription
enrollmentIdintegerEnrollment ID
courseIdintegerCourse Id
titlestringMr, Mrs, Prof, Dr
lnamestringLast Name
courseCodestringCourse Code
descriptionstringCourse Description
trainerstringTrainer Name
startDatedateCourse start date
endDatedateCourse End Date
progressstringCourse Progress
firstTimeViewedDatedatetimeDate when trainee viewed course first time
statusintegerenabled/disabled status
datestringcertificate issued date
urlstringcertificate file url
CodeDescription
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

FieldTypeDescription
orderType
required
integer1-course,
2-learning object,
3-learning-path etc.
orderData
required
JSON ArrayFilter Parameter:
1. user ID
2. Course ID
3. CurrencyCode
4. Price
5. paymentProvider will be 1
{
   "userId": [8],
   "courseId": 1124,
   "currencyCode": "INR",
   "price": "1",
   "paymentProvider": 1
}
{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": null,
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}
FieldTypeDescription
acknowledgementstringSucess/Failure
CodeDescription
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

FieldTypeDescription
paymentProvider
required
integer1-RazorPay
orderData
required
JSON ArrayFilter Parameter:
1. currencyCode
2. price
{
   "currencyCode": "INR",
   "price": "1",
}
{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": 
            "orderId": [
                    {abc123xyz},
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}
FieldTypeDescription
acknowledgementstringSucess/Failure
dataintegerenrollment ID
CodeDescription
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

FieldTypeDescription
orderType
required
integer1-course,
2-learning object,
3-learning-path etc.
orderData
required
JSON ArrayFilter Parameter:
1. user ID
2. Course ID
3. CurrencyCode
4. Price
5. paymentProvider will be 1
6. transactionRefNo
{
   "userId": [8],
   "courseId": 1124,
   "currencyCode": "INR",
   "price": "1",
   "transactionRefNo": "pay_Izj2XMQ5LxuJip",
   "paymentProvider": 1
}
{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": 14634,
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}
FieldTypeDescription
acknowledgementstringSucess/Failure
dataintegerenrollment ID
CodeDescription
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

FieldTypeDescription
firstRecord
required
integerFirst record to return. Default: 1
count
required
integerNumber of records to be returned from the first record
Default: 20, Max count limit: 100
qstringfilter 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": []
            }
        }
    }
}
FieldTypeDescription
courseCategoryIdintCategory ID
namestringCategory Name
courseCodestringCourse Code
sortNointegerposition
courseCountintegernumber of courses
statusbooleanActive/Inactive
totalRecordsintegerCount of records returned
CodeDescription
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

FieldTypeDescription
categoryId
required
integerA 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": []
            }
        }
    }
}
FieldTypeDescription
courseCategoryIdintCategory ID
namestringCategory Name
courseCodestringCourse Code
coursesJSON Arraycourse details
courseIdintegernumber of courses
titlestringcourse name
courseCodestringcourse unique code
CodeDescription
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

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
qstringfilter 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": []
            }
        }
    }
}
FieldTypeDescription
departmentIdintegerDepartment ID
namestringDepartment Name
statusintegerEnabled/Disabled
totalRecordsintegercount of records returned
CodeDescription
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

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
qstringfilter 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": []
            }
        }
    }
}
FieldTypeDescription
designationIdintegerDesignation ID
namestringDesignation Name
statusintegerEnabled/Disabled
totalRecordsintegercount of records returned
CodeDescription
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

FieldTypeDescription
stateId
required
integerState ID
qintegerSearch by city name
{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "cityList": [
                    {
                        "cityId": 1,
                        "name": "Bombuflat"
                    },                  
                ],
                "totalRecords": 1
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}
FieldTypeDescription
cityIdintegerCity ID
namestringCity Name
totalRecordsintegercount of records returned
CodeDescription
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

FieldTypeDescription
qstringinput search string
{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "countryList": [
                    {
                        "countryId": 1,
                        "countryCode": "AF",
                        "name": "Afghanistan"
                    },                  
                ],
                "totalRecords": 1
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}
FieldTypeDescription
countryIdintegerCountry ID
countryCodestringCountry code
namestringCountry Name
totalRecordsintegercount 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

FieldTypeDescription
firstRecord
required
integerFirst record to return. Default: 1
count
required
integerNumber of records to be returned from the first record
Default: 20, Max count limit: 100
qstringfilter 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": []
            }
        }
    }
}
FieldTypeDescription
blogIdintegerBlog ID
titlestringBlog Title
descriptionstringBlog Description
thumbnailstringBlog Image
statusbooleanActive/Inactive
totalRecordsintegerCount of records returned
CodeDescription
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

FieldTypeDescription
blogId
required
integerA 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": []
            }
        }
    }
}
FieldTypeDescription
blogIdintegerBlog ID
titlestringBlog Title
descriptionstringBlog Description
thumbnailstringBlog Image
statusbooleanActive/Inactive
CodeDescription
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

FieldTypeDescription
countryId
required
integerCountry ID
qintegerSearch by state name
{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "stateList": [
                    {
                        "stateId": 42,
                        "name": "Badakhshan"
                    }                  
                ],
                "totalRecords": 1
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}
FieldTypeDescription
stateIdintegerState ID
namestringState Name
totalRecordsintegercount of records returned
CodeDescription
1001 ‘Missing countryId’
1002 ‘Invalid countryId’

For general error details, click here.

General Errors

CodeDescription
-1Unknown error
2Processing failed due to technical fault
3Currently web service not available for provided input payment type
4System error occurred
5Incorrect access token format
6Access token expired
7Invalid access token
8Missing access token
9Access token belongs to another user
10Count limit is greater than expected
11Method not allowed
12Service not found
13Count should be greater than 0
14Missing reCaptchaToken
15Invalid reCaptchaToken
23You do not have permission to perform this action.