Skip to main content

Badges

Awarded Badge List​

Use this API to list all badges awarded to a Trainee.

 GET /badge/{userId}/get-awarded-badges

Path parameters​

FieldTypeDescription
userId
required
integerThe user ID
{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "badgeList": [
                    {
                        "label": "Activity Badges",
                        "data": [
                            {
                                "badgeId": 145,
                                "badgeName": "Activity Rookie",
                                "onCompletionComment": "2 Logins",
                                "issued": true,
                                "badgeUrl": "https://www.example.com/badge1.png",
                                "badgeReportId": 4868
                            }
                        ]
                    },
                    {
                        "label": "Assessment Badges",
                        "data": [
                            {
                                "badgeId": 154,
                                "badgeName": "Assessment Rookie",
                                "onCompletionComment": "2 Assessments",
                                "issued": true,
                                "badgeUrl": "https://www.example.com/badge2.png",
                                "badgeReportId": 4862
                            }
                        ]
                    }
                ]
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Mark Awarded Badge as viewed​

Use this API to mark an awarded badge as viewed by Trainee

 GET /badge/{badgeReportId}/view-awarded-badge

Path parameters​

FieldTypeDescription
badgeReportId
required
integerA badgeReport ID
{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": true,
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Trainee Badge List​

Use this API to get a available badge list for a Trainee

 GET /badge/{badgeReportId}/view-awarded-badge

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "totalBadgeIssued": 2,
                "badgeList": [
                    {
                        "label": "Activity Badges",
                        "data": [
                            {
                                "badgeId": 145,
                                "badgeName": "Activity Rookie",
                                "onCompletionComment": "2 Logins",
                                "issued": true,
                                "badgeUrl": "https://www.example.com/badge2.png"
                            },
                        ]
                    }
                ]
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}