IMS Competencies and Academic Standards Exchange (CASE) Service Version 1.0: JSON Schema

IMS Candidate Final
Version 1.0
IMS Candidate Final
Date Issued: June 18, 2020
Status: This document is for review and adoption by the IMS membership.
This version: https://www.imsglobal.org/spec/case/v1p0/

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.

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

The Competencies and Academic Standards Exchange (CASE) Service specification is the definition of how systems achieve the exchange of information about learning standards and/or competencies. The key aim is to replace the current ways of documenting a learning standard and competency, typically a PDF or HTML document, by one which is machine readable both syntactically and semantically. Further, using this new specification it will be possible to electronically exchange these definitions so that applications, systems and tools can readily access this data.

1. Introduction

The Competencies and Academic Standards Exchange (CASE) specification defines how systems exchange and manage information about learning standards and/or competencies in a consistent and referenceable way. The key aim is to replace the current ways of documenting and referencing learning standards and competencies, which are typically published as a PDF or HTML document intended to be read by humans, by one which is also machine readable both syntactically and semantically. This allows for "Common Alignments" for content and referenceable unique identifiers for use in certificates and transcripts. Further, using this new specification it will be possible to electronically exchange these definitions so that applications, systems and tools can readily access and manage this data. This includes LMSs, Assessment tools, Curriculum Management applications, certificate and competency based evaluation systems and any other tool, process or content that would need to align to or reference a competency or framework.

This document describes the JSON Schema for CASE 1.0.

1.1 Conformance Statements

This document is an informative resource in the Document Set of the IMS Competencies and Academic Standards Exchange (CASE) Service Version 1.0 specification [CASE-10]. 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 critera for implementors of this specification.

1.2 Document Set

The documents that make up this specification are:

2. JSON Schema Files

2.1 Service Endpoint Response Payloads

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

Operation Successful Response Unsuccessful Response
getAllCFDocuments schema schema
getCFAssociation schema schema
getCFAssocationGrouping schema schema
getCFConcept schema schema
getCFDocument schema schema
getCFItem schema schema
getCFItemAssociations schema schema
getCFItemType schema schema
getCFLicense schema schema
getCFPackage schema schema
getCFRubric schema schema
getCFSubject schema schema

2.2 JSON-LD Document Schema

These JSON Schema files can be used to validate the JSON-LD document JSON.

A. Revision History

A.1 Version History

Version No. Release Date Comments
IMS Candidate Final Release 1.0 June 18, 2020 First release of the JSON-LD Binding for CASE Version 1.0. Only the JSON-LD JSON Schema has changed in this release.

A.2 Changes in the Release

The changes made in this document are:

B. References

B.1 Normative references

[CASE-10]
IMS Competencies and Academic Standards Exchange (CASE) Service Version 1.0. IMS Global Learning Consortium. July 7, 2017. IMS Final Release. URL: https://www.imsglobal.org/spec/case/v1p0/
[CASE-CERT-10]
IMS Competencies and Academic Standards Exchange (CASE) Service Version 1.0: Conformance and Certification. IMS Global Learning Consortium. July 7, 2017. IMS Final Release. URL: https://www.imsglobal.org/spec/case/v1p0/cert/
[CASE-CONTEXT-10]
IMS Competencies and Academic Standards Exchange (CASE) Service Version 1.0: JSON-LD Context. IMS Global Learning Consortium. June 18, 2020. IMS Candidate Final. URL: https://purl.imsglobal.org/spec/case/v1p0/context/
[CASE-IMPL-10]
IMS Competencies and Academic Standards Exchange (CASE) Service Version 1.0: Best Practices and Implementation Guide. IMS Global Learning Consortium. July 7, 2017. IMS Final Release. URL: https://www.imsglobal.org/spec/case/v1p0/impl/
[CASE-INFO-10]
IMS Competencies and Academic Standards Exchange (CASE) Service Version 1.0: Information Model. IMS Global Learning Consortium. July 7, 2017. IMS Final Release. URL: https://www.imsglobal.org/spec/case/v1p0/caseservicev1p0_infomodelv1p0.html
[CASE-JSON-10]
IMS Competencies and Academic Standards Exchange (CASE) Service Version 1.0: JSON Schema. IMS Global Learning Consortium. June 18, 2020. IMS Candidate Final. URL: https://purl.imsglobal.org/spec/case/v1p0/schema/json/
[CASE-JSONLD-10]
IMS Competencies and Academic Standards Exchange (CASE) Service Version 1.0: JSON-LD Binding. IMS Global Learning Consortium. June 18, 2020. IMS Candidate Final. URL: https://www.imsglobal.org/spec/case/v1p0/jsonld/
[CASE-OPEN-10]
IMS Competencies and Academic Standards Exchange (CASE) Service Version 1.0: OpenAPI Schema. IMS Global Learning Consortium. July 7, 2017. IMS Final Release. URL: https://purl.imsglobal.org/spec/case/v1p0/schema/openapi/
[CASE-REST-10]
IMS Competencies and Academic Standards Exchange (CASE) Service Version 1.0: REST/JSON Binding. IMS Global Learning Consortium. July 7, 2017. IMS Final Release. URL: https://www.imsglobal.org/spec/case/v1p0/caseservicev1p0_restbindv1p0.html
[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

C. List of Contributors

The following individuals contributed to the development of this document:

Name Organization
Raymond BaranoskiSAFARI Montage (USA)
Diana BidulescuHouston ISD (USA)
Adam BlumOpenEd (USA)
Jared BoothHMH (USA)
Clyde BoyerTrinity Education Group (USA)
Barry BrahierInfinite Campus (USA)
Christine CaseTrinity Education Group (USA)
Joseph ChapmanD2L (Canada)
Chris ChungIMS Global (USA)
Deb EverhartLearning Objects (USA)
David GappaSAFARI Montage (USA)
Jeremy GatzaFlorida Virtual School (USA)
Jeff GrannCapella University (USA)
Bob GroganeLumen (USA)
Jeroen HamersKennisnet (Netherlands)
Joel HernandezeLumen (USA)
Jill HobsonIMS Global (USA)
Chris HoustonCapella University (USA)
Jamey HyndsKaty ISD (USA)
Brian KubotaPearson (USA)
Andy KuritizkyHMH (USA)
Mark LeubaIMS Global (USA)
Karl LloydInstructure (USA)
Joshua MarksPCG (USA)
Lisa MattsonIMS Global (USA)
David MayesGwinnett County Schools (USA)
Greg NadeauPCG (USA)
Henk NijstadKennisnet (Netherlands)
Hugh NorwoodTrinity Education Group (USA)
Robert PangbornIBM (USA)
Steve PolyakACT (USA)
Brandt ReddSmarter Balance (USA)
Jennifer ReichlinPearson (USA)
William SantoD2L (Canada)
Bob SchlossIBM (USA)
McCall SmithInstructure (USA)
Colin SmythIMS Global (USA)
Davant StewartHouston ISD (USA)
Stewart SuttonDublin Core (USA)
Marcia van OploKennisnet (Netherlands)
Michele WagnerBaltimore County Public Schools (USA)
David WardPCG (USA)
Jennifer WhitingFlorida Virtual School (USA)
Avi YashchinIBM (USA)
Stuart SuttonCredential Engine