IMS Candidate Final

IMS Global Logo

IMS Extended Transcript Service Information Model Version 1.0

IMS Candidate Final
Version 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 Service Information Model v1.0

Revision: September 8, 2017

toc | top

Table of Contents

1. Introduction

1.1 Overview of the Service

1.2 Scope and Context

1.3 Structure of this Document

1.4 Nomenclature

1.5 References

2. The Use-cases

2.1 Use-case 1

2.2 Use-case 2

3. The Conceptual Model

3.1 Logical Data Model

3.2 Package Structure

3.3 Interoperability Model

4. Service Architecture and Specification Model

4.1 An Abstract Representation

4.2 Service Architecture and Specification Model

4.3 A Synchronous Service

5. The Behavior Model

5.1 Service Definition

5.2 "PackagesManager" Interface Description

5.2.1 "getSetOfExtendedTranscripts" Operation

6. The Interface Model

6.1 "PackageSet" Class Description

6.1.1 "results" Attribute Description

6.2 "imsx_StatusInfo" Class Description

6.2.1 "imsx_codeMajor" Attribute Description

6.2.2 "imsx_severity" Attribute Description

6.2.3 "imsx_description" Attribute Description

6.2.4 "imsx_codeMinor" Attribute Description

7. Data Model

7.1 Data Class Descriptions

7.1.1 "Assessment" Class Description

7.1.1.1 "assessmentMethod" Attribute Description

7.1.1.2 "scoringMethod" Attribute Description

7.1.1.3 "hasGroupParticipation" Attribute Description

7.1.1.4 "assessor" Attribute Description

7.1.1.5 "assessmentEvaluation" Attribute Description

7.1.1.6 "assessmentOutput" Attribute Description

7.1.2 "Association" Class Description

7.1.2.1 "id" Attribute Description

7.1.2.2 "type" Attribute Description

7.1.2.3 "associationType" Attribute Description

7.1.2.4 "entityType" Attribute Description

7.1.2.5 "entityId" Attribute Description

7.1.2.6 "additionalProperties" Attribute Description

7.1.3 "Basic" Class Description

7.1.4 "Certificate" Class Description

7.1.4.1 "level" Attribute Description

7.1.4.2 "areaOfStudy" Attribute Description

7.1.5 "CoCurricular" Class Description

7.1.5.1 "category" Attribute Description

7.1.5.2 "scoringMethod" Attribute Description

7.1.5.3 "role" Attribute Description

7.1.5.4 "startDate" Attribute Description

7.1.5.5 "endDate" Attribute Description

7.1.6 "Competency" Class Description

7.1.6.1 "humanCodingScheme" Attribute Description

7.1.6.2 "CFDocumentURI" Attribute Description

7.1.7 "Course" Class Description

7.1.7.1 "courseCode" Attribute Description

7.1.7.2 "startDate" Attribute Description

7.1.7.3 "endDate" Attribute Description

7.1.8 "Degree" Class Description

7.1.8.1 "programName" Attribute Description

7.1.8.2 "programSpecialization" Attribute Description

7.1.8.3 "level" Attribute Description

7.1.8.4 "areaOfStudy" Attribute Description

7.1.9 "Evidence" Class Description

7.1.9.1 "name" Attribute Description

7.1.9.2 "url" Attribute Description

7.1.9.3 "additionalProperties" Attribute Description

7.1.10 "ExtendedTranscript" Class Description

7.1.10.1 "id" Attribute Description

7.1.10.2 "type" Attribute Description

7.1.10.3 "createdAt" Attribute Description

7.1.10.4 "issuer" Attribute Description

7.1.10.5 "overviewUrl" Attribute Description

7.1.10.6 "person" Attribute Description

7.1.10.7 "records" Attribute Description

7.1.10.8 "transcriptEntities" Attribute Description

7.1.10.9 "additionalProperties" Attribute Description

7.1.11 "Issuer" Class Description

7.1.11.1 "id" Attribute Description

7.1.11.2 "type" Attribute Description

7.1.11.3 "name" Attribute Description

7.1.11.4 "URL" Attribute Description

7.1.11.5 "address" Attribute Description

7.1.11.6 "phone" Attribute Description

7.1.11.7 "logo" Attribute Description

7.1.11.8 "issuingPersonFullName" Attribute Description

7.1.11.9 "issuingPersonTitle" Attribute Description

7.1.11.10 "additionalProperties" Attribute Description

7.1.12 "Package" Class Description

7.1.12.1 "personID" Attribute Description

7.1.12.2 "extendedTranscript" Attribute Description

7.1.12.3 "statusInfo" Attribute Description

7.1.13 "PackageSet" Class Description

7.1.13.1 "results" Attribute Description

7.1.14 "Person" Class Description

7.1.14.1 "id" Attribute Description

7.1.14.2 "type" Attribute Description

7.1.14.3 "fullName" Attribute Description

7.1.14.4 "givenName" Attribute Description

7.1.14.5 "familyName" Attribute Description

7.1.14.6 "email" Attribute Description

7.1.14.7 "phone" Attribute Description

7.1.14.8 "mobile" Attribute Description

7.1.14.9 "studentId" Attribute Description

7.1.14.10 "birthDate" Attribute Description

7.1.14.11 "sourcedId" Attribute Description

7.1.14.12 "url" Attribute Description

7.1.14.13 "additionalProperties" Attribute Description

7.1.15 "Record" Class Description

7.1.15.1 "id" Attribute Description

7.1.15.2 "type" Attribute Description

7.1.15.3 "recordOf" Attribute Description

7.1.15.4 "date" Attribute Description

7.1.15.5 "term" Attribute Description

7.1.15.6 "result" Attribute Description

7.1.15.7 "credits" Attribute Description

7.1.15.8 "points" Attribute Description

7.1.15.9 "assertions" Attribute Description

7.1.15.10 "status" Attribute Description

7.1.15.11 "evidence" Attribute Description

7.1.15.12 "additionalProperties" Attribute Description

7.1.16 "RecordStatus" Class Description

7.1.16.1 "id" Attribute Description

7.1.16.2 "type" Attribute Description

7.1.16.3 "completed" Attribute Description

7.1.16.4 "notes" Attribute Description

7.1.16.5 "additionalProperties" Attribute Description

7.1.17 "TranscriptEntity" Class Description

7.1.17.1 "id" Attribute Description

7.1.17.2 "type" Attribute Description

7.1.17.3 "name" Attribute Description

7.1.17.4 "description" Attribute Description

7.1.17.5 "defaultCredits" Attribute Description

7.1.17.6 "defaultPoints" Attribute Description

7.1.17.7 "sourcedId" Attribute Description

7.1.17.8 "associations" Attribute Description

7.1.17.9 "alternativeLabel" Attribute Description

7.1.17.10 "additionalProperties" Attribute Description

7.1.18 "TranscriptEntityLink" Class Description

7.1.18.1 "id" Attribute Description

7.1.18.2 "type" Attribute Description

7.1.18.3 "entityType" Attribute Description

7.1.18.4 "entityId" Attribute Description

7.1.18.5 "additionalProperties" Attribute Description

7.1.19 "TranscriptEntitySet" Class Description

7.1.19.1 "id" Attribute Description

7.1.19.2 "type" Attribute Description

7.1.19.3 "assessments" Attribute Description

7.1.19.4 "certificates" Attribute Description

7.1.19.5 "coCurriculars" Attribute Description

7.1.19.6 "competencies" Attribute Description

7.1.19.7 "courses" Attribute Description

7.1.19.8 "degrees" Attribute Description

7.1.19.9 "basicEntities" Attribute Description

7.1.19.10 "additionalProperties" Attribute Description

7.1.20 "imsx_CodeMinor" Class Description

7.1.20.1 "imsx_codeMinorField" Attribute Description

7.1.21 "imsx_CodeMinorField" Class Description

7.1.21.1 "imsx_codeMinorFieldName" Attribute Description

7.1.21.2 "imsx_codeMinorFieldValue" Attribute Description

7.1.22 "imsx_StatusInfo" Class Description

7.1.22.1 "imsx_codeMajor" Attribute Description

7.1.22.2 "imsx_severity" Attribute Description

7.1.22.3 "imsx_description" Attribute Description

7.1.22.4 "imsx_codeMinor" Attribute Description

7.2 Derived Class Descriptions

7.2.1 "URL" Class Description

7.3 Enumerated Vocabulary Descriptions

7.3.1 "AssociationType" Vocabulary Description

7.3.2 "TranscriptType" Vocabulary Description

7.3.3 "imsx_CodeMajorEnum" Vocabulary Description

7.3.4 "imsx_CodeMinorValueEnum" Vocabulary Description

7.3.5 "imsx_SeverityEnum" Vocabulary Description

8. Extending and Profiling the Service

8.1 Extending the Service

8.1.1 Proprietary Operations

8.1.2 Proprietary Data Elements

8.2 Profiling the Service

Appendix A Modelling Concepts and Terms

A1 Behavior Descriptions Explanations

A1.1 Service Diagrams

A1.2 Operation Descriptions

A2 Interface Descriptions Explanations

A2.1 Parameter Model Diagrams

A2.2 Class Descriptions

A2.3 Attribute Descriptions

A3 Data Model Descriptions Explanations

A3.1 Data Model Diagrams

A3.2 Class Descriptions

A3.3 Attribute and Characteristic Descriptions

A3.4 Enumerated Vocabulary Descriptions

A3.5 External Vocabulary Descriptions

A3.6 Import Class Descriptions

Appendix B Service Status Codes

B1 Definition of the Status Codes

B1.1 Definition of the "CodeMajor" Values

B1.2 Definition of the "Severity" Values

B1.3 Definition of the "CodeMinor" Values

About this Document

List of Contributors

Revision History

toc | top

List of Figures

Figure 5.1 Service interface definitions

Figure 6.1 PackageSet class definitions

Figure 6.2 imsx_StatusInfo class definitions

Figure 7.1.1 Assessment class definitions

Figure 7.1.2 Association class definitions

Figure 7.1.3 Basic class definitions

Figure 7.1.4 Certificate class definitions

Figure 7.1.5 CoCurricular class definitions

Figure 7.1.6 Competency class definitions

Figure 7.1.7 Course class definitions

Figure 7.1.8 Degree class definitions

Figure 7.1.9 Evidence class definitions

Figure 7.1.10 ExtendedTranscript class definitions

Figure 7.1.11 Issuer class definitions

Figure 7.1.12 Package class definitions

Figure 7.1.13 PackageSet class definitions

Figure 7.1.14 Person class definitions

Figure 7.1.15 Record class definitions

Figure 7.1.16 RecordStatus class definitions

Figure 7.1.17 TranscriptEntity class definitions

Figure 7.1.18 TranscriptEntityLink class definitions

Figure 7.1.19 TranscriptEntitySet class definitions

Figure 7.1.20 imsx_CodeMinor class definitions

Figure 7.1.21 imsx_CodeMinorField class definitions

Figure 7.1.22 imsx_StatusInfo class definitions

Figure 7.2.1 URL class definitions

Figure 7.3.1 AssociationType class definitions

Figure 7.3.2 TranscriptType class definitions

Figure 7.3.3 imsx_CodeMajorEnum class definitions

Figure 7.3.4 imsx_CodeMinorValueEnum class definitions

Figure 7.3.5 imsx_SeverityEnum class definitions

toc | top

List of Tables

Table 5.1 The set of interfaces.

Table 5.2 The set of operations for the "PackagesManager" interface.

Table 6.1 "PackageSet" Class Description

Table 6.1.1 "results" Attribute Description

Table 6.2 "imsx_StatusInfo" Class Description

Table 6.2.1 "imsx_codeMajor" Attribute Description

Table 6.2.2 "imsx_severity" Attribute Description

Table 6.2.3 "imsx_description" Attribute Description

Table 6.2.4 "imsx_codeMinor" Attribute Description

Table 7.1.1 Assessment class definitions

Table 7.1.1.1 Description of the "assessmentMethod" attribute for the "Assessment" class

Table 7.1.1.2 Description of the "scoringMethod" attribute for the "Assessment" class

Table 7.1.1.3 Description of the "hasGroupParticipation" attribute for the "Assessment" class

Table 7.1.1.4 Description of the "assessor" attribute for the "Assessment" class

Table 7.1.1.5 Description of the "assessmentEvaluation" attribute for the "Assessment" class

Table 7.1.1.6 Description of the "assessmentOutput" attribute for the "Assessment" class

Table 7.1.2 Association class definitions

Table 7.1.2.1 Description of the "id" attribute for the "Association" class

Table 7.1.2.2 Description of the "type" attribute for the "Association" class

Table 7.1.2.3 Description of the "associationType" attribute for the "Association" class

Table 7.1.2.4 Description of the "entityType" attribute for the "Association" class

Table 7.1.2.5 Description of the "entityId" attribute for the "Association" class

Table 7.1.2.6 Description of the "additionalProperties" attribute for the "Association" class

Table 7.1.3 Basic class definitions

Table 7.1.4 Certificate class definitions

Table 7.1.4.1 Description of the "level" attribute for the "Certificate" class

Table 7.1.4.2 Description of the "areaOfStudy" attribute for the "Certificate" class

Table 7.1.5 CoCurricular class definitions

Table 7.1.5.1 Description of the "category" attribute for the "CoCurricular" class

Table 7.1.5.2 Description of the "scoringMethod" attribute for the "CoCurricular" class

Table 7.1.5.3 Description of the "role" attribute for the "CoCurricular" class

Table 7.1.5.4 Description of the "startDate" attribute for the "CoCurricular" class

Table 7.1.5.5 Description of the "endDate" attribute for the "CoCurricular" class

Table 7.1.6 Competency class definitions

Table 7.1.6.1 Description of the "humanCodingScheme" attribute for the "Competency" class

Table 7.1.6.2 Description of the "CFDocumentURI" attribute for the "Competency" class

Table 7.1.7 Course class definitions

Table 7.1.7.1 Description of the "courseCode" attribute for the "Course" class

Table 7.1.7.2 Description of the "startDate" attribute for the "Course" class

Table 7.1.7.3 Description of the "endDate" attribute for the "Course" class

Table 7.1.8 Degree class definitions

Table 7.1.8.1 Description of the "programName" attribute for the "Degree" class

Table 7.1.8.2 Description of the "programSpecialization" attribute for the "Degree" class

Table 7.1.8.3 Description of the "level" attribute for the "Degree" class

Table 7.1.8.4 Description of the "areaOfStudy" attribute for the "Degree" class

Table 7.1.9 Evidence class definitions

Table 7.1.9.1 Description of the "name" attribute for the "Evidence" class

Table 7.1.9.2 Description of the "url" attribute for the "Evidence" class

Table 7.1.9.3 Description of the "additionalProperties" attribute for the "Evidence" class

Table 7.1.10 ExtendedTranscript class definitions

Table 7.1.10.1 Description of the "id" attribute for the "ExtendedTranscript" class

Table 7.1.10.2 Description of the "type" attribute for the "ExtendedTranscript" class

Table 7.1.10.3 Description of the "createdAt" attribute for the "ExtendedTranscript" class

Table 7.1.10.4 Description of the "issuer" attribute for the "ExtendedTranscript" class

Table 7.1.10.5 Description of the "overviewUrl" attribute for the "ExtendedTranscript" class

Table 7.1.10.6 Description of the "person" attribute for the "ExtendedTranscript" class

Table 7.1.10.7 Description of the "records" attribute for the "ExtendedTranscript" class

Table 7.1.10.8 Description of the "transcriptEntities" attribute for the "ExtendedTranscript" class

Table 7.1.10.9 Description of the "additionalProperties" attribute for the "ExtendedTranscript" class

Table 7.1.11 Issuer class definitions

Table 7.1.11.1 Description of the "id" attribute for the "Issuer" class

Table 7.1.11.2 Description of the "type" attribute for the "Issuer" class

Table 7.1.11.3 Description of the "name" attribute for the "Issuer" class

Table 7.1.11.4 Description of the "URL" attribute for the "Issuer" class

Table 7.1.11.5 Description of the "address" attribute for the "Issuer" class

Table 7.1.11.6 Description of the "phone" attribute for the "Issuer" class

Table 7.1.11.7 Description of the "logo" attribute for the "Issuer" class

Table 7.1.11.8 Description of the "issuingPersonFullName" attribute for the "Issuer" class

Table 7.1.11.9 Description of the "issuingPersonTitle" attribute for the "Issuer" class

Table 7.1.11.10 Description of the "additionalProperties" attribute for the "Issuer" class

Table 7.1.12 Package class definitions

Table 7.1.12.1 Description of the "personID" attribute for the "Package" class

Table 7.1.12.2 Description of the "extendedTranscript" attribute for the "Package" class

Table 7.1.12.3 Description of the "statusInfo" attribute for the "Package" class

Table 7.1.13 PackageSet class definitions

Table 7.1.13.1 Description of the "results" attribute for the "PackageSet" class

Table 7.1.14 Person class definitions

Table 7.1.14.1 Description of the "id" attribute for the "Person" class

Table 7.1.14.2 Description of the "type" attribute for the "Person" class

Table 7.1.14.3 Description of the "fullName" attribute for the "Person" class

Table 7.1.14.4 Description of the "givenName" attribute for the "Person" class

Table 7.1.14.5 Description of the "familyName" attribute for the "Person" class

Table 7.1.14.6 Description of the "email" attribute for the "Person" class

Table 7.1.14.7 Description of the "phone" attribute for the "Person" class

Table 7.1.14.8 Description of the "mobile" attribute for the "Person" class

Table 7.1.14.9 Description of the "studentId" attribute for the "Person" class

Table 7.1.14.10 Description of the "birthDate" attribute for the "Person" class

Table 7.1.14.11 Description of the "sourcedId" attribute for the "Person" class

Table 7.1.14.12 Description of the "url" attribute for the "Person" class

Table 7.1.14.13 Description of the "additionalProperties" attribute for the "Person" class

Table 7.1.15 Record class definitions

Table 7.1.15.1 Description of the "id" attribute for the "Record" class

Table 7.1.15.2 Description of the "type" attribute for the "Record" class

Table 7.1.15.3 Description of the "recordOf" attribute for the "Record" class

Table 7.1.15.4 Description of the "date" attribute for the "Record" class

Table 7.1.15.5 Description of the "term" attribute for the "Record" class

Table 7.1.15.6 Description of the "result" attribute for the "Record" class

Table 7.1.15.7 Description of the "credits" attribute for the "Record" class

Table 7.1.15.8 Description of the "points" attribute for the "Record" class

Table 7.1.15.9 Description of the "assertions" attribute for the "Record" class

Table 7.1.15.10 Description of the "status" attribute for the "Record" class

Table 7.1.15.11 Description of the "evidence" attribute for the "Record" class

Table 7.1.15.12 Description of the "additionalProperties" attribute for the "Record" class

Table 7.1.16 RecordStatus class definitions

Table 7.1.16.1 Description of the "id" attribute for the "RecordStatus" class

Table 7.1.16.2 Description of the "type" attribute for the "RecordStatus" class

Table 7.1.16.3 Description of the "completed" attribute for the "RecordStatus" class

Table 7.1.16.4 Description of the "notes" attribute for the "RecordStatus" class

Table 7.1.16.5 Description of the "additionalProperties" attribute for the "RecordStatus" class

Table 7.1.17 TranscriptEntity class definitions

Table 7.1.17.1 Description of the "id" attribute for the "TranscriptEntity" class

Table 7.1.17.2 Description of the "type" attribute for the "TranscriptEntity" class

Table 7.1.17.3 Description of the "name" attribute for the "TranscriptEntity" class

Table 7.1.17.4 Description of the "description" attribute for the "TranscriptEntity" class

Table 7.1.17.5 Description of the "defaultCredits" attribute for the "TranscriptEntity" class

Table 7.1.17.6 Description of the "defaultPoints" attribute for the "TranscriptEntity" class

Table 7.1.17.7 Description of the "sourcedId" attribute for the "TranscriptEntity" class

Table 7.1.17.8 Description of the "associations" attribute for the "TranscriptEntity" class

Table 7.1.17.9 Description of the "alternativeLabel" attribute for the "TranscriptEntity" class

Table 7.1.17.10 Description of the "additionalProperties" attribute for the "TranscriptEntity" class

Table 7.1.18 TranscriptEntityLink class definitions

Table 7.1.18.1 Description of the "id" attribute for the "TranscriptEntityLink" class

Table 7.1.18.2 Description of the "type" attribute for the "TranscriptEntityLink" class

Table 7.1.18.3 Description of the "entityType" attribute for the "TranscriptEntityLink" class

Table 7.1.18.4 Description of the "entityId" attribute for the "TranscriptEntityLink" class

Table 7.1.18.5 Description of the "additionalProperties" attribute for the "TranscriptEntityLink" class

Table 7.1.19 TranscriptEntitySet class definitions

Table 7.1.19.1 Description of the "id" attribute for the "TranscriptEntitySet" class

Table 7.1.19.2 Description of the "type" attribute for the "TranscriptEntitySet" class

Table 7.1.19.3 Description of the "assessments" attribute for the "TranscriptEntitySet" class

Table 7.1.19.4 Description of the "certificates" attribute for the "TranscriptEntitySet" class

Table 7.1.19.5 Description of the "coCurriculars" attribute for the "TranscriptEntitySet" class

Table 7.1.19.6 Description of the "competencies" attribute for the "TranscriptEntitySet" class

Table 7.1.19.7 Description of the "courses" attribute for the "TranscriptEntitySet" class

Table 7.1.19.8 Description of the "degrees" attribute for the "TranscriptEntitySet" class

Table 7.1.19.9 Description of the "basicEntities" attribute for the "TranscriptEntitySet" class

Table 7.1.19.10 Description of the "additionalProperties" attribute for the "TranscriptEntitySet" class

Table 7.1.20 imsx_CodeMinor class definitions

Table 7.1.20.1 Description of the "imsx_codeMinorField" attribute for the "imsx_CodeMinor" class

Table 7.1.21 imsx_CodeMinorField class definitions

Table 7.1.21.1 Description of the "imsx_codeMinorFieldName" attribute for the "imsx_CodeMinorField" class

Table 7.1.21.2 Description of the "imsx_codeMinorFieldValue" attribute for the "imsx_CodeMinorField" class

Table 7.1.22 imsx_StatusInfo class definitions

Table 7.1.22.1 Description of the "imsx_codeMajor" attribute for the "imsx_StatusInfo" class

Table 7.1.22.2 Description of the "imsx_severity" attribute for the "imsx_StatusInfo" class

Table 7.1.22.3 Description of the "imsx_description" attribute for the "imsx_StatusInfo" class

Table 7.1.22.4 Description of the "imsx_codeMinor" attribute for the "imsx_StatusInfo" class

Table 7.2.1 URL class definitions

Table 7.3.1 AssociationType class definitions

Table 7.3.2 TranscriptType class definitions

Table 7.3.3 imsx_CodeMajorEnum class definitions

Table 7.3.4 imsx_CodeMinorValueEnum class definitions

Table 7.3.5 imsx_SeverityEnum class definitions

Table A3.1 The key to the descriptions of data model diagrams

Table A3.2 The key to the descriptions of the data class tables

Table A3.3 The key to the descriptions of the data attribute/characteristic tables

Table A3.4 The key to the descriptions of the enumerated vocabulary tables

Table A3.5 The key to the descriptions of the external vocabulary tables

Table A3.6 The key to the descriptions of the import class tables

toc | top

1. Introduction

1.1 Overview of the Service

The IMS Extended Transcript (eT) Specification has been designed to create, transmit, and render an individual's set of achievements from one issuer, in a digital, machine-readable format. The specification allows for global adoption and supports shared tools within the IMS Global community.

The Extended Transcript supports interoperability in that eT Providers and Consumers can consistently send and receive transcripts among conformant entities. The IMS Extended Transcript specification describes an information model, service definition, and implementation guide to allow institutions, suppliers, and others to "extend" the traditional transcript with records and types of information that are typically not found in a traditional transcript, such as competency attainment and co-curricular activities, and to define and facilitate an institution's learner achievements record store for collection of eTs.

The eT digitized information can be consumed by other schools, institutions, employers, and any other entities that are conformant as eT consumers. In this machine readable format, eT data enables granular and expansive discoverability of learning achievements that was not previously possible.

1.2 Scope and Context

This document is the IMS Extended Transcript (eT) Service Model v1.0 and as such it is used as the basis for the development of the following documents:

This information model defines the IMS Extended Transcript Abstract Application Programming Interface (a-API). This service model is described using the Unified Modeling Language (UML) based upon the IMS Global Model Driven Specification approach and the associated modelling toolkit [I-BAT, 06]. This means that this specification is based upon the concepts of:

1.3 Structure of this Document

The structure of the rest of this document is:

2. The Use-cases The set of core use-cases supported by this specification. This includes the retrieval of machine readable extended transcripts.
3. The Conceptual Model The underlying conceptual data model and the set of relationships between the various learning standard and competency components. This includes schematic visualizations that are not based upon UML;
4. Service Architecture and Specification Model An overview of the service including the key use-cases and the underlying service architecture and end-system service objects.
5. The Behavior Model The definition of the operations of the service. This focuses on the description of the behaviors supported by the service. The behaviors are group as interfaces;
6. The Interface Model The definition of the data models exchanged between the service End Systems. These are the parameters exchanged across the interoperability interface. These are an abbreviated description with the full set of details in the corresponding data class description;
7. Data Model The definition of the data classes for the full data exchange. This addresses the data classes used to supplement the interface parameters. The descriptions are grouped according to their type e.g. data, enumeration, derived, etc;
8. Extending and Profiling the Service An explanation of how the service can be extended, using the permitted points of extension, and/or profiled. Profiling is the process by which the specification is tailored to a specific set of market/domain requirements;
Appendix A Modelling Concepts and Terms An overview of the model driven approach, the concepts and the terms used by IMS to create the service model representations (based upon a profile of UML), the corresponding set of bindings and the accompanying documentation (including this information model);
Appendix B Service Status Codes A summary list of the status codes, and their causes, that can be returned by each of the operations forming the service. These describe the end-to-end status of the transaction.

1.4 Nomenclature

A-API Abstract API
API Application Programming Interface
CBE Competency Based education
ET Extended Transcript
HE Higher Education
IETF Internet Engineering Task Force
JSON Java Script Object Notation
REST Representation State TRansfer
RFC Request for Comments
UML Unified Modelling Language
URI Uniform Resource Identifier
URL Uniform Resource Locator
XML Exchange Markup Language
XSD XML Schema Definition

1.5 References

[I-BAT, 06] IMS Binding Auto-generation Toolkit (I-BAT), C.Smythe, IMS Global Learning Consortium Inc., July 2006.
[eT, 17a] IMS Extended Transcript (eT) 1.0 REST/JSON Binding Candidate Final Document, Bryan Smith, Learning Objects (USA), Chris Houston Capella University (USA), Markus Gylling, IMS Global (Sweden), IMS Global Learning Consortium Inc., September 8, 2017, http://www.imsglobal.org/et/.
[eT, 17b] IMS Extended Transcript (eT) 1.0 Conformance and Certification Candidate Final Document, Bryan Smith, Learning Objects (USA), Chris Houston Capella University (USA), Markus Gylling, IMS Global (Sweden), IMS Global Learning Consortium Inc., September 8, 2017, http://www.imsglobal.org/et/.
[eT, 17c] IMS Extended Transcript (eT) 1.0 Best Practices and Implemetation Guide Candidate Final Document, Bryan Smith, Learning Objects (USA), Chris Houston Capella University (USA), Markus Gylling, IMS Global (Sweden), IMS Global Learning Consortium Inc., September 8, 2017, http://www.imsglobal.org/et/.

toc | top

2. The Use-cases

The set of uses cases that can be supported by the usage of the eT service are:

2.1 Use-case 1

The summary description for this use-case is given in Table 2.1.

Table 2.1 The single extended transcript request usecase.
Title: Requesting a single extended transcript
Local ID: ET-01
Description: An organization or system reads (GETs) a single person's extended transcript from an issuing organization's system. This use case supports user experiences such as showing a person their own extended transcript as well as systems interoperability uses such as transferring eT data from one system to another.
Actors: eT Provider and eT Consumer
Institution, Vendor, Student Information System (SIS), Learning Management System (LMS), Employer, Organization, eT Renderer, or Internal System.
Trigger: eT Consumer 'calls' the eT Provider's service to GET the extended transcript with the unique identifier of the person whose achievements are recorded in the extended transcript.
Preconditions: Consumer knows the Provider's End Point.
Consumer knows the unique identifier for the Person.
Consumer has any needed authentication or authorization to access the Provider system.
Primary Flow: Consumer system/service will initiate a call to the Provider's system/service for a specific Person.
Compliant eT payload will be generated by Provider based on a lookup of the unique identifier of the Person.
Provider responds HTTP status 200 with the payload to the Consumer.
Consumer receives the eT payload.
Consumer processes the payload successfully.
Alternate Flow: Consumer is not authorized
Provider responds with HTTP status 403, not authorized.
Provider processing error occurs
Provider responds with HTTP status 200 with a Package including status either 'failure' or 'unsupported' in the payload using the imdx_StatusInfo.
Success Conditions: eT Payload is successfully transferred from Provider to Consumer via IMS eT compliant service. The response contains a payload Package which includes a status of imdx_StatusInfo of 'success', and the extendedTranscript.
Exception Conditions: eT Payload is not successfully transferred.
Person's unique identifier is not found.
Data is missing or invalid.
Consumer is not authorized.

2.2 Use-case 2

The summary description for this use-case is given in Table 2.2.

Table 2.3 The multiple transcripts request usecase.
Title: Requesting multiple extended transcripts
Local ID: ET-02
Description: An organization or system reads (GETs) more than one person's extended transcripts from an issuing organization's system. This use case supports systems interoperability uses such as transferring eT data from one system to another. It can also be used to get data to populate collections or repositories of extended transcripts.
Actors: eT Provider and eT Consumer
Institution, Vendor, Student Information System (SIS), Learning Management System (LMS), Employer, Organization, eT Renderer, or Internal System.
Trigger: eT Consumer ‘calls' the eT Provider's service to GET extended transcripts with the unique identifiers of multiple persons whose achievements are recorded in the extended transcripts.
Preconditions: Consumer knows the Provider's End Point.
Consumer knows the unique identifiers for the Persons whose extended transcripts are to be requested.
Consumer has any needed authentication or authorization to access the Provider system.
Primary Flow: Consumer system/service will initiate a call to the Provider's system/service for multiple Persons Compliant eT payload will be generated by Provider based on a lookup of the unique identifiers of the Persons.
Provider responds HTTP status 200 with the payload to the Consumer.
Consumer receives the eT payload.
Consumer processes the payload successfully.
Alternate Flow: Consumer is not authorized
Provider responds with HTTP status 403, not authorized.
Provider processing error occurs
Provider responds with HTTP status 200 with a Package including status either ‘failure' or ‘unsupported' in the payload using the imsx_StatusInfo.
Success Conditions: eT Payload is successfully transferred from Provider to Consumer via IMS eT compliant service. The response contains a payload Package which includes a status of imdx_StatusInfo of ‘success', and the extendedTranscripts.
Exception Conditions: eT Payload is not successfully transferred.
One or more Person unique identifiers are not found.
Data is missing or invalid.
Consumer is not authorized.

toc | top

3. The Conceptual Model

3.1 Logical Data Model

The data model for the Extended Transcript specification consists of a set of core classes which are used to define the data properties. A representation of the logical data model for the data structures in the eT is shown in Figure 3.1.

Diagram of the logical data model of the IMS eT specification.

Figure 3.1 - The logical data model for the Extended Transcript specification. The set of classes in the logical model are: Extended-Transcript: the entire package or file of a single Extended Transcript; Person: The individual whose transcript records are being represented; Issuer: the institution or entity issuing the transcript records; Record: the individual records for a person and issuer; Transcript-Entity: a specified object that has specific, semantic fields that may be in addition to the core set of transcript record fields. Transcript-Entity instances are associated using relationship types.

3.2 Package Structure

An Extended Transcript Package (Package) is the structure that is used to contain an ExtendedTranscript and the associated components to create a complete and standalone structure, i.e. a system using the Package has no need for other contextual data. A schematic representation of the structure of an Extended Transcript Package is shown in Figure 3.2.

Diagram of the schematic
representation of the structure of an Extended Transcript Package.

Figure 3.2 - A schematic representation of the structure of an Extended Transcript Package.

The outer container, the Package, has direct children of:

3.3 Interoperability Model

The Extended Transcript service defines how transcript data is exchanged. It does not address how the data is stored and/or processed in the end-systems that exchange the information. A schematic representation of the service provided by the Extended Transcript specification is shown in Figure 3.3.

Diagram of the interoperability supplied by the Extended Transcript service.

Figure 3.3 - The interoperability supplied by the Extended Transcript service.

The Extended Transcript service is realised as a Web Service (the actual implementation is defined by the associated binding specification and, currently, only a REST/JSON based binding is available). In Extended Transcript 1.0 only a pull service model is provided i.e. a consumer must read the data from a service provider. It is possible to chain systems together and so some systems could be both an Extended Transcript consumer and service provider. In the cases where an intermediate system acquires data from more than one service provider (it is a data aggregator) it must support both consumer and provider functionality.

toc | top

4. Service Architecture and Specification Model

4.1 An Abstract Representation

It is important to remember that this document contains a description of the underlying information model in terms of the abstract Application Programming Interface (API). The manner in which this abstract representation is visualized is not intended to dictate the implementation form of the Service. The breakdown of the service into its interface classes is a convenient way to document the set of behaviors. The objective for producing these interfaces is to identify and define the messages that are exchanged between the end-systems to realize the system behaviors required of the service.

The internal organization of an implementation of the full abstract API is beyond the scope of this specification. The only constraint is that the external behavior of the abstract API complies with this specification. This means that a .NET, J2EE, etc. physical implementation of this abstract API does not have to represent the functionality using the same breakdown of operations/methods. This physical implementation is not subject to the conformance specification.

It is important to note that the UML representation of the interfaces is used to help develop and document the Information Model and various Bindings. It is not a requirement for a system to implement this interface as defined i.e. to use the same parameters, etc. Conformance against this specification will be confirmed by inspecting the appropriate binding of the information model and ensuring that the relevant information is present and that different sequences of activity result in the predicted and mandated behavior. It is essential that the behaviors described by each of the operations are fully supported and that the behaviors described by different sequences are also maintained.

4.2 Service Architecture and Specification Model

The basic architectural model for the eT Service specification is shown in Figure 4.1. In this architecture the scope of the eT Service specification is shown as the dotted line. The scope of the interoperability is the data and behavioral models of the objects being exchanged.

Diagram of the eT service architecture.

Figure 4.1 - The eT service architecture.

It is important to remember that the structure of the exchanged information has NO bearing on how the same information is contained within the 'consumer' and 'provider' eT systems (the eT repositories in the two end-systems). It is simply a representation of the data used to facilitate exchange between the end-systems. The only constraint on the end-system repositories is that they provide data persistence consistent with the required behavior.

4.3 A Synchronous Service

The eT Service is a synchronous service i.e. the consumer is blocked until the response from the provider is received. This means that a consumer can only have one outstanding request with a service provider. The corresponding sequence of actions is shown in Figure 4.2.

Diagram of the action sequence for the eT synchronous service.

Figure 4.2 - The action sequence for the eT synchronous service.

Figure 4.2 shows the action sequence from the prespective of the consumer but It must be noted that a Service Provider will be expected to support concurrent requests (perhaps hundreds to thousands) from many consumers.

toc | top

5. The Behavior Model

5.1 Service Definition

The model for the service representation is shown in Figure 5.1 and Table 5.1 (the syntax and semantics for this representation is described in Appendix A1.1). Following the service definition are the descriptions for the set of corresponding service operations (the syntax and semantics for these descrptions is described in Appendix A1.2).

UML model of the service.

Figure 5.1 - Service interface definitions.

Table 5.1 The set of interfaces.
Interface Description
PackagesManager The set of service operations that manage access to the Extended Transcript Packages as a whole. The set of endpoints assigned to this tag are:

5.2 PackagesManager Interface Description

The set of service operations that manage access to the Extended Transcript Packages as a whole. The set of endpoints assigned to this tag are:

The set of operations for this interface are summarized in Table 5.2.

Table 5.2 The set of operations for the "PackagesManager" interface.
Operation Description
getSetOfExtendedTranscripts This is a request to the Service Provider to provide a set of Extended Transcripts that corresponds to the IDs given in the personIDs parameter. For each requested transcript that can not be found the 'unknownobject' status code must be reported.

5.2.1 "getSetOfExtendedTranscripts" Operation

Name: getSetOfExtendedTranscripts ()
Return Function Parameter: statusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API.
Supplied (in) Parameters: None.
Returned (out) Parameters: packages : PackageSet - a set of Package objects. On successful retrieval, each Package object contains an Extended Transcript, the ID of the person to whom the transcript applies, and a status code.
Behavior: This is a request to the Service Provider to provide a set of Extended Transcripts that corresponds to the IDs given in the personIDs parameter. For each requested transcript that can not be found the 'unknownobject' status code must be reported.
Notes: Query Parameters for the REST-based binding have been defined for this operation, namely:
  • personIDs - array of IDs for users for which an extended transcript is requested.

toc | top

6. The Interface Model

The set of operations described within the behavior model (The Behavior Model) are based upon class descriptions specific to the parameters of the operations. All parameters are mandatory. The syntax and semantics for this representation is described in Appendix A2.

6.1 PackageSet Class Description

The data model for the "PackageSet" class is shown in Figure 6.1 and the accompanying definition in Table 6.1.

UML diagram of the PackageSet class.

Figure 6.1 - PackageSet class definitions.

Table 6.1 Description of the "PackageSet" class.
Descriptor Definition
Class Name PackageSet
Class Type Container [ Unordered ]
Parents Service parameter data-type used in the following operations:
Characteristics There are no characteristics.
Children The set of children attributes are:
Description A set of Package objects returned by the Service Provider that correspond to the persons identified via the personIDs parameter.

6.1.1 "results" Attribute Description

The description of the "results" attribute for the "PackageSet" class is given in Table 6.1.1.

Table 6.1.1 Description of the "results" attribute for the "PackageSet" class.
Descriptor Definition
Attribute Name results
Data Type Package
Value Space Container [ Unordered ]
Scope Local ("-")
Multiplicity [1.. unbounded]
Description The set of Package objects.

6.2 imsx_StatusInfo Class Description

The data model for the "imsx_StatusInfo" class is shown in Figure 6.2 and the accompanying definition in Table 6.2.

UML diagram of the imsx_StatusInfo class.

Figure 6.2 - imsx_StatusInfo class definitions.

Table 6.2 Description of the "imsx_StatusInfo" class.
Descriptor Definition
Class Name imsx_StatusInfo
Class Type Container [ Sequence ]
Parents Service parameter data-type used in the following operations:
Characteristics There are no characteristics.
Children The set of children attributes are:
Description This is the container for the status code and associated information returned within the HTTP messages received from the Service Provider.

6.2.1 "imsx_codeMajor" Attribute Description

The description of the "imsx_codeMajor" attribute for the "imsx_StatusInfo" class is given in Table 6.2.1.

Table 6.2.1 Description of the "imsx_codeMajor" attribute for the "imsx_StatusInfo" class.
Descriptor Definition
Attribute Name imsx_codeMajor
Data Type imsx_CodeMajorEnum
Value Space Enumerated value set of: { success | processing | failure | unsupported }
Scope Local ("-")
Multiplicity [1]
Description The code major value (from the corresponding enumerated vocabulary).

6.2.2 "imsx_severity" Attribute Description

The description of the "imsx_severity" attribute for the "imsx_StatusInfo" class is given in Table 6.2.2.

Table 6.2.2 Description of the "imsx_severity" attribute for the "imsx_StatusInfo" class.
Descriptor Definition
Attribute Name imsx_severity
Data Type imsx_SeverityEnum
Value Space Enumerated value set of: { status | warning | error }
Scope Local ("-")
Multiplicity [1]
Description The severity value (from the corresponding enumerated vocabulary).

6.2.3 "imsx_description" Attribute Description

The description of the "imsx_description" attribute for the "imsx_StatusInfo" class is given in Table 6.2.3.

Table 6.2.3 Description of the "imsx_description" attribute for the "imsx_StatusInfo" class.
Descriptor Definition
Attribute Name imsx_description
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description A human readable description supplied by the entity creating the status code information.

6.2.4 "imsx_codeMinor" Attribute Description

The description of the "imsx_codeMinor" attribute for the "imsx_StatusInfo" class is given in Table 6.2.4.

Table 6.2.4 Description of the "imsx_codeMinor" attribute for the "imsx_StatusInfo" class.
Descriptor Definition
Attribute Name imsx_codeMinor
Data Type imsx_CodeMinor
Value Space Container [ Sequence ]
Scope Local ("-")
Multiplicity [0..1]
Description The set of reported code minor status codes.

toc | top

7. Data Model

7.1 Data Class Descriptions

All of the data classes used within this Information Model are described in this Section. The syntax and semantics for this representation is described in Appendix A3.2.

7.1.1 Assessment Class Description

The data model for the "Assessment" class is shown in Figure 7.1.1 and the accompanying definition in Table 7.1.1.

UML diagram of the Assessment class.

Figure 7.1.1 - Assessment class definitions.

Table 7.1.1 Description of the "Assessment" class.
Descriptor Definition
Class Name Assessment
Class Type Container [ Unordered ]
Parents The set of parent classes are:
Derived Classes There are no derived classes.
Super Classes The set of classes from which this class is derived:
Characteristics There are no characteristics.
Children The set of children attributes are: The set of inherited children attributes are:
Description Assessment of work or performance

7.1.1.1 "assessmentMethod" Attribute Description

The description of the "assessmentMethod" attribute for the "Assessment" class is given in Table 7.1.1.1.

Table 7.1.1.1 Description of the "assessmentMethod" attribute for the "Assessment" class.
Descriptor Definition
Attribute Name assessmentMethod
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description An enumeration of assessment methods. See http://www.credreg.net/ctdl/terms#AssessmentMethod.

7.1.1.2 "scoringMethod" Attribute Description

The description of the "scoringMethod" attribute for the "Assessment" class is given in Table 7.1.1.2.

Table 7.1.1.2 Description of the "scoringMethod" attribute for the "Assessment" class.
Descriptor Definition
Attribute Name scoringMethod
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description An enumeration of types of applicable scoring. See http://www.credreg.net/ctdl/terms#ScoringMethod.

7.1.1.3 "hasGroupParticipation" Attribute Description

The description of the "hasGroupParticipation" attribute for the "Assessment" class is given in Table 7.1.1.3.

Table 7.1.1.3 Description of the "hasGroupParticipation" attribute for the "Assessment" class.
Descriptor Definition
Attribute Name hasGroupParticipation
Data Type Boolean (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description True or False that completing the assessment activity being referenced requires two or more participants. See https://www.imsglobal.org/ims-badge-extensions-education

7.1.1.4 "assessor" Attribute Description

The description of the "assessor" attribute for the "Assessment" class is given in Table 7.1.1.4.

Table 7.1.1.4 Description of the "assessor" attribute for the "Assessment" class.
Descriptor Definition
Attribute Name assessor
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Organization, person, or role that assessed the work

7.1.1.5 "assessmentEvaluation" Attribute Description

The description of the "assessmentEvaluation" attribute for the "Assessment" class is given in Table 7.1.1.5.

Table 7.1.1.5 Description of the "assessmentEvaluation" attribute for the "Assessment" class.
Descriptor Definition
Attribute Name assessmentEvaluation
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Link to studies or other information about research or calculations of reliability and validity for the assessment or the scoring methods. See https://www.imsglobal.org/ims-badge-extensions-education

7.1.1.6 "assessmentOutput" Attribute Description

The description of the "assessmentOutput" attribute for the "Assessment" class is given in Table 7.1.1.6.

Table 7.1.1.6 Description of the "assessmentOutput" attribute for the "Assessment" class.
Descriptor Definition
Attribute Name assessmentOutput
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Additional details about assessment type. Values for assessmentOutput are expected to be words or phrases that describe the key features of the evidence produced. See https://www.imsglobal.org/ims-badge-extensions-education

7.1.2 Association Class Description

The data model for the "Association" class is shown in Figure 7.1.2 and the accompanying definition in Table 7.1.2.

UML diagram of the Association class.

Figure 7.1.2 - Association class definitions.

Table 7.1.2 Description of the "Association" class.
Descriptor Definition
Class Name Association
Class Type Container [ Unordered ]
Parents The set of parent classes are:
Derived Classes There are no derived classes.
Super Classes This class is not derived from another class.
Characteristics There are no characteristics.
Children The set of children attributes are:
Description Establish a relationship between two transcript entities contained within this transcript.

7.1.2.1 "id" Attribute Description

The description of the "id" attribute for the "Association" class is given in Table 7.1.2.1.

Table 7.1.2.1 Description of the "id" attribute for the "Association" class.
Descriptor Definition
Attribute Name id
Data Type NormalizedString (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [1]
Description Unique identifier for the associated object

7.1.2.2 "type" Attribute Description

The description of the "type" attribute for the "Association" class is given in Table 7.1.2.2.

Table 7.1.2.2 Description of the "type" attribute for the "Association" class.
Descriptor Definition
Attribute Name type
Data Type NormalizedString (Primitive-type)
Value Space See Appendix A3.3.
Default = "Relationship".
Scope Local ("-")
Multiplicity [1]
Description Type of the associated object

7.1.2.3 "associationType" Attribute Description

The description of the "associationType" attribute for the "Association" class is given in Table 7.1.2.3.

Table 7.1.2.3 Description of the "associationType" attribute for the "Association" class.
Descriptor Definition
Attribute Name associationType
Data Type AssociationType
Value Space Enumerated value set of: { exactMatchOf | precedes | isChildOf | isParentOf | hasSkillLevel | replacedBy | isPartOf | exemplar | isRelatedTo | isPeerOf }
Scope Local ("-")
Multiplicity [0.. unbounded]
Description The type of relationship. ("isParentOf", "isChildOf", etc.)

7.1.2.4 "entityType" Attribute Description

The description of the "entityType" attribute for the "Association" class is given in Table 7.1.2.4.

Table 7.1.2.4 Description of the "entityType" attribute for the "Association" class.
Descriptor Definition
Attribute Name entityType
Data Type TranscriptType
Value Space Enumerated value set of: { Basic | Competency | Course | Degree | Certificate | Assessment | CoCurricular }
Scope Global ("+")
Multiplicity [1]
Description The type of the associated transcript entity. (E.g., "Basic", "Certificate", "CoCurricular", etc.)

7.1.2.5 "entityId" Attribute Description

The description of the "entityId" attribute for the "Association" class is given in Table 7.1.2.5.

Table 7.1.2.5 Description of the "entityId" attribute for the "Association" class.
Descriptor Definition
Attribute Name entityId
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Global ("+")
Multiplicity [1]
Description The id of the associated transcript entity.

7.1.2.6 "additionalProperties" Attribute Description

The description of the "additionalProperties" attribute for the "Association" class is given in Table 7.1.2.6.

Table 7.1.2.6 Description of the "additionalProperties" attribute for the "Association" class.
Descriptor Definition
Attribute Name additionalProperties
Data Type Namespace (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0.. unbounded]
Description Additional extension properties.

7.1.3 Basic Class Description

The data model for the "Basic" class is shown in Figure 7.1.3 and the accompanying definition in Table 7.1.3.

UML diagram of the Basic class.

Figure 7.1.3 - Basic class definitions.

Table 7.1.3 Description of the "Basic" class.
Descriptor Definition
Class Name Basic
Class Type Container [ Unordered ]
Parents The set of parent classes are:
Derived Classes There are no derived classes.
Super Classes The set of classes from which this class is derived:
Characteristics There are no characteristics.
Children The set of inherited children attributes are:
Description Provides support for representing transcript entities that are not semantically compatible with other transcript entity classes.

7.1.4 Certificate Class Description

The data model for the "Certificate" class is shown in Figure 7.1.4 and the accompanying definition in Table 7.1.4.

UML diagram of the Certificate class.

Figure 7.1.4 - Certificate class definitions.

Table 7.1.4 Description of the "Certificate" class.
Descriptor Definition
Class Name Certificate
Class Type Container [ Unordered ]
Parents The set of parent classes are:
Derived Classes There are no derived classes.
Super Classes The set of classes from which this class is derived:
Characteristics There are no characteristics.
Children The set of children attributes are: The set of inherited children attributes are:
Description A credential that designates requisite mastery of the knowledge and skills of an occupation, profession, or academic program. See http://www.credreg.net/ctdl/terms#Certificate

7.1.4.1 "level" Attribute Description

The description of the "level" attribute for the "Certificate" class is given in Table 7.1.4.1.

Table 7.1.4.1 Description of the "level" attribute for the "Certificate" class.
Descriptor Definition
Attribute Name level
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Relative position of the certificate in relation to others. Examples include Undergraduate, Master's, Associate, etc.

7.1.4.2 "areaOfStudy" Attribute Description

The description of the "areaOfStudy" attribute for the "Certificate" class is given in Table 7.1.4.2.

Table 7.1.4.2 Description of the "areaOfStudy" attribute for the "Certificate" class.
Descriptor Definition
Attribute Name areaOfStudy
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Area of study or category associated with this certificate. Examples include Infomatics, Accounting, Human Resources Management.

7.1.5 CoCurricular Class Description

The data model for the "CoCurricular" class is shown in Figure 7.1.5 and the accompanying definition in Table 7.1.5.

UML diagram of the CoCurricular class.

Figure 7.1.5 - CoCurricular class definitions.

Table 7.1.5 Description of the "CoCurricular" class.
Descriptor Definition
Class Name CoCurricular
Class Type Container [ Unordered ]
Parents The set of parent classes are:
Derived Classes There are no derived classes.
Super Classes The set of classes from which this class is derived:
Characteristics There are no characteristics.
Children The set of children attributes are: The set of inherited children attributes are:
Description Activities, achievements, or learning attained in addition to the offical academic curriculum or study, though still asserted by the Issuer. Generally outside of the classroom or course setting. Examples include student government, sports, music, art, debate, photography and others.

7.1.5.1 "category" Attribute Description

The description of the "category" attribute for the "CoCurricular" class is given in Table 7.1.5.1.

Table 7.1.5.1 Description of the "category" attribute for the "CoCurricular" class.
Descriptor Definition
Attribute Name category
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Area of cocurricular activity, as defined by thte Issuer. Examples include sports, community service, student government, arts, etc.

7.1.5.2 "scoringMethod" Attribute Description

The description of the "scoringMethod" attribute for the "CoCurricular" class is given in Table 7.1.5.2.

Table 7.1.5.2 Description of the "scoringMethod" attribute for the "CoCurricular" class.
Descriptor Definition
Attribute Name scoringMethod
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description An enumeration of types of applicable scoring. See http://www.credreg.net/ctdl/terms#ScoringMethod.

7.1.5.3 "role" Attribute Description

The description of the "role" attribute for the "CoCurricular" class is given in Table 7.1.5.3.

Table 7.1.5.3 Description of the "role" attribute for the "CoCurricular" class.
Descriptor Definition
Attribute Name role
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Role, position, or title of the Person in the cocurricular activity, achievement, or learning experience. Examples include Student President, Intern, Captain, etc.

7.1.5.4 "startDate" Attribute Description

The description of the "startDate" attribute for the "CoCurricular" class is given in Table 7.1.5.4.

Table 7.1.5.4 Description of the "startDate" attribute for the "CoCurricular" class.
Descriptor Definition
Attribute Name startDate
Data Type DateTime (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Starting date of the Person’s involvement in the cocurricular activity.

7.1.5.5 "endDate" Attribute Description

The description of the "endDate" attribute for the "CoCurricular" class is given in Table 7.1.5.5.

Table 7.1.5.5 Description of the "endDate" attribute for the "CoCurricular" class.
Descriptor Definition
Attribute Name endDate
Data Type DateTime (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Ending date of the Person’s involvement in the cocurricular activity.

7.1.6 Competency Class Description

The data model for the "Competency" class is shown in Figure 7.1.6 and the accompanying definition in Table 7.1.6.

UML diagram of the Competency class.

Figure 7.1.6 - Competency class definitions.

Table 7.1.6 Description of the "Competency" class.
Descriptor Definition
Class Name Competency
Class Type Container [ Unordered ]
Parents The set of parent classes are:
Derived Classes There are no derived classes.
Super Classes The set of classes from which this class is derived:
Characteristics There are no characteristics.
Children The set of children attributes are: The set of inherited children attributes are:
Description Measurable or observable knowledge, skills, and abilities necessary to successful performance of a person in a given context. See http://credreg.net/ctdl#Competency

7.1.6.1 "humanCodingScheme" Attribute Description

The description of the "humanCodingScheme" attribute for the "Competency" class is given in Table 7.1.6.1.

Table 7.1.6.1 Description of the "humanCodingScheme" attribute for the "Competency" class.
Descriptor Definition
Attribute Name humanCodingScheme
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Human-referenceable code designated by the competency publisher to identify this competency item among others. See IMS CASE #DataAttribute_CFPckgItem_humanCodingScheme

7.1.6.2 "CFDocumentURI" Attribute Description

The description of the "CFDocumentURI" attribute for the "Competency" class is given in Table 7.1.6.2.

Table 7.1.6.2 Description of the "CFDocumentURI" attribute for the "Competency" class.
Descriptor Definition
Attribute Name CFDocumentURI
Data Type AnyURI (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Provides IMS CASE interoperability. If this competency is a CFItem using the CASE standard, this identifier maps to the containing CFDocument. .

7.1.7 Course Class Description

The data model for the "Course" class is shown in Figure 7.1.7 and the accompanying definition in Table 7.1.7.

UML diagram of the Course class.

Figure 7.1.7 - Course class definitions.

Table 7.1.7 Description of the "Course" class.
Descriptor Definition
Class Name Course
Class Type Container [ Unordered ]
Parents The set of parent classes are:
Derived Classes There are no derived classes.
Super Classes The set of classes from which this class is derived:
Characteristics There are no characteristics.
Children The set of children attributes are: The set of inherited children attributes are:
Description Description of an educational course which may be offered as distinct instances at different times and places, or through different media or modes of study. An educational course is a sequence of one or more educational events and/or creative works which aims to build knowledge, competence or ability of learners. See http://www.credreg.net/ctdl/terms#Course

7.1.7.1 "courseCode" Attribute Description

The description of the "courseCode" attribute for the "Course" class is given in Table 7.1.7.1.

Table 7.1.7.1 Description of the "courseCode" attribute for the "Course" class.
Descriptor Definition
Attribute Name courseCode
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description The identifier used for the course, typically in course catalogs and curricula. Example: "PSY1000"

7.1.7.2 "startDate" Attribute Description

The description of the "startDate" attribute for the "Course" class is given in Table 7.1.7.2.

Table 7.1.7.2 Description of the "startDate" attribute for the "Course" class.
Descriptor Definition
Attribute Name startDate
Data Type DateTime (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Date this course starts.

7.1.7.3 "endDate" Attribute Description

The description of the "endDate" attribute for the "Course" class is given in Table 7.1.7.3.

Table 7.1.7.3 Description of the "endDate" attribute for the "Course" class.
Descriptor Definition
Attribute Name endDate
Data Type DateTime (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Date this course ends.

7.1.8 Degree Class Description

The data model for the "Degree" class is shown in Figure 7.1.8 and the accompanying definition in Table 7.1.8.

UML diagram of the Degree class.

Figure 7.1.8 - Degree class definitions.

Table 7.1.8 Description of the "Degree" class.
Descriptor Definition
Class Name Degree
Class Type Container [ Unordered ]
Parents The set of parent classes are:
Derived Classes There are no derived classes.
Super Classes The set of classes from which this class is derived:
Characteristics There are no characteristics.
Children The set of children attributes are: The set of inherited children attributes are:
Description Academic credential conferred upon completion of a program or course of study, typically over multiple years at postsecondary education institutions. See http://www.credreg.net/ctdl/terms#Degree

7.1.8.1 "programName" Attribute Description

The description of the "programName" attribute for the "Degree" class is given in Table 7.1.8.1.

Table 7.1.8.1 Description of the "programName" attribute for the "Degree" class.
Descriptor Definition
Attribute Name programName
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [1]
Description Name of the program associated with this degree. Examples include, Master of Business Administration, or Bachelor of Science in Nursing.

7.1.8.2 "programSpecialization" Attribute Description

The description of the "programSpecialization" attribute for the "Degree" class is given in Table 7.1.8.2.

Table 7.1.8.2 Description of the "programSpecialization" attribute for the "Degree" class.
Descriptor Definition
Attribute Name programSpecialization
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Name of the specialization or focus of this degree. Examples include Entrepreneurship, General Business Administration, or Finance.

7.1.8.3 "level" Attribute Description

The description of the "level" attribute for the "Degree" class is given in Table 7.1.8.3.

Table 7.1.8.3 Description of the "level" attribute for the "Degree" class.
Descriptor Definition
Attribute Name level
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Academic level associated with this degree. Examples include Master's, Doctoral, or Bachelor's.

7.1.8.4 "areaOfStudy" Attribute Description

The description of the "areaOfStudy" attribute for the "Degree" class is given in Table 7.1.8.4.

Table 7.1.8.4 Description of the "areaOfStudy" attribute for the "Degree" class.
Descriptor Definition
Attribute Name areaOfStudy
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Area of study or category associated with this degree. Examples include Business, Education, Psychology, or Nursing.

7.1.9 Evidence Class Description

The data model for the "Evidence" class is shown in Figure 7.1.9 and the accompanying definition in Table 7.1.9.

UML diagram of the Evidence class.

Figure 7.1.9 - Evidence class definitions.

Table 7.1.9 Description of the "Evidence" class.
Descriptor Definition
Class Name Evidence
Class Type Container [ Unordered ]
Parents The set of parent classes are:
Derived Classes There are no derived classes.
Super Classes This class is not derived from another class.
Characteristics There are no characteristics.
Children The set of children attributes are:
Description One or more artifacts that represent supporting evidence for the record. Examples include text, media, websites, etc.

7.1.9.1 "name" Attribute Description

The description of the "name" attribute for the "Evidence" class is given in Table 7.1.9.1.

Table 7.1.9.1 Description of the "name" attribute for the "Evidence" class.
Descriptor Definition
Attribute Name name
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [1]
Description Title for the actual evidentice artifact..

7.1.9.2 "url" Attribute Description

The description of the "url" attribute for the "Evidence" class is given in Table 7.1.9.2.

Table 7.1.9.2 Description of the "url" attribute for the "Evidence" class.
Descriptor Definition
Attribute Name url
Data Type URL
Value Space Container [ DerivedType ]
Scope Local ("-")
Multiplicity [1]
Description Reference to the actual evidence artifact..

7.1.9.3 "additionalProperties" Attribute Description

The description of the "additionalProperties" attribute for the "Evidence" class is given in Table 7.1.9.3.

Table 7.1.9.3 Description of the "additionalProperties" attribute for the "Evidence" class.
Descriptor Definition
Attribute Name additionalProperties
Data Type Namespace (Primitive-type)
Value Space See Appendix A3.3.
Default = "true".
Scope Local ("-")
Multiplicity [0.. unbounded]
Description Additional extension properties.

7.1.10 ExtendedTranscript Class Description

The data model for the "ExtendedTranscript" class is shown in Figure 7.1.10 and the accompanying definition in Table 7.1.10.

UML diagram of the ExtendedTranscript class.

Figure 7.1.10 - ExtendedTranscript class definitions.

Table 7.1.10 Description of the "ExtendedTranscript" class.
Descriptor Definition
Class Name ExtendedTranscript
Class Type Container [ Unordered ]
Parents The set of parent classes are:
Derived Classes There are no derived classes.
Super Classes This class is not derived from another class.
Characteristics There are no characteristics.
Children The set of children attributes are:
Description Collection of Records for a single person declared by a single Issuer.

7.1.10.1 "id" Attribute Description

The description of the "id" attribute for the "ExtendedTranscript" class is given in Table 7.1.10.1.

Table 7.1.10.1 Description of the "id" attribute for the "ExtendedTranscript" class.
Descriptor Definition
Attribute Name id
Data Type NormalizedString (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [1]
Description Unique identifier for the associated object

7.1.10.2 "type" Attribute Description

The description of the "type" attribute for the "ExtendedTranscript" class is given in Table 7.1.10.2.

Table 7.1.10.2 Description of the "type" attribute for the "ExtendedTranscript" class.
Descriptor Definition
Attribute Name type
Data Type NormalizedString (Primitive-type)
Value Space See Appendix A3.3.
Default = "ExtendedTranscript".
Scope Local ("-")
Multiplicity [1]
Description Type of the associated object

7.1.10.3 "createdAt" Attribute Description

The description of the "createdAt" attribute for the "ExtendedTranscript" class is given in Table 7.1.10.3.

Table 7.1.10.3 Description of the "createdAt" attribute for the "ExtendedTranscript" class.
Descriptor Definition
Attribute Name createdAt
Data Type DateTime (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [1]
Description Date and time this transcript was produced

7.1.10.4 "issuer" Attribute Description

The description of the "issuer" attribute for the "ExtendedTranscript" class is given in Table 7.1.10.4.

Table 7.1.10.4 Description of the "issuer" attribute for the "ExtendedTranscript" class.
Descriptor Definition
Attribute Name issuer
Data Type Issuer
Value Space Container [ Unordered ]
Scope Local ("-")
Multiplicity [0..1]
Description The issuer of this extended transcript.

7.1.10.5 "overviewUrl" Attribute Description

The description of the "overviewUrl" attribute for the "ExtendedTranscript" class is given in Table 7.1.10.5.

Table 7.1.10.5 Description of the "overviewUrl" attribute for the "ExtendedTranscript" class.
Descriptor Definition
Attribute Name overviewUrl
Data Type URL
Value Space Container [ DerivedType ]
Scope Local ("-")
Multiplicity [0..1]
Description URL to access the issuer's documentation for the extended transcript. This may include a general description of the transcript, along with any policies around the issuance and interpretation of the transcript.

7.1.10.6 "person" Attribute Description

The description of the "person" attribute for the "ExtendedTranscript" class is given in Table 7.1.10.6.

Table 7.1.10.6 Description of the "person" attribute for the "ExtendedTranscript" class.
Descriptor Definition
Attribute Name person
Data Type Person
Value Space Container [ Unordered ]
Scope Local ("-")
Multiplicity [0..1]
Description The person to whom this transcript is issued.

7.1.10.7 "records" Attribute Description

The description of the "records" attribute for the "ExtendedTranscript" class is given in Table 7.1.10.7.

Table 7.1.10.7 Description of the "records" attribute for the "ExtendedTranscript" class.
Descriptor Definition
Attribute Name records
Data Type Record
Value Space Container [ Unordered ]
Scope Local ("-")
Multiplicity [1.. unbounded]
Description The Records of this transcript.

7.1.10.8 "transcriptEntities" Attribute Description

The description of the "transcriptEntities" attribute for the "ExtendedTranscript" class is given in Table 7.1.10.8.

Table 7.1.10.8 Description of the "transcriptEntities" attribute for the "ExtendedTranscript" class.
Descriptor Definition
Attribute Name transcriptEntities
Data Type TranscriptEntitySet
Value Space Container [ Unordered ]
Scope Local ("-")
Multiplicity [1]
Description Collection of all the transcript entities contained within this transcript.

7.1.10.9 "additionalProperties" Attribute Description

The description of the "additionalProperties" attribute for the "ExtendedTranscript" class is given in Table 7.1.10.9.

Table 7.1.10.9 Description of the "additionalProperties" attribute for the "ExtendedTranscript" class.
Descriptor Definition
Attribute Name additionalProperties
Data Type Namespace (Primitive-type)
Value Space See Appendix A3.3.
Default = "true".
Scope Local ("-")
Multiplicity [0.. unbounded]
Description Additional extension properties.

7.1.11 Issuer Class Description

The data model for the "Issuer" class is shown in Figure 7.1.11 and the accompanying definition in Table 7.1.11.

UML diagram of the Issuer class.

Figure 7.1.11 - Issuer class definitions.

Table 7.1.11 Description of the "Issuer" class.
Descriptor Definition
Class Name Issuer
Class Type Container [ Unordered ]
Parents The set of parent classes are:
Derived Classes There are no derived classes.
Super Classes This class is not derived from another class.
Characteristics There are no characteristics.
Children The set of children attributes are:
Description The issuing organization of this extended transcript

7.1.11.1 "id" Attribute Description

The description of the "id" attribute for the "Issuer" class is given in Table 7.1.11.1.

Table 7.1.11.1 Description of the "id" attribute for the "Issuer" class.
Descriptor Definition
Attribute Name id
Data Type NormalizedString (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [1]
Description Unique identifier for the associated object

7.1.11.2 "type" Attribute Description

The description of the "type" attribute for the "Issuer" class is given in Table 7.1.11.2.

Table 7.1.11.2 Description of the "type" attribute for the "Issuer" class.
Descriptor Definition
Attribute Name type
Data Type NormalizedString (Primitive-type)
Value Space See Appendix A3.3.
Default = "Issuer".
Scope Local ("-")
Multiplicity [1]
Description Type of the associated object

7.1.11.3 "name" Attribute Description

The description of the "name" attribute for the "Issuer" class is given in Table 7.1.11.3.

Table 7.1.11.3 Description of the "name" attribute for the "Issuer" class.
Descriptor Definition
Attribute Name name
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [1]
Description Name of the issuing organization.

7.1.11.4 "URL" Attribute Description

The description of the "URL" attribute for the "Issuer" class is given in Table 7.1.11.4.

Table 7.1.11.4 Description of the "URL" attribute for the "Issuer" class.
Descriptor Definition
Attribute Name URL
Data Type AnyURI (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [1]
Description Web resource that provides additional information about the Issuer.

7.1.11.5 "address" Attribute Description

The description of the "address" attribute for the "Issuer" class is given in Table 7.1.11.5.

Table 7.1.11.5 Description of the "address" attribute for the "Issuer" class.
Descriptor Definition
Attribute Name address
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Mailing address or location for the issuing organization.

7.1.11.6 "phone" Attribute Description

The description of the "phone" attribute for the "Issuer" class is given in Table 7.1.11.6.

Table 7.1.11.6 Description of the "phone" attribute for the "Issuer" class.
Descriptor Definition
Attribute Name phone
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Phone number available for contacting the Issuer.

7.1.11.7 "logo" Attribute Description

The description of the "logo" attribute for the "Issuer" class is given in Table 7.1.11.7.

Table 7.1.11.7 Description of the "logo" attribute for the "Issuer" class.
Descriptor Definition
Attribute Name logo
Data Type AnyURI (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Issuer's logo. This is either a URL to a publicly-available image, or a data URI for embedding an image in the transcript.

7.1.11.8 "issuingPersonFullName" Attribute Description

The description of the "issuingPersonFullName" attribute for the "Issuer" class is given in Table 7.1.11.8.

Table 7.1.11.8 Description of the "issuingPersonFullName" attribute for the "Issuer" class.
Descriptor Definition
Attribute Name issuingPersonFullName
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description The name of the person who has the authority to issue the Extended Transcript.

7.1.11.9 "issuingPersonTitle" Attribute Description

The description of the "issuingPersonTitle" attribute for the "Issuer" class is given in Table 7.1.11.9.

Table 7.1.11.9 Description of the "issuingPersonTitle" attribute for the "Issuer" class.
Descriptor Definition
Attribute Name issuingPersonTitle
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description The role, title or position of the person who has the authority to issue the Extended Transcript.

7.1.11.10 "additionalProperties" Attribute Description

The description of the "additionalProperties" attribute for the "Issuer" class is given in Table 7.1.11.10.

Table 7.1.11.10 Description of the "additionalProperties" attribute for the "Issuer" class.
Descriptor Definition
Attribute Name additionalProperties
Data Type Namespace (Primitive-type)
Value Space See Appendix A3.3.
Default = "true".
Scope Local ("-")
Multiplicity [0.. unbounded]
Description Additional extension properties.

7.1.12 Package Class Description

The data model for the "Package" class is shown in Figure 7.1.12 and the accompanying definition in Table 7.1.12.

UML diagram of the Package class.

Figure 7.1.12 - Package class definitions.

Table 7.1.12 Description of the "Package" class.
Descriptor Definition
Class Name Package
Class Type Container [ Unordered ]
Parents The set of parent classes are:
Derived Classes There are no derived classes.
Super Classes This class is not derived from another class.
Characteristics There are no characteristics.
Children The set of children attributes are:
Description A Package contains zero or one Extended Transcripts (no transcript will be returned if the requested transcript was not found), the ID of the person to whom the transcript applies, and a status code.

7.1.12.1 "personID" Attribute Description

The description of the "personID" attribute for the "Package" class is given in Table 7.1.12.1.

Table 7.1.12.1 Description of the "personID" attribute for the "Package" class.
Descriptor Definition
Attribute Name personID
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [1]
Description The ID of a person for which an extended transcript is requested.

7.1.12.2 "extendedTranscript" Attribute Description

The description of the "extendedTranscript" attribute for the "Package" class is given in Table 7.1.12.2.

Table 7.1.12.2 Description of the "extendedTranscript" attribute for the "Package" class.
Descriptor Definition
Attribute Name extendedTranscript
Data Type ExtendedTranscript
Value Space Container [ Unordered ]
Scope Local ("-")
Multiplicity [0..1]
Description The Extended Transcript instance of this Package.

7.1.12.3 "statusInfo" Attribute Description

The description of the "statusInfo" attribute for the "Package" class is given in Table 7.1.12.3.

Table 7.1.12.3 Description of the "statusInfo" attribute for the "Package" class.
Descriptor Definition
Attribute Name statusInfo
Data Type imsx_StatusInfo
Value Space Container [ Sequence ]
Scope Local ("-")
Multiplicity [1]
Description A status code representing the result of processing the request.

7.1.13 PackageSet Class Description

The data model for the "PackageSet" class is shown in Figure 7.1.13 and the accompanying definition in Table 7.1.13.

UML diagram of the PackageSet class.

Figure 7.1.13 - PackageSet class definitions.

Table 7.1.13 Description of the "PackageSet" class.
Descriptor Definition
Class Name PackageSet
Class Type Container [ Unordered ]
Parents There are no parent classes.
Derived Classes There are no derived classes.
Super Classes This class is not derived from another class.
Characteristics There are no characteristics.
Children The set of children attributes are:
Description A set of Package objects returned by the Service Provider that correspond to the persons identified via the personIDs parameter.

7.1.13.1 "results" Attribute Description

The description of the "results" attribute for the "PackageSet" class is given in Table 7.1.13.1.

Table 7.1.13.1 Description of the "results" attribute for the "PackageSet" class.
Descriptor Definition
Attribute Name results
Data Type Package
Value Space Container [ Unordered ]
Scope Local ("-")
Multiplicity [1.. unbounded]
Description The set of Package objects.

7.1.14 Person Class Description

The data model for the "Person" class is shown in Figure 7.1.14 and the accompanying definition in Table 7.1.14.

UML diagram of the Person class.

Figure 7.1.14 - Person class definitions.

Table 7.1.14 Description of the "Person" class.
Descriptor Definition
Class Name Person
Class Type Container [ Unordered ]
Parents The set of parent classes are:
Derived Classes There are no derived classes.
Super Classes This class is not derived from another class.
Characteristics There are no characteristics.
Children The set of children attributes are:
Description Individual who is the subject of the transcript.

7.1.14.1 "id" Attribute Description

The description of the "id" attribute for the "Person" class is given in Table 7.1.14.1.

Table 7.1.14.1 Description of the "id" attribute for the "Person" class.
Descriptor Definition
Attribute Name id
Data Type NormalizedString (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [1]
Description Unique identifier for the associated object

7.1.14.2 "type" Attribute Description

The description of the "type" attribute for the "Person" class is given in Table 7.1.14.2.

Table 7.1.14.2 Description of the "type" attribute for the "Person" class.
Descriptor Definition
Attribute Name type
Data Type NormalizedString (Primitive-type)
Value Space See Appendix A3.3.
Default = "Person".
Scope Local ("-")
Multiplicity [1]
Description Type of the associated object

7.1.14.3 "fullName" Attribute Description

The description of the "fullName" attribute for the "Person" class is given in Table 7.1.14.3.

Table 7.1.14.3 Description of the "fullName" attribute for the "Person" class.
Descriptor Definition
Attribute Name fullName
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [1]
Description Full name of the person. (Compatible with the LIS definition of Person.Name)

7.1.14.4 "givenName" Attribute Description

The description of the "givenName" attribute for the "Person" class is given in Table 7.1.14.4.

Table 7.1.14.4 Description of the "givenName" attribute for the "Person" class.
Descriptor Definition
Attribute Name givenName
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [1]
Description Given name (first name) of the person.

7.1.14.5 "familyName" Attribute Description

The description of the "familyName" attribute for the "Person" class is given in Table 7.1.14.5.

Table 7.1.14.5 Description of the "familyName" attribute for the "Person" class.
Descriptor Definition
Attribute Name familyName
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [1]
Description Family name (last name) of the person.

7.1.14.6 "email" Attribute Description

The description of the "email" attribute for the "Person" class is given in Table 7.1.14.6.

Table 7.1.14.6 Description of the "email" attribute for the "Person" class.
Descriptor Definition
Attribute Name email
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Primary email address for the individual.

7.1.14.7 "phone" Attribute Description

The description of the "phone" attribute for the "Person" class is given in Table 7.1.14.7.

Table 7.1.14.7 Description of the "phone" attribute for the "Person" class.
Descriptor Definition
Attribute Name phone
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Primary phone number for the individual.

7.1.14.8 "mobile" Attribute Description

The description of the "mobile" attribute for the "Person" class is given in Table 7.1.14.8.

Table 7.1.14.8 Description of the "mobile" attribute for the "Person" class.
Descriptor Definition
Attribute Name mobile
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Mobile phone number for the individual, if available. May be the same value as "phone".

7.1.14.9 "studentId" Attribute Description

The description of the "studentId" attribute for the "Person" class is given in Table 7.1.14.9.

Table 7.1.14.9 Description of the "studentId" attribute for the "Person" class.
Descriptor Definition
Attribute Name studentId
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Institution's student identifier for the person. This is frequently issued through a Student Information System.

7.1.14.10 "birthDate" Attribute Description

The description of the "birthDate" attribute for the "Person" class is given in Table 7.1.14.10.

Table 7.1.14.10 Description of the "birthDate" attribute for the "Person" class.
Descriptor Definition
Attribute Name birthDate
Data Type Date (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Person's date of birth.

7.1.14.11 "sourcedId" Attribute Description

The description of the "sourcedId" attribute for the "Person" class is given in Table 7.1.14.11.

Table 7.1.14.11 Description of the "sourcedId" attribute for the "Person" class.
Descriptor Definition
Attribute Name sourcedId
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Person's unique "sourcedId" value, which is used for providing interoperability with Learning Information Services (LIS).

7.1.14.12 "url" Attribute Description

The description of the "url" attribute for the "Person" class is given in Table 7.1.14.12.

Table 7.1.14.12 Description of the "url" attribute for the "Person" class.
Descriptor Definition
Attribute Name url
Data Type AnyURI (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Web resource that uniquely represents or belongs to the individual. This may be a resource about the individual, hosting provided by the instution to the individual, or an web resource independently controlled by the individual.

7.1.14.13 "additionalProperties" Attribute Description

The description of the "additionalProperties" attribute for the "Person" class is given in Table 7.1.14.13.

Table 7.1.14.13 Description of the "additionalProperties" attribute for the "Person" class.
Descriptor Definition
Attribute Name additionalProperties
Data Type Namespace (Primitive-type)
Value Space See Appendix A3.3.
Default = "true".
Scope Local ("-")
Multiplicity [0.. unbounded]
Description Additional extension properties.

7.1.15 Record Class Description

The data model for the "Record" class is shown in Figure 7.1.15 and the accompanying definition in Table 7.1.15.

UML diagram of the Record class.

Figure 7.1.15 - Record class definitions.

Table 7.1.15 Description of the "Record" class.
Descriptor Definition
Class Name Record
Class Type Container [ Unordered ]
Parents The set of parent classes are:
Derived Classes There are no derived classes.
Super Classes This class is not derived from another class.
Characteristics There are no characteristics.
Children The set of children attributes are:
Description Person's status and relevant metadata regarding a specific transcript entity, as recognized by the issuer. May include associated results, assertions, and evidence.

7.1.15.1 "id" Attribute Description

The description of the "id" attribute for the "Record" class is given in Table 7.1.15.1.

Table 7.1.15.1 Description of the "id" attribute for the "Record" class.
Descriptor Definition
Attribute Name id
Data Type NormalizedString (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [1]
Description Unique identifier for the associated object

7.1.15.2 "type" Attribute Description

The description of the "type" attribute for the "Record" class is given in Table 7.1.15.2.

Table 7.1.15.2 Description of the "type" attribute for the "Record" class.
Descriptor Definition
Attribute Name type
Data Type NormalizedString (Primitive-type)
Value Space See Appendix A3.3.
Default = "Record".
Scope Local ("-")
Multiplicity [1]
Description Type of the associated object

7.1.15.3 "recordOf" Attribute Description

The description of the "recordOf" attribute for the "Record" class is given in Table 7.1.15.3.

Table 7.1.15.3 Description of the "recordOf" attribute for the "Record" class.
Descriptor Definition
Attribute Name recordOf
Data Type TranscriptEntityLink
Value Space Container [ Unordered ]
Scope Local ("-")
Multiplicity [1]
Description Reference to a TranscriptEntity

7.1.15.4 "date" Attribute Description

The description of the "date" attribute for the "Record" class is given in Table 7.1.15.4.

Table 7.1.15.4 Description of the "date" attribute for the "Record" class.
Descriptor Definition
Attribute Name date
Data Type DateTime (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [1]
Description Date that this achievement, performance, or activity occurred.

7.1.15.5 "term" Attribute Description

The description of the "term" attribute for the "Record" class is given in Table 7.1.15.5.

Table 7.1.15.5 Description of the "term" attribute for the "Record" class.
Descriptor Definition
Attribute Name term
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Academic term in which the achievement, performance, or activity occurred.

7.1.15.6 "result" Attribute Description

The description of the "result" attribute for the "Record" class is given in Table 7.1.15.6.

Table 7.1.15.6 Description of the "result" attribute for the "Record" class.
Descriptor Definition
Attribute Name result
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Level, grade, or other outcome measurement associated with the record. (E.g., "92%", "A-", "Mastered")

7.1.15.7 "credits" Attribute Description

The description of the "credits" attribute for the "Record" class is given in Table 7.1.15.7.

Table 7.1.15.7 Description of the "credits" attribute for the "Record" class.
Descriptor Definition
Attribute Name credits
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Credit hours earned by the learner that is associated with this record.

7.1.15.8 "points" Attribute Description

The description of the "points" attribute for the "Record" class is given in Table 7.1.15.8.

Table 7.1.15.8 Description of the "points" attribute for the "Record" class.
Descriptor Definition
Attribute Name points
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Associated points earned by the learner that is associated with this record.

7.1.15.9 "assertions" Attribute Description

The description of the "assertions" attribute for the "Record" class is given in Table 7.1.15.9.

Table 7.1.15.9 Description of the "assertions" attribute for the "Record" class.
Descriptor Definition
Attribute Name assertions
Data Type AnyURI (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0.. unbounded]
Description Collection of URLs to Open Badge assertions relevant to this record.

7.1.15.10 "status" Attribute Description

The description of the "status" attribute for the "Record" class is given in Table 7.1.15.10.

Table 7.1.15.10 Description of the "status" attribute for the "Record" class.
Descriptor Definition
Attribute Name status
Data Type RecordStatus
Value Space Container [ Unordered ]
Scope Local ("-")
Multiplicity [0..1]
Description State or condition of the record defined by completed and notes properties.

7.1.15.11 "evidence" Attribute Description

The description of the "evidence" attribute for the "Record" class is given in Table 7.1.15.11.

Table 7.1.15.11 Description of the "evidence" attribute for the "Record" class.
Descriptor Definition
Attribute Name evidence
Data Type Evidence
Value Space Container [ Unordered ]
Scope Local ("-")
Multiplicity [0.. unbounded]
Description Evidence for the record.

7.1.15.12 "additionalProperties" Attribute Description

The description of the "additionalProperties" attribute for the "Record" class is given in Table 7.1.15.12.

Table 7.1.15.12 Description of the "additionalProperties" attribute for the "Record" class.
Descriptor Definition
Attribute Name additionalProperties
Data Type Namespace (Primitive-type)
Value Space See Appendix A3.3.
Default = "true".
Scope Local ("-")
Multiplicity [0.. unbounded]
Description Additional extension properties.

7.1.16 RecordStatus Class Description

The data model for the "RecordStatus" class is shown in Figure 7.1.16 and the accompanying definition in Table 7.1.16.

UML diagram of the RecordStatus class.

Figure 7.1.16 - RecordStatus class definitions.

Table 7.1.16 Description of the "RecordStatus" class.
Descriptor Definition
Class Name RecordStatus
Class Type Container [ Unordered ]
Parents The set of parent classes are:
Derived Classes There are no derived classes.
Super Classes This class is not derived from another class.
Characteristics There are no characteristics.
Children The set of children attributes are:
Description State or condition of the record defined by completed and notes properties.

7.1.16.1 "id" Attribute Description

The description of the "id" attribute for the "RecordStatus" class is given in Table 7.1.16.1.

Table 7.1.16.1 Description of the "id" attribute for the "RecordStatus" class.
Descriptor Definition
Attribute Name id
Data Type NormalizedString (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [1]
Description Unique identifier for the associated object

7.1.16.2 "type" Attribute Description

The description of the "type" attribute for the "RecordStatus" class is given in Table 7.1.16.2.

Table 7.1.16.2 Description of the "type" attribute for the "RecordStatus" class.
Descriptor Definition
Attribute Name type
Data Type NormalizedString (Primitive-type)
Value Space See Appendix A3.3.
Default = "RecordStatus".
Scope Local ("-")
Multiplicity [1]
Description Type of the associated object

7.1.16.3 "completed" Attribute Description

The description of the "completed" attribute for the "RecordStatus" class is given in Table 7.1.16.3.

Table 7.1.16.3 Description of the "completed" attribute for the "RecordStatus" class.
Descriptor Definition
Attribute Name completed
Data Type Boolean (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description True if this record is fully achieved, otherwise false. If this property is absent, the record is considered completed.

7.1.16.4 "notes" Attribute Description

The description of the "notes" attribute for the "RecordStatus" class is given in Table 7.1.16.4.

Table 7.1.16.4 Description of the "notes" attribute for the "RecordStatus" class.
Descriptor Definition
Attribute Name notes
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Any explanatory notes about the status of the record.

7.1.16.5 "additionalProperties" Attribute Description

The description of the "additionalProperties" attribute for the "RecordStatus" class is given in Table 7.1.16.5.

Table 7.1.16.5 Description of the "additionalProperties" attribute for the "RecordStatus" class.
Descriptor Definition
Attribute Name additionalProperties
Data Type Namespace (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0.. unbounded]
Description Additional extension properties.

7.1.17 TranscriptEntity Class Description

The data model for the "TranscriptEntity" class is shown in Figure 7.1.17 and the accompanying definition in Table 7.1.17.

UML diagram of the TranscriptEntity class.

Figure 7.1.17 - TranscriptEntity class definitions.

Table 7.1.17 Description of the "TranscriptEntity" class.
Descriptor Definition
Class Name TranscriptEntity
Class Type Container [ Unordered ]
Parents There are no parent classes.
Derived Classes The set of derived classes are:
Super Classes This class is not derived from another class.
Characteristics There are no characteristics.
Children The set of children attributes are:
Description A transcript entity, such as degree or course, provides context for defining an achievement, performance, or outcome record. Each type of transcript entity has a set of required and optional fields that provide structure for defining entities of that type.

7.1.17.1 "id" Attribute Description

The description of the "id" attribute for the "TranscriptEntity" class is given in Table 7.1.17.1.

Table 7.1.17.1 Description of the "id" attribute for the "TranscriptEntity" class.
Descriptor Definition
Attribute Name id
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [1]
Description Unique identifier for the associated object

7.1.17.2 "type" Attribute Description

The description of the "type" attribute for the "TranscriptEntity" class is given in Table 7.1.17.2.

Table 7.1.17.2 Description of the "type" attribute for the "TranscriptEntity" class.
Descriptor Definition
Attribute Name type
Data Type TranscriptType
Value Space Enumerated value set of: { Basic | Competency | Course | Degree | Certificate | Assessment | CoCurricular }
Scope Local ("-")
Multiplicity [1]
Description Type of the associated object

7.1.17.3 "name" Attribute Description

The description of the "name" attribute for the "TranscriptEntity" class is given in Table 7.1.17.3.

Table 7.1.17.3 Description of the "name" attribute for the "TranscriptEntity" class.
Descriptor Definition
Attribute Name name
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [1]
Description The name of the entity.

7.1.17.4 "description" Attribute Description

The description of the "description" attribute for the "TranscriptEntity" class is given in Table 7.1.17.4.

Table 7.1.17.4 Description of the "description" attribute for the "TranscriptEntity" class.
Descriptor Definition
Attribute Name description
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description The description of the entity.

7.1.17.5 "defaultCredits" Attribute Description

The description of the "defaultCredits" attribute for the "TranscriptEntity" class is given in Table 7.1.17.5.

Table 7.1.17.5 Description of the "defaultCredits" attribute for the "TranscriptEntity" class.
Descriptor Definition
Attribute Name defaultCredits
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Credit hours associated with this entity, or credit hours possible.. Example: "3.0"

7.1.17.6 "defaultPoints" Attribute Description

The description of the "defaultPoints" attribute for the "TranscriptEntity" class is given in Table 7.1.17.6.

Table 7.1.17.6 Description of the "defaultPoints" attribute for the "TranscriptEntity" class.
Descriptor Definition
Attribute Name defaultPoints
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Points associated with this entity, or points possible.. Example: "6.0".

7.1.17.7 "sourcedId" Attribute Description

The description of the "sourcedId" attribute for the "TranscriptEntity" class is given in Table 7.1.17.7.

Table 7.1.17.7 Description of the "sourcedId" attribute for the "TranscriptEntity" class.
Descriptor Definition
Attribute Name sourcedId
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Reference to the source identifier of the entity, if sourced from LIS or another system or standard. .

7.1.17.8 "associations" Attribute Description

The description of the "associations" attribute for the "TranscriptEntity" class is given in Table 7.1.17.8.

Table 7.1.17.8 Description of the "associations" attribute for the "TranscriptEntity" class.
Descriptor Definition
Attribute Name associations
Data Type Association
Value Space Container [ Unordered ]
Scope Local ("-")
Multiplicity [1.. unbounded]
Description Collection of relationships belonging to this transcript entity.

7.1.17.9 "alternativeLabel" Attribute Description

The description of the "alternativeLabel" attribute for the "TranscriptEntity" class is given in Table 7.1.17.9.

Table 7.1.17.9 Description of the "alternativeLabel" attribute for the "TranscriptEntity" class.
Descriptor Definition
Attribute Name alternativeLabel
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description Alternate "term" for referring to this type of competency. Some organizations may want to refer to the competency achievements as outcomes, objectives, skills, etc. Semantically they are the same as Competencies, but diversity of terms is used. This allows flexibility for an organization to define their own terms to use instead of "Competency." See IMS CASE #DataAttribute_CFPckgItem_alternativeLabel

7.1.17.10 "additionalProperties" Attribute Description

The description of the "additionalProperties" attribute for the "TranscriptEntity" class is given in Table 7.1.17.10.

Table 7.1.17.10 Description of the "additionalProperties" attribute for the "TranscriptEntity" class.
Descriptor Definition
Attribute Name additionalProperties
Data Type Namespace (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0.. unbounded]
Description Additional extension properties.

7.1.18 TranscriptEntityLink Class Description

The data model for the "TranscriptEntityLink" class is shown in Figure 7.1.18 and the accompanying definition in Table 7.1.18.

UML diagram of the TranscriptEntityLink class.

Figure 7.1.18 - TranscriptEntityLink class definitions.

Table 7.1.18 Description of the "TranscriptEntityLink" class.
Descriptor Definition
Class Name TranscriptEntityLink
Class Type Container [ Unordered ]
Parents The set of parent classes are:
Derived Classes There are no derived classes.
Super Classes This class is not derived from another class.
Characteristics There are no characteristics.
Children The set of children attributes are:
Description A reference to a transcript entity contained within this transcript.

7.1.18.1 "id" Attribute Description

The description of the "id" attribute for the "TranscriptEntityLink" class is given in Table 7.1.18.1.

Table 7.1.18.1 Description of the "id" attribute for the "TranscriptEntityLink" class.
Descriptor Definition
Attribute Name id
Data Type NormalizedString (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [1]
Description Unique identifier for the associated object

7.1.18.2 "type" Attribute Description

The description of the "type" attribute for the "TranscriptEntityLink" class is given in Table 7.1.18.2.

Table 7.1.18.2 Description of the "type" attribute for the "TranscriptEntityLink" class.
Descriptor Definition
Attribute Name type
Data Type NormalizedString (Primitive-type)
Value Space See Appendix A3.3.
Default = "TranscriptEntityLink".
Scope Local ("-")
Multiplicity [1]
Description Type of the associated object

7.1.18.3 "entityType" Attribute Description

The description of the "entityType" attribute for the "TranscriptEntityLink" class is given in Table 7.1.18.3.

Table 7.1.18.3 Description of the "entityType" attribute for the "TranscriptEntityLink" class.
Descriptor Definition
Attribute Name entityType
Data Type TranscriptType
Value Space Enumerated value set of: { Basic | Competency | Course | Degree | Certificate | Assessment | CoCurricular }
Scope Local ("-")
Multiplicity [1]
Description The type of the associated transcript entity. (E.g., "Basic", "Certificate", "CoCurricular", etc.)

7.1.18.4 "entityId" Attribute Description

The description of the "entityId" attribute for the "TranscriptEntityLink" class is given in Table 7.1.18.4.

Table 7.1.18.4 Description of the "entityId" attribute for the "TranscriptEntityLink" class.
Descriptor Definition
Attribute Name entityId
Data Type NormalizedString (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [1]
Description The id of the associated transcript entity.

7.1.18.5 "additionalProperties" Attribute Description

The description of the "additionalProperties" attribute for the "TranscriptEntityLink" class is given in Table 7.1.18.5.

Table 7.1.18.5 Description of the "additionalProperties" attribute for the "TranscriptEntityLink" class.
Descriptor Definition
Attribute Name additionalProperties
Data Type Namespace (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0.. unbounded]
Description Additional extension properties.

7.1.19 TranscriptEntitySet Class Description

The data model for the "TranscriptEntitySet" class is shown in Figure 7.1.19 and the accompanying definition in Table 7.1.19.

UML diagram of the TranscriptEntitySet class.

Figure 7.1.19 - TranscriptEntitySet class definitions.

Table 7.1.19 Description of the "TranscriptEntitySet" class.
Descriptor Definition
Class Name TranscriptEntitySet
Class Type Container [ Unordered ]
Parents The set of parent classes are:
Derived Classes There are no derived classes.
Super Classes This class is not derived from another class.
Characteristics There are no characteristics.
Children The set of children attributes are:
Description A collection of transcript entities, partitioned by entity types. Note that all transcript entities referenced within a transcript must be included in this collection.

7.1.19.1 "id" Attribute Description

The description of the "id" attribute for the "TranscriptEntitySet" class is given in Table 7.1.19.1.

Table 7.1.19.1 Description of the "id" attribute for the "TranscriptEntitySet" class.
Descriptor Definition
Attribute Name id
Data Type NormalizedString (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [1]
Description Unique identifier for the associated object

7.1.19.2 "type" Attribute Description

The description of the "type" attribute for the "TranscriptEntitySet" class is given in Table 7.1.19.2.

Table 7.1.19.2 Description of the "type" attribute for the "TranscriptEntitySet" class.
Descriptor Definition
Attribute Name type
Data Type NormalizedString (Primitive-type)
Value Space See Appendix A3.3.
Default = "TranscriptEntitySet".
Scope Local ("-")
Multiplicity [1]
Description Type of the associated object

7.1.19.3 "assessments" Attribute Description

The description of the "assessments" attribute for the "TranscriptEntitySet" class is given in Table 7.1.19.3.

Table 7.1.19.3 Description of the "assessments" attribute for the "TranscriptEntitySet" class.
Descriptor Definition
Attribute Name assessments
Data Type Assessment
Value Space Container [ Unordered ]
Scope Local ("-")
Multiplicity [0.. unbounded]
Description Collection of all assessment transcript entities.

7.1.19.4 "certificates" Attribute Description

The description of the "certificates" attribute for the "TranscriptEntitySet" class is given in Table 7.1.19.4.

Table 7.1.19.4 Description of the "certificates" attribute for the "TranscriptEntitySet" class.
Descriptor Definition
Attribute Name certificates
Data Type Certificate
Value Space Container [ Unordered ]
Scope Local ("-")
Multiplicity [0.. unbounded]
Description Collection of all certificate transcript entities.

7.1.19.5 "coCurriculars" Attribute Description

The description of the "coCurriculars" attribute for the "TranscriptEntitySet" class is given in Table 7.1.19.5.

Table 7.1.19.5 Description of the "coCurriculars" attribute for the "TranscriptEntitySet" class.
Descriptor Definition
Attribute Name coCurriculars
Data Type CoCurricular
Value Space Container [ Unordered ]
Scope Local ("-")
Multiplicity [0.. unbounded]
Description Collection of all co-curricular transcript entities.

7.1.19.6 "competencies" Attribute Description

The description of the "competencies" attribute for the "TranscriptEntitySet" class is given in Table 7.1.19.6.

Table 7.1.19.6 Description of the "competencies" attribute for the "TranscriptEntitySet" class.
Descriptor Definition
Attribute Name competencies
Data Type Competency
Value Space Container [ Unordered ]
Scope Local ("-")
Multiplicity [0.. unbounded]
Description Collection of all competency transcript entities.

7.1.19.7 "courses" Attribute Description

The description of the "courses" attribute for the "TranscriptEntitySet" class is given in Table 7.1.19.7.

Table 7.1.19.7 Description of the "courses" attribute for the "TranscriptEntitySet" class.
Descriptor Definition
Attribute Name courses
Data Type Course
Value Space Container [ Unordered ]
Scope Local ("-")
Multiplicity [0.. unbounded]
Description Collection of all course transcript entities.

7.1.19.8 "degrees" Attribute Description

The description of the "degrees" attribute for the "TranscriptEntitySet" class is given in Table 7.1.19.8.

Table 7.1.19.8 Description of the "degrees" attribute for the "TranscriptEntitySet" class.
Descriptor Definition
Attribute Name degrees
Data Type Degree
Value Space Container [ Unordered ]
Scope Local ("-")
Multiplicity [0.. unbounded]
Description Collection of all degree transcript entities.

7.1.19.9 "basicEntities" Attribute Description

The description of the "basicEntities" attribute for the "TranscriptEntitySet" class is given in Table 7.1.19.9.

Table 7.1.19.9 Description of the "basicEntities" attribute for the "TranscriptEntitySet" class.
Descriptor Definition
Attribute Name basicEntities
Data Type Basic
Value Space Container [ Unordered ]
Scope Local ("-")
Multiplicity [0.. unbounded]
Description Collection of all basic transcript entities.

7.1.19.10 "additionalProperties" Attribute Description

The description of the "additionalProperties" attribute for the "TranscriptEntitySet" class is given in Table 7.1.19.10.

Table 7.1.19.10 Description of the "additionalProperties" attribute for the "TranscriptEntitySet" class.
Descriptor Definition
Attribute Name additionalProperties
Data Type Namespace (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0.. unbounded]
Description Additional extension properties.

7.1.20 imsx_CodeMinor Class Description

The data model for the "imsx_CodeMinor" class is shown in Figure 7.1.20 and the accompanying definition in Table 7.1.20.

UML diagram of the imsx_CodeMinor class.

Figure 7.1.20 - imsx_CodeMinor class definitions.

Table 7.1.20 Description of the "imsx_CodeMinor" class.
Descriptor Definition
Class Name imsx_CodeMinor
Class Type Container [ Sequence ]
Parents The set of parent classes are:
Derived Classes There are no derived classes.
Super Classes This class is not derived from another class.
Characteristics There are no characteristics.
Children The set of children attributes are:
Description This is the container for the set of code minor status codes reported in the responses from the Service Provider.

7.1.20.1 "imsx_codeMinorField" Attribute Description

The description of the "imsx_codeMinorField" attribute for the "imsx_CodeMinor" class is given in Table 7.1.20.1.

Table 7.1.20.1 Description of the "imsx_codeMinorField" attribute for the "imsx_CodeMinor" class.
Descriptor Definition
Attribute Name imsx_codeMinorField
Data Type imsx_CodeMinorField
Value Space Container [ Sequence ]
Scope Local ("-")
Multiplicity [1.. unbounded]
Description Each reported code minor status code.

7.1.21 imsx_CodeMinorField Class Description

The data model for the "imsx_CodeMinorField" class is shown in Figure 7.1.21 and the accompanying definition in Table 7.1.21.

UML diagram of the imsx_CodeMinorField class.

Figure 7.1.21 - imsx_CodeMinorField class definitions.

Table 7.1.21 Description of the "imsx_CodeMinorField" class.
Descriptor Definition
Class Name imsx_CodeMinorField
Class Type Container [ Sequence ]
Parents The set of parent classes are:
Derived Classes There are no derived classes.
Super Classes This class is not derived from another class.
Characteristics There are no characteristics.
Children The set of children attributes are:
Description This is the container for a single code minor status code.

7.1.21.1 "imsx_codeMinorFieldName" Attribute Description

The description of the "imsx_codeMinorFieldName" attribute for the "imsx_CodeMinorField" class is given in Table 7.1.21.1.

Table 7.1.21.1 Description of the "imsx_codeMinorFieldName" attribute for the "imsx_CodeMinorField" class.
Descriptor Definition
Attribute Name imsx_codeMinorFieldName
Data Type NormalizedString (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [1]
Description Tiis should contain the identity of the system that has produced the code minor status code report.

7.1.21.2 "imsx_codeMinorFieldValue" Attribute Description

The description of the "imsx_codeMinorFieldValue" attribute for the "imsx_CodeMinorField" class is given in Table 7.1.21.2.

Table 7.1.21.2 Description of the "imsx_codeMinorFieldValue" attribute for the "imsx_CodeMinorField" class.
Descriptor Definition
Attribute Name imsx_codeMinorFieldValue
Data Type imsx_CodeMinorValueEnum
Value Space Enumerated value set of: { fullsuccess | server_busy | invaliddata | unauthorisedrequest | internal_server_error | forbidden | targetreadfailure }
Scope Local ("-")
Multiplicity [1]
Description The code minor status code (this is a value from the corresponding enumerated vocabulary).

7.1.22 imsx_StatusInfo Class Description

The data model for the "imsx_StatusInfo" class is shown in Figure 7.1.22 and the accompanying definition in Table 7.1.22.

UML diagram of the imsx_StatusInfo class.

Figure 7.1.22 - imsx_StatusInfo class definitions.

Table 7.1.22 Description of the "imsx_StatusInfo" class.
Descriptor Definition
Class Name imsx_StatusInfo
Class Type Container [ Sequence ]
Parents The set of parent classes are:
Derived Classes There are no derived classes.
Super Classes This class is not derived from another class.
Characteristics There are no characteristics.
Children The set of children attributes are:
Description This is the container for the status code and associated information returned within the HTTP messages received from the Service Provider.

7.1.22.1 "imsx_codeMajor" Attribute Description

The description of the "imsx_codeMajor" attribute for the "imsx_StatusInfo" class is given in Table 7.1.22.1.

Table 7.1.22.1 Description of the "imsx_codeMajor" attribute for the "imsx_StatusInfo" class.
Descriptor Definition
Attribute Name imsx_codeMajor
Data Type imsx_CodeMajorEnum
Value Space Enumerated value set of: { success | processing | failure | unsupported }
Scope Local ("-")
Multiplicity [1]
Description The code major value (from the corresponding enumerated vocabulary).

7.1.22.2 "imsx_severity" Attribute Description

The description of the "imsx_severity" attribute for the "imsx_StatusInfo" class is given in Table 7.1.22.2.

Table 7.1.22.2 Description of the "imsx_severity" attribute for the "imsx_StatusInfo" class.
Descriptor Definition
Attribute Name imsx_severity
Data Type imsx_SeverityEnum
Value Space Enumerated value set of: { status | warning | error }
Scope Local ("-")
Multiplicity [1]
Description The severity value (from the corresponding enumerated vocabulary).

7.1.22.3 "imsx_description" Attribute Description

The description of the "imsx_description" attribute for the "imsx_StatusInfo" class is given in Table 7.1.22.3.

Table 7.1.22.3 Description of the "imsx_description" attribute for the "imsx_StatusInfo" class.
Descriptor Definition
Attribute Name imsx_description
Data Type String (Primitive-type)
Value Space See Appendix A3.3.
Scope Local ("-")
Multiplicity [0..1]
Description A human readable description supplied by the entity creating the status code information.

7.1.22.4 "imsx_codeMinor" Attribute Description

The description of the "imsx_codeMinor" attribute for the "imsx_StatusInfo" class is given in Table 7.1.22.4.

Table 7.1.22.4 Description of the "imsx_codeMinor" attribute for the "imsx_StatusInfo" class.
Descriptor Definition
Attribute Name imsx_codeMinor
Data Type imsx_CodeMinor
Value Space Container [ Sequence ]
Scope Local ("-")
Multiplicity [0..1]
Description The set of reported code minor status codes.

7.2 Derived Class Descriptions

All of the derived data classes used within this Information Model are described in this Section. The syntax and semantics for this representation is described in Appendix A3.2.

7.2.1 URL Class Description

The data model for the "URL" class is shown in Figure 7.2.1 and the accompanying definition in Table 7.2.1.

UML diagram of the URL class.

Figure 7.2.1 - URL class definitions.

Table 7.2.1 Description of the "URL" class.
Descriptor Definition
Class Name URL
Class Type Container [ DerivedType ]
Parents The set of parent classes are:
Derived Classes There are no derived classes.
Super Classes The set of classes from which this class is derived:
Characteristics There are no characteristics.
Children There are no children.
Description No description supplied.

7.3 Enumerated Vocabulary Descriptions

All of the enumerated vocabularies used within this Information Model are described in this Section. The syntax and semantics for this representation is described in Appendix A3.4.

7.3.1 AssociationType Vocabulary Description

The data model for the "AssociationType" enumerated class is shown in Figure 7.3.1 and the accompanying vocabulary definition in Table 7.3.1.

UML diagram of the AssociationType class.

Figure 7.3.1 - AssociationType class definitions.

Table 7.3.1 Description of the "AssociationType" enumerated vocabulary terms.
Term Definition
exactMatchOf Current entity is equivalent to specified entity.
exemplar Current entity is considered a best practice of the specified entity.
hasSkillLevel Specified entity is the skill level of the current entity.
isChildOf Current entity is the child of the specified entity, either as part of a taxonomy, as part of a learning plan, or a hierarchical structure representing an education experience. (Note that there is no restriction in the number of parents a child may have.)
isParentOf Current entity is the parent of the specified entity, either as part of a taxonomy, as part of a learning plan, or a hierarchical structure representing an education experience.
isPartOf Current entity is classified as being logically or semantically contained as a subset of the specified entity. This relationship is included primarily for interoperability with the IMS CASE standard. Hierarchical relationships should use isChildOf or isParentOf relationships instead of isPartOf, even when entities are different types.
isPeerOf Current entity is parallel to the specified entity.
isRelatedTo Current entity is related to specified entity in a manner that is not covered by another relationship type.
precedes Current entity comes before the specified entity in time or order.
replacedBy Current entity has been supplanted by, displaced by, or superseded by the specified entity.

7.3.2 TranscriptType Vocabulary Description

The data model for the "TranscriptType" enumerated class is shown in Figure 7.3.2 and the accompanying vocabulary definition in Table 7.3.2.

UML diagram of the TranscriptType class.

Figure 7.3.2 - TranscriptType class definitions.

Table 7.3.2 Description of the "TranscriptType" enumerated vocabulary terms.
Term Definition
Assessment Assessment of work or performance
Basic Provides support for representing transcript entities that are not semantically compatible with other transcript entity classes.
Certificate A credential that designates requisite mastery of the knowledge and skills of an occupation, profession, or academic program. See http://www.credreg.net/ctdl/terms#Certificate
CoCurricular Activities, achievements, or learning attained in addition to the offical academic curriculum or study, though still asserted by the Issuer. Generally outside of the classroom or course setting. Examples include student government, sports, music, art, debate, photography and others.
Competency Measurable or observable knowledge, skills, and abilities necessary to successful performance of a person in a given context. See http://credreg.net/ctdl#Competency
Course Description of an educational course which may be offered as distinct instances at different times and places, or through different media or modes of study. An educational course is a sequence of one or more educational events and/or creative works which aims to build knowledge, competence or ability of learners. See http://www.credreg.net/ctdl/terms#Course
Degree Academic credential conferred upon completion of a program or course of study, typically over multiple years at postsecondary education institutions. See http://www.credreg.net/ctdl/terms#Degree

7.3.3 imsx_CodeMajorEnum Vocabulary Description

This is the set of primary status report values i.e. the major code assigned to the status block. This is used in conjunction with the 'Severity' structure in the status object.The data model for the "imsx_CodeMajorEnum" enumerated class is shown in Figure 7.3.3 and the accompanying vocabulary definition in Table 7.3.3.

UML diagram of the imsx_CodeMajorEnum class.

Figure 7.3.3 - imsx_CodeMajorEnum class definitions.

Table 7.3.3 Description of the "imsx_CodeMajorEnum" enumerated vocabulary terms.
Term Definition
failure Denotes that the transaction request has failed. The detailed reason will be reported in the accmpanying 'codeMinor' fields.
processing Denotes that the request is being processed at the destination or there has been a local transmission failure. This value is used in asynchronous services.
success Denotes that the request has been successfully completed. If the associated 'severity' value is 'warning' then the request has been partially successful i.e. best effort by the service provider. Other parts of the status information may provide more insight into a partial sucess response.
unsupported Denotes that the service provider does not support the requested operation. This is the required default response for an unsupported operation by an implementation.

7.3.4 imsx_CodeMinorValueEnum Vocabulary Description

This is the set of codeMinor status codes tha are used to provide further insight into the completion status of the end-to-end transaction i.e. this should be used to provide more information than would be suplied be a HTTP code.The data model for the "imsx_CodeMinorValueEnum" enumerated class is shown in Figure 7.3.4 and the accompanying vocabulary definition in Table 7.3.4.

UML diagram of the imsx_CodeMinorValueEnum class.

Figure 7.3.4 - imsx_CodeMinorValueEnum class definitions.

Table 7.3.4 Description of the "imsx_CodeMinorValueEnum" enumerated vocabulary terms.
Term Definition
forbidden This is used to indicate that the server can be reached and process the request but refuses to take any further action. This would be accompanied by the 'codeMajor/severity' values of 'failure/error' and for a REST binding a HTTP code of '403'.
fullsuccess The request has been fully and successfully implemented by the Service Provider. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'.
internal_server_error This should be used only if there is catastrophic error and there is not a more appropriate code. This would be accompanied by the 'codeMajor/severity' values of 'failure/error' and for a REST binding a HTTP code of '500'.
invaliddata One or more of the supplied PersonIDs were invalid i.e. the Service Proivder could not locate an associated object. The Service Provdier has attempted to return as many objects as possble. This would be accompanied by the 'codeMajor/severity' values of 'failure/error' and for a REST binding a HTTP code of '404'.
server_busy The server is receiving too many requests. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error' and for a REST binding a HTTP code of '429'.
targetreadfailure The Service Provider could not complete the read request i.e. the form of the URL Query Parameters was invalid. This would be accompanied by the 'codeMajor/severity' values of 'failure/error' and for a REST binding a HTTP code of '400'.
unauthorisedrequest The request was not correctly authorised. This would be accompanied by the 'codeMajor/severity' values of 'failure/error' and for a REST binding a HTTP code of '401'.

7.3.5 imsx_SeverityEnum Vocabulary Description

This is the context for the status report values. This is used in conjunction with the 'CodeMajor' structure in the status object.The data model for the "imsx_SeverityEnum" enumerated class is shown in Figure 7.3.5 and the accompanying vocabulary definition in Table 7.3.5.

UML diagram of the imsx_SeverityEnum class.

Figure 7.3.5 - imsx_SeverityEnum class definitions.

Table 7.3.5 Description of the "imsx_SeverityEnum" enumerated vocabulary terms.
Term Definition
error A catastrophic error has occurred in processing the request and so the request was not completed (the Service Provider may not even have received the request).
status The request has been completed and a response was received from the Service Provider.
warning The request has only been partially completed. For an asynchronous service a further response should be expected.

toc | top

8. Extending and Profiling the Service

8.1 Extending the Service

Proprietary extensions of the service are based upon two approaches:

It is NOT permitted to change the behavior of the current set of operations. Such changes MUST be supported by the creation of new operations.

8.1.1 Proprietary Operations

The definition of new operations should follow the same format as adopted herein. The new operations should be defined using a new interface type. Every operation must result in the return of a status code that describes the final state of the request on the target end system.

An example of creating such an extension is given in the accompanying Best Practices document [eT, 17c].

8.1.2 Proprietary Data Elements

Extensions to the data model are permitted, but must not collide with already defined data model names and/or semantics. It is strongly recommended to define extensions in collaboration with IMS Global, and only after communicating with the IMS Extended Transcript working group.

8.2 Profiling the Service

This Service can be profiled. In general, Profiling is used to:

Valid Profiles must be restrictive i.e. optional features can be removed or constraints increased but new features must not be added. A Profile of this service is made by annotating the UML supplied with the documentation for the specification.

It is strongly recommended that a profile of this specification is undertaken either by, or with the close support, of IMS Global. However, no matter who is responsible for creating the profile artefacts (documents, XSDs, etc.), it is strongly recommended that the IMS specification tools are used. This will ensure that the artefacts are consistent with the base specifications and that useful support documentation is automatically produced e.g. creation of a document that summarises the differences between the base specification and the profile. Organizations wishing to produce a profile of this specification should contact Lisa Mattson (IMS Global Chief Operations Officer) at: lmattson@imsglobal.org.

toc | top

Appendix A Modelling Concepts and Terms

A1 Behavior Descriptions Explanations

A1.1 Service Model Diagrams

Table A1.1 provides the key to the descriptions of service model diagrams.

Table A1.1 The key to the descriptions of service model diagrams.
Feature Definition and Usage
Service Model Package Each service model description is enclosed in a UML Package that has the stereotype of « serviceModel » under which is the name of the service being described. A service must have at least one Interface (the breakdown of the service into the component transactions is a design decision).
Interface Class Each interface description is enclosed in a UML Package that has the stereotype of « Interface » under which is the name of the interface being described. An interface is a collection of operations that support a common set of transaction objectives. An interface must have at least one operation. An Interface class has no attributes.
Operation Description The behaviors provided by an interface are defined by the set of operations. Each operation must have a unique name and is accompanied by the set of parameters that are sent to the service (in) and those returned by the service (out). An operation can also have a formal return parameter whose form and usage depends upon the actual binding realisation. The description may also include a stereotype for the identification of the nature operation e.g. read, create, etc.

A1.2 Operation Descriptions

Table A1.2 provides the key to the descriptions of the operation tables.

Table A1.2 The key to the operation description tables.
Descriptor Definition
Name The name given to the operation being described. In the case of an interface, by definition, every operation has the scope value of global denoted by the "+" symbol before the name.
Stereotype Before the name of the operation there may be a stereotype classifier. This is used to provide information about the nature of the behavior of the operation. The permitted set of stereotype values and their meaning are:
  • « create » - indicates that a request is being made to create a new object/resource where the requester provides the associated unique identifier;
  • « createbp » - indicates that a request is being made to create a new object/resource where the responder provides the associated unique identifier;
  • « read » - indicates that a request is being made to read an existing object/resource;
  • « update » - indicates that a request is being made to update an existing object/resource i.e. an additive write;
  • « delete » - indicates that a request is being made to delete an existing object/resource;
  • « replace » - indicates that a request is being made to replace an existing object/resource i.e. a destructive write;
  • « query » - indicates that a request is being made search for objects/resources according to a defined set of search criteria.
Return Function Parameter The formal return parameter for the operation/method returned for the transaction request (the form in which this information is provided depends on the realisation of the binding). The description includes the name of the parameter and the data-type in the form "name:data-type" pair. The name/data-type provides a link to the associated interface data-type description in The Interface Model.
Supplied (in) Parameters The list of parameters that are sent from the client to the end-service in the service request message. Each parameter description includes the name of the parameter and the data-type in the form "name:data-type" pair. The name/data-type provides a link to the associated interface data-type description in The Interface Model.
Supplied (out) Parameters The list of parameters that are returned from the end-service in the service response message. Each parameter description includes the name of the parameter and the data-type in the form "name:data-type" pair. The name/data-type provides a link to the associated interface data-type description in The Interface Model.
Behavior A description of the behavior of the operation.
Notes Further information on the behavior particularly in the context of the use of other operations and the relationship to the behaviors of those operations.

A2 Interface Descriptions Explanations

A2.1 Parameter Model Diagrams

Table A2.1 provides the key to the descriptions of parameter data model diagrams.

Table A2.1 The key to the descriptions of parameter model diagrams.
Feature Definition and Usage
Data Model Package Each parameter data model description is enclosed in a UML Package that has the stereotype of « dataModel » under which is the name of the class being described.
DerivedType Class This is a class that is identified by the stereotype « DerivedType » under which is the name of the data-type. A derived class is one that is derived either from another derived class or a PrimitiveType class.
Enumeration Class This is a class that is identified by the stereotype « Enumeration » under which is the name of the enumeration data-type. The enumeration class consists of the list of tokens that are the permitted values of the assigned attribute.
Selection Class This is a class that is identified by the stereotype « Selection » under which is the name of the data-type. The selection means that only one of the listed attributes make occur in an instance. If this is an abstract class then multiple iterations of the instance may occur and the multiplicity of the attribute defines the constraints on the number of times the attribute can occur in the full instance.
Sequence Class This is a class that is identified by the stereotype « Sequence » under which is the name of the data-type. The sequence means that the listed attributes must occur only in the order of the attributes listed on the class. The associated multiplicity defines the number of times the attribute may occur consecutively in the instance.
Unordered Class This is a class that is identified by the stereotype « Unordered » under which is the name of the data-type. The unordering means that the listed attributes may occur in any order but the associated multiplicity for the attribute must be followed (when binding to XML this requires the use of Schematron rules to enforce the multiplicity).
Attribute Description Each class contains a set of attributes. Each attribute description consists of the scope, name, data-type and multiplicity (see Appendix A2.3 for a more complete description).
Composition Arrow This is an arrow with a filled diamond head to indicate that the child class is a composite structure of the parent class i.e. the child class only exists within the context of the parent class. This association allows complex structures to be constructed with common subcomponents.

A2.2 Class Descriptions

Table A2.2 provides the key to the descriptions of the parameter data class tables.

Table A2.2 The key to the descriptions of the data class tables.
Descriptor Definition
Class Name The name given to the class being described.
Class Type The nature of the class (for a paramter data-type this must not be an abstract class). This is described as a "Container [...]" with the value of "..." being (see Appendix A2.1 for the meaning of these values):
  • "DerivedType"
  • "Sequence"
  • "Selection"
  • "Unordered"
Parents This is the list of operations for which this class is a data-type for one or more of the parameters. Each entry is linked to the corresponding operation description.
Children Lists the set of attributes for this class (the only other permitted associations are generalizations). The list of children includes those that are grouped under a corresponding stereotyped attribute class. Each child is linked to the corresponding attribute description table. The nature of the relationship between the children is defined by the stereotype of the parent class i.e. the class type.
Description Contains descriptions relating to the class and its properties and relationships.

A2.3 Attribute Descriptions

Table A2.3 provides the key to the descriptions of the data attributes for the data classes for the operation parameters.

Table A2.3 The key to the descriptions of the data attribute tables.
Descriptor Definition
Attribute Name The name given to the attribute being described.
Data Type This is the data-type of the attribute. It can take many forms:
  • Class Name - the name of the Class (this is linked to the class definition);
  • Primtive Data-types from:-
    • DataTime - the date/time data-type (using the ISO 8601 format);
    • NormalizedString - the normalized string data type (strings with line feeds, carriage returns and tab characters removed);
    • String - the normalized string data type.
Value Space The range of valid values for this class (including any default value). If the value space is unspecified, it is not known or is not important. This value space must be defined in terms of the associated data-type.
Scope This is the scope of the attribute with permitted values of:
  • Local - denoted by "-" and meaning the attribue has significance and access within the context of the parent class only;
  • Global - denoted by "+" and meaning that the attribute has global scoping (so must have a unique name) and can be accessed from anywhere.
Multiplicity A property of an attribute indicating the number of times it may be used or appear in a given class instance. The values of this property are expressed as a range or shorthand for a range using the notation:
  • "0..1" [optional; restricted]
  • "0..unbounded" [optional; unrestricted]
  • "1..1" [mandatory; restricted]
  • "1..unbounded" [mandatory; unrestricted]
Description Contains descriptions relating to the attribute and its values space.

A3 Data Model Descriptions Explanations

A3.1 Data Model Diagrams

Table A3.1 provides the key to the descriptions of data model diagrams.

Table A3.1 The key to the descriptions of data model diagrams.
Feature Definition and Usage
Data Model Package Each data model description is enclosed in a UML Package that has the stereotype of « dataModel » under which is the name of the data model diagram being described. Only one logical data model can be described.
DerivedType Class This is a class that is identified by the stereotype « DerivedType » under which is the name of the data-type. A derived class is one that is derived either from another derived class or a PrimitiveType class.
Enumeration Class This is a class that is identified by the stereotype « Enumeration » under which is the name of the enumeration data-type. The enumeration class consists of the list of tokens that are the permitted values of the assigned attribute.
Enumerated List Class This is a class that is identified by the stereotype « EnumeratedList » under which is the name of the enumerated list data-type. The enumeration list class consists of the list of tokens that are the permitted values of the assigned attribute. A list of tokens is permitted using comma separation.
PrimitiveType Class This is a class that is identified by the stereotype « PrimitiveType » under which is the name of the primitive data-type. A PrimitiveType is one of the many base data-types on which a data model can be built (see Appendix A3.3 for the set of primitive types that are available).
Selection Class This is a class that is identified by the stereotype « Selection » under which is the name of the data-type. The selection means that only one of the listed attributes make occur in an instance. If this is an abstract class then multiple iterations of the instance may occur and the multiplicity of the attribute defines the constraints on the number of times the attribute can occur in the full instance. If the stereotype and associated name of the class are in italics this denotes the class is abstract.
Sequence Class This is a class that is identified by the stereotype « Sequence » under which is the name of the data-type. The sequence means that the listed attributes must occur only in the order of the attributes listed on the class. The associated multiplicity defines the number of times the attribute may occur consecutively in the instance. If the stereotype and associated name of the class are in italics this denotes the class is abstract.
Unordered Class This is a class that is identified by the stereotype « Unordered » under which is the name of the data-type. The unordering means that the listed attributes may occur in any order but the associated multiplicity for the attribute must be followed (when binding to XML this requires the use of Schematron rules to enforce the multiplicity). If the stereotype and associated name of the class are in italics this denotes the class is abstract.
List Class This is a class that is identified by the stereotype « List » under which is the name of the data-type. A list class is one in which the associated instance will consist of a list of objects that conform to the permitted data-types of the list (the superclasses for the list class). The terms in the list are separated by a space.
Union Class This is a class that is identified by the stereotype « Union » under which is the name of the data-type. A union class is one in which the associated instance will consist of a objects that conform to the any of the permitted data-types of the union (the superclasses for the union class).
Characteristic Description Many classes contain a set of characteristics (the set of characteristics are listed under the stereotype « Characteristics »). Each characteristic description consists of the scope, name, data-type and multiplicity (see Appendix A3.3 for a more complete description). Note that when bound to XSD/XML, a characteristic is mapped to an XML attribute.
Attribute Description Many classes contain a set of attributes (the set of attributes are listed under the stereotype « Attributes »). Each attribute description consists of the scope, name, data-type and multiplicity (see Appendix A3.3 for a more complete description). Note when bound to XSD/XML, an attribute is mapped to an XML element.
Composition Arrow This is an arrow with a filled diamond head to indicate that the child class is a composite structure of the parent class i.e. the child class only exists within the context of the parent class. This association allows complex structures to be constructed with common subcomponents.
Generalization Arrow This is an arrow with a white arrow head to indicate the class/superclass relationship. The arrow points in the direction of generality i.e. from the class to the super class.

toc | top

A3.2 Class Descriptions

Table A3.2 provides the key to the descriptions of the data class tables.

Table A3.2 The key to the descriptions of the data class tables.
Category Definition
Class Name The name given to the class being described.
Class Type The nature of the class. This is described as a "Container [...]" or "Abstract Container [...]". The value of "..." being (see Appendix A3.1 for the meaning of these values):
  • "DerivedType"
  • "List"
  • "Selection"
  • "Sequence"
  • "Union"
  • "Unordered"
If the container is also marked as "Mixed" then the children are permitted to include text as well as attributes.
Parents This is the list of classes that contain the class being described as either the type of a child characteristic or attribute. In the case of a Root Class the entry is also labelled as "Root Class".
Derived Classes The set of classes that are derived from this class (there may be none). The entries are linked to the corresponding class descriptions.
Super Classes The set of super classes from which the class being described is derived (there may be none). The entries are linked to the corresponding class descriptions.
Characteristics Lists the set of characteristics for this class. The list of characteristics includes those that are inherited. Each characteristic is linked to the corresponding characteristic description table.
Children Lists the set of attributes for this class (the only other permitted associations are generalizations). The list of children includes those attributes that are inherited. Each child entry is linked to the corresponding attribute description table. The nature of the relationship between the children is defined by the stereotype of the parent class i.e. the class type. If the child is in italics this denotes a reference to an abstract class and that an instance would NOT contain a child of that name but would be replaced by a complex set of children as defined by the associated abstract class.
Description Contains descriptions relating to the class and its properties and relationships.

toc | top

A3.3 Attribute and Characteristic Descriptions

Table A3.3 provides the key to the descriptions of the data attributes/characteristics for the data classes.

Table A3.3 The key to the descriptions of the data attribute/characteristic tables.
Category Definition
Attribute Name or Characteristic Name The name given to the attribute or characteristic being described. If the name is in italics this denotes an abstract attribute or characteristic.
Data Type This is the data-type of the attribute or characteristic (if this is in italics it denotes an abstract class). The data-type can take many forms:
  • Class Name - the name of the Class (this is linked to the class definition elsewhere in this document);
  • Primitive Data-types from:-
    • AnyTypeLax - the namespace data-type i.e. defining data from any context (this is used for allowing any form of extension);
    • AnyURI - the AnyURI data-type (absolute or relatve URI);
    • Base - the base data-type for defining a base URI/URL link reference;
    • Boolean - the boolean data-type (with permitted values of "true" and "false");
    • Date - the date data-type (using the [ISO 8601] format);
    • DateTime - the date/time data-type (using the [ISO 8601] format);
    • Decimal - the decimal data-type (a variable precision number that is either positive or negative);
    • Double - the double data-type (double precision floating point number - 64bit);
    • Empty - the associated instance must be empty;
    • ID - the unique identifier data-type;
    • IDREF - the reference to a previously defined unique identifier data-type (ID);
    • IDREFS - a list, whitespace separated, of references to a previously defined unique identifier data-type (ID);
    • Int - the int data-type (this is derived from the "decimal" data-type);
    • Integer - the integer data-type (using the);
    • Language - the language data-type as defined in [RFC 3066];
    • Namespace - the namespace data-type i.e. defining data from a context other than that as the default for the data model (this is used for importing other data models);
    • NamespaceLax - the namespace data-type i.e. defining data from a context other than that as the default for the data model (this is used for importing other data models but being lax on the validation);
    • NonNegativeInteger - the non-negative integer data-type (this is derived from the "integer" data-type) i.e. an integer that is zero or higher;
    • NCName - the NCName data-type (derived from the Name data-type);
    • NormalizedString - the normalized string data type (strings with line feeds, carriage returns and tab characters removed);
    • String - the normalized string data type;
    • Time - the time data-type (using the [ISO 8601] format).
Value Space The range of valid values for this attribute/characteristic (including any default value). If the value space is unspecified, it is not known or is not important. This value space must be defined in terms of the associated data-type.
Scope This is the scope of the attribute/characteristic with permitted values of:
  • Local - denoted by "-" and meaning the attribute/characteristic has significance and access within the context of the parent class only;
  • Global - denoted by "+" and meaning that the attribute/characteristic has global scoping (so must have a unique name) and can be accessed from anywhere.
Multiplicity A property of an attribute/characteristic indicating the number of times it may be used or appear in a given class instance. The values of this property are expressed as a range or shorthand for a range using the notation:
  • "0..1" [optional; restricted]
  • "0..*" [optional; unrestricted]
  • "1" [mandatory; restricted]
  • "1..*" [mandatory; unrestricted]
Description Contains descriptions relating to the attribute/characteristic and its values space.

toc | top

A3.4 Enumerated Vocabulary Descriptions

Table A3.4 provides the key to the descriptions of the enumerated vocabulary classes. These are vocabularies that will be contained within the binding form itself

Table A3.4 The key to the descriptions of the enumerated vocabulary tables.
Category Definition
Term The vocabulary token itself i.e. the vocabulary entry.
Definition The meaning of the term and how it should be used.

toc | top

A3.5 External Vocabulary Descriptions

Table A3.5 provides the key to the descriptions of the external vocabulary classes. These are vocabularies that will be contained in some independent format e.g. using the IMS VDEX.

Table A3.5 The key to the descriptions of the external vocabulary tables.
Category Definition
Term The vocabulary token itself i.e. the vocabulary entry.
Definition The meaning of the term and how it should be used. This consists of the "Caption" and "Description" of the vocabulary term. The caption is used to provide a human readable label for the term.

toc | top

A3.6 Import Class Descriptions

Table A3.6 provides the key to the descriptions of the import classes.

Table A3.6 The key to the descriptions of the imported class tables.
Category Definition
Import Class Name The name of the class.
Parent Classes The list of parent classes, and the associated children, that use this imported class. Each class and attribute name has a link to its corresponding tabular description in the information model.
Description The description of how the class is used within the data model.

toc | top

Appendix B Service Status Codes

When a behavior-based IMS service model is developed each operation is required to return status information. This status information provides contextual information about the completed success or otherwise of the operation. There are two types of status information that are available to the end-systems:

B1 Definition of the Status Codes

The status information for the business transactions is carried in a single status information object that contains the following sub-structures:

The interpretation of the "CodeMajor/Severity" behavior matrix is summarized in Table B1.1.

Table B1.1 Interpretation of the of the "CodeMajor/Severity" behavior matrix.
Severity CodeMajor
"Success" "Processing" "Failure" "Unsupported"
"Status" The transaction request has been completed successfully. The transaction request is being processed at the destination i.e. the request has been received and acknowledged. This combination is used in asynchronous services. The transaction request has failed. The detailed reason will be reported in the accmpanying "codeMinor" fields. The destination service handler does not support the requested operation. This is the required default response for an unsupported operation by an implementation.
"Warning" Some of the request has been completed successfully e.g. partial data storage, etc. The request has been transmitted but acknowledgement of receipt at the destination has not been received. This combination is used in asynchronous services. Not permitted. Not permitted.
"Error" Not permitted. An error has been detected in the immediate transmission communications handler i.e. the message has not left the local end-system. There has been a failure in the end-to-end system communications mechanism and so the request has not been delivered. The destination service handler does not recognise the requested operation i.e. it is an unknown service extension.

B1.1 Definition of the "CodeMajor" Values

The set of codes used for the "codeMajor" status code field are defined in Table B1.2.

Table B1.2 Definition of the "CodeMajor" status code values.
Status Code Description
success Denotes that the request has been successfully completed. If the associated 'severity' value is 'warning' then the request has been partially successful i.e. best effort by the service provider. Other parts of the status information may provide more insight into a partial sucess response.
processing Denotes that the request is being processed at the destination or there has been a local transmission failure. This value is used in asynchronous services.
failure Denotes that the transaction request has failed. The detailed reason will be reported in the accmpanying 'codeMinor' fields.
unsupported Denotes that the service provider does not support the requested operation. This is the required default response for an unsupported operation by an implementation.

B1.2 Definition of the "Severity" Values

The set of codes used for the "severity" status code field are defined in Table B1.3.

Table B1.3 Definition of the "Severity" status code values.
Status Code Description
status The request has been completed and a response was received from the Service Provider.
warning The request has only been partially completed. For an asynchronous service a further response should be expected.
error A catastrophic error has occurred in processing the request and so the request was not completed (the Service Provider may not even have received the request).

B1.3 Definition of the "CodeMinor" Values

The set of codes used for the "codeMinor" status code field are defined in Table B1.4.

Table B1.4 Definition of the "CodeMinor" status code field values.
Status Code Description
forbidden This is used to indicate that the server can be reached and process the request but refuses to take any further action. This would be accompanied by the 'codeMajor/severity' values of 'failure/error' and for a REST binding a HTTP code of '403'.
fullsuccess The request has been fully and successfully implemented by the Service Provider. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'.
internal_server_error This should be used only if there is catastrophic error and there is not a more appropriate code. This would be accompanied by the 'codeMajor/severity' values of 'failure/error' and for a REST binding a HTTP code of '500'.
invaliddata One or more of the supplied PersonIDs were invalid i.e. the Service Proivder could not locate an associated object. The Service Provdier has attempted to return as many objects as possble. This would be accompanied by the 'codeMajor/severity' values of 'failure/error' and for a REST binding a HTTP code of '404'.
server_busy The server is receiving too many requests. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error' and for a REST binding a HTTP code of '429'.
targetreadfailure The Service Provider could not complete the read request i.e. the form of the URL Query Parameters was invalid. This would be accompanied by the 'codeMajor/severity' values of 'failure/error' and for a REST binding a HTTP code of '400'.
unauthorisedrequest The request was not correctly authorised. This would be accompanied by the 'codeMajor/severity' values of 'failure/error' and for a REST binding a HTTP code of '401'.

toc | top

About this Document

Title: IMS Extended Transcript Service Information Model v1.0
Editors: Bryan Smith, Learning Objects (USA)
Chris Houston, Capella University (USA)
Markus Gylling, IMS Global Learning Consortium (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 and communicate learner achievement records in a standardized format. This standard defines an information model 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 contains the information model for the Extended Transcript service.

Revision Information: First release of this specification.
Purpose: For adoption and implementation of extended transcripts in a standardized, machine-readable format.
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
Candidate Final September 8, 2017 First release of the Extended Transcript specification.

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 Service Information Model v1.0

Date: September 8, 2017

toc | top