Badges
Awarded Badge List
Use this API to list all badges awarded to a Trainee.
GET /badge/{userId}/get-awarded-badges Try now
Path parameters
| Field | Type | Description |
|---|---|---|
| userId required | integer | The user ID |
For general error details, click here.
- Response
- Schema
- Error Codes
{
"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": []
}
}
}
}
| Field | Type | Description |
|---|---|---|
| badgeList | array | Array of badge category objects. |
| label | string | Label describing the badge category. |
| data | array | Array of badge objects within the category. |
| badgeId | number | ID of the badge. |
| badgeName | string | Name of the badge. |
| onCompletionComment | string | Comment indicating the completion requirement. |
| issued | boolean | Indicates if the badge has been issued. |
| badgeUrl | string | URL to the badge image. |
| badgeReportId | number | ID of the badge report. |
Mark Awarded Badge as viewed
Use this API to mark an awarded badge as viewed by Trainee
GET /badge/{badgeReportId}/view-awarded-badge Try now
Path parameters
| Field | Type | Description |
|---|---|---|
| badgeReportId required | integer | A badgeReport ID |
For general error details, click here.
- Response
- Schema
- Error Codes
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": true,
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}
| Field | Type | Description |
|---|---|---|
| data | boolean | It will return true when badge marked as viewed. |
Trainee Badge List
Use this API to get a available badge list for a Trainee
GET /badge/{badgeReportId}/view-awarded-badge Try now
For general error details, click here.
- Response
- Schema
- Error Codes
{
"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": []
}
}
}
}
| Field | Type | Description |
|---|---|---|
| totalBadgeIssued | number | Total number of badges issued. |
| badgeList | array | Array of badge category objects. |
| label | string | Label describing the badge category. |
| data | array | Array of badge objects within the category. |
| badgeId | number | ID of the badge. |
| badgeName | string | Name of the badge. |
| onCompletionComment | string | Comment indicating the completion requirement. |
| issued | boolean | Indicates if the badge has been issued. |
| badgeUrl | string | URL to the badge image. |