Category
Category List
Use this API to list all Course 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
- Schema
- Error Codes
{
"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 | ID of the category |
name | string | Name of the category |
courseCode | string | Code associated with the category |
sortNo | integer | Position of the category |
courseCount | integer | Number of courses linked to the category |
status | boolean | Active/Inactive status of the category |
totalRecords | integer | Count of records returned |
Code | Description |
---|---|
1003 | "Invalid firstRecord" |
1004 | "Invalid count" |
For general error details, click here.
Course Category - Courses
Use this API to get a list of Courses that belong to a specific category.
GET /course-category/{categoryId}/detail
Path parameters
Field | Type | Description |
---|---|---|
categoryId required | integer | A single category ID |
- Response
- Schema
- Error Codes
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": {
"courseCategoryId": 32,
"name": "Test",
"courses": [
{
"courseId": 6,
"title": "Social Entrepreneurship",
"courseCode": "SE1"
}
]
},
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}
Field | Type | Description | |
---|---|---|---|
courseCategoryId | int | ID of the category | |
name | string | Name of the category | |
courseCode | string | Code associated with the category | |
courses | JSON Array | Details of the course | |
courseId | integer | ID of the course | |
title | string | Name of the course | |
courseCode | string | Code associated with the course |
Code | Description |
---|---|
1001 | "Missing categoryId" |
1003 | "Invalid categoryId" |
For general error details, click here.