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 }

Example:

The example is in PHP.

Course List

List all courses for a company

HTTP REQUEST

POST 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",      
        }
      }

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 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": "float",
        "price_USD": "float",
        "thumbnail": "string",
        "department": "string",
        "designation": "string",
        "faq": "string",
        "demovideo": "string",
        "features": "string",
        "trainer_displayname": "string",
        "tags": "strings",
        "updatedDate": "datetime"
     }
}

Course Details

Retrieve single course details

HTTP REQUEST

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

QUERY PARAMETERS

Field Type Description
courseID 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": "float",
        "price_USD": "float",
        "thumbnail": "string",
        "department": "string",
        "designation": "string",
        "faq": "string",
        "demovideo": "",
        "features": "string",
        "trainer_displayname": "string",
        "tags": "string",
        "updatedDate": "datetime",
        "seo": {
            "title": "string",
            "description": "string",
            "keywords": "string"
        }
     }
}

Course Modules

List of all course modules with list of course documents in each module.

HTTP REQUEST

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

QUERY PARAMETERS

Field Type Description
courseID Integer Single course id
subjectID Integer Course subject id
enrollmentID Integer The user enrollment id

Example Response:

200 OK
{
    "success": true,
    "data": {
        "modules": [
            {
                "chapterID": "integer",
                "module": "string",
                "modaltitle": "string",
                "modaldescription": "string",
                "isSequenceDate": "boolean",
                "courseDocuments": [
                    {
                        "doccontent": "string",
                        "checked": "boolean",
                        "documentID": "integer",
                        "documentTypeID": "integer",
                        "disableDocument": "boolean",
                        "icon": "string",
                        "color": "string"
                    }, 
                ]
            },  
    ],     
   }
}

Course Module View

Returns course ga chapter event and enrollment id.

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/module-view

QUERY PARAMETERS

Field Type Description
courseID Integer Single course id
enrollmentID Integer The user enrollment id

Example Response:

200 OK
{
    "success": true,
    "data": {
        "content": {
            "gachapterevent": "string",
            "encEnrollmentID": "string"
        }     
   }
}

Course Document View

Returns course document details.

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/document-view

QUERY PARAMETERS

Field Type Description
documentID integer The course document id.
enrollmentID integer The user enrollment id.

Example Response:

200 OK
{
    "success": true,
    "data": {
        "coursedocument": {
            "id": "integer",
            "version": "integer",
            "name": "string",
            "description": "string",
            "documentTypeID": "integer",
            "chapterID": "integer",
            "secure": "integer",
            "effectonprogress": "integer",
            "enrollmentID": "integer",
            "done": "boolean",
            "courseID": "integer",
            "subjectID": "integer",
            "gachapterevent": "string",
            "gadocumentevent": "string"
        },
        "url": "string"
    }     
   }
}

Update Course Document Status

Updates single course document status.

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/update-document-status

QUERY PARAMETERS

Field Type Description
documentID integer The course document id.
enrollmentID integer The user enrollment id.
courseID integer The course id.
subjectID integer The course subject id.
docStatus string pending/open

Example Response:

200 OK
{
    "success": true,
    "data": {
        "success": "Course document status updated."
    }
}

Poll Answer

Submit user poll answer

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/poll-answer

QUERY PARAMETERS

Field Type Description
documentID integer The course document id.
enrollmentID integer The user enrollment id.
userAnswer integer The user answer

Example Response:

200 OK
{
    "success": true,
    "data": {
        "flag": true
    }
}

Assessment Answer

Submit user assessment answer

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/user-answer

QUERY PARAMETERS

Field Type Description
documentID integer The course document id.
enrollmentID integer The user enrollment id.
userAnswer integer The user answer
questionID integer The question id
Note: if question single_multiple = 2 userAnser must be array.

Example Response:

200 OK
{
    "success": true,
    "data": {
        "answer": "integer",
        "correct": "boolean"
    }
}

Survey Answer

Submit user survey answer

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/survey-answer

QUERY PARAMETERS

Field Type Description
documentID integer The course document id.
enrollmentID integer The user enrollment id.
userAnswer integer The user answer
questionID integer The question id
Note: if question single_multiple = 2 userAnser must be array.

Example Response:

200 OK
{
    "success": true,
    "data": {
        "answer": "integer",
        "correct": "boolean"
    }
}

Reset Practice Test or Assessment

Reset individual trainee practice test or assessment.

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/reset-practice-assessment

QUERY PARAMETERS

Field Type Description
documentID integer The course document id.
enrollmentID integer The user enrollment id.
subjectID integer The course subject id

Example Response:

200 OK
{
    "success": true,
    "data": {
        "percent": "integer",
        "assignment": "boolean",
        "coursedocid": "integer"
    }
}

Reset Assignment

Reset individual trainee assignment.

HTTP REQUEST

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

QUERY PARAMETERS

Field Type Description
evaluateID integer The evaluation id.

Example Response:

200 OK
{
    "success": true,
    "data": {
       "flag": "boolean"
    }
}

Reschedule Assigment

Reschedule individual trainee assignment.

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/reschedule-assignment

QUERY PARAMETERS

Field Type Description
evaluateID integer The evaluation id.

Example Response:

200 OK
{
    "success": true,
    "data": {
       "flag": "boolean"
    }
}

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
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": {
        "popular_courses": [
            {
                "id": "integer",
                "title": "string",
                "courseCode": "string",
                "description": "string",
                "duration": "integer",
                "start_date": "date",
                "end_date": "date",
                "price_INR": "float",
                "price_USD": "float",
                "thumbnail": "string",
                "rates": "integer"
            },
        ],
        "totalCount": "integer",
        "pageSize": "integer",
        "page": "integer"
    }
}

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 Integer type i.e 1 (for current enrollment) / 2 (for all enrollments)
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":  [
            {
                "id": "integer",
                "title": "string",
                "courseCode": "string",
                "description": "string",
                "duration": "integer",
                "start_date": "date",
                "end_date": "date",
                "price_INR": "float",
                "price_USD": "float",
                "thumbnail": "string",
                "department": "string",
                "designation": "string",
                "enrollmentcount": "string"
            }
        ]
}

Register Trainee

Register as a new trainee

HTTP REQUEST

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

QUERY PARAMETERS

Field Type Description
fname string First name of the user
lname Integer Last name of the user
mobile Integer Mobile number of the user
email string Email of the user

Example Response:

200 OK
{
    "success": true,
    "data": {
        "user": {
            "id": "integer",
            "title": "string",
            "fname": "string",
            "lname": "string",
            "mobile": "9664131394",
            "email": "string",
            "password": "string",
            "auth_key": "string",
            "password_reset_token": "string",
            "password_reset_date": "date",
            "rollno": "string",
            "department": "string",
            "designation": "string",
            "grade": "string",
            "state": "integer",
            "companyname": "string",
            "subcompanyID": "integer",
            "companyManagerID": "integer",
            "workphone": "string",
            "address": "string",
            "city": "string",
            "zip": "string",
            "country": "string",
            "companyID": "integer",
            "roleID": "integer",
            "createdBy": "integer",
            "createdDate": "date",
            "updatedDate": "date",
            "status": "integer",
            "gstno": "string",
            "sessionID": "string"
        },
    }
}

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 integer The user id
courseID Integer Single course id
startDate string Date should be greater than todays date.

Example Response:

200 OK
{
    "success": true,
    "data": {
        "success": "Trainee enrolled"
    }
}

Trainee List

List trainees in a company

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/trainee-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": {
        "user_list": [
            {
                "id": "integer",
                "rollno": "integer",
                "title": "string",
                "fname": "string",
                "lname": "string",
                "email": "string"
            },
      ],
        "totalCount": "integer",
        "page": "integer",
        "pageSize": "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 Integer The user id
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": [
        {
        "id": "integer",
        "fname": "string",
        "lname": "string",
        "email": "string",
        "rollno": "intger",
        "grade": "string",
        "companyname": "string",
        "workphone": "intger",
        "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
email string The user email id
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": [
        {
        "id": "integer",
        "fname": "string",
        "lname": "string",
        "email": "string",
        "rollno": "intger",
        "grade": "string",
        "companyname": "string",
        "workphone": "intger",
        "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
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": {
        "ongoing": [
            {
                "title": "string",
                "courseCode": "string",
                "completedPercent": "integer",
                "startDate": "date",
                "endDate": "date",
                "isachived": "integer",
                "achivedDate": "datetime"
            }
        ],
        "expired": [
            {
                "title": "string",
                "courseCode": "string",
                "completedPercent": "integer",
                "startDate": "date",
                "endDate": "date",
                "isachived": "integer",
                "achivedDate": "datetime"
            }
        ],
        "complted": [
            {
                "title": "string",
                "courseCode": "string",
                "completedPercent": "string",
                "startDate": "date",
                "endDate": "date",
                "isachived": "integer",
                "achivedDate": "datetime"
            }
        ],
        "learningpaths": {
            "learningpath_name": [
                {
                    "id": "integer",
                    "name": "string",
                    "code": "string",
                    "title": "string",
                    "courseCode": "string",
                    "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

POST https://app.alphalearn.com/webapi/v1/user-update?userid=

QUERY PARAMETERS

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

Example Response:

200 OK
{
    "success": true,
    "data": {
        "success": "User details Updated."
    }
}

Delete Trainee

Delete a trainee user

HTTP REQUEST

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

QUERY PARAMETERS

Field Type Description
userID integer The user id

Example Response:

200 OK
{
    "success": true,
    "data": {
        "success": "Trainee deleted."
    }
}

Disable Trainee

Disable a trainee.

HTTP REQUEST

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

QUERY PARAMETERS

Field Type Description
userID integer The user id

Example Response:

200 OK
{
    "success": true,
    "data": {
        "success": "Trainee disabled."
    }
}

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 integer The user enrollment id

Example Response:

200 OK
{
    "success": true,
    "data": {
        "success": "Trainee unenrolled."
    }
}

Batch List

List all batches for a company

HTTP REQUEST

POST https://app.alphalearn.com/webapi/v1/batch-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": {
        "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 Integer The batch id
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_batch": [
            {
               "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 Integer The batch id
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": {
        "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 Integer The batch id
userID 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
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": {
        "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 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

Retrieve a single exam basic detail

HTTP REQUEST

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

QUERY PARAMETERS

Field Type Description
email string The email id of the user
password string The password of the user

Example Response:

200 OK
{
    "success": true,
    "data": {
        "user": {
            "id": "integer",
            "title": "string",
            "fname": "string",
            "lname": "string",
            "mobile": "9664131394",
            "email": "string",
            "password": "string",
            "auth_key": "string",
            "password_reset_token": "string",
            "password_reset_date": "date",
            "rollno": "string",
            "department": "string",
            "designation": "string",
            "grade": "string",
            "state": "integer",
            "companyname": "string",
            "subcompanyID": "integer",
            "companyManagerID": "integer",
            "workphone": "string",
            "address": "string",
            "city": "string",
            "zip": "string",
            "country": "string",
            "roleID": "integer",
            "createdBy": "integer",
            "createdDate": "date",
            "updatedDate": "date",
            "status": "integer",
            "gstno": "string",
            "sessionID": "string"
        },
        "enrollmentstatus": "string",
        "showMyOrder": "boolean"
    }
}

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 returned records in current api call

Example Response:

200 OK
{
    "success": true,
    "data":{
        "announcement": [
           {
                "id": "integer",
                "title": "New  ISO Course Launched",
                "description": "Course ISO 22000 Food Safety Management 
                                System has been launched.Enrollment will 
                                begin from 1st June 2019.",
                "createdDate": "date",
                "createdBy": "integer",
                "updatedDate": "date",
                "updatedBy": "integer",
                "status": "integer"
          },
      ]
   }
}

FAQ list

Retrieve faq list

HTTP REQUEST

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

QUERY PARAMETERS

Field Type Description
pageSize integer Number of returned records in current api call

Example Response:

200 OK
{
    "success": true,
    "data":{
        "faq": [
           {
             "id": "integer",
             "question": "string",
             "status": "integer",
             "createdDate": "date",
             "updatedDate": "date",
             "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 Integer The blog id
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": {
                "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
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":{
       "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
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": {
        "category": [
            {
               "id": "integer",
               "parent_id": "integer",
               "name": "string"
            }, 
        ],
        "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 Integer The category id
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",
                 "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 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
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",
                 "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 integer The id of the webinar

Example Response:

200 OK
{
    "success": true,
    "data": {
        "id": "1971",
        "topic": "HR - Analytics",
        "code": "HR - 0010-20",
        "start_time": "2021-06-02 10:00:00",
        "duration": "120",
        "timezone": "Asia/Calcutta",
        "enrollmentlimit": "100",
        "agenda": "Start using data to drive better, fact-based, people-decisions that ultimately benefit both the organization and its employees.",
        "host_video": "1",
        "panelists_video": "1",
        "practice_session": "1",
        "hd_video": "1",
        "approval_type": "0",
        "auto_recording": "none",
        "display_recording": "0",
        "enforce_login": "1",
        "show_share_button": "1",
        "allow_multiple_devices": "1",
        "webinarId": "86367763868",
        "uuid": "cBH1uWbBSG2fPtlU3ruYFQ==",
        "host_id": "7WU5z5WIR4aKmFvbyWbwGQ",
        "start_url": "https://us02web.zoom.us/s/86367763868?zak=eyJ6bV9za20iOiJ6bV9vMm0iLCJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjbGllbnQiLCJ1aWQiOiI3V1U1ejVXSVI0YUttRnZieVdid0dRIiwiaXNzIjoid2ViIiwic3R5IjoxMDAsIndjZCI6InVzMDIiLCJjbHQiOjAsInN0ayI6IlZfSXdES1Rja1VyQ0toSlVsb2xZeExZSk82WGtJa0x6Q2dqaHFTTlJsREEuQmdZZ1FsaDBjVzl1ZFVkUWVHa3JZV3hRZEdSdGVETmFSMVpPZFRWcVFUZG1halpBWmpRNVpEa3lNV1ZtWkRFMVpHVmlOamszTURCaVpqUmhZekEwTlRJNU5qUmxPR0UzWlRBeU16a3lZbVE0WldFeU1qa3dNVEl4WmpRM1lXWm1ZVFk1WlFBZ2NGb3lVRmRpSzAxSlRqSnhXblZZVlVscVNXVlNOVE50ZW05V2RTdHJUMlVBQkhWek1ESUFBQUY0aHNicExnQVNkUUFBQUEiLCJleHAiOjE2MTcxNzYwODYsImlhdCI6MTYxNzE2ODg4NiwiYWlkIjoiX1E0YjNNV0tUa1NZcjlpcVpVc21WdyIsImNpZCI6IiJ9.CWIIawZpl2IHai7DGjsLCNWn1pYgzaaiQgy6sRgfZuA",
        "join_url": "https://us02web.zoom.us/j/86367763868",
        "panelist_id": "",
        "panelist_name": "",
        "panelist_email": "",
        "panelist_join_url": "",
        "thumbnail": "https://s3.ap-south-1.amazonaws.com/test.alphalearn.com/cElGbkQyUENEVk09/webinars/zoom_1622537586.jpg",
        "passcode": "",
        "is_recurring": "1",
        "re_type": "2",
        "type": "0",
        "registration_type": "1",
        "re_repeat_interval": "1",
        "re_weekly_days": "",
        "re_monthly_type": "1",
        "re_monthly_day": "1",
        "re_monthly_week": "1",
        "re_monthly_week_day": "1",
        "re_enddate_type": "1",
        "re_end_times": "7",
        "re_end_date_time": "2021-08-31",
        "occurrence_id": "1622608200000",
        "price": null,
        "priceDoller": null,
        "description_frontend": "",
        "status": "0",
        "attendance_marked": "0",
        "totalEnrolled": "2",
        "configEmail": "john.doe@gmail.com",
        "webinarStatus": "2",
        "course": {
            "courseID": "3",
            "title": "Human Resource Management"
        }
    }
}

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 integer The id of the webinar
userID integer The id of the trainee
sendMail integer This parameter is used to send mail. If set to “1” mails will be sent.

Example Response:

200 OK
{
    "success": true,
    "data": {
        "message": "Successfully Enrolled",
        "enrollment": {
            "id": "82747",
            "userID": "53483",
            "webinarID": "86367763868",
            "occurrence_id": "1622608200000",
            "registrant_id": "2FAeGXPXQ_eLYWI8tA82lA",
            "join_url": "https://us02web.zoom.us/w/86367763868?tk=X1SRMdYdRCNqosPbh11-Dojsywss0YwWBcHxmQkM-7g.DQIAAAAUG-t9nBYyRkFlR1hQWFFfZUxZV0k4dEE4MmxBAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
        }
    }
}