API - Documentation

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://app.alphalearn.com/webapi/v1

The AlphaLearn API endpoint is pretty straight forward.The base URL is app.alphalearn.com followed by the version number of the API, currently at version 1.

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 companyID) in JSON format to auth/login API which will return you the jwt token and refresh token and user basic details.

WT token is valid for 50 min

Refresh token valid for 10 days

If the token expires use auth/refresh-token API using refresh-token as a post parameter to regenerate the token.

If the refresh token has expired please log out and call auth/login API again.

Course List

List all courses for a company

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/course-list

QUERY PARAMETERS

Field	Type	Description
pageSize	Integer	Number of records to be returned with in a single API call. Default is 20
page	Integer	Page number of the records.
allcourse	Integer	allcourse = 1, if courses belong to any category.

Example Response:

200 OK

{
          "success": true,
          "data": {
          "course_list": [
            {
                "id": "integer",
                "title": "string",
                "courseCode": "string",
                "thumbnail": "string",
                "description": "string",
                "price_INR": "integer",
                "price_USD": "integer",
                "start_date": "date",
                "end_date": "date",
                "updatedDate": "datetime",
                "department": "string",
                "designation": "string",
                "trainer_displayname": "string",
                "hidetrainername": "integer",
                "duration": "integer",
                "courseID": "string",
                "currency": [
                    {
                        "typeID": "integer",
                        "currencyCode": "string",
                        "price": "integer",
                        "isDefault": "integer"
                    },
                ]
            },
          ],
          "totalCount": "integer",
          "pageSize": "integer"
          "page": "integer",      
        }
      }

Course Basic Details

Retrieve a single course basic detail

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/course-basic-details

QUERY PARAMETERS

Field	Type	Description
courseID required	Integer	ID of a single course

Example Response:

200 OK

{
"success": true,
    "data": {
        "id": "integer",
        "title": "string",
        "courseCode": "string",
        "description": "string",
        "duration": "integer",
        "start_date": "date",
        "end_date": "date",
        "price_INR": "integer",
        "price_USD": "integer",
        "thumbnail": "string",
        "department": "integer",
        "designation": "integer",
        "faq": "string",
        "demovideo": "string",
        "features": "string",
        "trainer_displayname": "string",
        "tags": "string",
        "updatedDate": "datetime",
        "currency": [
        {
           "typeID": "integer",
           "currencyCode": "string",
           "price": "integer",
           "isDefault": "integer"
        },
        ],
        "countryCurrency": "string"
    }
}

Course Details

Retrieve single course details

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/course-all-details

QUERY PARAMETERS

Field	Type	Description
courseID required	Integer	Single course id

Example Response:

200 OK

{
"success": true,
    "data": {
        "id": "integer",
        "title": "string",
        "courseCode": "string",
        "description": "string",
        "duration": "integer",
        "start_date": "date",
        "end_date": "date",
        "price_INR": "integer",
        "price_USD": "integer",
        "thumbnail": "string",
        "department": "integer",
        "designation": "integer",
        "faq": "string",
        "demovideo": "string",
        "features": "string",
        "trainer_displayname": "string",
        "tags": "string",
        "updatedDate": "datetime",
        "seo": {
        "title": "string",
        "description": "string",
        "keywords": "string"
        },
        "currency": [
        {
            "typeID": "integer",
            "currencyCode": "string",
            "price": "integer",
            "isDefault": "integer"
        },
        ],
        "countryCurrency": "USD"
    }
}

Course by Enrollments

Course list according to enrollmets

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/course-by-enrollments

QUERY PARAMETERS

Field	Type	Description
type required	Integer	type i.e 1 (for current enrollment) / 2 (for all enrollments)
pageSize	Integer	Number of records to be returned with in a single API call. Default is 20
page	Integer	Page number of the records

Example Response:

200 OK

{
    "success": true,
    "data": [
        {
            "id": "integer",
            "title": "string",
            "courseCode": "integer",
            "description": "string",
            "duration": "integer",
            "start_date": "date",
            "end_date": "date",
            "price_INR": "integer",
            "price_USD": "integer",
            "thumbnail": "string",
            "department": "integer",
            "designation": "integer",
            "enrollmentcount": "integer",
            "currency": [
                {
                    "typeID": "integer",
                    "currencyCode": "string",
                    "price": "integer",
                    "isDefault": "integer"
                }
            ],
            "countryCurrency": "string"
        },
    ]
}

Course by Ratings

Course list according to ratings

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/course-by-ratings

QUERY PARAMETERS

Field	Type	Description
pageSize	Integer	Number of records to be returned with in a single API call. Default is 20
page	Integer	Page number of the records.

Example Response:

200 OK

{
    "success": true,
    "data": {
        "popular_courses": [
            {
                "id": "integer",
                "title": "string",
                "courseCode": "string",
                "description": "string",
                "duration": "integer",
                "start_date": "date",
                "end_date": "date",
                "price_INR": "integer",
                "price_USD": "integer",
                "thumbnail": "string",
                "rates": "integer",
                "currency": [
                    {
                        "typeID": "integer",
                        "currencyCode": "string",
                        "price": "integer",
                        "isDefault": "integer"
                    }
                ]
            }
        ],
        "totalCount": "integer",
        "pageSize": "integer",
        "page": "integer",
        "countryCurrency": "string"
    }
}

Register Trainee

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/tempsignup

QUERY PARAMETERS

Field	Type	Description
fname required	string	First name of the user
lname required	string	Last name of the user
email required	string	Email of the user
mobile required	Integer	Mobile number of the user
city	integer	City of the user
country	integer	Country of the user
state	integer	State of the user
zipcode	integer	Zipcode of the user
fromip	integer	IP address of the user. It should be a hidden field.
hpot	integer	A blank hidden input field in the registration form.

Example Response:

200 OK

{
    "success": true,
    "data": {
        "token": "string",
     }
}

Trainee List

List trainees in a company

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/trainee-list

QUERY PARAMETERS

Field	Type	Description
pageSize	Integer	Number of records to be returned with in a single API call. Default is 20
page	Integer	Page number of the records.

Example Response:

200 OK

{
    "success": true,
    "data": {
        "trainee_list": [
            {
                "id": "integer",
                "rollno": "string",
                "title": "string",
                "fname": "string",
                "lname": "string",
                "email": "string"
            },
        ],
        "totalCount": "integer",
        "pageSize": "integer",
        "page": "integer"
    }
}

Trainee Profile

Retrieve a single trainee basic details

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/trainee-profile

QUERY PARAMETERS

Field	Type	Description
userID required	Integer	The user id

Example Response:

200 OK

{
    "success": true,
    "data": {
        "id": "integer",
        "fname": "string",
        "lname": "string",
        "email": "string",
        "rollno": "string",
        "grade": "string",
        "companyname": "string",
        "workphone": "integer",
        "address": "string",
        "timezone": "string",
        "department": "string",
        "city": "string",
        "states": "string",
        "country": "string",
        "zip": "string",
        "zone": "string"
    }
}

Trainee Basic Details

Retrieve a single trainee basic details using its email ID

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/trainee-basic-details

QUERY PARAMETERS

Field	Type	Description
emailID required	string	The user email id

Example Response:

200 OK

{
    "success": true,
    "data": {
        "id": "integer",
        "fname": "string",
        "lname": "string",
        "email": "string",
        "rollno": "string",
        "grade": "string",
        "companyname": "string",
        "workphone": "integer",
        "address": "string",
        "timezone": "string",
        "department": "string",
        "city": "string",
        "states": "string",
        "country": "string",
        "zip": "string",
        "zone": "string"
    }
}

Trainee Details

Course list for a particular user who is logged in

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/trainee-details

QUERY PARAMETERS

Field	Type	Description
userID required	Integer	The user id

Example Response:

200 OK

{
    "success": true,
    "data": {
        "ongoing": [
            {
                "id": "integer",
                "title": "string",
                "courseCode": "string",
                "completedPercent": "integer",
                "startDate": "date",
                "endDate": "date",
                "isachived": "integer",
                "achivedDate": "datetime"
            }
        ],
        "expired": [
            {
                "title": "string",
                "courseCode": "integer",
                "completedPercent": "integer",
                "startDate": "date",
                "endDate": "date",
                "isachived": "integer",
                "achivedDate": "datetime"
            },
        ],
        "complted": [
            {
                "title": "string",
                "courseCode": "integer",
                "completedPercent": "integer",
                "startDate": "date",
                "endDate": "date",
                "isachived": "integer",
                "achivedDate": "datetime"
            },
        ],
        "learningpaths": [
            {
                "id": "integer",
                "name": "string",
                "title": "string",
                "courseCode": "integer",
                "completedPercent": "integer",
                "startDate": "date",
                "endDate": "date",
                "isachived": "integer",
                "achivedDate": "datetime"
            },
        ],
        "exam": [
            {
                "examTitle": "string",
                "duration": "integer",
                "total_questions": "integer",
                "total_marks": "integer",
                "passingMarks": "integer",
                "startDate": "date",
                "endDate": "date",
                "attemptDate": "datetime",
                "submitDate": "datetime",
                "scheduledon": "datetime",
                "status": "integer"
            },
        ]
    }
}

Update Trainee Profile

Update a single trainee basic details

HTTP REQUEST

GET https://app.alphalearn.com/webapi/v1/update-trainee-profile?userid=

QUERY PARAMETERS

Field	Type	Description
userID required	integer	The user id
fname required	string	Firstname of the user
lname required	string	Lastname of the user
mobile required	number	Contact number of the user
city required	integer	City of the user
country required	integer	Country of the user
state required	integer	State of the user
status required	integer	Status of the user

Example Response:

200 OK

{
    "success": true,
    "data": {
        "success": "User Updated."
    }
}

Enroll Trainee

Enroll a single trainee to a course.

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/enroll-trainee

QUERY PARAMETERS

Field	Type	Description
userID required	integer	The user id
courseID required	Integer	Single course id
startDate	string	Date should be greater than todays date. This will be considered as course start date.
sendMail	integer	To send email to trainee or not. 1 – Send email, 0 – Do not send email

Example Response:

200 OK

{
    "success": true,
    "data": {
        "success": "User enrolled"
    }
}

Unenroll Trainee

Un enroll a trainee from a course

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/unenroll-trainee

QUERY PARAMETERS

Field	Type	Description
userenrollID required	integer	The user enrollment id

Example Response:

200 OK

{
    "success": true,
    "data": {
        "success": "User unenrolled."
    }
}

Disable Trainee

Disable a trainee.

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/disable-trainee

QUERY PARAMETERS

Field	Type	Description
userID required	integer	The user id

Example Response:

200 OK

{
    "success": true,
    "data": {
        "success": "User disabled."
    }
}

Delete Trainee

Delete a trainee user

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/delete-trainee

QUERY PARAMETERS

Field	Type	Description
userID required	integer	The user id

Example Response:

200 OK

{
    "success": true,
    "data": {
        "success": "User deleted."
    }
}

Batch List

List all batches for a company

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/batch-list

QUERY PARAMETERS

Field	Type	Description
pageSize	Integer	Number of records to be returned with in a single API call. Default is 20
page	Integer	Page number of the records.

Example Response:

200 OK

{
    "success": true,
    "data": {
        "batch_list": [
            {
                "id": "integer",
                "name": "string",
                "description": "string"
            }
        ],
        "totalCount": "integer",
        "pageSize": "integer",
        "page": "integer"
    }
}

Courses in Batch

List all courses in a batch

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/courses-in-batch

QUERY PARAMETERS

Field	Type	Description
batchID required	Integer	The batch id
pageSize	Integer	Number of records to be returned with in a single API call. Default is 20
page	Integer	Page number of the records.

Example Response:

200 OK

{
    "success": true,
    "data": {
        "course_batch": [
            {
               "courseID": "integer",
               "title": "string",
               "startDate": "date",
               "endDate": "date"
            }
        ],
        "totalCount": "integer",
        "pageSize": "integer",
        "page": "integer",
    }
}

Trainees in Batch

List all trainees in a batch

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/trainees-in-batch

QUERY PARAMETERS

Field	Type	Description
batchID required	Integer	The batch id
pageSize	Integer	Number of records to be returned with in a single API call. Default is 20
page	Integer	Page number of the records.

Example Response:

200 OK

{
 "success": true,
    "data": {
        "user_batch": [
            {
               "id": "integer",
               "fname": "string",
               "lname": "string",
               "email": "string",
               "rollno": "string"
            }, 
        ],
        "totalCount": "integer",
        "pageSize": "integer",
        "page": "integer"
    }
}

Add Trainee to Batch

Add a single trainee to batch

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/trainees-in-batch

QUERY PARAMETERS

Field	Type	Description
batchID required	Integer	The batch id
userID required	Integer	The user id

Example Response:

200 OK

{
    "success": true,
    "data": {
        "success": "User added to batch"
    }
}

Exam List

List all exams for a company

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/exam-list

QUERY PARAMETERS

Field	Type	Description
pageSize	Integer	Number of records to be returned with in a single API call. Default is 20
page	Integer	Page number of the records.

Example Response:

200 OK

{
 "success": true,
    "data": {
        "examlist": [
            {
               "id": "integer",
               "examTitle": "string",
            }, 
        ],
        "totalCount": "integer",
        "pageSize": "integer",
        "page": "integer"
        
    }
}

Exam Details

Retrieve a single exam basic detail

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/exam-details

QUERY PARAMETERS

Field	Type	Description
examID required	Integer	The exam id

Example Response:

200 OK

{
"success": true,
    "data": [
        {
            "id": "integer",
            "courseID": "integer",
            "subjectID": "integer",
            "examTitle": "string",
            "period": "integer",
            "duration": "integer",
            "tquestion": "integer",
            "tmarks": "integer",
            "beoc": "integer",
            "startDate": "date",
            "passingMarks": "integer",
            "sequenceRandom": "integer",
            "examtypeMarks": "integer",
            "isAutomated": "integer",
            "status": "integer",
            "showResult": "integer",
            "noOfAttempts": "integer",
            "isreschbytrainee": "integer",
            "isprogresshundred": "integer",
            "appearAfter": "integer",
            "createdDate": "date",
            "updatedDate": "date",
            "reminder1": "integer",
            "reminder2": "integer",
            "eventrestriction": "integer",
            "eventcount": "integer"
        }
    ]
}

Login

HTTP REQUEST

POST https://app.alphalearn.com/webapi/auth/login

QUERY PARAMETERS

Field	Type	Description
email required	string	The email id of the user
password required	string	The password of the user
domainName required	string	The company custom domain

Example Response:

200 OK

{
    "success": true,
    "data": {
        "user": {
            "id": "integer",
            "title": "string",
            "fname": "string",
            "lname": "string",
            "mobile": "integer",
            "email": "string",
            "rollno": "string",
            "timezone": "string",
        },
        "token": "string",
        "refresh-token": "string",
    }

}

Regenerate Token

If token expires, regenerate token using refresh token

HTTP REQUEST

POST https://app.alphalearn.com/webapi/auth/refresh-token

QUERY PARAMETERS

Field	Type	Description
refresh-token required	string	Refresh token generated during login

Example Response:

200 OK

{
    "status": ok,
    "token": "string"
}

Forgot Password

Get an email with a reset password link.

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/forgot

QUERY PARAMETERS

Field	Type	Description
emailID required	string	Email address of the user

Example Response:

200 OK

{
    "success": "string",
}

Validate Token

Set new password for your account.

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/validate-token

QUERY PARAMETERS

Field	Type	Description
token required	string	reset password token
fs required	string	value should be one

Example Response:

200 OK

{
    "success": "true",
}

Reset Password

Set new password for your account.

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/reset

QUERY PARAMETERS

Field	Type	Description
password required	string	password of the user
confirmpassword required	string	send same password value

Example Response:

200 OK

{
    "success": "true",
}

Regenerate Token

List of courses in which trainee is enrolled.

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/my-courses

QUERY PARAMETERS

Field	Type	Description
page	integer	Page number of the records.

Example Response:

200 OK

{
    "success": true,
    "data": {
        "courses": [
            {
                "completedPercent": "integer",
                "id": "integer",
                "description": "string",
                "title": "string",
                "courseID": "integer",
                "faculty": "string",
                "createdDate": "date",
                "endDate": "date",
                "enrollmentstatus": "string"
            },
        ],
        "totalCount": "integer",
        "pageSize": "integer",
        "page": "integer"
    }
}

User Enrollment Status

Retrieve a single course basic detail along with enrollment status for a user

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/courseview?id=

Pass encrypted course id.

Example Response:

200 OK

{
"success": true,
    "data": {
        "id": "integer",
        "title": "string",
        "courseCode": "string",
        "description": "string",
        "duration": "integer",
        "start_date": "date",
        "end_date": "date",
        "price_INR": "integer",
        "price_USD": "integer",
        "thumbnail": "string",
        "department": "integer",
        "designation": "integer",
        "faq": "string",
        "demovideo": "string",
        "features": "string",
        "trainer_displayname": "string",
        "tags": "string",
        "updatedDate": "datetime",
        "enrollmentstatus": "string",
        "currency": [
        {
           "typeID": "integer",
           "currencyCode": "string",
           "price": "integer",
           "isDefault": "integer"
        },
        ],
        "countryCurrency": "string"
    }
}

Announcements List

Retrieve announcement list

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/announcement-list

QUERY PARAMETERS

Field	Type	Description
pageSize	Integer	Number of records to be returned with in a single API call. Default is 20
page	Integer	Page number of the records.

Example Response:

200 OK

{
    "success": true,
    "data": {
        "announcement": [
            {
                "id": "integer",
                "title": "string",
                "description": "string",
                "companyID": "integer",
                "createdDate": "datetime",
                "createdBy": "integer",
                "updatedDate": "datetime",
                "updatedBy": "integer",
                "status": "integer",
                "type": "integer",
                "siteID": "integer"
            }
        ]
    }
}

FAQ list

Retrieve faq list

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/faq-list

QUERY PARAMETERS

pageSize	Integer	Number of records to be returned with in a single API call. Default is 20
page	Integer	Page number of the records.

Example Response:

200 OK

{
    "success": true,
    "data": {
        "faq": [
            {
                "id": "integer",
                "question": "string",
                "answer": "string",
                "status": "integer",
                "companyID": "integer",
                "createdDate": "datetime",
                "updatedDate": "datetime",
                "createdBy": "integer",
                "updatedBy": "integer"
            }
        ]
    }
}

Blog List

List all blogs for a company. The list consist of 6 latest blogs and 6 old blogs.

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/blog-list

QUERY PARAMETERS

Field	Type	Description
No Query Arguments

Example Response:

200 OK

{
    "success": true,
    "data": {
        "latest": [
            {
                "id": "integer",
                "title": "string",
                "description": "string",
                "name": "string",
                "createdDate": "date",
                "image": "string"
            }
        ],
        "old": [
            {
                "id": "integer",
                "title": "string",
                "description": "string",
                "name": "string",
                "createdDate": "date",
                "image": "string"
            }
        ],
    }
}

Blog Details

Retrieve a single blog.

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/blog-details

QUERY PARAMETERS

Field	Type	Description
blogID required	Integer	The blog id

Example Response:

200 OK

{
    "success": true,
    "data": {
                "id": "integer",
                "title": "string",
                "description": "string",
                "name": "string",
                "createdDate": "date",
                "image": "string"
    }
}

Testimonials List

Retrieve latest testimonials list

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/testimonials-list

QUERY PARAMETERS

Field	Type	Description
No Query Arguments

Example Response:

200 OK

{
    "success": true,
    "data":{
       "testimonials": [
         {     
            "id": "integer",
            "description": "string",
            "createdDate": "date",
            "updatedDate": "date",
            "createdBy": "integer",
            "updatedBy": "integer",
            "status": "integer"
        },
     ]
  }
}

Course Categories

List all categories for a company. Courses can be linked to a particular category.

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/course-category

QUERY PARAMETERS

Field	Type	Description
pageSize	Integer	Number of records to be returned with in a single API call. Default is 20
page	Integer	Page number of the records.

Example Response:

200 OK

{
 "success": true,
    "data": {
        "category": [
            {
               "id": "integer",
               "parent_id": "integer",
               "name": "string",
               "totalCourses": "integer"
            }, 
        ],
        "totalCount": "integer",
        "pageSize": "integer",
        "page": "integer"
        
    }
}

Course By Category

Retrieve course list based on single category.

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/course-list

QUERY PARAMETERS

Field	Type	Description
categoryID required	Integer	The category id
pageSize	Integer	Number of records to be returned with in a single API call. Default is 20
page	Integer	Page number of the records.

Example Response:

200 OK

{
          "success": true,
          "data": {
          "course_list": [
            {
                "id": "integer",
                "title": "string",
                "courseCode": "string",
                "thumbnail": "string",
                "description": "string",
                "price_INR": "integer",
                "price_USD": "integer",
                "start_date": "date",
                "end_date": "date",
                "updatedDate": "datetime",
                "department": "string",
                "designation": "string",
                "trainer_displayname": "string",
                "hidetrainername": "integer",
                "duration": "integer",
                "courseID": "string",
                "currency": [
                    {
                        "typeID": "integer",
                        "currencyCode": "string",
                        "price": "integer",
                        "isDefault": "integer"
                    },
                ]
            },
          ],
          "totalCount": "integer",
          "pageSize": "integer"
          "page": "integer",    
          "countryCurrency": "string" 
        }
      }

RazorPay Transaction

This API will capture transaction details and enroll trainee to a particular course.

RazorPay allows you to pass notes. In notes pass reference as “reference” and fieldname value as UID/{userID}/CID/{courseID}/NOL/0/SD/{courseStartDate}/ED/{courseEndDate} also pass description as “Course Enrollment”

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/transaction

QUERY PARAMETERS

Field	Type	Description
razorpay_payment_id required	integer	RazorPay payment ID after successful payment.

Example Response:

200 OK

{
    "success": true,
    "data": {
                "transactionID": "integer",
                "orderID": "integer",
                "courseID": "integer"
        ],
    }
}

Transaction History

List order summary details

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/transactionhistory

QUERY PARAMETERS

Field	Type	Description
transactionID	integer	RazorPay transaction ID

Example Response:

200 OK

{
    "success": true,
    "data": {
        "transaction": {
            "id": "integer",
            "paymentID": "string",
            "amount": "integer",
            "currency": "string",
            "status": "string",
            "orderID": "string",
            "method": "string",
            "description": "string",
            "bank": "string",
            "wallet": "string",
            "vpa": "string",
            "email": "string",
            "contact": "integer",
            "userID": "integer",
            "userEnrollmentIDlist": "string",
            "courseID": "integer",
            "trainingprogramrequestID": "integer",
            "noLicense": "integer",
            "startDate": "date",
            "endDate": "date",
            "serviceTax": "",
            "createdDate": "datetime",
            "receipt": "3",
            "type": "1",
        "courses": {
                "id": "integer",
                "title": "string",
                "courseCode": "string",
                "description": "string",
                "duration": "integer",
                "start_date": "date",
                "end_date": "date",
                "price_INR": "integer",
                "price_USD": "integer",
                "thumbnail": "string",
                "department": "integer",
                "designation": "integer",
                "faq": "string",
                "demovideo": "string",
                "features": "string",
                "trainer_displayname": "string",
                "tags": "string",
                "updatedDate": "datetime",
                "seo": {
                "title": "string",
                "description": "string",
                "keywords": "string"
            }
        },
        "totalCount": "1"
    }
}

Get Company Details

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/get-company-info

QUERY PARAMETERS

Field	Type	Description
email required	string	API user email address
domain required	string	S3 domain name or Custom domain

Example Response:

200 OK

{
    "success": true,
    "data": {
        "id": "integer",
        "name": "string",
     }
}

Country List

List all countries

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/country

QUERY PARAMETERS

Field	Type	Description
No Parameter

Example Response:

200 OK

{
          "success": true,
          "data": {
            {
                "id": "integer",
                "name": "string",
            },      
        }
      }

State List

List all states

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/states

QUERY PARAMETERS

Field	Type	Description
countryID	integer	The country id which passed to get particular country state list.

Example Response:

200 OK

{
          "success": true,
          "data": {
            {
                "id": "integer",
                "name": "string",
            },      
        }
      }

City List

List all states

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/cities

QUERY PARAMETERS

Field	Type	Description
stateID	integer	The state id which used to get particular state’s city list.

Example Response:

200 OK

{
          "success": true,
          "data": {
            {
                "id": "integer",
                "name": "string",
            },      
        }
      }

Zoom Webinar List

List all webinars for a company.

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/zoom-webinars

QUERY PARAMETERS

Field	Type	Description
status	integer	Status of webinar
	3 – completed, 2 – upcoming
title	string	name of webinar
courseID	integer	ID of a related course
group	string	For unique webinars group only those webinar whos enrollment = Enroll trainees to all occurrences
pageSize	Integer	Number of records to be returned with in a single API call. Default is 20
page	Integer	Page number of the records.

Example Response:

200 OK

{
    "success": true,
     "data": {
        "course_list": [
            {
                "id": "integer",
                "title": "string",
                "courseCode": "string",
                "thumbnail": "string",
                 "description": "string",
                "price_inr": "integer",
                "price_USD": "integer",
                "start_date": "date",
                "end_date": "date",
                "updatedDate": "datetime",
                "department": "string",
                "designation": "string"
            },  
    ],
        "totalCount": "integer",
        "pageSize": "integer"
        "page": "integer",      
   }
}

Zoom Webinar Details

Retrive single webinars details.

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/zoom-webinar-details

QUERY PARAMETERS

Field	Type	Description
id required	integer	The id of the webinar

Example Response:

200 OK

{
    "success": true,
    "data": {
        "id": "integer",
        "topic": "string",
        "code": "string",
        "start_time": "datetime",
        "duration": "integer",
        "timezone": "string",
        "enrollmentlimit": "integer",
        "agenda": "string",
        "host_video": "integer",
        "panelists_video": "integer",
        "practice_session": "integer",
        "hd_video": "integer",
        "approval_type": "integer",
        "auto_recording": "string",
        "display_recording": "integer",
        "enforce_login": "integer",
        "show_share_button": "integer",
        "allow_multiple_devices": "integer",
        "webinarId": "integer",
        "uuid": "string",
        "host_id": "string",
        "start_url": "string",
        "join_url": "string",
        "panelist_id": "integer",
        "panelist_name": "string",
        "panelist_email": "string",
        "panelist_join_url": "string",
        "thumbnail": "string",
        "passcode": "string",
        "is_recurring": "integer",
        "re_type": "integer",
        "type": "integer",
        "registration_type": "integer",
        "re_repeat_interval": "integer",
        "re_weekly_days": "integer",
        "re_monthly_type": "integer",
        "re_monthly_day": "integer",
        "re_monthly_week": "integer",
        "re_monthly_week_day": "integer",
        "re_enddate_type": "integer",
        "re_end_times": "integer",
        "re_end_date_time": "date",
        "occurrence_id": "integer",
        "price": "integer",
        "priceDoller": "integer",
        "description_frontend": "string",
        "status": "integer",
        "attendance_marked": "integer",
        "totalEnrolled": "integer",
        "configEmail": "string",
        "webinarStatus": "integer",
        "course": {
            "courseID": "integer",
            "title": "string"
        }
    }
}

Enroll a trainee in Zoom Webinar

Enroll a trainee to a single webinar.

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/zoom-webinar-enroll

QUERY PARAMETERS

Field	Type	Description
id required	integer	The id of the webinar
userID required	integer	The id of the trainee
sendMail	integer	To send email to trainee or not. 1 – Send email, 0 – Do not send email

Example Response:

200 OK

{
    "success": true,
    "data": {
        "message": "Successfully Enrolled",
        "enrollment": {
            "id": "integer",
            "userID": "integer",
            "webinarID": "integer",
            "occurrence_id": "integer",
            "registrant_id": "string",
            "join_url": "string"
        }
    }
}

Course List

To get the course list you need to make a POST call to the following url :
https://app.alphalearn.com/webapi/v1/course-list

QUERY PARAMETERS

Field	Type	Description
totalCount	Integer	Total number of records
pageSize	Integer	Number of returned records in current api call
page	Integer	Current page number of returned records

Example Response:

200 OK

{
      "success": true,
      "data": {
      "course_list": [
      {
        "id": "integer",
        "title": "string",
        "courseCode": "string",
        "thumbnail": "string",
        "companyID": "integer",
        "description": "string",
        "price_inr": "integer",
        "price_USD": "integer",
        "start_date": "date",
        "end_date": "date",
        "updatedDate": "datetime",
        "department": "string",
        "designation": "string"
      },  
      ],
      "totalCount": "integer",
      "pageSize": "integer"
      "page": "integer",      
    }
  }

Errors

The Westeros API uses the following error codes:

Error Code	Meaning
X000	Some parameters are missing. This error appears when you don't pass every mandatory parameters.
X001	Unknown or unvalid `secret_key`. This error appears if you use an unknow API key or if your API key expired.
X002	Unvalid `secret_key` for this domain. This error appears if you use an API key non specified for your domain. Developper or Universal API keys doesn't have domain checker.
X003	Unknown or unvalid user `token`. This error appears if you use an unknow user `token` or if the user `token` expired.