Skip to main content

Tag

Tag List​

Use this API to list all tags.

 GET /tag/list

Query string parameters​

FieldTypeDescription
firstRecord
required
integerFirst record to return. Default: 1
count
required
integerNumber of records to be returned from the first record Default: 20, Max count limit: 100
inUsebooleanIndicates if the tag is in use. 1-yes, 0-no
qstringfilter data by tag name
{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "tagList": [
                    {
                        "tagId": 3,
                        "name": "Cyber Security",
                        "status": "Active"
                    }
                ],
                "totalRecords": 1
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Tag Details - Courses​

Use this API to get a list of Courses that use a specific tag.

 GET /tag/{tagId}/detail

Path parameters​

FieldTypeDescription
tagId
required
integerA single tag ID
{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "tagId": 1,
                "name": "AWS",
                "courses": [
                    {
                        "courseId": 1117,
                        "title": "Test Course",
                        "courseCode": "0021",
                        "thumbnail": null
                    },
                    {
                        "courseId": 3,
                        "title": "HTM Validation.",
                        "courseCode": "101",
                        "thumbnail": "thumbnail.jpg"
                    }
                ]
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}