| Date Issued: | 19th September, 2022 |
| Latest version: | http://www.imsglobal.org/activity/onerosterlis/ |
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.
| Org Name | Date Election Made | Necessary Claims | Type |
|---|---|---|---|
| Anthology Inc. | 10th August 2022 | No | RF RAND (Required & Optional Elements) |
| D2L Corporation | 21st July 2022 | No | RF RAND (Required & Optional Elements) |
| Gwinnett County Public Schools | 22nd July 2022 | No | RF RAND (Required & Optional Elements) |
| Infinite Campus Inc | 25th July 2022 | No | RF RAND (Required & Optional Elements) |
| Microsoft Corporation | 8th August 2022 | No | RF RAND (Required & Optional Elements) |
| SameGoal Inc | 21st July 2022 | No | RF RAND (Required & Optional Elements) |
Copyright © 2022 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.
© 2022 IMS Global Learning Consortium, Inc.
All Rights Reserved.
Trademark information: http://www.imsglobal.org/copyright.html
Document Name: IMS OneRoster Resources Service v1.2
Revision: 19th September, 2022
The IMS OneRoster (OR) standard addresses the exchange of student data (primarily about people, courses, enrollments and grades) between different educational systems for the specific needs of K-12. The primary use-case is the exchange of data between a Student Information System (SIS) and Learning Management System (LMS). In OR 1.2, the service has been split into three core services:
This OR 1.2 Resources Service provides the ability to manage the allocation of resources to classes, courses and users. It does NOT enable access to the resources themselves. A OneRoster resource is a description of a resource with sufficient information such that the resource itself could be obtained. In this document the data exchange is described in an implementation-independent format i.e. using a profile of the Unified Modeling Language (UML). The service description includes the definition of the data formats that are exchanged using a set of service operations.
1. Introduction
1.2 Conventions
1.3 Changes in the Resources Service 1.2
1.4 Structure of this Document
1.5 Nomenclature
2. Use-cases
3. Service Architecture and Specification Model
3.1 An Abstract Representation
3.2 Service Providers and Service Consumers
3.3 Service Objects
4.2 "ClassesManagement" Interface Description
4.2.1 "getResourcesForClass" Operation
4.3 "CoursesManagement" Interface Description
4.3.1 "getResourcesForCourse" Operation
4.4 "ResourcesManagement" Interface Description
4.4.1 "getAllResources" Operation
4.4.2 "getResource" Operation
5.2 "ResourceSet" Class Description
5.2.1 "resources" Attribute Description
5.3 "SingleResource" Class Description
5.3.1 "resource" Attribute Description
5.4 "imsx_StatusInfo" Class Description
5.4.1 "imsx_codeMajor" Attribute Description
5.4.2 "imsx_severity" Attribute Description
6.1.1 "Base" Class Description
6.1.1.1 "sourcedId" Attribute Description
6.1.1.2 "status" Attribute Description
6.1.1.3 "dateLastModified" Attribute Description
6.1.1.4 "metadata" Attribute Description
6.1.2 "Metadata" Class Description
6.1.2.1 "extensions" Attribute Description
6.1.3 "Resource" Class Description
6.1.3.1 "title" Attribute Description
6.1.3.2 "roles" Attribute Description
6.1.3.3 "importance" Attribute Description
6.1.3.4 "vendorResourceId" Attribute Description
6.1.3.5 "vendorId" Attribute Description
6.1.3.6 "applicationId" Attribute Description
6.1.4 "ResourceSet" Class Description
6.1.4.1 "resources" Attribute Description
6.1.5 "SingleResource" Class Description
6.1.5.1 "resource" Attribute Description
6.1.6 "imsx_CodeMinor" Class Description
6.1.6.1 "imsx_codeMinorField" Attribute Description
6.1.7 "imsx_CodeMinorField" Class Description
6.1.7.1 "imsx_codeMinorFieldName" Attribute Description
6.1.7.2 "imsx_codeMinorFieldValue" Attribute Description
6.1.8 "imsx_StatusInfo" Class Description
6.1.8.1 "imsx_codeMajor" Attribute Description
6.1.8.2 "imsx_severity" Attribute Description
6.1.8.3 "imsx_description" Attribute Description
6.1.8.4 "imsx_CodeMinor" Attribute Description
6.2 Derived Class Descriptions
6.2.1 "GUID" Class Description
6.2.2 "Identifier" Class Description
6.2.3 "RoleExtString" Class Description
6.2.3.1 "pattern" Attribute Description
6.3.1 "RoleEnumExt" Class Description
6.4 Enumerated Vocabulary Descriptions
6.4.1 "BaseStatusEnum" Vocabulary Description
6.4.2 "ImportanceEnum" Vocabulary Description
6.4.3 "RoleEnum" Vocabulary Description
6.4.4 "imsx_CodeMajorEnum" Vocabulary Description
8. Extending and Profiling the Service
8.1 Extending the Specification
8.1.1 Proprietary Operations
8.1.2 Proprietary Data Elements
Appendix A Modelling Concepts and Terms
A1 Behavior Descriptions Explanations
A1.1 Service Diagrams
A2 Interface Descriptions Explanations
A2.2 Class 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
Appendix B Service Status Codes
B1 Definition of the Status Codes
B1.1 Definition of the "CodeMajor" Values
Figure 4.1 Service interface definitions
Figure 5.1 GUID class definitions
Figure 5.2 ResourceSet class definitions
Figure 5.3 SingleResource class definitions
Figure 5.4 imsx_StatusInfo class definitions
Figure 6.1.1 Base class definitions
Figure 6.1.2 Metadata class definitions
Figure 6.1.3 Resource class definitions
Figure 6.1.4 ResourceSet class definitions
Figure 6.1.5 SingleResource class definitions
Figure 6.1.6 imsx_CodeMinor class definitions
Figure 6.1.7 imsx_CodeMinorField class definitions
Figure 6.1.8 imsx_StatusInfo class definitions
Figure 6.2.1 GUID class definitions
Figure 6.2.2 Identifier class definitions
Figure 6.2.3 RoleExtString class definitions
Figure 6.3.1 RoleEnumExt class definitions
Figure 6.4.1 BaseStatusEnum class definitions
Figure 6.4.2 ImportanceEnum class definitions
Figure 6.4.3 RoleEnum class definitions
Figure 6.4.4 imsx_CodeMajorEnum class definitions
Figure 6.4.5 imsx_CodeMinorValueEnum class definitions
Figure 6.4.6 imsx_SeverityEnum class definitions
Figure 7.1 CPResource link data definition.
Table 4.1 The set of interfaces.
Table 4.2 The set of operations for the "ClassesManagement" interface.
Table 4.3 The set of operations for the "CoursesManagement" interface.
Table 4.4 The set of operations for the "ResourcesManagement" interface.
Table 4.5 The set of operations for the "UsersManagement" interface.
Table 5.1 "GUID" Class Description
Table 5.2 "ResourceSet" Class Description
Table 5.2.1 "resources" Attribute Description
Table 5.3 "SingleResource" Class Description
Table 5.3.1 "resource" Attribute Description
Table 5.4 "imsx_StatusInfo" Class Description
Table 5.4.1 "imsx_codeMajor" Attribute Description
Table 5.4.2 "imsx_severity" Attribute Description
Table 5.4.3 "imsx_description" Attribute Description
Table 5.4.4 "imsx_CodeMinor" Attribute Description
Table 6.1.1 Base class definitions
Table 6.1.1.1 Description of the "sourcedId" attribute for the "Base" class
Table 6.1.1.2 Description of the "status" attribute for the "Base" class
Table 6.1.1.3 Description of the "dateLastModified" attribute for the "Base" class
Table 6.1.1.4 Description of the "metadata" attribute for the "Base" class
Table 6.1.2 Metadata class definitions
Table 6.1.2.1 Description of the "extensions" attribute for the "Metadata" class
Table 6.1.3 Resource class definitions
Table 6.1.3.1 Description of the "title" attribute for the "Resource" class
Table 6.1.3.2 Description of the "roles" attribute for the "Resource" class
Table 6.1.3.3 Description of the "importance" attribute for the "Resource" class
Table 6.1.3.4 Description of the "vendorResourceId" attribute for the "Resource" class
Table 6.1.3.5 Description of the "vendorId" attribute for the "Resource" class
Table 6.1.3.6 Description of the "applicationId" attribute for the "Resource" class
Table 6.1.4 ResourceSet class definitions
Table 6.1.4.1 Description of the "resources" attribute for the "ResourceSet" class
Table 6.1.5 SingleResource class definitions
Table 6.1.5.1 Description of the "resource" attribute for the "SingleResource" class
Table 6.1.6 imsx_CodeMinor class definitions
Table 6.1.6.1 Description of the "imsx_codeMinorField" attribute for the "imsx_CodeMinor" class
Table 6.1.7 imsx_CodeMinorField class definitions
Table 6.1.7.1 Description of the "imsx_codeMinorFieldName" attribute for the "imsx_CodeMinorField" class
Table 6.1.7.2 Description of the "imsx_codeMinorFieldValue" attribute for the "imsx_CodeMinorField" class
Table 6.1.8 imsx_StatusInfo class definitions
Table 6.1.8.1 Description of the "imsx_codeMajor" attribute for the "imsx_StatusInfo" class
Table 6.1.8.2 Description of the "imsx_severity" attribute for the "imsx_StatusInfo" class
Table 6.1.8.3 Description of the "imsx_description" attribute for the "imsx_StatusInfo" class
Table 6.1.8.4 Description of the "imsx_CodeMinor" attribute for the "imsx_StatusInfo" class
Table 6.2.1 GUID class definitions
Table 6.2.2 Identifier class definitions
Table 6.2.3 RoleExtString class definitions
Table 6.2.3.1 Description of the "pattern" attribute for the "RoleExtString" class
Table 6.3.1 RoleEnumExt class description
Table 6.4.1 BaseStatusEnum class definitions
Table 6.4.2 ImportanceEnum class definitions
Table 6.4.3 RoleEnum class definitions
Table 6.4.4 imsx_CodeMajorEnum class definitions
Table 6.4.5 imsx_CodeMinorValueEnum class definitions
Table 6.4.6 imsx_SeverityEnum class definitions
Table 7.1 Description of the CPResource link data class.
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
Table A3.7 The key to the descriptions of the link data tables
Table A3.8 The key to the descriptions of the common data model persistent identifier tables
Table B1.1 Interpretation of the CodeMajor/Severity behavior matrix
Table B1.2 Definition of the CodeMajor status code values
Table B1.3 Definition of the Severity status code values
Table B1.4 Definition of the CodeMinor status code field values
This Section is NOT NORMATIVE.
This document is the OneRoster 1.2 Resources Service Model and as such it is used as the basis for the development of the following documents:
This information model defines the OneRoster Resources Abstract Application Programming Interface (a-API). This service model is described using the Unified Modeling Language (UML) based upon the 1EdTech Model Driven Specification approach and the associated modelling toolkit [I-BAT, 06]. This means that this specification is based upon the concepts of:
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.
The only changes made in this new version are:
The structure of the rest of this document is:
| 2. Use-cases | The set resource allocation use-cases that are a supported by this service. Only a one-line summary of each use-case is provided; |
| 3. 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; |
| 4. 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; |
| 5. The Interface Data 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; |
| 6. The 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. |
| 7. Link Data Definitions | The set of descriptions for the link data definitions that are used to establish the intra- and inter- specification relationships; |
| 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; |
| References | The set of cited documents, normative and informative, that are used to support the technical details in this document; |
| 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. |
| API | Application Programming Interface |
| GUID | Globally Unique Identifier |
| HTTP | Hypertext Transfer Protocol |
| I-BAT | IMS Binding Autogeneration Toolkit |
| IETF | Internet Engineering Task Force |
| JSON | Java Script Object Notation |
| LIS | Learning Information Services |
| NCES | National Centre for Education Statistics |
| OAS | OpenAPI Specification |
| PII | Personally Identifiable Information |
| REST | Representational State Transfer |
| RFC | Request for Comments |
| TLS | Transport Layer Security |
| UML | Unified Modeling Language |
| URI | Uniform Resource Identifier |
| URL | Uniform Resource Locator |
| UTC | Coordinated Universal Time |
| YAML | Yet Another Markup Language |
This Section is NOT NORMATIVE.
The set of use-cases addressed by the OR Resources Service are summarised in Table 2.1.
| ID | Use-case Description |
|---|---|
| 1 | To enable a system to obtain information about the set of resources that should be used when taking a specific class. To provide the set of identifiers that are allocated to a class. |
| 2 | To enable a system to obtain information about the set of resources that should be used when taking a specific course. To provide the set of identifiers that are allocated to a course. |
| 3 | To enable a system to obtain information about the set of resources that should be made available to a specific user. To provide the set of identifiers that are allocated to a user. |
This Section is NOT NORMATIVE.
It is important to remember that this document contains a description of the underlying service 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 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.
The basic architectural model for the OR Resources Service specification is shown in Figure 3.1. In this architecture the scope of the IMS OR Resources Service specification is shown as the dotted line. The scope of the interoperability is the data and behavioral models of the objects being exchanged.
Figure 3.1 - The OR Resources 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' OR Resources systems (the OR Resources 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.
The set of service objects that are exchanged between end-systems are:
The set of service collection objects that are exchanged between end-systems are:
A class and/or a course and/or a user has a set of associated resources. A class, course and user MUST reference the set of associated resources. A UML class representation of this set of relationships is shown in Figure 3.2.
Figure 3.2 - The logical relationships between resources and classes, courses and users.
In general a resource will be associated with more than one class and/or course and/or user.
The OR Resources 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 3.3.
Figure 3.3 - The action sequence for the OR Resources synchronous service.
Figure 3.3 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 from many consumers.
Apart from the 'getAllResources()' call, the other calls require provision of a 'sourcedId' to identify either the resource itself or the associated class or course. Therefore, support for the Resources endpoints should also require support for the OR Rostering endpoints. The Class and Course classes contain the set of sourcedIds for the resources associated with the class or course retrospectively and so this is the entry point for obtaining the associated resource allocations.
This Section is NORMATIVE
The model for the service representation is shown in Figure 4.1 and Table 4.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 descriptions is described in Appendix A1.2).
Figure 4.1 - Service interface definitions.
| Interface | Description |
|---|---|
| ClassesManagement | This enables the management of information about resources i.e. the allocation of resources to classes. |
| CoursesManagement | This enables the management of information about resources i.e. the allocation of resources to courses. |
| ResourcesManagement | This enables the management of information about resources. |
| UsersManagement | This enables the management of information about resources i.e. the allocation of resources to courses. |
This enables the management of information about resources i.e. the allocation of resources to classes.
The set of operations for this interface are summarized in Table 4.2.
| Operation | Description |
|---|---|
| getResourcesForClass | To read, get, the collection of resources associated to the specified class. This is the OneRoster description of the resources and not the actual resources. If the specified class cannot be identified within the service provider then a status code of 'unknownobject' must be reported. |
| Name: | getResourcesForClass () |
| 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. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed. |
| Supplied (in) Parameters: | classSourcedId : GUID - the unique identifier, GUID, for this class. |
| Returned (out) Parameters: | resources : ResourceSet - the set of OneRoster resource descriptions that are used by the specified class. |
| Behavior: | To read, get, the collection of resources associated to the specified class. This is the OneRoster description of the resources and not the actual resources. If the specified class cannot be identified within the service provider then a status code of 'unknownobject' must be reported. |
| Notes: |
Query Parameters for the REST-based binding have been defined for this operation, namely:
|
This enables the management of information about resources i.e. the allocation of resources to courses.
The set of operations for this interface are summarized in Table 4.3.
| Operation | Description |
|---|---|
| getResourcesForCourse | To read, get, the collection of resources associated to the specified course. This is the OneRoster description of the resources and not the actual resources. If the specified class cannot be identified within the service provider then a status code of 'unknownobject' must be reported. |
| Name: | getResourcesForCourse () |
| 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. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed. |
| Supplied (in) Parameters: | courseSourcedId : GUID - the unique identifier, GUID, for the course. |
| Returned (out) Parameters: | resources : ResourceSet - the set of OneRoster resource descriptions that are used by the specified course. |
| Behavior: | To read, get, the collection of resources associated to the specified course. This is the OneRoster description of the resources and not the actual resources. If the specified class cannot be identified within the service provider then a status code of 'unknownobject' must be reported. |
| Notes: |
Query Parameters for the REST-based binding have been defined for this operation, namely:
|
This enables the management of information about resources.
The set of operations for this interface are summarized in Table 4.4.
| Operation | Description |
|---|---|
| getAllResources | To read, get, a collection of resources i.e. all resources. This is the OneRoster description of the resources and not the actual resources. |
| getResource | To read, get, a specific OneRoster resource description. If the specified class cannot be identified within the service provider then a status code of 'unknownobject' must be reported. |
| Name: | getAllResources () |
| 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. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed. |
| Supplied (in) Parameters: | None. |
| Returned (out) Parameters: | resources : ResourceSet - the set of OneRoster resource descriptions that have been read from the service provider. |
| Behavior: | To read, get, a collection of resources i.e. all resources. This is the OneRoster description of the resources and not the actual resources. |
| Notes: |
Query Parameters for the REST-based binding have been defined for this operation, namely:
|
| Name: | getResource () |
| 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. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed. |
| Supplied (in) Parameters: | sourcedId : GUID - the unique identifier, GUID, for the resource. |
| Returned (out) Parameters: | resource : SingleResource - the OneRoster resource description that has been read from the service provider. |
| Behavior: | To read, get, a specific OneRoster resource description. If the specified class cannot be identified within the service provider then a status code of 'unknownobject' must be reported. |
| Notes: |
Query Parameters for the REST-based binding have been defined for this operation, namely:
|
This enables the management of information about resources i.e. the allocation of resources to courses.
The set of operations for this interface are summarized in Table 4.5.
| Operation | Description |
|---|---|
| getResourcesForUser | To read, get, the collection of resources available to the specified user. This is the OneRoster description of the resources and not the actual resources. If the specified user cannot be identified within the service provider then a status code of 'unknownobject' must be reported. |
| Name: | getResourcesForUser () |
| 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. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed. |
| Supplied (in) Parameters: | userSourcedId : GUID - the unique identifier, GUID, for the user. |
| Returned (out) Parameters: | resources : ResourceSet - the set of OneRoster resource descriptions that are available to the specified user. |
| Behavior: | To read, get, the collection of resources available to the specified user. This is the OneRoster description of the resources and not the actual resources. If the specified user cannot be identified within the service provider then a status code of 'unknownobject' must be reported. |
| Notes: |
Query Parameters for the REST-based binding have been defined for this operation, namely:
|
This Section is NORMATIVE
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.
The data model for the "GUID" class is shown in Figure 5.1 and the accompanying definition in Table 5.1.
Figure 5.1 - GUID class definitions.
| Descriptor | Definition |
|---|---|
| Class Name | GUID |
| Class Type | Container [ DerivedType ] |
| Parents | Service parameter data-type used in the following operations: |
| Characteristics | There are no characteristics. |
| Children | There are no children. |
| Description | The data-type for establishing a Globally Unique Identifier (GUID). This is the data-type used for a 'sourcedId'. There is no predefined structure for the GUID. |
The data model for the "ResourceSet" class is shown in Figure 5.2 and the accompanying definition in Table 5.2.
Figure 5.2 - ResourceSet class definitions.
| Descriptor | Definition |
|---|---|
| Class Name | ResourceSet |
| 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 | The container for a collection of resource records. The order is not significant. This may be empty. The service provider may not have any resources or cannot identfiy any resources that fit the specified filter constraints. |
The description of the "resources" attribute for the "ResourceSet" class is given in Table 5.2.1.
| Descriptor | Definition |
|---|---|
| Attribute Name | resources |
| Data Type | Resource |
| Value Space | Container [ Sequence ] |
| Scope | Local ("-") |
| Multiplicity | [0.. unbounded] |
| Description | The set of contained resource identfiers. |
The data model for the "SingleResource" class is shown in Figure 5.3 and the accompanying definition in Table 5.3.
Figure 5.3 - SingleResource class definitions.
| Descriptor | Definition |
|---|---|
| Class Name | SingleResource |
| 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 | The container for a single resource. This may be empty i.e. the resource has no properties that obey any of the specified selection criteria. |
The description of the "resource" attribute for the "SingleResource" class is given in Table 5.3.1.
| Descriptor | Definition |
|---|---|
| Attribute Name | resource |
| Data Type | Resource |
| Value Space | Container [ Sequence ] |
| Scope | Local ("-") |
| Multiplicity | [1] |
| Description | The label for the contained resource. |
The data model for the "imsx_StatusInfo" class is shown in Figure 5.4 and the accompanying definition in Table 5.4.
Figure 5.4 - imsx_StatusInfo class definitions.
| 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. For the OneRoster Resources service this object will only be returned to provide information about a failed request i.e. it will NOT be in the payload for a successful request. See Appendix B for further information on the interpretation of the information contained within this class. |
The description of the "imsx_codeMajor" attribute for the "imsx_StatusInfo" class is given in Table 5.4.1.
| 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). See Appendix B for further information on the interpretation of this set of codes. The permitted vocabulary for the values for the CodeMajor field. |
The description of the "imsx_severity" attribute for the "imsx_StatusInfo" class is given in Table 5.4.2.
| 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). See Appendix B for further information on the interpretation of this set of codes. |
The description of the "imsx_description" attribute for the "imsx_StatusInfo" class is given in Table 5.4.3.
| 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. |
The description of the "imsx_CodeMinor" attribute for the "imsx_StatusInfo" class is given in Table 5.4.4.
| 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. See Appendix B for further information on the interpretation of this set of codes. |
This Section is NORMATIVE.
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.
The data model for the "Base" class is shown in Figure 6.1.1 and the accompanying definition in Table 6.1.1.
Figure 6.1.1 - Base class definitions.
The description of the "sourcedId" attribute for the "Base" class is given in Table 6.1.1.1.
| Descriptor | Definition |
|---|---|
| Attribute Name | sourcedId |
| Data Type | GUID |
| Value Space | Container [ DerivedType ] |
| Scope | Local ("-") |
| Multiplicity | [1] |
| Description | All Objects MUST be identified by a Source Identifier. This is a GUID i.e. a unique system interoperability identifier for an object. This is the GUID that SYSTEMS will refer to when making API calls, or when needing to identify an object. It is RECOMMENDED that systems are able to map whichever local identifiers (e.g. database key fields) they use to the corresponding SourcedId. The sourcedId of an object is considered an addressable property of an entity and as such will not be treated as Personally Identifiable Information (PII) by certified products. Therefore, as a part of certification, vendors will be required to declare that they will notify customers via documentation or other formal and documented agreement that sourcedIds should never contain PII in general, but particularly users. This means that if a customer includes a student name in an enrollment.sourcedId, it will not fall to any certified product to protect the enrollment.sourcedId as PII, or even the userSourcedId field in the enrollment record. |
The description of the "status" attribute for the "Base" class is given in Table 6.1.1.2.
| Descriptor | Definition |
|---|---|
| Attribute Name | status |
| Data Type | BaseStatusEnum |
| Value Space | Enumerated value set of: { active | tobedeleted } |
| Scope | Local ("-") |
| Multiplicity | [1] |
| Description | All objects MUST BE either 'active' or 'tobedeleted'. Something which is flagged 'tobedeleted' is to be considered safe to delete. Systems can delete records that are flagged as such if they wish, but they are not under any compulsion to do so. NOTE: In v1.1 the enumeration value of 'inactive' was removed and so for backwards compatibility all such marked objects should be interpreted as 'tobedeleted'. |
The description of the "dateLastModified" attribute for the "Base" class is given in Table 6.1.1.3.
| Descriptor | Definition |
|---|---|
| Attribute Name | dateLastModified |
| Data Type | DateTime (Primitive-type) |
| Value Space | See Appendix A3.3. |
| Scope | Local ("-") |
| Multiplicity | [1] |
| Description | All objects MUST be annotated with the dateTime upon which they were last modified. This enables requesters to query for just the latest objects. DateTimes MUST be expressed in W3C profile of [ISO 8601] and MUST contain the UTC timezone. |
The description of the "metadata" attribute for the "Base" class is given in Table 6.1.1.4.
| Descriptor | Definition |
|---|---|
| Attribute Name | metadata |
| Data Type | Metadata |
| Value Space | Container [ Sequence ] |
| Scope | Local ("-") |
| Multiplicity | [0..1] |
| Description | All objects CAN be extended using the Metadata class. This specification is silent on what implementers may consider to be appropriate extensions. |
The data model for the "Metadata" class is shown in Figure 6.1.2 and the accompanying definition in Table 6.1.2.
Figure 6.1.2 - Metadata class definitions.
The description of the "extensions" attribute for the "Metadata" class is given in Table 6.1.2.1.
| Descriptor | Definition |
|---|---|
| Attribute Name | extensions |
| Data Type | Namespace (Primitive-type) |
| Value Space | See Appendix A3.3. |
| Scope | Global ("+") |
| Multiplicity | [0.. unbounded] |
| Description | The form of the extension will be determined by the associated binding (for examples see [OR-IMPL-12]). |
The data model for the "Resource" class is shown in Figure 6.1.3 and the accompanying definition in Table 6.1.3.
Figure 6.1.3 - Resource class definitions.
The description of the "title" attribute for the "Resource" class is given in Table 6.1.3.1.
| Descriptor | Definition |
|---|---|
| Attribute Name | title |
| Data Type | NormalizedString (Primitive-type) |
| Value Space | See Appendix A3.3. |
| Scope | Local ("-") |
| Multiplicity | [0..1] |
| Description | A human readable title/label for the resource. |
The description of the "roles" attribute for the "Resource" class is given in Table 6.1.3.2.
| Descriptor | Definition |
|---|---|
| Attribute Name | roles |
| Data Type | RoleEnumExt |
| Value Space | Container [ Union ] |
| Scope | Local ("-") |
| Multiplicity | [0.. unbounded] |
| Description | The set of roles, types of users, who are expected to make use of the resource. |
The description of the "importance" attribute for the "Resource" class is given in Table 6.1.3.3.
| Descriptor | Definition |
|---|---|
| Attribute Name | importance |
| Data Type | ImportanceEnum |
| Value Space | Enumerated value set of: { primary | secondary } |
| Scope | Local ("-") |
| Multiplicity | [0..1] |
| Description | This is an indicator of the significance of the resource i.e. primary or secondary. |
The description of the "vendorResourceId" attribute for the "Resource" class is given in Table 6.1.3.4.
| Descriptor | Definition |
|---|---|
| Attribute Name | vendorResourceId |
| Data Type | Identifier |
| Value Space | Container [ DerivedType ] |
| Scope | Local ("-") |
| Multiplicity | [1] |
| Description | This is a unique identifier for the resource allocated by the vendor. |
| Link Data | In the context of the 1EdTech Ecosystem this is a pointer to the actual resource as defined within a Content Package/Common Cartridge/Thin Common Cartridge. The value for the vendorResourceId MUST have the same value as the identifier for the actual resource in the corresponoing Package/Cartridge. It is the responsibility of the learning/content management systems to be able to reconcile this identifer mapping. See CPResource for the details about this link. |
The description of the "vendorId" attribute for the "Resource" class is given in Table 6.1.3.5.
| Descriptor | Definition |
|---|---|
| Attribute Name | vendorId |
| Data Type | Identifier |
| Value Space | Container [ DerivedType ] |
| Scope | Local ("-") |
| Multiplicity | [0..1] |
| Description | Identifier for the vendor who created the resource. This will be assigned by 1EdTech as part of Conformance Certification. |
The description of the "applicationId" attribute for the "Resource" class is given in Table 6.1.3.6.
| Descriptor | Definition |
|---|---|
| Attribute Name | applicationId |
| Data Type | Identifier |
| Value Space | Container [ DerivedType ] |
| Scope | Local ("-") |
| Multiplicity | [0..1] |
| Description | Identifier for the application associated with the resource. The nature, and how this identifier is assigned is not defined by this specification. |
The data model for the "ResourceSet" class is shown in Figure 6.1.4 and the accompanying definition in Table 6.1.4.
Figure 6.1.4 - ResourceSet class definitions.
The description of the "resources" attribute for the "ResourceSet" class is given in Table 6.1.4.1.
| Descriptor | Definition |
|---|---|
| Attribute Name | resources |
| Data Type | Resource |
| Value Space | Container [ Sequence ] |
| Scope | Local ("-") |
| Multiplicity | [0.. unbounded] |
| Description | The set of contained resource identfiers. |
The data model for the "SingleResource" class is shown in Figure 6.1.5 and the accompanying definition in Table 6.1.5.
Figure 6.1.5 - SingleResource class definitions.
The description of the "resource" attribute for the "SingleResource" class is given in Table 6.1.5.1.
| Descriptor | Definition |
|---|---|
| Attribute Name | resource |
| Data Type | Resource |
| Value Space | Container [ Sequence ] |
| Scope | Local ("-") |
| Multiplicity | [1] |
| Description | The label for the contained resource. |
The data model for the "imsx_CodeMinor" class is shown in Figure 6.1.6 and the accompanying definition in Table 6.1.6.
Figure 6.1.6 - imsx_CodeMinor class definitions.
The description of the "imsx_codeMinorField" attribute for the "imsx_CodeMinor" class is given in Table 6.1.6.1.
| 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. |
The data model for the "imsx_CodeMinorField" class is shown in Figure 6.1.7 and the accompanying definition in Table 6.1.7.
Figure 6.1.7 - imsx_CodeMinorField class definitions.
The description of the "imsx_codeMinorFieldName" attribute for the "imsx_CodeMinorField" class is given in Table 6.1.7.1.
| Descriptor | Definition |
|---|---|
| Attribute Name | imsx_codeMinorFieldName |
| Data Type | NormalizedString (Primitive-type) |
| Value Space | See Appendix A3.3. Default = "TargetEndSystem". |
| Scope | Local ("-") |
| Multiplicity | [1] |
| Description | This should contain the identity of the system that has produced the code minor status code report. In most cases this will be the target service provider denoted as 'TargetEndSystem'. |
The description of the "imsx_codeMinorFieldValue" attribute for the "imsx_CodeMinorField" class is given in Table 6.1.7.2.
| Descriptor | Definition |
|---|---|
| Attribute Name | imsx_codeMinorFieldValue |
| Data Type | imsx_CodeMinorValueEnum |
| Value Space | Enumerated value set of: { fullsuccess | invalid_filter_field | invalid_selection_field | forbidden | unauthorisedrequest | internal_server_error | server_busy | unknownobject | invaliddata | invalid_sort_field | unsupported } |
| Scope | Local ("-") |
| Multiplicity | [1] |
| Description | The code minor status code (this is a value from the corresponding enumerated vocabulary). |
The data model for the "imsx_StatusInfo" class is shown in Figure 6.1.8 and the accompanying definition in Table 6.1.8.
Figure 6.1.8 - imsx_StatusInfo class definitions.
The description of the "imsx_codeMajor" attribute for the "imsx_StatusInfo" class is given in Table 6.1.8.1.
| 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). See Appendix B for further information on the interpretation of this set of codes. The permitted vocabulary for the values for the CodeMajor field. |
The description of the "imsx_severity" attribute for the "imsx_StatusInfo" class is given in Table 6.1.8.2.
| 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). See Appendix B for further information on the interpretation of this set of codes. |
The description of the "imsx_description" attribute for the "imsx_StatusInfo" class is given in Table 6.1.8.3.
| 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. |
The description of the "imsx_CodeMinor" attribute for the "imsx_StatusInfo" class is given in Table 6.1.8.4.
| 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. See Appendix B for further information on the interpretation of this set of codes. |
This Section is NORMATIVE.
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.
The data model for the "GUID" class is shown in Figure 6.2.1 and the accompanying definition in Table 6.2.1.
Figure 6.2.1 - GUID class definitions.
The data model for the "Identifier" class is shown in Figure 6.2.2 and the accompanying definition in Table 6.2.2.
Figure 6.2.2 - Identifier class definitions.
The data model for the "RoleExtString" class is shown in Figure 6.2.3 and the accompanying definition in Table 6.2.3.
Figure 6.2.3 - RoleExtString class definitions.
The description of the "pattern" attribute for the "RoleExtString" class is given in Table 6.2.3.
| Descriptor | Definition |
|---|---|
| Attribute Name | pattern |
| Data Type | String (Primitive-type) |
| Value Space | See Appendix A3.3. Default = "(ext:)[a-zA-Z0-9\.\-_]+". |
| Scope | Local ("-") |
| Multiplicity | [1] |
| Description | The regular expression to constrain the structure of the string that MUST be used when creating a new, proprietary, vocabulary term. The term must start with the substring 'ext:'. |
The set of union classes used within this Information Model are described in this Section. The syntax and semantics for this representation is described in Appendix A3.2.
The data model for the "RoleEnumExt" class is shown in Figure 6.3.1 and the accompanying definition in Table 6.3.1.
Figure 6.3.1 - RoleEnumExt class definitions.
This Section is NORMATIVE.
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.
The permitted vocabulary for the status value of a record. The data model for the "BaseStatusEnum" enumerated class is shown in Figure 6.4.1 and the accompanying vocabulary definition in Table 6.4.1.
Figure 6.4.1 - BaseStatusEnum class definitions.
| Term | Definition |
|---|---|
| active | An active record. |
| tobedeleted | Denotes that it is safe to delete the record. |
The permitted vocabulary for the 'importance' value of a resource. The data model for the "ImportanceEnum" enumerated class is shown in Figure 6.4.2 and the accompanying vocabulary definition in Table 6.4.2.
Figure 6.4.2 - ImportanceEnum class definitions.
| Term | Definition |
|---|---|
| primary | A resource of primary usage. |
| secondary | A resource of secondary usage/significance. |
The permitted vocabulary for the 'role' value for the targeted user of a resource. The data model for the "RoleEnum" enumerated class is shown in Figure 6.4.3 and the accompanying vocabulary definition in Table 6.4.3.
Figure 6.4.3 - RoleEnum class definitions.
The permitted vocabulary for the values for the CodeMajor field. The data model for the "imsx_CodeMajorEnum" enumerated class is shown in Figure 6.4.4 and the accompanying vocabulary definition in Table 6.4.4.
Figure 6.4.4 - imsx_CodeMajorEnum class definitions.
The permitted vocabulary for the values for the CodeMinorValue field. The data model for the "imsx_CodeMinorValueEnum" enumerated class is shown in Figure 6.4.5 and the accompanying vocabulary definition in Table 6.4.5.
Figure 6.4.5 - imsx_CodeMinorValueEnum class definitions.
The permitted vocabulary for the values for the Severity field. The data model for the "imsx_SeverityEnum" enumerated class is shown in Figure 6.4.6 and the accompanying vocabulary definition in Table 6.4.6.
Figure 6.4.6 - imsx_SeverityEnum class definitions.
This Section is NORMATIVE.
All of the link data for the relationships used within this Information Model are described in this Section. The syntax and semantics for this representation is described in Appendix A3.7.
The description for the "CPResource" link data class is shown in Figure 7.1 and defined in Table 7.1.
Figure 7.1 - CPResource link data definition.
This section is NOT NORMATIVE.
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.
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 [OR-IMPL-12].
It is recognized that implementers may wish to extend the specification. The preferred mechanism for doing this is for implementers to use an extension space within the OneRoster data model, and then set their parsers to read those extension attributes. Extensions are ONLY permitted using the 'metadata' attribute within the 'Base' class (see Sub-section 5.1.1 for more details).
In this version the ability to extend some of the enumerated vocabularies has been added: currently, ONLY the 'RoleEnum' vocabulary MAY be extended. Each proprietary term must start with the characters 'ext:'.
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 1EdTech. However, no matter who is responsible for creating the profile artefacts (documents, XSDs, etc.), it is strongly recommended that the 1EdTech 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 the 1EdTech VP of Operations at: operations@1edtech.org.
| [I-BAT, 06] | IMS Binding Auto-generation Toolkit (I-BAT), C.Smythe, IMS Global Learning Consortium Inc., July 2006. |
| [ISO 8601] | ISO8601:2004 Data elements and interchange formats - Information interchange - Representation of dates and times, ISO, International Standards Organization (ISO), , 2000. |
| [OR-CERT-12] | IMS OneRoster 1.2 Conformance and Certification Final Release, M.Richards, J.McGhee and C.Smythe, IMS Global Learning Consortium Inc., June 2022, https://www.imsglobal.org/spec/oneroster/v1p2/cert. |
| [OR-GBK-SM-12] | IMS OneRoster 1.2 Gradebook Services Final Release, M.Richards, J.McGhee and C.Smythe, IMS Global Learning Consortium Inc., June 2022, https://www.imsglobal.org/spec/oneroster/v1p2/gradebook/info. |
| [OR-IMPL-12] | IMS OneRoster 1.2 Best Practices and Implementation Guide Final Release, M.Richards, J.McGhee and C.Smythe, IMS Global Learning Consortium Inc., June 2022, https://www.imsglobal.org/spec/oneroster/v1p2/impl. |
| [OR-RES-RJ-12] | IMS OneRoster 1.2 Resources REST/JSON Binding Final Release, M.Richards, J.McGhee and C.Smythe, IMS Global Learning Consortium Inc., June 2022, https://www.imsglobal.org/spec/oneroster/v1p2/resource/bind/rest. |
| [OR-ROS-SM-12] | IMS OneRoster 1.2 Rostering Services Final Release, M.Richards, J.McGhee and C.Smythe, IMS Global Learning Consortium Inc., June 2022, https://www.imsglobal.org/spec/oneroster/v1p2/rostering/info. |
| [RFC 2119] | Key words for use in RFCs to Indicate Requirement Levels, S. Bradner, IETF (RFC 2119), March 1997, https://www.ietf.org/rfc/rfc3066.txt. |
| [RFC 2617] | HTTP Authentication: Basic and Digest Access Authentication, J. Franks, P. Hallam-Baker, J. Hostetler, S. Lawrence, P. Leach, A. Luotonen and L. Stewart, IETF (RFC 2167), 1999, https://tools.ietf.org/pdf/rfc2617.pdf. |
| [RFC 3066] | Tags for the Identification of Languages, H.Alvestrand, IETF (RFC 3066), January 2001, https://www.ietf.org/rfc/rfc3066.txt. |
| [RFC 5849] | OAuth Version 1.0, IETF, IETF (RFC 5849), April 2010, https://tools.ietf.org/pdf/rfc5849.pdf. |
| [RFC 6749] | The OAuth 2.0 Authorization Framework, D.Hardt, IETF (RFC 6749), 2012, https://tools.ietf.org/pdf/rfc6749.pdf. |
| [RFC 6750] | The OAuth 2.0 Authorization Framework: Bearer Token Usage, D.Hardt, IETF (RFC 6750), 2012, https://tools.ietf.org/pdf/rfc6750.pdf. |
| [Security, 21] | IMS Security Framework 1.1, C.Smythe, N.Mills, C.Vervoort and M.Mckell, IMS Global Learning Consortium Inc., July 2021, https://www.imsglobal.org/spec/security/v1p1/. |
| [UNICODE, 16] | UNICODE Collation Algorithm Version 9.0, M.Davis, K.Whistler and M.Scheer, Unicode Technical Standard #10, May 2016. |
| [VDEX, 04] | IMS Vocbulary Definition Exchange (VDEX) 1.0, A.Cooper, IMS Global Learning Consortium, February 2004, https://www.imsglobal.org/vdex/vdexv1p0/imsvdex_infov1p0.html. |
This Appendix is NOT NORMATIVE.
This section is NOT NORMATIVE.
Table A1.1 provides the key to the descriptions of service model diagrams.
| Feature | Definition and Usage |
|---|---|
| Service Model Package | Each synchronous or asynchronous 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. |
Table A1.2 provides the key to the descriptions of the operation 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:
|
| 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 Data Model. In situations where there is no return function this entry will be set to "void" |
| 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 Data 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 Data 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. |
This section is NOT NORMATIVE.
Table A2.1 provides the key to the descriptions of parameter data 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. |
Table A2.2 provides the key to the descriptions of the parameter data class tables.
| Descriptor | Definition |
|---|---|
| Class Name | The name given to the class being described. |
| Class Type | The nature of the class (for a parameter 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):
|
| 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. |
Table A2.3 provides the key to the descriptions of the data attributes for the data classes for the operation parameters.
| 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:
|
| 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:
|
| 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:
|
| Description | Contains descriptions relating to the attribute and its values space. |
This section is NOT NORMATIVE.
Table A3.1 provides 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. |
| Aggregation Arrow | This is an arrow with a white diamond head to indicate that the child class is an aggregate structure to the parent class i.e. the child class may exist without the context of the parent class. This association allows complex structures to be constructed with common subcomponents. |
| 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. |
Table A3.2 provides 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):
|
| 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. |
| Link Data | Lists the set of attributes for this class that are used to provide links to other data objects in the data model. Many types of link references are available. This row is ONLY shown when the class contains at least one link data definition. |
| Description | Contains descriptions relating to the class and its properties and relationships. |
Table A3.3 provides the key to the descriptions of the data attributes/characteristics for the data classes.
| 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:
|
| 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:
|
| 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:
|
| Description | Contains descriptions relating to the attribute/characteristic and its values space. |
| Link Data | Contains the description of the link data definition. A link to the corresponding detailed link data description is supplied. This row is ONLY shown when the attribute/characteristice is a link data definition. |
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 ».
| Category | Definition |
|---|---|
| Term | The vocabulary token itself i.e. the vocabulary entry. |
| Definition | The meaning of the term and how it should be used. |
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].
| 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. |
Table A3.6 provides the key to the descriptions of the import classes.
| 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. |
Table A3.7 provides the key to the descriptions of the link data definitions.
| Category | Definition |
|---|---|
| Target Class Name | This is the name of the target class i.e. the destination point of the link reference. |
| Link Type | This is the type of link that is being used. The types of link available are:
|
| Link Sources | This is the set of classes that contain attributes/characteristics which use the link data defined by this entry. A link to the attribute/characteristic is provided. |
| Source Attribute | This is the attribute/characteristic in the source object that contains the identifier of the target object (a characteristic name MUST start with an "@"). This will only be supplied if the pointer is contained within a substructure within the source object. If there is no source the statement "Not Applicable" will be displayed. |
| Target Attribute | This is the attribute/characteristic in the target class which is the container for the identifier of the object being identified (a characteristic name MUST start with an "@"). It is the value for this identifier which MUST be supplied in the source object. For "CPResourceId" link types the fixed value of "@identifier" will be given. If there is no target the statement "Not Applicable" will be displayed. |
| Parent Class Name | This is the name of the class that contains both the source and target attributes/characteristics. This value will only be supplied for the "IntraParentClassId" link types. If there is no parent class name the statement "Not Applicable" will be displayed. |
| Description | The description of how the link data is used within the data model. |
Table A3.8 provides the key to the descriptions of the common data model persistent identifier definitions.
| Category | Definition |
|---|---|
| Name | This is the name of the data model component which has been assigned a common data model persistent identifier. |
| Type | This is the type of link that is being used. The types of link available are:
|
| Persistent Identifier | The common data model persistent identifier that has been assigned to this data model component. By definition, this is a unique (within the context of the IMS Common Data Model) and very long-lived identifier |
This Section is NORMATIVE
When a behavior-based 1EdTech 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:
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.
| 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 accompanying "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. |
The set of codes used for the "codeMajor" status code field are defined in Table B1.2.
| 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 success 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 accompanying '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. |
The set of codes used for the "severity" status code field are defined in Table B1.3.
| 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 significant error has occurred in processing the request and so the request was not completed (the Service Provider may not even have received the request). |
The set of codes used for the "codeMinor" status code field are defined in Table B1.4.
| Status Code | Description |
|---|---|
| createsuccess | The request has been fully and successfully implemented by the Service Provider. For a REST binding this will have an HTTP code of '201' for a successful 'PUT' request. |
| deletesuccess | The request has been fully and successfully implemented by the Service Provider. For a REST binding this will have an HTTP code of '204' for a successful 'DELETE' request. |
| 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'. |
| internalservererror | 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 | This error condition may occur if a JSON request/response body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error' and a HTTP code of '422'. |
| invalidfilterfield | An invalid filter field was supplied and so the filtering was not possible. No data has been reurned. This would be accompanied by the 'codeMajor/severity' values of 'failure/error' and for a REST binding a HTTP code of '400'. |
| invalidselectionfield | An invalid selection field was supplied and data filtering on the selection criteria was not possible. This would be accompanied by the 'codeMajor/severity' values of 'failure/error' and for a REST binding a HTTP code of '400'. |
| invalidsortfield | An invalid sort field was supplied and sorting was not possible. This would be accompanied by the 'codeMajor/severity' values of 'failure/error' and for a REST binding a HTTP code of '400'. |
| readsuccess | The request has been fully and successfully implemented by the Service Provider. For a REST binding this will have an HTTP code of '200' for a successful 'GET' request. |
| replacesuccess | The request has been fully and successfully implemented by the Service Provider. For a REST binding this will have an HTTP code of '201' for a successful 'PUT' request. |
| serverbusy | 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'. |
| 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'. |
| unknownobject | The supplied identifier is unknown in the Service Provider and so the object could not be changed. This would be accompanied by the 'codeMajor/severity' values of 'failure/error' and for a REST binding a HTTP code of '404'. |
| 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. This would be accompanied by the 'codeMajor/severity' values of 'failure/error' and for a REST binding a HTTP code of '500'. |
| Title: | IMS OneRoster Resources Service v1.2 |
| Editors: | Colin Smythe (1EdTech) and Joshua McGhee (1EdTech) |
| Co-chairs: | Matt Richards (Infinite Campus, USA) |
| Version: | 1.0 |
| Version Date: | 19th September, 2022 |
| Status: | IMS Final Release |
| Summary: | This is the OneRoster 1.2 Resources Service specification. It defines the exchange of the identification of the resources that are linked to classes, courses and users. This service is made available as a REST/JSON based binding to support resources allocation to classes and courses data exchange. |
| Revision Information: | The first release of the OneRoster 1.2 Resources Service specification based upon the I-BAT. Support for the allocation of resources to users has been added in this version. |
| Purpose: | For public adoption. |
| Document Location: | https://www.imsglobal.org/spec/oneroster/v1p2/resource/info |
The following individuals contributed to the development of this document:
| Eric Adams | Instructure (USA) |
| Barry Brahier | Infinite Campus (USA) |
| Tom Clark | Pearson (USA) |
| Linda Feng | Unicon (USA) |
| Viktor Haag | Desire2Learn (Canada) |
| Richard Heim | LearningMate (USA) |
| Tom Ingram | Escambia County School District (USA) |
| Oxana Jurosevic | Instructure (USA) |
| Jong Kim | Pearson (USA) |
| Andrew Kuritzky | Edmentum (USA) |
| David Mayes | Gwinnett County Schools (USA) |
| Joshua McGhee | 1EdTech (USA) |
| Phil Nicholls | 1EdTech (UK) |
| Padraig O'hiceadha | HMH (UK) |
| Upendra Penegalapati | Pearson (USA) |
| James Perreault | FLVS (USA) |
| Patrick Porter | Houston ISD (USA) |
| Matthew Richards | Infinite Campus (USA) |
| Wendy Riedy | Microsoft (USA) |
| Kurt Rompot | Pearson (USA) |
| Gabrielle Sanderson | Illuminate Education (USA) |
| Colin Smythe | 1EdTech (UK) |
| Konrad Stimeling | K12 Inc (USA) |
| Aditya Subramaniam | Schoology (USA) |
| Matt Vella | Schoology (USA) |
| TJ Vering | Microsoft (USA) |
| Mark Walls | Gwinnett County Schools (USA) |
| Version No. | Release Date | Comments |
|---|---|---|
| Final Release 1.0 / Docment 1.0 | 1st July, 2015 | First release of the OneRoster Service specification. |
| Final Release 1.1 / Docment 1.0 | 1st November, 2016 | This second release includes new operations to create and delete single objects, support for the exchange of Result, LineItem, Category and Resource objects. |
| Final Release 1.2 / Docment 1.0 | 19th September, 2022 | This is the first release of the OneRoster 1.2 Resources Service as a standalone document. The new functionality added is support for the exchange information about the availability of resources for users using the new endpoint getResourcesForUser(). |
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 OneRoster Resources Service v1.2
Date: 19th September, 2022
