This piece delves into the intricacies of the API designed for extracting badge details associated with an account. Leveraging this endpoint facilitates retrieving badge information in JSON format, encompassing all badges within the Adobe Learning Manager account. The response payload includes crucial details such as badge ID, image URL, name, and status. Discover the process of extracting badge information effortlessly with the GET badges endpoint in the ALM API.
-
- GET /badges
- Retrieves a list of badges for an account
- GET /badges
Implementation Notes
Get a list of all badges created for an account in your Adobe Learning Manager account.
-
-
- Example Response
-
{
“data”: [
{
“id”: “string”,
“type”: “string”,
“attributes”: {
“imageUrl”: “string”,
“name”: “string”,
“state”: “string”
}
}
]
}
Response Content-Type: application/vnd.api+json;charset=UTF-8
Curl
curl -X GET –header ‘Accept: application/vnd.api+json’ –header ‘Authorization: oauth 2fd8739cfe45ecd258732b601ad4fe8e20123’ ‘https://learningmanager.adobe.com/primeapi/v2/badges?page[offset]=0&page[limit]=10&sort=name’
Request URL
https://learningmanager.adobe.com/primeapi/v2/badges?page[offset]=0&page[limit]=10&sort=name
Response Body
{
“links”: {
“self”: “https://learningmanager.adobe.com/primeapi/v2/badges?page[offset]=0&page[limit]=10&sort=name”,
“next”: “https://learningmanager.adobe.com/primeapi/v2/badges?page[offset]=10&page[limit]=10&sort=name”
},
“data”: [
{
“id”: “1089752”,
“type”: “badge”,
“attributes”: {
“imageUrl”: “https://cpcontents.adobe.com/public/account/108079/accountassets/108079/badges/591-5916423_advanced-java-logo-png-transparent-png_ea61ef37364b427c9cba7d5e449dd482.png”,
“name”: “Advance Java”,
“state”: “Retired”
}
}
]
}
Response Code
200
Response Headers
{
“access-control-allow-credentials”: “true”,
“access-control-allow-headers”: “X-acap-all-roles, X-acap-account,X-acap-user,X-acap-caller-role,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type, x-experience-api-version, Authorization, X-CSRF-TOKEN, X-HTTP-Method-Override, X-acap-ug-manager-scope, X-acap-extension-token”,
“access-control-allow-methods”: “GET, POST, OPTIONS, PUT, HEAD, DELETE, PATCH”,
“access-control-expose-headers”: “Requested-Accept-Language, x-rate-limit, x-burst, x-excess-requests-per-second, Retry-After”,
“age”: “-1”,
“cache-control”: “no-cache, no-store, max-age=0, must-revalidate”,
“content-encoding”: “gzip”,
“content-type”: “application/vnd.api+json;charset=UTF-8”,
“date”: “Sun, 26 May 2024 14:02:32 GMT”,
“expires”: “-1”,
“pragma”: “no-cache”,
“requested-accept-language”: “en-US,en;q=0.9”,
“server”: “openresty”,
“server-timing”: “server_resp;dur=50”,
“strict-transport-security”: “max-age=31536000; includeSubDomains”,
“x-content-type-options”: “nosniff”,
“x-frame-options”: “SAMEORIGIN”,
“x-request-id”: “gwc34g45h23jd643beb6aff51dafdbfee443ea256c31233”,
“x-xss-protection”: “1”
}
Parameters
Parameter | Value | Description | Parameter Type | Data Type |
---|---|---|---|---|
Mention the starting range value of the records to be displayed in page | query | integer | ||
Mention the maximum number of records to be displayed per page. Max allowed is 10 | query | integer | ||
name (default) -name | Choose the type of sorting to be applied to the results. Sorting based on recommendation score will only be applicable for PRL enabled LOs | query | string | |
Mention badge ids for which data is being requested.Max allowed number of ids that can be included is 10 | query | Array[] |
Error Messages
——————————————————————————————————————————-
#how to extract badge list of ALM account using API #download using API #Json #retrieve badges API #list badges API #badge names #badge URL #badge image #badge status #badge deleted #badge retired
You must be logged in to post a comment.