Open Badges Specification v2.1: JSON Schema Files 2.1 Final Release

Date Issued:	November 27, 2023
Status:	This is an informative 1EdTech document that may be revised at any time.

IPR and Distribution Notice

Recipients of this document are requested to submit, with their comments, notification of any relevant patent claims or other intellectual property rights of which they may be aware that might be infringed by any implementation of the specification set forth in this document, and to provide supporting documentation.

1EdTech takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on 1EdTech's procedures with respect to rights in 1EdTech specifications can be found at the 1EdTech Intellectual Property Rights webpage: http://www.imsglobal.org/ipr/imsipr_policyFinal.pdf .

Use of this specification to develop products or services is governed by the license with 1EdTech found on the 1EdTech website: http://www.imsglobal.org/speclicense.html.

Permission is granted to all parties to use excerpts from this document as needed in producing requests for proposals.

The limited permissions granted above are perpetual and will not be revoked by 1EdTech or its successors or assigns.

THIS SPECIFICATION IS BEING OFFERED WITHOUT ANY WARRANTY WHATSOEVER, AND IN PARTICULAR, ANY WARRANTY OF NONINFRINGEMENT IS EXPRESSLY DISCLAIMED. ANY USE OF THIS SPECIFICATION SHALL BE MADE ENTIRELY AT THE IMPLEMENTER'S OWN RISK, AND NEITHER THE CONSORTIUM, NOR ANY OF ITS MEMBERS OR SUBMITTERS, SHALL HAVE ANY LIABILITY WHATSOEVER TO ANY IMPLEMENTER OR THIRD PARTY FOR ANY DAMAGES OF ANY NATURE WHATSOEVER, DIRECTLY OR INDIRECTLY, ARISING FROM THE USE OF THIS SPECIFICATION.

Public contributions, comments and questions can be posted here: http://www.imsglobal.org/forums/ims-glc-public-forums-and-resources .

Trademark information: http://www.imsglobal.org/copyright.html

Abstract

A list of all the JSON Schema files for the specification Open Badges Specification v2.1.

Conformance and Certification

This document is an informative resource in the Document Set of the Open Badges Specification specification [OB-21]. As such, it does not include any normative requirements. Occurrences in this document of terms such as MAY, MUST, MUST NOT, SHOULD or RECOMMENDED have no impact on the conformance criteria for implementors of this specification.

1. Service Endpoint Request Payloads

These JSON Schema files can be used to validate the JSON in the service endpoint request payload.

Operation	Request Payload JSON Schema
postAssertion	schema
postProfile	schema

2. Service Endpoint Response Payloads

These JSON Schema files can be used to validate the JSON returned by each service endpoint response payload.

Operation	HTTP Status Codes	Response Payload JSON Schema
`getAssertions`	200	schema
`getAssertions`	4xx, 5xx	schema
`getManifest`	200	schema
`getProfile`	200	schema
`getProfile`	4xx, 5xx	schema
`postAssertion`	200, 4xx, 5xx	schema
`postProfile`	200	schema
`postProfile`	4xx, 5xx	schema

A. References

A.1 Normative references

[RFC2119]: Key words for use in RFCs to Indicate Requirement Levels. S. Bradner. IETF. March 1997. Best Current Practice. URL: https://www.rfc-editor.org/rfc/rfc2119

A.2 Informative references

[OB-21]: Open Badges Specification v2.1. Jeff Bohrer; Andy Miller. IMS Global Learning Consortium. November 27, 2023. IMS Final Release. URL: https://www.imsglobal.org/spec/ob/v2p1/