Open Badges Specification v2.1: JSON Schema Files

Date Issued: October 7, 2020
Status: This is an informative IMS Global 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.

IMS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the 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 IMS's procedures with respect to rights in IMS specifications can be found at the IMS Intellectual Property Rights web page: http://www.imsglobal.org/ipr/imsipr_policyFinal.pdf.

The following participating organizations have made explicit license commitments to this specification:

Org name Date election made Necessary claims Type
Concentric Sky October 24, 2019 No RF RAND (Required & Optional Elements)
Digital Knowledge October 11, 2019 No RF RAND (Required & Optional Elements)
Washington State Board for Community and Technical Colleges (WSBCTC) October 4, 2019 No RF RAND (Required & Optional Elements)
Credly October 3, 2019 No RF RAND (Required & Optional Elements)

Use of this specification to develop products or services is governed by the license with IMS found on the IMS 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 IMS 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.

© 2020 IMS Global Learning Consortium, Inc. All Rights Reserved.

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

Abstract

Open Badges are visual symbols of accomplishments packed with verifiable metadata according to the Open Badges specification. The Open Badges 2.0 specification [OB-20] defines the properties necessary to define an achievement and award it to a recipient, as well as procedures for verifying badge authenticity and “baking” badge information into portable image files. It includes term definitions for representations of data in Open Badges. The Open Badges 2.1 specification [OB-21] defines an API for exchanging badge information. These term definitions appear in the current Open Badges Specification v2.1: JSON-LD Context Files.

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.

2. Specification Documents

The full set of documents is comprised of the following documents:

3. JSON Schema Files

3.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

3.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. Revision History

This section is non-normative.

A.1 Version History

Version No. Release Date Comments
Version 2.1 IMS Candidate Final Public October 7, 2020 Releasing as Candidate Final Public.
Version 2.1 IMS Candidate Final January 24, 2020 Second coordinated release.
v2.1 Candidate Final August 29, 2019 First release of the Candidate Final specification.

B. References

B.1 Normative references

[OB-21]
Open Badges Specification v2.1. Jeff Bohrer; Andy Miller. IMS Global. January 24, 2020. URL: https://www.imsglobal.org/spec/ob/v2p1/
[OB-CERT-21]
Open Badges Specification v2.1: Conformance and Certification Guide. Jeff Bohrer; Andy Miller. IMS Global. January 24, 2020. URL: https://www.imsglobal.org/spec/ob/v2p1/cert/
[OB-JSON-21]
Open Badges Specification v2.1: JSON Schema Files. Jeff Bohrer; Andy Miller. IMS Global. January 24, 2020. URL: https://purl.imsglobal.org/spec/ob/v2p1/schema/json/
[OB-JSONLD-21]
Open Badges Specification v2.1: JSON-LD Context Files. Jeff Bohrer; Alex Hripak; Andy Miller; Nate Otto. IMS Global. January 24, 2020. URL: https://purl.imsglobal.org/spec/ob/v2p1/context/
[OB-OPEN-21]
Open Badges Specification v2.1: OpenAPI Files. Jeff Bohrer; Andy Miller. IMS Global. January 24, 2020. URL: https://purl.imsglobal.org/spec/ob/v2p1/schema/openapi/imsob_v2p1.yaml
[RFC2119]
Key words for use in RFCs to Indicate Requirement Levels. S. Bradner. IETF. March 1997. Best Current Practice. URL: https://tools.ietf.org/html/rfc2119

B.2 Informative references

[OB-20]
Open Badges v2.0. Otto, Nate; Bohrer, Jeff; Cook, Timothy; Gylling, Markus; Hripak, Alexander; Pitcher, Justin. IMS Global Learning Consortium. April 2018. IMS Final Release. URL: https://www.imsglobal.org/spec/ob/v2p0/

C. List of Contributors

The following individuals contributed to the development of this document:

Name Organization Role
Alexander HripakCredlyEditor
Sara ArjonaMoodle
Jeff BohrerIMS Global
Viktor HaagD2L
Takahiro HataDigital Knowledge EdTech Lab
Chris HoustoneLumen
Mark LeubaIMS Global
Andy MillerIMS Global
Omid MufeedDigitalme
Nate OttoConcentric Sky
Justin PitcherCampus Labs
Alex ReisD2L