NAnavigatr
Badge

Read Open Badge

Changed on

Retrieve a badge using the Open Badges Schema.

get/v1/badge/{badge_id}/open_badges

Request

  • Base URL
    https://api.navigatr.app (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL/v1/token

Path parameters

badge_idinteger required

Headers

X-Access-Tokenstring nullable

Response

Successful Response

@contextstring
typestring
idstring
namestring
descriptionstring
tagsstring[] nullable

Example response

{
  "id": "https://navigatr.app/badge/12345/Learn-Your-ABCs",
  "name": "Learn Your ABCs",
  "description": "This badge is awarded to earners who have demonstrated their knowledge of all letters of the English alphabet."
}

Changes

  • 4039d06e340bRevision changes
    • info

      api operation id read_open_badge_v1_badge__badge_id__open_badges_get removed and replaced with badge_read_open_badge

    • info

      added the new optional header request parameter X-Access-Token

    • info

      added the optional property /// to the response with the status

    • info

      the response's property default value changed from Unauthorized access to Insufficient permissions for the status

  • 6eb631bcc695Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      response property alignment list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property issuer/description list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property issuer/image list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property tags list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • info

      removed from the response property allOf list for the response status

    • info

      added subschema #2 to the response property anyOf list for the response status

    • info

      added subschema #2 to the response property anyOf list for the response status