Category List

Use this API to list a all courses categories.

 

HTTP REQUEST

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
{
    "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": []
            }
        }
    }
}
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
Code Description
1003 ‘Invalid firstRecord’
1004 ‘Invalid count’

For general error details, click here.