NAnavigatr
Badge

Read Badge Criteria

Changed on

Get an array of criteria for a badge.

get/v1/badge/{badge_id}/criteria

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

external_idstring nullable
descriptionstring nullable
type'Application' | 'Assessment' | 'Award' | 'Badge' | 'Course' | 'Credential' | 'Education_Experience' | 'Leadership' | 'Member' | 'Participant' | 'Pathway' | 'Payment' | 'Portfolio' | 'Presenter' | 'Project' | 'Professional_Experience' | 'Schedule_Registration' | 'Volunteer' | 'Other'
external_urlstring nullable
badge_idinteger nullable
idinteger nullable

Example response

[
  {
    "external_id": "ABCD-EFG-HIJK-LMNOPQRS",
    "description": "Earners must have completed a three stage interview process before they can earn this badge.",
    "external_url": "https://apply.org"
  }
]

Changes

  • 4039d06e340bRevision changes
    • warning

      added the new Pathway enum value to the // response property for the response status

    • info

      api operation id read_badge_criteria_v1_badge__badge_id__criteria_get removed and replaced with badge_read_badge_criteria

    • 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

  • 6eb631bcc695Revision changes
    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

      response property items/id 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 string to no type for status

    • info

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

    • info

      removed the Application enum value from the / response property for the response status

    • info

      removed the Assessment enum value from the / response property for the response status

    • info

      removed the Award enum value from the / response property for the response status

    • info

      removed the Badge enum value from the / response property for the response status

    • info

      removed the Course enum value from the / response property for the response status

    • info

      removed the Credential enum value from the / response property for the response status

    • info

      removed the Education_Experience enum value from the / response property for the response status

    • info

      removed the Leadership enum value from the / response property for the response status

    • info

      removed the Member enum value from the / response property for the response status

    • info

      removed the Other enum value from the / response property for the response status

    • info

      removed the Participant enum value from the / response property for the response status

    • info

      removed the Payment enum value from the / response property for the response status

    • info

      removed the Portfolio enum value from the / response property for the response status

    • info

      removed the Presenter enum value from the / response property for the response status

    • info

      removed the Professional_Experience enum value from the / response property for the response status

    • info

      removed the Project enum value from the / response property for the response status

    • info

      removed the Schedule_Registration enum value from the / response property for the response status

    • info

      removed the Volunteer enum value from the / response property for the response status