Subject

Subjects List

Use this API to list all subjects within a multi-subject course.

 GET /subject/{courseId}/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 name

Response

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "subjectList": [
                    {
                        "subjectId": 132,
                        "name": "Creative Thinking",
                        "subjectCode": "Sub 1"
                    },
                    {
                        "subjectId": 133,
                        "name": "Communication Skills",
                        "subjectCode": "Sub 2"
                    }
                ],
                "totalRecords": 2
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Field	Type	Description
subjectId	number	ID of the subject.
name	string	Name of the subject.
subjectCode	string	Code of the subject.
totalRecords	number	Total number of users.

Error Codes

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

For general error details, click here.