application/vnd.ims.lis.v2.result+json FormatIPR 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/
Copyright © 2016 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/
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.
© 2016 IMS Global Learning Consortium, Inc.
All Rights Reserved.
The IMS Logo and Learning Tools Interoperability (LTI) are trademarks of the IMS Global
Learning Consortium, Inc. in the United States and/or other countries.
Result resources.This specification defines a REST API for reading and updating Result resources. Following common conventions, the API uses a different HTTP verb for each type of operation: GET for read and PUT for update
Implementations of this REST API may be incomplete; a given server might support only a subset of the HTTP verbs. A server that supports the complete API will expose two different kinds of endpoints: a container endpoint for receiving POST requests and item endpoints for manipulating individual instances. This specification document does not prescribe a method for discovering the endpoint URLs.
Result resources manipulated via this REST API are represented as JSON documents in the application/vnd.ims.lis.v2.result+json format. For detailed information about this media type, see [Result-media-type].
| Request Header Name | Value |
|---|---|
| Authorization | Authorization parameters dictated by the OAuth Body Hash Protocol |
| Accept | application/vnd.ims.lis.v2.result+json |
Table 2 describes the possible responses from the GET method.
| HTTP Status | Description |
|---|---|
| 200 OK | The request was successful. The response contains a JSON document in the format defined by the |
| 301 Moved Permanently | The URI for the requested resource has changed. In this case, the response body is empty, and the new URI is provided in the |
| 307 Temporary Redirect | The requested resource resides temporarily under a different URI. In this case, the response body is empty, and the temporary URI is defined by the |
| 401 Unauthorized | The client did not authenticate properly. |
| 404 Not Found | The server has not found anything matching the request URI. |
| 500 Internal Service Error | The server encountered an unexpected condition which prevented it from fulfilling the request. |
| Request Header Name | Value |
|---|---|
| Content-Type | application/vnd.ims.lis.v2.result+json |
| Authorization | Authorization parameters dictated by the OAuth Body Hash Protocol |
Table 4 describes the possible responses from the PUT method. In all cases, the response body is empty.
| HTTP Status | Description |
|---|---|
| 200 OK | The request was successful. |
| 401 Unauthorized | The client did not authenticate properly. |
| 404 Not Found | The server has not found anything matching the request URI. |
| 500 Internal Service Error | The server encountered an unexpected condition which prevented it from fulfilling the request. |
application/vnd.ims.lis.v2.result+json format. IMS Final Release. 10 September 2015.| Title: | A REST API for Result Resources in the application/vnd.ims.lis.v2.result+json Format |
|---|---|
| Editor: | Stephen Vickers (IMS Global) |
| Version: | 2.0 |
| Version Date: | 10 September 2015 |
| Release: | Final Release |
| Status: | IMS Final Release |
| Purpose: | This document is made available for review and comment by the public community at large. |
The following list of individuals contributed to the authoring of this document:
| Craig Dunk | D2L | Padraig O'hiceadha | HMH |
| Viktor Haag | D2L | Charles Severance | IMS Global |
| Brad Humphrey | Instructure | Colin Smythe | IMS Global |
| Greg McFall | Pearson | Matt Stoelting | Cengage |
| Mark McKell | IMS Global | John Tibbetts | Vitalsource |
| Bracken Mosbacker | Lumen Learning | Claude Vervoort | Cengage |
| Lance Neumann | Blackboard | Stephen Vickers | IMS Global |