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/
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.
This specification defines a REST API for reading
LISMembershipContainer resources via an HTTP GET request.
LISMembershipContainer resources manipulated via this REST API are represented as JSON documents in the
application/vnd.ims.lis.v2.membershipcontainer+json format. For detailed information about this media type, see [LISMembershipContainer-media-type].
|limit||Specifies the maximum number of items that should be delivered per page. This parameter is merely a hint. The server is not obligated to honor this limit and may at its own discretion choose a different value for the number of items per page.|
|role||The role for a membership. The result set will be filtered so that it includes only those memberships that contain this role. The value of the parameter should be the full URI for the role, although the simple name may be used for context-level roles. If omitted, the result set will include all memberships with any role.|
|rlid||The ID of a resource link within the context and associated and the Tool Provider. The result set will be filtered so that it includes only those memberships that are permitted to access the resource link. If omitted, the result set will include all memberships for the context.|
|Request Header Name||Value|
|Authorization||Authorization parameters dictated by the OAuth Body Hash Protocol|
Table 3 describes the possible responses from the GET method.
|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.|
application/vnd.ims.lis.v2.membershipcontainer+jsonformat. IMS Final Release. 24 May 2016.
|Title:||A REST API for LISMembershipContainer Resources in the
|Editor:||Stephen Vickers (IMS Global)|
|Version Date:||24 May 2016|
|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:
|Vikas Gupta||Pearson||Padraig O'hiceadha||Houghton Mifflin Harcourt|
|Viktor Haag||D2L||Charles Severance||University of Michigan|
|Brad Humphrey||Instructure||John Tibbetts||Vitalsource|
|Greg McFall||Pearson||Claude Vervoort||Cengage|
|Bracken Mosbacker||Instructure||Stephen Vickers||IMS Global Learning Consortium|