Topics: Frontend

Login

Login

Login


Login by sending email and password

QueryArguments

email string An email of the user
password string A password of the user
Definition:

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

Example Request:

 curl -X POST \
  https://app.alphalearn.com/webapi/v1/login\
  -H 'authorization: Bearer {Authorization Token}' \

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

Announcement List

Announcement List

Announcements List


Retrieve announcement list

QueryArguments

pageSize Number of returned records in current api call
Definition:

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

Example Request:

 curl -X POST \
  https://app.alphalearn.com/webapi/v1/announcement-list\
  -H 'authorization: Bearer {Authorization Token}' \

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

FAQs list

FAQs list

FAQ list


Retrieve faq list

QueryArguments

pageSize Number of returned records in current api call
Definition:

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

Example Request:

 curl -X POST \
  https://app.alphalearn.com/webapi/v1/faq-list \
  -H 'authorization: Bearer {Authorization Token}' \

Example Response:

200 OK

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

Blog List

Blog List

Blog List


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

QueryArguments

No Query Arguments
Definition:

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

Example Request:

 curl -X POST \
  https://app.alphalearn.com/webapi/v1/blog-list\
  -H 'authorization: Bearer {Authorization Token}' \

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

Blog Details

Blog Details


Retrieve a single blog.

QueryArguments

blogID integer The blog id
totalCount Total number of records
pageSize Number of returned records in current api call
page Current page number of returned records
Definition:

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

Example Request:

 curl -X POST \
  https://app.alphalearn.com/webapi/v1/blog-details\
  -H 'authorization: Bearer {Authorization Token}' \
  -F blogID={blogID}

Example Response:

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

Testimonials List

Testimonials List

Testimonials List


Retrieve latest testimonials list

QueryArguments

totalCount Total number of records
pageSize Number of returned records in current api call
page Current page number of returned records
Definition:

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

Example Request:

 curl -X POST \
  https://app.alphalearn.com/webapi/v1/testimonials-list \
  -H 'authorization: Bearer {Authorization Token}' \

Example Response:

200 OK

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

Course Categories

Course Categories

Course Categories


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

QueryArguments

totalCount Total number of records
pageSize Number of returned records in current api call
page Current page number of returned records
Definition:

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

Example Request:

 curl -X POST \
  https://app.alphalearn.com/webapi/v1/course-category  \
  -H 'authorization: Bearer {Authorization Token}' \

Example Response:

200 OK
{
 "success": true,
    "data": {
        "examlist": [
            {
               "id": "integer",
               "parent_id": "integer",
               "name": "string"
            }, 
        ],
        "totalCount": "integer",
        "pageSize": "integer",
        "page": "integer"
        
    }
}

Course By Category

Course By Category

Course By Category


Retrieve course list based on single category.

QueryArguments

categoryID integer The category id
totalCount Total number of records
pageSize Number of returned records in current api call
page Current page number of returned records
Definition:

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

Example Request:

 curl -X POST \
  https://app.alphalearn.com/webapi/v1/course-list\
  -H 'authorization: Bearer {Authorization Token}' \
  -F categoryID={categoryID}

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