IMS OneRoster®: Conformance and Certification
IMS Final Release
|Date Issued:||19th February 2020|
IPR and Distribution Notices
Recipients of this document are requested to submit, with their comments, notification of any relevant patent claims or other intellectual property rights of which they may be aware that might be infringed by any implementation of the specification set forth in this document, and to provide supporting documentation.
IMS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on IMS's procedures with respect to rights in IMS specifications can be found at the IMS Intellectual Property Rights web page: http://www.imsglobal.org/ipr/imsipr_policyFinal.pdf.
Copyright © 2019 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: http://www.imsglobal.org/forums/ims-glc-public-forums-and-resources/learning-information-services-oneroster-public-forum.
© 2019 IMS Global Learning Consortium, Inc.
All Rights Reserved.
Trademark information: http://www.imsglobal.org/copyright.html
The IMS Logo and OneRoster are trademarks of the IMS Global Learning Consortium, Inc. in the United States and/or other countries.
Document Name: IMS OneRoster® 1.1 Conformance and Certification v1.0.3
Revision: 19th February, 2020
3.2.1 Importing CSV Files
3.2.2 Exporting CSV Files
The OneRoster® standard is designed to be a subset of the full IMS Learning Information Services (LIS) standard that focuses on the K-12/Schools needs to exchange roster information and grades. The standard includes a REST-based binding (also described by an OpenAPI [OpenAPI, 14] file) to make it quicker and easier to implement the exchange of information about people, membership, courses and gradebooks. In addition to the REST binding description, a format for CSV file based exchange has also been included (CSV files are typically exchanged between the school and the vendor to populate the roster information needed to gain access to learning tools, portals and learning environments).
The purpose of this document is provide the details of the conformance process and certifications available for the IMS OneRoster 1.1 standard. Conformance certification is available for:
- Systems that import and/or export OneRoster CSV files;
- Systems that act as service providers and/or service consumers of the REST-based OneRoster services.
This document is the Final Release, meaning the technical solution is now made available as a public document and as such several IMS Members have aleady successfully completed conformance certification at the time of release of the document.
IMS strongly encourages its members and the community to provide feedback to continue the evolution and improvement of the OneRoster standard. To join the IMS developer and conformance certification community focused on OneRoster please visit the IMS OneRoster Alliance online here: http://www.imsglobal.org/lis/index.html
Public contributions, comments and questions can be posted here: Public OneRoster Forums.
The structure of the rest of this document is:
|2. The Conformance Process||The formal process to be undertaken by a vendor wishing to obtain OneRoster conformance certification;|
|3. CSV Exchange Conformance||Conformance testing to be undertaken by systems seeking CSV exchange certification and/or verification that the CSV files are conformant;|
|4. REST-based Exchange Conformance||Conformance testing and the available conformance certifications for vendors seeking conformance to the OneRoster REST-based exchange;|
|5. OneRoster Certifications||A summary of the set of possible OneRoster certifications that a product could obtain and an explanation of how these could be combined to make a product solution.|
|[OneRoster, 17a]||OneRoster Specification and REST Binding v1.1, P.Nicholls and C.Smythe, IMS Global Learning Consortium, Inc., April 2017, http://www.imsglobal.org/lis/imsonerosterv1p1/imsOneRoster-v1p1.html.|
|[OneRoster, 17b]||OneRoster 1.1 CSV Tables, P.Nicholls and C.Smythe, IMS Global Learning Consortium, Inc., April 2017, https://www.imsglobal.org/lis/imsOneRosterv1p1/imsOneRosterCSV-v1p1.html.|
|[OAuth, 10]||OAuth Version 1.0 (RFC 5849), IETF, April 2010, http://www.rfc-editor.org/info/rfc5849.|
|[OpenAPI, 14]||OpenAPI Specification (fka Swagger RESTful API Documentation Specification), Open API Initiative (Linux Foundation), September 2014, https://openapis.org/specification.|
|API||Application Programming Interface|
|CSV||Comma Separated Values|
|HTTP||HyperText Transfer Protocol|
|IUT||Implementation Under Test|
|LIS||Learning Information Services|
|REST||Representational State Transfer|
|SHA||Secure Hash Algorithm|
The process for conformance testing implementations of OneRoster includes the following:
- Go to the IMS Conformance Test Suite for OneRoster for either the REST or CSV version of OneRoster. Conformance Test Suite links are available in the IMS LIS Alliance and the relevant link details are given in Sections 3 and 4 of this document;
- Follow the onscreen instructions to run the tests;
- Once the test has been successfully run, submit a print out of the test results along with the following information to email@example.com:
- Your Name
- Your Organization
- Your Product Name and Version
- Date the Product was tested
- Whether you are a Service/Data Provider or a Service/Data Consumer
- Whether you support the REST version, the CSV Version or both REST and CSV
- The optional features supported by your system (these must also have been subjected to conformance testing).
All Tests for either version must be passed successfully to be considered IMS compliant.
All Tests for either the REST version or the CSV version must be passed successfully to be considered IMS OneRoster compliant. There are three functional modes:
- Rostering - the enrolment of people in classes;
- Resources - the association of teaching/learning resources with courses/classes;
- Gradebooks - the scores/grades for a learner who has completed some assessment of their learning activity on a class/course.
For CSV conformance ALL systems MUST support the 'Rostering' mode and for every operational processing mode that is supported by the product. For example, if both CSV import and export processing are supported then 'Rostering' for BOTH of these is required.
For the REST binding ALL systems MUST support at LEAST ONE of the 'Rostering', 'Resources' and 'Gradebooks' modes.
After you have submitted your successful conformance information to firstname.lastname@example.org, and received confirmation and a registration number from IMS Global you may then apply the appropriate conformance mark. The IMS Global conformance chart will list your conformance details. If you have any questions, please feel free to contact us at any point.
Membership in the OneRoster/Learning Information Services Alliance is the only way to achieve official conformance to the OneRoster standard. Products without a IMS conformance Registration Number are not considered to be compliant by IMS Global.
Bug/Issues with Certification Suite
If you encounter any bugs in the certification suites, you can send your issue to email@example.com or log it in github here: