Topics: Courses

Course List

Course List

Course List


List all courses for a company

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-list 

Example Request:

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

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

Course Basic Details

Course Basic Details


Retrieve a single course basic detail

QueryArguments

courseID integer The course id
Definition:

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

Example Request:

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

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

Course Details

Course Details


Retrieve single course details

QueryArguments

courseID integer The course id
Definition:

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

Example Request:

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

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 By Ratings

Course By Ratings

Course by Ratings


Course list according to ratings

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-by-ratings 

Example Request:

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

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 By Enrollments

Course by Enrollments


Course list according to enrollmets

QueryArguments

type integer type i.e 1 (for current enrollment) / 2 (for all enrollments)
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-by-enrollments

Example Request:

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

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