IMS Candidate Final

IMS Global Logo

IMS Extended Transcript (eT) Service Version 1.0:
Conformance and Certification

IMS Candidate Final 1.0

Date Issued: September 8, 2017
Latest version: http://www.imsglobal.org/et/

IPR and Distribution Notices

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.

Copyright © 2017 IMS Global Learning Consortium. All Rights Reserved.

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: www.imsglobal.org/forums/ims-glc-public-forums-and-resources.

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

Document Name: IMS Extended Transcript (eT) Service v1.0 Conformance and Certification

Revision: 10th March, 2017

toc | top

Table of Contents

1. Introduction

1.1 Scope and Context

1.2 Status of this Document

1.3 Structure of this Document

1.4 Nomenclature

1.5 Related Documents

2. The Conformance Process

2.1 Conformance Testing Process

2.1.1 Requirements for Extended Transcript Service 1.0 Conformance

2.1.2 Extended Transcript Service Conformance Mark

3. Service Provider Conformance

3.1 Required Endpoint Support

3.2 Optional Endpoint Support

3.3 Service Provider Compliance

4. Service Consumer Conformance

4.1 Required Endpoint Support

4.2 Optional Endpoint Support

4.3 Service Consumer Compliance

5. Extended Transcript Service Certifications

About this Document

List of Contributors

Revision History

toc | top

1. Introduction

1.1. Scope and Context

The Extended Transcript (eT) Service specification is used to organize, store and communicate learner achievement records in a standardized format. This standard defines a set of data models for institutional academic record issuers, learners’ whose records are represented, and the learner records themselves. It also describes how this data can be requested as single documents or sets of documents using a set of service calls.

This document is the Extended Transcript (eT) Service v1.0 Conformance and Certification document and as such it is used to define how a product can be certified as Extended Transcript Service 1.0 compliant. The formal definition of the Extended Transcript Service 1.0 is supplied in the following documents:

1.2 Status of this Document

This document is released so that IMS Members can adopt and implement the Extended Transcript Service 1.0 specification. Once a minimum number of implementations have achieved certification and no problems with the specification have been found then IMS can begin the process of publishing it as a Final Release document.

1.3. Structure of this Document

The structure of the rest of this document is:

2. The Conformance Process The formal process to be undertaken by a vendor wishing to obtain Extended Transcript Service conformance certification;
3. Service Provider Conformance The conformance requirements that must be achieved for the certifciation of a service provider;
4. Service Consumer Conformance The conformance requirements that must be achieved for the certifciation of a service consumer;
5. Extended Transcript Service Certifications A comparison of the endpoint certification requirments for a service provider and a service consumer.

1.4. Nomenclature

API Application Programming Interface
IUT Implementation Under Test
JSON Java Script Object Notation
eT IMS Extended Transcript
REST Representation State Transfer

1.5. References

[eT, 17a] IMS Extended Transcript Service 1.0 Candidate Final Document, Editor, Editor, IMS Global Learning Consortium Inc., May 2017, http://www.imsglobal.org/???. [[ ED NOTE: URL to be supplied in the Final Release document. ]]
[eT, 17b] IMS Extended Transcript Service 1.0 REST/JSON Binding Candidate Final Document, , Editor, Editor, IMS Global Learning Consortium Inc., May 2017, http://www.imsglobal.org/???. [[ ED NOTE: URL to be supplied in the Final Release document. ]]

toc | top

2. The Conformance Process

2.1 Conformance Testing Process

The process for conformance testing implementations of Extended Transcript Service includes the following:

All Tests for either profile must be passed successfully to be considered IMS compliant.

2.1.1 Requirements for Extended Transcript Service 1.0 Conformance

All of the REQUIRED feature tests MUST be passed successfully to be considered Extended Transcript Service compliant.

2.1.2 Extended Transcript Service Conformance Mark

After you have submitted your successful conformance information to conformance@imsglobal.org, and received confirmation and a registration number from IMS Global you may then apply the appropriate conformance mark. The IMS Global conformance chart will list your conformance details. If you have any questions, please feel free to contact us at any point.

Membership in the Extended Transcript Service Alliance is the only way to achieve official conformance to the Extended Transcript Service standard. Products without a IMS conformance Registration Number are not considered to be compliant by IMS Global.

toc | top

3. Service Provider Conformance

In Tables 3.1 and 3.2, the following should be noted:

3.1 Required Endpoint Support

The set of endpoints that MUST be supported by a Service Provider is listed in Table 3.1.

Table 3.1 The endpoints that must be supported by a compliant Extended Transcript service provider.
Service Call Endpoint HTTP Verb Mode
getSetOfExtendedTranscripts /extendedTranscripts/ GET Resp

3.2 Optional Endpoint Support

This version of the Extended Transcript specification does not define any optional endpoints for Service Providers.

3.3 Service Provider Compliance

The functional capabilities of such systems are:

The Conformance Test System used to certify a Extended Transcript Service Provider is available at: [[ ED NOTE: URL to be supplied in the Final Release document. ]]

toc | top

4. Service Consumer Conformance

In Tables 4.1 and 4.2, the following should be noted:

4.1 Required Endpoint Support

The set of endpoints that MUST be supported by a Service Consumer is listed in Table 4.1.

Table 4.1 The endpoints that must be supported by a compliant Extended Transcript service consumer.
Service Call Endpoint HTTP Verb Mode
getSetOfExtendedTranscripts /extendedTranscripts/ GET Init

4.2 Optional Endpoint Support

This version of the Extended Transcript specification does not define any optional endpoints for Service Consumers.

4.3 Service Consumer Compliance

The functional capabilities of such systems are:

The Conformance Test System used to certify a Extended Transcript Service Consumer is available at: [[ ED NOTE: URL to be supplied in the Final Release document. ]]

toc | top

toc | top

About this Document

Title: IMS Extended Transcript Service (eT) v1.0: Conformance and Certification
Editors: Markus Gylling, IMS Global (Sweden)
Deb Everhart, Learning Objects (USA)
Chris Houston, Capella (USA)
Bryan Smith, Learning Objects (USA)

Co-chairs: Jeff Grann, Capella University (USA)
Deb Everhart, Learning Objects (USA)

Version: 1.0
Version Date: September 8, 2017
Status: IMS Candidate Final
Summary: The IMS Extended Transcript service is used to organize, store and communicate learner achievement records in a standardized format. This standard defines a set of data models for institutional academic record issuers, learners' whose records are represented, and the learner records themselves. It also describes how this data can be requested as single documents or sets of documents using a set of service calls.

Revision Information: First release of this specification.
Purpose: For adoption and evaluation by IMS Members.
Document Location: IMS Competency Framework and Competency Based Education Task Forces Forums

toc | top

List of Contributors

The following individuals contributed to the development of this document:

Insiya Bream UMUC (USA)
Kenny Burnham Parchment (USA)
Andrea Deau University of Wisconsin-Extension (USA)
Deb Everhart Learning Objects (USA)
Steve Gance WA Comm & Tech Colleges (USA)
Jeff Grann Capella University (USA)
Paul Gray Learning Objects (USA)
Bob Grogan eLumen (USA)
Markus Gylling IMS Global Learning Consortium (USA)
Chris Houston Capella University (USA)
Mark Leuba IMS Global Learning Consortium (USA)
Phillip Long University of Texas at Austin (USA)
Nate Otto Concentric Sky (USA)
Joellen Shendy UMUC (USA)
Bryan Smith Learning Objects (USA)
Chris Tatem University of Maryland University College (USA)

toc | top

Revision History

Version No. Release Date Comments
IMS Candidate Final September 8, 2017 The Candidate Final release that is ready for adoption and implementation by IMS Members.

toc | top

IMS Global Learning Consortium, Inc. ("IMS Global") is publishing the information contained in this document ("Specification") for purposes of scientific, experimental, and scholarly collaboration only.

IMS Global makes no warranty or representation regarding the accuracy or completeness of the Specification.

This material is provided on an "As Is" and "As Available" basis.

The Specification is at all times subject to change and revision without notice.

It is your sole responsibility to evaluate the usefulness, accuracy, and completeness of the Specification as it relates to you.

IMS Global would appreciate receiving your comments and suggestions.

Please contact IMS Global through our website at http://www.imsglobal.org.

Please refer to Document Name: IMS Extended Transcript (eT) Service v1.0: Conformance and Certification

Date: September 8, 2017

toc | top