Category

Category List

Use this API to list all courses categories.

 GET /course-category/course-category-list

Query string parameters

Field	Type	Description
firstRecord required	integer	First record to return. Default: 1
count required	integer	Number of records to be returned from the first record Default: 20, Max count limit: 100
q	string	filter data by category name

Response

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "courseCategoryList": [
                    {
                        "courseCategoryId": 32,
                        "name": "Test",
                        "sortNo": 1,
                        "courseCount": 1,
                        "status": true
                    }
                ],
                "totalRecords": 1
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Field	Type	Description
courseCategoryId	int	Category ID
name	string	Category Name
courseCode	string	Course Code
sortNo	integer	position
courseCount	integer	number of courses
status	boolean	Active/Inactive
totalRecords	integer	Count of records returned

Error Codes

Code	Description
1003	"Invalid firstRecord"
1004	"Invalid count"

For general error details, click here.

Category Details

Use this API to get courses that belong to specific categories.

 GET /course-category/{categoryId}/detail

Path parameters

Field	Type	Description
categoryId required	integer	A single category ID

Response

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "courseCategoryId": 32,
                "name": "Test",
                "courses": [
                    {
                        "courseId": 6,
                        "title": "Social Entrepreneurship",
                        "courseCode": "SE1"
                    }
                ]
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Field	Type	Description
courseCategoryId	int	Category ID
name	string	Category Name
courseCode	string	Course Code
courses	JSON Array	course details
courseId	integer	number of courses
title	string	course name
courseCode	string	course unique code

Error Codes

Code	Description
1001	"Missing categoryId"
1003	"Invalid categoryId"

For general error details, click here.