Course List
The API endpoint {{baseUrl}}/api/course/courses is a POST request that is used to retrieve a list of courses.
Request
-
Method: POST
-
Base URL: {{baseUrl}}
-
Path: /api/course/categories
-
Headers:
- Content-Type: application/x-www-form-urlencoded
Request Body
The request body for this endpoint is of type x-www-form-urlencoded.
-
idst(string): User ID -
auth(string): Authentication token. -
category(string): Category ID -
page(string): Page number to return -
limit(string): Number of records to return.
Response
Upon a successful execution of the request, the API returns a JSON response with a status code of 200. The courses key in the response contains an array of course objects. Each course object consists of the following fields:
-
course_id(string): The unique identifier for the course. -
code(string): The code associated with the course. -
course_name(string): The name of the course. -
course_description(string): The description of the course. -
course_box_description(string): The box description of the course. -
status(string): The status of the course. -
selling(string): The selling status of the course. -
price(string): The price of the course. -
subscribe_method(string): The method for subscribing to the course.-
0- Only Admin can subscribe users to the course -
1- Subscription requires admin approval -
2- Subscription is free to all
-
-
unsubscribe_method(string): The method for unsubscribing from the course.-
0- Only Admin can unsubscribe users to the course -
1- Unsubscription requires admin approval -
2- Unsubscription is free to all
-
-
course_edition(string): The edition of the course. -
course_type(string): The type of the course. -
can_subscribe(string): The subscription availability status.-
0- Subscription is closed -
1- Subscription is open at all times -
2- Subscription is open only when the current date is within the subscription start and end date set on the course (Key: sub_start_date sub_end_date
-
-
sub_start_date(string): The start date for subscription. -
sub_end_date(string): The end date for subscription. -
date_begin(string): The start date of the course. -
date_end(string): The end date of the course. -
course_link(string): The link to the course. -
img_course(string): The image associated with the course. -
category_id(string): The unique identifier for the category of the course. -
category(string): The category of the course. -
enrolled(string): The enrollment status of the course. -
dates(array): An array of dates associated with the course.
Each field in the courses response object represents a specific attribute of the course and is accompanied by its respective data type.
