LTI Resource Search Service

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.

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.

Abstract

The Learning Tools Interoperability (LTI) Resource Search specification defines how to search digital repositories for a set of resources via a web services API. The standard addresses searching learning object repositories (LORs), and other catalogs of learning resources. The specification supports executing these search from learning tools using various attributes of resources and returning full metadata about the resources to the learning tools. Results can be launched either as URLs or LTI links. The goal of the LTI Resource Search standard is a standard way for students and teachers to be able to search resource providers, such as learning object repositories, from single sources or aggregated from multiple sources, within a learning object consumer such as a learning management system or other educational platform.

List of Figures

List of Tables

Table 3.1 The set of interfaces.

Table 3.2 The set of operations for the "ResourceSearchManager" interface.

Table 3.3 The set of operations for the "SubjectsManager" interface.

Table 4.1 "ResourceSet" Class Description

Table 4.1.1 "resources" Attribute Description

Table 4.2 "SubjectSet" Class Description

Table 4.2.1 "subjects" Attribute Description

Table 4.3 "imsx_StatusInfo" Class Description

Table 4.3.1 "imsx_codeMajor" Attribute Description

Table 4.3.2 "imsx_severity" Attribute Description

Table 4.3.3 "imsx_description" Attribute Description

Table 4.3.4 "imsx_codeMinor" Attribute Description

Table 5.1.1 CCLTILink class definitions

Table 5.1.1.1 Description of the "cartridge_bundle" attribute for the "CCLTILink" class

Table 5.1.1.2 Description of the "cartridge_icon" attribute for the "CCLTILink" class

Table 5.1.1.3 Description of the "metadata" attribute for the "CCLTILink" class

Table 5.1.2 CSMSet class definitions

Table 5.1.2.1 Description of the "resourceLabel" attribute for the "CSMSet" class

Table 5.1.2.2 Description of the "resourcePartId" attribute for the "CSMSet" class

Table 5.1.2.3 Description of the "curriculumStandardsMetadata" attribute for the "CSMSet" class

Table 5.1.3 CurriculumStandardsMetadata class definitions

Table 5.1.3.1 Description of the "providerId" attribute for the "CurriculumStandardsMetadata" class

Table 5.1.3.2 Description of the "setOfGUIDs" attribute for the "CurriculumStandardsMetadata" class

Table 5.1.4 LTILink class definitions

Table 5.1.4.1 Description of the "title" attribute for the "LTILink" class

Table 5.1.4.2 Description of the "description" attribute for the "LTILink" class

Table 5.1.4.3 Description of the "custom" attribute for the "LTILink" class

Table 5.1.4.4 Description of the "extensions" attribute for the "LTILink" class

Table 5.1.4.5 Description of the "launch_url" attribute for the "LTILink" class

Table 5.1.4.6 Description of the "secure_launch_url" attribute for the "LTILink" class

Table 5.1.4.7 Description of the "icon" attribute for the "LTILink" class

Table 5.1.4.8 Description of the "secure_icon" attribute for the "LTILink" class

Table 5.1.4.9 Description of the "vendor" attribute for the "LTILink" class

Table 5.1.5 LTILinkResourceRef class definitions

Table 5.1.5.1 Description of the "name" attribute for the "LTILinkResourceRef" class

Table 5.1.5.2 Description of the "resourceUri" attribute for the "LTILinkResourceRef" class

Table 5.1.6 LabelledGUID class definitions

Table 5.1.6.1 Description of the "label" attribute for the "LabelledGUID" class

Table 5.1.6.2 Description of the "caseItemURI" attribute for the "LabelledGUID" class

Table 5.1.6.3 Description of the "GUID" attribute for the "LabelledGUID" class

Table 5.1.7 LearningObjectives class definitions

Table 5.1.7.1 Description of the "alignmentType" attribute for the "LearningObjectives" class

Table 5.1.7.2 Description of the "educationalFramework" attribute for the "LearningObjectives" class

Table 5.1.7.3 Description of the "targetDescription" attribute for the "LearningObjectives" class

Table 5.1.7.4 Description of the "targetName" attribute for the "LearningObjectives" class

Table 5.1.7.5 Description of the "targetURL" attribute for the "LearningObjectives" class

Table 5.1.7.6 Description of the "caseItemUri" attribute for the "LearningObjectives" class

Table 5.1.7.7 Description of the "caseItemGUID" attribute for the "LearningObjectives" class

Table 5.1.8 Metadata class definitions

Table 5.1.8.1 Description of the "curriculumStandardsMetadataSet" attribute for the "Metadata" class

Table 5.1.9 PlatformPropertySet class definitions

Table 5.1.9.1 Description of the "platform" attribute for the "PlatformPropertySet" class

Table 5.1.9.2 Description of the "properties" attribute for the "PlatformPropertySet" class

Table 5.1.10 Property class definitions

Table 5.1.10.1 Description of the "name" attribute for the "Property" class

Table 5.1.10.2 Description of the "value" attribute for the "Property" class

Table 5.1.11 PropertySet class definitions

Table 5.1.11.1 Description of the "properties" attribute for the "PropertySet" class

Table 5.1.12 Resource class definitions

Table 5.1.12.1 Description of the "name" attribute for the "Resource" class

Table 5.1.12.2 Description of the "description" attribute for the "Resource" class

Table 5.1.12.3 Description of the "subject" attribute for the "Resource" class

Table 5.1.12.4 Description of the "url" attribute for the "Resource" class

Table 5.1.12.5 Description of the "ltiLink" attribute for the "Resource" class

Table 5.1.12.6 Description of the "learningResourceType" attribute for the "Resource" class

Table 5.1.12.7 Description of the "language" attribute for the "Resource" class

Table 5.1.12.8 Description of the "thumbnailUrl" attribute for the "Resource" class

Table 5.1.12.9 Description of the "typicalAgeRange" attribute for the "Resource" class

Table 5.1.12.10 Description of the "textComplexity" attribute for the "Resource" class

Table 5.1.12.11 Description of the "learningObjectives" attribute for the "Resource" class

Table 5.1.12.12 Description of the "author" attribute for the "Resource" class

Table 5.1.12.13 Description of the "publisher" attribute for the "Resource" class

Table 5.1.12.14 Description of the "useRightsURL" attribute for the "Resource" class

Table 5.1.12.15 Description of the "timeRequired" attribute for the "Resource" class

Table 5.1.12.16 Description of the "technicalFormat" attribute for the "Resource" class

Table 5.1.12.17 Description of the "educationalAudience" attribute for the "Resource" class

Table 5.1.12.18 Description of the "accessibilityAPI" attribute for the "Resource" class

Table 5.1.12.19 Description of the "accessibilityInputMethods" attribute for the "Resource" class

Table 5.1.12.20 Description of the "accessibilityFeatures" attribute for the "Resource" class

Table 5.1.12.21 Description of the "accessibilityHazards" attribute for the "Resource" class

Table 5.1.12.22 Description of the "accessMode" attribute for the "Resource" class

Table 5.1.12.23 Description of the "publishDate" attribute for the "Resource" class

Table 5.1.12.24 Description of the "rating" attribute for the "Resource" class

Table 5.1.12.25 Description of the "relevance" attribute for the "Resource" class

Table 5.1.12.26 Description of the "extensions" attribute for the "Resource" class

Table 5.1.13 ResourceSet class definitions

Table 5.1.13.1 Description of the "resources" attribute for the "ResourceSet" class

Table 5.1.14 SetOfGUIDs class definitions

Table 5.1.14.1 Description of the "region" attribute for the "SetOfGUIDs" class

Table 5.1.14.2 Description of the "version" attribute for the "SetOfGUIDs" class

Table 5.1.14.3 Description of the "labelledGUID" attribute for the "SetOfGUIDs" class

Table 5.1.15 Subject class definitions

Table 5.1.15.1 Description of the "identifier" attribute for the "Subject" class

Table 5.1.15.2 Description of the "name" attribute for the "Subject" class

Table 5.1.15.3 Description of the "parent" attribute for the "Subject" class

Table 5.1.16 SubjectSet class definitions

Table 5.1.16.1 Description of the "subjects" attribute for the "SubjectSet" class

Table 5.1.17 TextComplexity class definitions

Table 5.1.17.1 Description of the "name" attribute for the "TextComplexity" class

Table 5.1.17.2 Description of the "value" attribute for the "TextComplexity" class

Table 5.1.18 Vendor class definitions

Table 5.1.18.1 Description of the "code" attribute for the "Vendor" class

Table 5.1.18.2 Description of the "name" attribute for the "Vendor" class

Table 5.1.18.3 Description of the "description" attribute for the "Vendor" class

Table 5.1.18.4 Description of the "url" attribute for the "Vendor" class

Table 5.1.18.5 Description of the "emailContact" attribute for the "Vendor" class

Table 5.1.19 imsx_CodeMinor class definitions

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

Table 5.1.20 imsx_CodeMinorField class definitions

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

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

Table 5.1.21 imsx_StatusInfo class definitions

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

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

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

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

Table 5.2.1 AgeRange class definitions

Table 5.2.2 Float0to1 class definitions

Table 5.2.3 GUID class definitions

Table 5.2.4 NString1024 class definitions

Table 5.2.5 NString2048 class definitions

Table 5.2.6 URL class definitions

Table 5.3.1 AccessModeEnum class definitions

Table 5.3.2 AccessibilityAPIEnum class definitions

Table 5.3.3 AccessibilityInputEnum class definitions

Table 5.3.4 AlignmentTypeEnum class definitions

Table 5.3.5 EducationalAudienceEnum class definitions

Table 5.3.6 HazardEnum class definitions

Table 5.3.7 LRTEnum class definitions

Table 5.3.8 RatingEnum class definitions

Table 5.3.9 TextComplexityNameEnum class definitions

Table 5.3.10 imsx_CodeMajorEnum class definitions

Table 5.3.11 imsx_CodeMinorValueEnum class definitions

Table 5.3.12 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

1. Introduction

1.1 Scope and Context

This document is the LTI Resource Search (RS) Service Model v1.0 and as such it is used as the basis for the development of the following documents:

This service model is defined to enable the exchange of information as identified in the core use-cases [RS-UC, 18]. This service model defines the RS 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.2 Conventions

All sections marked as non-normative, all authoring guidelines, diagrams (with the exception of the UML diagrams), examples, and notes in this specification are non-normative. Everything else in this specification is normative.

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119]. This means that from the perspective of conformance:

The Conformance and Certification Guide for this specification may introduce greater normative constraints than those defined here for specific service or implementation categories.

The SHOULD/SHOULD NOT/RECOMMENDED statements MUST NOT be used in any document, or section of a document, that is responsible for defining the information model and/or the associated bindings and/or conformance and certification.

1.3 Structure of this Document

1.4 Nomenclature

2. Service Architecture and Specification Model

2.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 Service 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 service 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.

2.2 Service Architecture and Specification Model

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

2.3 Service Objects

The set of service collection objects that are exchanged between end-systems are:

2.4 The LTI Resource Search Service Choreography

The LTI Resource Search Service consists of a set of synchronous messsage exchanges, 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 LTI Resource Search Engine. The corresponding sequence of actions is shown in Figure 2.2.

3. The Behavior Model

3.1 Service Definition

Table 3.1 The set of interfaces.
Interface	Description
ResourceSearchManager	The set of service operations that manage searching for resources.
SubjectsManager	The set of service operations that manage access to the lists of subjects supported by a LOR.

3.2 ResourceSearchManager Interface Description

Table 3.2 The set of operations for the "ResourceSearchManager" interface.
Operation	Description
searchForResources	This is the search request. The criteria for the search are passed as query parameters and the set of identified resources are returned in the payload for the response message.

3.2.1 "searchForResources" Operation

3.3 SubjectsManager Interface Description

Table 3.3 The set of operations for the "SubjectsManager" interface.
Operation	Description
getAllSubjects	To obtain, read, the list of subjects that are supported by a LOR.

3.3.1 "getAllSubjects" Operation

4. The Interface Model

4.1 ResourceSet Class Description

Table 4.1 Description of the "ResourceSet" class.
Descriptor	Definition
Class Name	ResourceSet
Class Type	Container [ Unordered ]
Parents	Service parameter data-type used in the following operations: searchForResources
Characteristics	There are no characteristics.
Children	The set of children attributes are: resources
Description	The container for the set of resources that have been supplied by the service provider. This may be empty if none of the resources fulfill the search criteria. The order of resources is not significant.

4.1.1 "resources" Attribute Description

Table 4.1.1 Description of the "resources" attribute for the "ResourceSet" class.
Descriptor	Definition
Attribute Name	resources
Data Type	Resource
Value Space	Container [ Unordered ]
Scope	Local ("-")
Multiplicity	[0.. unbounded]
Description	The actual resources supplied by the service provider. The order of resources is not significant.

4.2 SubjectSet Class Description

Table 4.2 Description of the "SubjectSet" class.
Descriptor	Definition
Class Name	SubjectSet
Class Type	Container [ Unordered ]
Parents	Service parameter data-type used in the following operations: getAllSubjects
Characteristics	There are no characteristics.
Children	The set of children attributes are: subjects
Description	The container for the set of subjects that have been supplied by the service provider. This may be empty if none of the subjects fulfill the search criteria. The order of subjects is not significant.

4.2.1 "subjects" Attribute Description

Table 4.2.1 Description of the "subjects" attribute for the "SubjectSet" class.
Descriptor	Definition
Attribute Name	subjects
Data Type	Subject
Value Space	Container [ Unordered ]
Scope	Local ("-")
Multiplicity	[0.. unbounded]
Description	The actual list of subject supplied by the service provider. The order of subjects is not significant.

4.3 imsx_StatusInfo Class Description

Table 4.3 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: searchForResources getAllSubjects
Characteristics	There are no characteristics.
Children	The set of children attributes are: imsx_codeMajor imsx_severity imsx_description imsx_codeMinor
Description	This is the container for the status code and associated information returned within the HTTP messages received from the Service Provider.

4.3.1 "imsx_codeMajor" Attribute Description

Table 4.3.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).

4.3.2 "imsx_severity" Attribute Description

Table 4.3.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).

4.3.3 "imsx_description" Attribute Description

Table 4.3.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.

4.3.4 "imsx_codeMinor" Attribute Description

Table 4.3.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.

5. Data Model

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

5.1.1 CCLTILink Class Description

Table 5.1.1 Description of the "CCLTILink" class.
Descriptor	Definition
Class Name	CCLTILink
Class Type	Container [ Unordered ]
Parents	The set of parent classes are: Resource
Derived Classes	There are no derived classes.
Super Classes	The set of classes from which this class is derived: LTILink
Characteristics	There are no characteristics.
Children	The set of children attributes are: cartridge_bundle cartridge_icon metadata The set of inherited children attributes are: title description custom extensions launch_url secure_launch_url icon secure_icon vendor
Description	The extended set of information used to define the presence of an LTI Link resource (this is based upon the definition for including an LTI link inside an IMS Common Cartridge or IMS Thin Common Cartridge).

5.1.1.1 "cartridge_bundle" Attribute Description

Table 5.1.1.1 Description of the "cartridge_bundle" attribute for the "CCLTILink" class.
Descriptor	Definition
Attribute Name	cartridge_bundle
Data Type	LTILinkResourceRef
Value Space	Container [ Unordered ]
Scope	Local ("-")
Multiplicity	[0..1]
Description	A link to a bundled set of files. For example this could be a link to zip file that contains all of the icons.

5.1.1.2 "cartridge_icon" Attribute Description

Table 5.1.1.2 Description of the "cartridge_icon" attribute for the "CCLTILink" class.
Descriptor	Definition
Attribute Name	cartridge_icon
Data Type	LTILinkResourceRef
Value Space	Container [ Unordered ]
Scope	Local ("-")
Multiplicity	[0..1]
Description	An icon for the link to the cartridge. This could be used to provide an alternative visualisation to the use of the URL itself.

5.1.1.3 "metadata" Attribute Description

Table 5.1.1.3 Description of the "metadata" attribute for the "CCLTILink" class.
Descriptor	Definition
Attribute Name	metadata
Data Type	Metadata
Value Space	Container [ Unordered ]
Scope	Local ("-")
Multiplicity	[0..1]
Description	The set of metadata that is associated with the LTI Link.

5.1.2 CSMSet Class Description

Table 5.1.2 Description of the "CSMSet" class.
Descriptor	Definition
Class Name	CSMSet
Class Type	Container [ Unordered ]
Parents	The set of parent classes are: Metadata
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: resourceLabel resourcePartId curriculumStandardsMetadata
Description	This is the is the container for the set of curriculum standards metadata. Each member of the set contains the curriculum standards metadata for a specific source of the GUIDs.

5.1.2.1 "resourceLabel" Attribute Description

Table 5.1.2.1 Description of the "resourceLabel" attribute for the "CSMSet" class.
Descriptor	Definition
Attribute Name	resourceLabel
Data Type	NormalizedString (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[0..1]
Description	This is a human readable label used to identify the type of resource, or part of resource, to which the enclosed metadata refers.

5.1.2.2 "resourcePartId" Attribute Description

Table 5.1.2.2 Description of the "resourcePartId" attribute for the "CSMSet" class.
Descriptor	Definition
Attribute Name	resourcePartId
Data Type	NormalizedString (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[0..1]
Description	This is used to contain the appropriate identifier that is used to identify the resource part.

5.1.2.3 "curriculumStandardsMetadata" Attribute Description

Table 5.1.2.3 Description of the "curriculumStandardsMetadata" attribute for the "CSMSet" class.
Descriptor	Definition
Attribute Name	curriculumStandardsMetadata
Data Type	CurriculumStandardsMetadata
Value Space	Container [ Unordered ]
Scope	Local ("-")
Multiplicity	[1.. unbounded]
Description	The curriculum standards associated from a single source of the curriculum standards definition.

5.1.3 CurriculumStandardsMetadata Class Description

Table 5.1.3 Description of the "CurriculumStandardsMetadata" class.
Descriptor	Definition
Class Name	CurriculumStandardsMetadata
Class Type	Container [ Unordered ]
Parents	The set of parent classes are: CSMSet
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: providerId setOfGUIDs
Description	This is the container for the special metadata for curriculum standards for a particular domain of GUID provider.

5.1.3.1 "providerId" Attribute Description

Table 5.1.3.1 Description of the "providerId" attribute for the "CurriculumStandardsMetadata" class.
Descriptor	Definition
Attribute Name	providerId
Data Type	NormalizedString (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[0..1]
Description	This is used to denote the originator of the GUID scheme.

5.1.3.2 "setOfGUIDs" Attribute Description

Table 5.1.3.2 Description of the "setOfGUIDs" attribute for the "CurriculumStandardsMetadata" class.
Descriptor	Definition
Attribute Name	setOfGUIDs
Data Type	SetOfGUIDs
Value Space	Container [ Unordered ]
Scope	Local ("-")
Multiplicity	[1.. unbounded]
Description	The set of curriculum standards GUIDs that apply to the learning associated resource.

5.1.4 LTILink Class Description

Table 5.1.4 Description of the "LTILink" class.
Descriptor	Definition
Class Name	LTILink
Class Type	Container [ Unordered ]
Parents	There are no parent classes.
Derived Classes	The set of derived classes are: CCLTILink
Super Classes	This class is not derived from another class.
Characteristics	There are no characteristics.
Children	The set of children attributes are: title description custom extensions launch_url secure_launch_url icon secure_icon vendor
Description	The container for all of the core information about an LTI Link.

5.1.4.1 "title" Attribute Description

Table 5.1.4.1 Description of the "title" attribute for the "LTILink" class.
Descriptor	Definition
Attribute Name	title
Data Type	NormalizedString (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[1]
Description	The human readable title/label for the activity being addressed by the content available through the LTI link.

5.1.4.2 "description" Attribute Description

Table 5.1.4.2 Description of the "description" attribute for the "LTILink" class.
Descriptor	Definition
Attribute Name	description
Data Type	String (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[0..1]
Description	A human readable description of the activity addressed by the content supplied via the LTI link.

5.1.4.3 "custom" Attribute Description

Table 5.1.4.3 Description of the "custom" attribute for the "LTILink" class.
Descriptor	Definition
Attribute Name	custom
Data Type	PropertySet
Value Space	Container [ Unordered ]
Scope	Local ("-")
Multiplicity	[0..1]
Description	A set of custom key value pairs that were placed in the link in the system that originally authored the link. These will be supplied as parameters on the launch call.

5.1.4.4 "extensions" Attribute Description

Table 5.1.4.4 Description of the "extensions" attribute for the "LTILink" class.
Descriptor	Definition
Attribute Name	extensions
Data Type	PlatformPropertySet
Value Space	Container [ Unordered ]
Scope	Local ("-")
Multiplicity	[0..1]
Description	The extensions allows the hosting Tool Consumer (TC) to add its own key/value pairs to the link. The TC may use extensions to store information that the TC or authoring environment might use across an export-import cycle. In order to allow multiple sets of extensions to be contained in the same LTI descriptor, authoring environments should add the platform attribute and include an identifier that identifies the authoring environment.

5.1.4.5 "launch_url" Attribute Description

Table 5.1.4.5 Description of the "launch_url" attribute for the "LTILink" class.
Descriptor	Definition
Attribute Name	launch_url
Data Type	URL
Value Space	Container [ DerivedType ]
Scope	Local ("-")
Multiplicity	[0..1]
Description	The URL for the LTI launch. One of either the launch_url or the secure_launch_url must be specified. It is acceptable to specify both and if both are specified, the Tool Consumer (TC) decides which to use. Typically, the TC will use a secure_launch_url when embedding the Tool in a secure page and the launch_url when embedding the tool in a non-secure page. So, it is important that the Tool Provider (TP) provides the same functionality whether the launch_url or secure_launch_url is used.

5.1.4.6 "secure_launch_url" Attribute Description

Table 5.1.4.6 Description of the "secure_launch_url" attribute for the "LTILink" class.
Descriptor	Definition
Attribute Name	secure_launch_url
Data Type	URL
Value Space	Container [ DerivedType ]
Scope	Local ("-")
Multiplicity	[0..1]
Description	A secure URL for the LTI launch. One of either the launch_url or the secure_launch_url must be specified. It is acceptable to specify both and if both are specified, the Tool Consumer (TC) decides which to use. Typically, the TC will use a secure_launch_url when embedding the Tool in a secure page and the launch_url when embedding the tool in a non-secure page. So, it is important that the Tool Provider (TP) provides the same functionality whether the launch_url or secure_launch_url is used.

5.1.4.7 "icon" Attribute Description

Table 5.1.4.7 Description of the "icon" attribute for the "LTILink" class.
Descriptor	Definition
Attribute Name	icon
Data Type	URL
Value Space	Container [ DerivedType ]
Scope	Local ("-")
Multiplicity	[0..1]
Description	A URL to an icon for this tool.

5.1.4.8 "secure_icon" Attribute Description

Table 5.1.4.8 Description of the "secure_icon" attribute for the "LTILink" class.
Descriptor	Definition
Attribute Name	secure_icon
Data Type	URL
Value Space	Container [ DerivedType ]
Scope	Local ("-")
Multiplicity	[0..1]
Description	A secure URL to an icon for this tool.

5.1.4.9 "vendor" Attribute Description

Table 5.1.4.9 Description of the "vendor" attribute for the "LTILink" class.
Descriptor	Definition
Attribute Name	vendor
Data Type	Vendor
Value Space	Container [ Unordered ]
Scope	Local ("-")
Multiplicity	[1]
Description	The information about the vendor of the tool accessed via this LTI link.

5.1.5 LTILinkResourceRef Class Description

Table 5.1.5 Description of the "LTILinkResourceRef" class.
Descriptor	Definition
Class Name	LTILinkResourceRef
Class Type	Container [ Unordered ]
Parents	The set of parent classes are: CCLTILink
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: name resourceUri
Description	The container for the link information.

5.1.5.1 "name" Attribute Description

Table 5.1.5.1 Description of the "name" attribute for the "LTILinkResourceRef" class.
Descriptor	Definition
Attribute Name	name
Data Type	NormalizedString (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[1]
Description	The name of the type of content supplied by the link.

5.1.5.2 "resourceUri" Attribute Description

Table 5.1.5.2 Description of the "resourceUri" attribute for the "LTILinkResourceRef" class.
Descriptor	Definition
Attribute Name	resourceUri
Data Type	AnyURI (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[1]
Description	The URI for the link.

5.1.6 LabelledGUID Class Description

Table 5.1.6 Description of the "LabelledGUID" class.
Descriptor	Definition
Class Name	LabelledGUID
Class Type	Container [ Unordered ]
Parents	The set of parent classes are: SetOfGUIDs
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: label caseItemURI GUID
Description	The labelled curriculum standard GUID.

5.1.6.1 "label" Attribute Description

Table 5.1.6.1 Description of the "label" attribute for the "LabelledGUID" class.
Descriptor	Definition
Attribute Name	label
Data Type	NormalizedString (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[0..1]
Description	A human readable string to provide a clue about the nature of the curriculum standard.

5.1.6.2 "caseItemURI" Attribute Description

Table 5.1.6.2 Description of the "caseItemURI" attribute for the "LabelledGUID" class.
Descriptor	Definition
Attribute Name	caseItemURI
Data Type	AnyURI (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[0..1]
Description	The corresponding Competency and Academic Standards (CASE) URI. This is the URI used for alignment with the IMS CASE Service 1.0 specification [CASE, 17].

5.1.6.3 "GUID" Attribute Description

Table 5.1.6.3 Description of the "GUID" attribute for the "LabelledGUID" class.
Descriptor	Definition
Attribute Name	GUID
Data Type	GUID
Value Space	Container [ DerivedType ]
Scope	Local ("-")
Multiplicity	[1]
Description	The GUID itself.

5.1.7 LearningObjectives Class Description

Table 5.1.7 Description of the "LearningObjectives" class.
Descriptor	Definition
Class Name	LearningObjectives
Class Type	Container [ Unordered ]
Parents	The set of parent classes are: Resource
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: alignmentType educationalFramework targetDescription targetName targetURL caseItemUri caseItemGUID
Description	The container for the learning objectives which are addressed by the resource.

5.1.7.1 "alignmentType" Attribute Description

Table 5.1.7.1 Description of the "alignmentType" attribute for the "LearningObjectives" class.
Descriptor	Definition
Attribute Name	alignmentType
Data Type	AlignmentTypeEnum
Value Space	Enumerated value set of: { assesses \| teaches \| requires \| textComplexity \| readingLevel \| educationalSubject \| educationLevel }
Scope	Local ("-")
Multiplicity	[1]
Description	A category of alignment between the learning resource and the framework node.

5.1.7.2 "educationalFramework" Attribute Description

Table 5.1.7.2 Description of the "educationalFramework" attribute for the "LearningObjectives" class.
Descriptor	Definition
Attribute Name	educationalFramework
Data Type	NormalizedString (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[0..1]
Description	The framework to which the resource being described is aligned.

5.1.7.3 "targetDescription" Attribute Description

Table 5.1.7.3 Description of the "targetDescription" attribute for the "LearningObjectives" class.
Descriptor	Definition
Attribute Name	targetDescription
Data Type	NormalizedString (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[0..1]
Description	The description of a node in an established educational framework.

5.1.7.4 "targetName" Attribute Description

Table 5.1.7.4 Description of the "targetName" attribute for the "LearningObjectives" class.
Descriptor	Definition
Attribute Name	targetName
Data Type	NormalizedString (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[0..1]
Description	The name of a node in an established educational framework.

5.1.7.5 "targetURL" Attribute Description

5.1.7.6 "caseItemUri" Attribute Description

5.1.7.7 "caseItemGUID" Attribute Description

5.1.8 Metadata Class Description

5.1.8.1 "curriculumStandardsMetadataSet" Attribute Description

5.1.9 PlatformPropertySet Class Description

5.1.9.1 "platform" Attribute Description

5.1.9.2 "properties" Attribute Description

5.1.10 Property Class Description

5.1.10.1 "name" Attribute Description

5.1.10.2 "value" Attribute Description

5.1.11 PropertySet Class Description

5.1.11.1 "properties" Attribute Description

5.1.12 Resource Class Description

5.1.12.1 "name" Attribute Description

5.1.12.2 "description" Attribute Description

5.1.12.3 "subject" Attribute Description

5.1.12.4 "url" Attribute Description

5.1.12.5 "ltiLink" Attribute Description

5.1.12.6 "learningResourceType" Attribute Description

5.1.12.7 "language" Attribute Description

5.1.12.8 "thumbnailUrl" Attribute Description

5.1.12.9 "typicalAgeRange" Attribute Description

5.1.12.10 "textComplexity" Attribute Description

5.1.12.11 "learningObjectives" Attribute Description

5.1.12.12 "author" Attribute Description

5.1.12.13 "publisher" Attribute Description

5.1.12.14 "useRightsURL" Attribute Description

5.1.12.15 "timeRequired" Attribute Description

5.1.12.16 "technicalFormat" Attribute Description

5.1.12.17 "educationalAudience" Attribute Description

5.1.12.18 "accessibilityAPI" Attribute Description

5.1.12.19 "accessibilityInputMethods" Attribute Description

5.1.12.20 "accessibilityFeatures" Attribute Description

5.1.12.21 "accessibilityHazards" Attribute Description

5.1.12.22 "accessMode" Attribute Description

5.1.12.23 "publishDate" Attribute Description

5.1.12.24 "rating" Attribute Description

5.1.12.25 "relevance" Attribute Description

5.1.12.26 "extensions" Attribute Description

5.1.13 ResourceSet Class Description

5.1.13.1 "resources" Attribute Description

5.1.14 SetOfGUIDs Class Description

5.1.14.1 "region" Attribute Description

5.1.14.2 "version" Attribute Description

5.1.14.3 "labelledGUID" Attribute Description

5.1.15 Subject Class Description

5.1.15.1 "identifier" Attribute Description

5.1.15.2 "name" Attribute Description

5.1.15.3 "parent" Attribute Description

5.1.16 SubjectSet Class Description

5.1.16.1 "subjects" Attribute Description

5.1.17 TextComplexity Class Description

5.1.17.1 "name" Attribute Description

5.1.17.2 "value" Attribute Description

5.1.18 Vendor Class Description

5.1.18.1 "code" Attribute Description

5.1.18.2 "name" Attribute Description

5.1.18.3 "description" Attribute Description

5.1.18.4 "url" Attribute Description

5.1.18.5 "emailContact" Attribute Description

5.1.19 imsx_CodeMinor Class Description

5.1.19.1 "imsx_codeMinorField" Attribute Description

5.1.20 imsx_CodeMinorField Class Description

5.1.20.1 "imsx_codeMinorFieldName" Attribute Description

5.1.20.2 "imsx_codeMinorFieldValue" Attribute Description

5.1.21 imsx_StatusInfo Class Description

5.1.21.1 "imsx_codeMajor" Attribute Description

5.1.21.2 "imsx_severity" Attribute Description

5.1.21.3 "imsx_description" Attribute Description

5.1.21.4 "imsx_codeMinor" Attribute Description

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

5.2.1 AgeRange Class Description

5.2.2 Float0to1 Class Description

5.2.3 GUID Class Description

5.2.4 NString1024 Class Description

5.2.5 NString2048 Class Description

5.2.6 URL Class Description

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

5.3.1 AccessModeEnum Vocabulary Description

5.3.2 AccessibilityAPIEnum Vocabulary Description

5.3.3 AccessibilityInputEnum Vocabulary Description

5.3.4 AlignmentTypeEnum Vocabulary Description

5.3.5 EducationalAudienceEnum Vocabulary Description

5.3.6 HazardEnum Vocabulary Description

5.3.7 LRTEnum Vocabulary Description

5.3.8 RatingEnum Vocabulary Description

5.3.9 TextComplexityNameEnum Vocabulary Description

5.3.10 imsx_CodeMajorEnum Vocabulary Description

5.3.11 imsx_CodeMinorValueEnum Vocabulary Description

5.3.12 imsx_SeverityEnum Vocabulary Description

6. Extending and Profiling the Service

6.1 Extending the Service

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.

6.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 [RS-BP, 18].

6.1.2 Proprietary Data Elements

It is recognized that implementers may wish to extend the specification. Extensions are ONLY permitted in the 'Resource' class within the data model.

6.2 Profiling the Service

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.

References

Appendix A Modeling Concepts and Terms

A1 Behavior Descriptions Explanations

A1.1 Service Model 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

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

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. They are contained within a class that has a stereotype of either « Enumeration » or « EnumeratedList ».

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 [VDEX, 04].

A3.6 Import Class Descriptions

Appendix B Service Status Codes

B1 Definition of the Status Codes

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

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

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.

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.

Date Issued:	10th September, 2018
Latest version:	https://www.imsglobal.org/spec/lti-rs/latest/

API	Application Programming Interface
AfAPNP	Access for All Personal Needs and Preferences
CASE	Competencies and Academic Standards Exchange
HTTP	Hypertext Transfer Protocol
I-BAT	IMS Binding Autogeneration Toolkit
IETF	Internet Engineering Task Force
ISO	International Standards Organization
JSON	Java Script Object Notation
LOR	Learning Object Repository
LTI	Learning Tools Interoperability
OAS	OpenAPI Specification
PNP	Personal Needs and Preferences
REST	Representation State Transfer
RFC	Request for Comments
RS	LTI Resource Search
TLS	Transport Layer Security
UML	Unified Modeling Language
URI	Uniform Resource Identifier
URL	Uniform Resource Locator
YAML	Yet Another Markup Language

Name:	searchForResources ()
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:	resourceSet : ResourceSet - the set of resources that have been identified as conforming to the query criteria.
Behavior:	This is the search request. The criteria for the search are passed as query parameters and the set of identified resources are returned in the payload for the response message.
Notes:	Query Parameters for the REST-based binding have been defined for this operation, namely: limit - this is used as part of the data pagination mechanism to control the number of records returned in any one response message. The 'limit' defines the download segmentation value i.e. the maximum number of records to be contained in the response. The form of implementation is described in the corresponding binding document(s). offset - this is used as part of the data pagination mechanism to control the download rate of data. The 'offset' is the number of the first record to be supplied in the segmented response message. The form of implementation is described in the corresponding binding document(s). filter - the filtering rules to be applied when identifying the records to be supplied in the response message. Filtering defines the search criteria to be applied at the service provider for the identification and selection of the resources to be returned. A strict vocabulary is used for the permitted search terms (see the RS REST/JSON binding document 'Keyword Searching' in Sub-section 3.1 [RS-RJ, 18]). sort - this is used as part of the sorting mechanism to be use by the service provider. The 'sort' identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The form of implementation is described in the corresponding binding document(s). orderBy - this is used as part of the sorting mechanism to be use by the service provider. This defines the form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The form of implementation is described in the corresponding binding document(s). fields - to identify the range of fields, and only those fields, that should be supplied in the response message. The permitted vocabulary for these fields is determined by the payloads that are returned in the corresponding response messages.

Name:	getAllSubjects ()
Return Function Parameter:	imsx_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:	subjectSet : SubjectSet - the list of subjects that are supported by the LOR.
Behavior:	To obtain, read, the list of subjects that are supported by a LOR.

2. 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;
3. 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 grouped as interfaces;
4. 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;
5. 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;
6. 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;
References	The set of references that are cited throughout this document;
Appendix A Modeling 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.

Descriptor	Definition
Attribute Name	targetURL
Data Type	URL
Value Space	Container [ DerivedType ]
Scope	Local ("-")
Multiplicity	[0..1]
Description	The URL of a node in an established educational framework.

Descriptor	Definition
Attribute Name	caseItemGUID
Data Type	GUID
Value Space	Container [ DerivedType ]
Scope	Local ("-")
Multiplicity	[0..1]
Description	Reference to CASE CFItem as a GUID [CASE, 17].

Descriptor	Definition
Attribute Name	curriculumStandardsMetadataSet
Data Type	CSMSet
Value Space	Container [ Unordered ]
Scope	Local ("-")
Multiplicity	[0..1]
Description	The set of curriculum standards annotations i.e. identification of the set of curriculum standards that are supported by the content supplied by this resource link.

Descriptor	Definition
Attribute Name	platform
Data Type	NormalizedString (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[1]
Description	The identifier for the authoring environment.

Descriptor	Definition
Attribute Name	properties
Data Type	Property
Value Space	Container [ Unordered ]
Scope	Local ("-")
Multiplicity	[1.. unbounded]
Description	The set of extension properties for the identified platform.

Descriptor	Definition
Attribute Name	value
Data Type	NormalizedString (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[1]
Description	The value for the property.

Descriptor	Definition
Attribute Name	learningResourceType
Data Type	LRTEnum
Value Space	Enumerated value set of: { Assessment/Item \| Assessment/Formative \| Assessment/Interim \| Assessment/Rubric \| Assessment/Preparation \| Collection/Course \| Collection/Unit \| Collection/Curriculum Guide \| Collection/Lesson \| Game \| Interactive/Simulation \| Interactive/Animation \| Interactive/Whiteboard \| Activity/Worksheet \| Activity/Learning \| Activity/Experiment \| Lecture \| Text/Book \| Text/Chapter \| Text/Document \| Text/Article \| Text/Passage \| Text/Textbook \| Text/Reference \| Text/Website \| Media/Audio \| Media/Images/Visuals \| Media/Video \| Other }
Scope	Local ("-")
Multiplicity	[1.. unbounded]
Description	The type of the resource. There may be multiple types.

Descriptor	Definition
Attribute Name	language
Data Type	Language (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[0.. unbounded]
Description	The languages used in the resource. International two digit code for language e.g. 'en' for English. Use the [RFC 3066] annotation.

Descriptor	Definition
Attribute Name	thumbnailUrl
Data Type	URL
Value Space	Container [ DerivedType ]
Scope	Local ("-")
Multiplicity	[0..1]
Description	Link to a thumbnail representing resource.

Descriptor	Definition
Attribute Name	typicalAgeRange
Data Type	AgeRange
Value Space	Container [ DerivedType ]
Scope	Local ("-")
Multiplicity	[0..1]
Description	Age of the typical intended user. This is described as EITHER the minimum-maximum age range (the format is '11-12', '5-7', etc. with ONLY integers permitted) OR the age as a single integer e.g. '9'.

Descriptor	Definition
Attribute Name	textComplexity
Data Type	TextComplexity
Value Space	Container [ Unordered ]
Scope	Local ("-")
Multiplicity	[0.. unbounded]
Description	A number indicating text complexity based on number of established measures.

Descriptor	Definition
Attribute Name	author
Data Type	NString2048
Value Space	Container [ DerivedType ]
Scope	Local ("-")
Multiplicity	[0.. unbounded]
Description	Author or creator of the resource.

Descriptor	Definition
Attribute Name	publisher
Data Type	NString2048
Value Space	Container [ DerivedType ]
Scope	Local ("-")
Multiplicity	[1]
Description	Owner of the rights to the resource or who made it available (company or person).

Descriptor	Definition
Attribute Name	useRightsURL
Data Type	URL
Value Space	Container [ DerivedType ]
Scope	Local ("-")
Multiplicity	[0..1]
Description	URL describing how resource can be licensed. Could be Creative Commons license link or link to other specific open or proprietary license.

Descriptor	Definition
Attribute Name	timeRequired
Data Type	Duration (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[0..1]
Description	Time that the resource takes to consume. Use the [ISO 8601] format for a duration.

Descriptor	Definition
Attribute Name	technicalFormat
Data Type	NormalizedString (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[0..1]
Description	A valid MIME type format for the resource e.g. text, HTML, PDF, MPEG, MP3, etc. See https://www.iana.org/assignments/media-types/media-types.xhtml.

Descriptor	Definition
Attribute Name	educationalAudience
Data Type	EducationalAudienceEnum
Value Space	Enumerated value set of: { student \| teacher \| administrator \| parent \| aide \| proctor \| guardian \| relative }
Scope	Local ("-")
Multiplicity	[0.. unbounded]
Description	For whom the resource is intended.

Descriptor	Definition
Attribute Name	accessibilityAPI
Data Type	AccessibilityAPIEnum
Value Space	Enumerated value set of: { MSAA \| UIAutomation \| ARIAv1 \| IAccessible2 \| AndroidAccessibility \| ATK \| AT-SPI \| BlackberryAccessibility \| JavaAccessibility \| MacOSXAccessibility }
Scope	Local ("-")
Multiplicity	[0.. unbounded]
Description	Which (if any) accessibility API is supported by the resource.

Descriptor	Definition
Attribute Name	accessibilityInputMethods
Data Type	AccessibilityInputEnum
Value Space	Enumerated value set of: { fullKeyboardControl \| fullMouseControl \| fullVoiceControl }
Scope	Local ("-")
Multiplicity	[0.. unbounded]
Description	How the resource can be controlled by the user, which includes full keyboard controllability, mouse controllability, and voice controllability.

IMS LTI Resource Search Service Version 1.0

IMS Final ReleaseVersion 1.0

IMS Final Release
Version 1.0

Descriptor	Definition
Attribute Name	accessibilityFeatures
Data Type	NormalizedString (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[0.. unbounded]
Description	These include alternatives and listed enhancements for the resource. These can be transformation features, navigation features, control features or augmentation features.

Descriptor	Definition
Attribute Name	accessibilityHazards
Data Type	HazardEnum
Value Space	Enumerated value set of: { flashing \| sound \| olfactoryHazard \| motionSimulation }
Scope	Local ("-")
Multiplicity	[0.. unbounded]
Description	The set of accessibility hazards which are encountered when using this resource.

Descriptor	Definition
Attribute Name	accessMode
Data Type	AccessModeEnum
Value Space	Enumerated value set of: { auditory \| color \| itemSize \| olfactory \| orientation \| position \| tactile \| textOnImage \| textual \| visual }
Scope	Local ("-")
Multiplicity	[0.. unbounded]
Description	The human sensory perceptual system or cognitive faculty through which a person may process or perceive information.

Descriptor	Definition
Attribute Name	publishDate
Data Type	Date (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[0..1]
Description	Date the resource was published by the publisher. The 'date' using the [ISO 8601] format.

Descriptor	Definition
Attribute Name	rating
Data Type	RatingEnum
Value Space	Enumerated value set of: { 1 \| 2 \| 3 \| 4 \| 5 }
Scope	Local ("-")
Multiplicity	[0..1]
Description	A rating of the quality of the resource determined by the Search Provider. Often derived from crowdsource ratings.

Descriptor	Definition
Attribute Name	relevance
Data Type	Float0to1
Value Space	Container [ DerivedType ]
Scope	Local ("-")
Multiplicity	[0..1]
Description	This is a floating point value based on relevance to the specific search. Higher relevance has a higher number.

Descriptor	Definition
Attribute Name	region
Data Type	NormalizedString (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[0..1]
Description	The region responsible for the definition.

Descriptor	Definition
Attribute Name	version
Data Type	NormalizedString (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[0..1]
Description	This is used to denote any relevant versioning information.

Descriptor	Definition
Attribute Name	identifier
Data Type	PositiveInteger (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[1]
Description	The unique identifier, an integer, of the subject node. For the root node the value will be 'null'.

Descriptor	Definition
Attribute Name	parent
Data Type	PositiveInteger (Primitive-type)
Value Space	See Appendix A3.3.
Scope	Local ("-")
Multiplicity	[1]
Description	An integer (the identifier of that subject node) that references the single parent of this node. The returned data must be a true rooted tree, where each node returned has a single parent.