NAnavigatr
Badge

Update Badge Alignment

Changed on

Update a specific badge alignment

Refused with a 422 when the alignment is the one the badge's qualification level manages: change the qualification level instead.

put/v1/badge/alignment/{alignment_id}

Request

Path parameters

alignment_idinteger required

Headers

X-Access-Tokenstring nullable

Request body

external_idstring nullable
namestring nullable
descriptionstring nullable
urlstring required
frameworkstring nullable
codestring nullable

Example request

{
  "external_id": "123-45678-90",
  "name": "Null Badging Standard - Example Layer",
  "description": "This badge has been mapped to the Example Layer of the Null Badging Standard"
}

Response

Successful Response

external_idstring nullable
namestring nullable
descriptionstring nullable
urlstring nullable
frameworkstring nullable
codestring nullable
idinteger nullable
badge_idinteger nullable

Example response

{
  "external_id": "123-45678-90",
  "name": "Null Badging Standard - Example Layer",
  "description": "This badge has been mapped to the Example Layer of the Null Badging Standard",
  "url": "https://Null_Badging/Example.org"
}

Changes

  • 5b575d75af2bRevision changes
    • breaking

      the response's property type changed from array to string for status

    • info

      the response's property default value Unprocessable data was added for the status

  • 4039d06e340bRevision changes
    • info

      api operation id update_badge_alignment_v1_badge_alignment__alignment_id__put removed and replaced with badge_update_badge_alignment

    • info

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

    • info

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

    • 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