application/vnd.ims.lis.v2.membershipcontainer+json
formatMedia Type | application/vnd.ims.lis.v2.membershipcontainer+json |
---|---|
RDF Type | http://purl.imsglobal.org/vocab/lis/v2/mm#LISMembershipContainer |
JSON-LD | http://purl.imsglobal.org/ctx/lis/v2/MembershipContainer |
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.
The items within a MembershipContainer are paginated in accordance with the W3C Linked Data Platform
recommendations. Figure 1 shows one page of items. It is the responsibility of the server to determine
the maximum number of items that will be returned in each page. In this example, the number of items is
artificially limited to just two items. In a typical, real-world case the number of items per page
will be larger. Notice that the payload gives the URI for the next page. If there is no next page,
the nextPage
property will not be present.
{ "@context" : [ "http://purl.imsglobal.org/ctx/lis/v2/MembershipContainer", { "liss" : "http://purl.imsglobal.org/vocab/lis/v2/status#", "lism" : "http://purl.imsglobal.org/vocab/lis/v2/membership#" } ], "@type" : "Page", "@id" : "http://lms.example.com/sections/2923/memberships/?rlid=49566-rkk96", "nextPage" : "http://lms.example.com/sections/2923/memberships/?rlid=49566-rkk96&p=2", "differences" : "http://lms.example.com/sections/2923/memberships/?x=1422554502", "pageOf" : { "@type" : "LISMembershipContainer", "membershipSubject" : { "@type" : "Context", "contextId" : "2923-abc", "membership" : [ { "status" : "liss:Active", "member" : { "@type" : "LISPerson", "sourcedId" : "school.edu:user", "userId" : "0ae836b9-7fc9-4060-006f-27b2066ac545", "email" : "user@school.edu", "familyName" : "Public", "name" : "Jane Q. Public", "image" : "http://...", "givenName" : "Jane" }, "message" : [ { "message_type" : "basic-lti-launch-request", "lis_result_sourcedid" : "83873872987329873264783687634", "ext" : { "user_username" : "jpublic" }, "custom" : { "country" : "Canada", "user_mobile" : "123-456-7890" } } ], "role" : [ "lism:Instructor" ] } ] } } }
This specification defines the structure of a JSON document using a graphical notation. In this notatation, an object is represented by a box that branches out to other boxes corresponding to the properties of that object, as shown in Figure 2.
Each box representing a property specifies the name and type of the property , as shown in Figure 3.
If a property is optional, its box will be decorated with a circle that contains a question mark, as shown in Figure 3.
If a property can have multiple values, then its box in the graphical notation is decorated with a circle that contains a plus sign (+) as shown in Figure 4. In this example, the membership
property may reference more than one Membership
object. Ordinarily, these values are encapsulated within a JSON array, but if it turns out that only one value is present, then the square brackets for the array are optional.
An object within a JSON-LD document may have one of four possible representations:
When an object is to be identified by a fully-qualified URI or a CURIE, the box representing the object will be decorated with the #uri hash tag, as shown in null.
When an object or enumerable value is to be identified by a simple name, the box representing the corresponding property will be decorated with the #sn hash tag, as shown in Figure 6.
The JSON-LD standard reserves a handful of property names and tokens that have special meaning. These names and tokens, described below, begin with the '@' symbol.
The @id property may identify a so-called blank node by using a CURIE with an underscore as the prefix. The binding of a JSON-LD document MAY include identifiers for blank nodes, but these identifiers are not required.
JSON-LD specifies four other reserved terms (@value, @language, @container, @list). Ordinarily, these terms are not used in the JSON binding for LISMembershipContainer
objects. However, implementations that extend this specification by including additional properties may utilize these reserved terms in accordance with the rules defined by [JSON-LD-syntax].
In JSON-LD, a context is used to map simple names that appear in a JSON document to URI values for properties or data types in a formal vocabulary (typically an RDF ontology). For example, the standard context [LIS-v2-MembershipContainer] for a LISMembershipContainer contains the following rewrite rules (among others):
{ "@context" = { "ldp" : "http://www.w3.org/ns/ldp#", "membershipSubject" : "ldp:membershipSubject", ... } }
A context may specify that the values of certain object properties must be rendered as URI references. The following snippet presents an example of such a rule.
{ "@context" = { ... "status" : { "@id" : "org:status", "@type" : "@id" } ... }
This rule is an example of type coercion. For more details about the syntax of a JSON-LD context, see [JSON-LD-syntax].
The following list defines the necessary and sufficient conditions for a document to conform to the application/vnd.ims.lis.v2.membershipcontainer+json
media type.
@type
property whose value is "LISMembershipContainer
".@context
property that references one or more JSON-LD contexts (either by URI or by value).@context
property, a non-empty collection MUST always be represented as a JSON array whose values are enclosed in square brackets. Whereas, in general, the JSON-LD syntax specification allows a collection containing a single value to omit the square brackets, the application/vnd.ims.lis.v2.membershipcontainer+json
media type requires square brackets for all non-empty collections other than the @context
property.@id
property of a given object is mandatory if the minimum cardinality of that property, as defined by this specification, is greater than zero. The @id
property is optional for all other objects (even if it is not explicitly listed in the set of properties for an object). Conforming implementations SHOULD include the @id
property for all addressable objects.@id
property is mandatory, then the value MUST NOT treat the object as a blank node. In this case, the @id
value MUST NOT be a CURIE with an underscore as the prefix.@type
property and a @context property.@type
property if the object value is a subtype of the declared range of the property.Figure 7 presents a complete graphical representation of the JSON binding for a LISMembershipContainer object. The subsections following this figure provide details about each object that appears in the JSON binding for a LISMembershipContainer object.
Property | Mult | Description | Type |
---|---|---|---|
@id | 0..1 | The URI that identifies this Agent instance. |
xs:anyURI |
{ "@type" : "Context", "contextId" : "2923-abc", "membership" : [ ... ] }
Property | Mult | Description | Type |
---|---|---|---|
@id | 0..1 | The URI that identifies this Context instance. |
xs:anyURI |
contextId | 1 | A unique string provided by the tool consumer to identify the context (as passed in the context_id launch parameter). | xs:normalizedString |
membership | * | A membership entity that records the role of some Agent within this Organization. | Membership |
name | 0..1 | The organization's assigned name. | xs:string |
{ "@type" : "LISMembershipContainer", "membershipSubject" : { ... } }
Property | Mult | Description | Type |
---|---|---|---|
@context | 1..* | This value specifies one or more JSON-LD contexts, either by reference or by value. When multiple contexts are specified, they must be encapsulated within an array. For most implementations, the value will be the single URI for the standard context associated with the
|
JSON-LD Context |
@type | 1 | A simple name identifying the object's type. The standard context [LIS-v2-MembershipContainer] defines the following simple names that are applicable:
Implementations may use a custom JSON-LD context which defines simple names for additional types that are subtypes of |
owl:Class (Simple Name reference)
|
@id | 0..1 | The URI that identifies this LISMembershipContainer instance. |
xs:anyURI |
membershipSubject | 0..1 | Indicates which resource is the subject for the members of the container. | Context |
{ "@type" : "LISPerson", "sourcedId" : "school.edu:user", "userId" : "0ae836b9-7fc9-4060-006f-27b2066ac545", "email" : "user@school.edu", "familyName" : "Public", "name" : "Jane Q. Public", "image" : "http://...", "givenName" : "Jane" }
Property | Mult | Description | Type |
---|---|---|---|
@id | 0..1 | The URI that identifies this LISPerson instance. |
xs:anyURI |
sourcedId | 0..1 | A unique identifier for the person as provisioned by an external system such as an SIS. | xs:normalizedString |
userId | 1 | A unique identifier for the person. | xs:normalizedString |
0..1 | The primary email address for the person. | xs:string | |
familyName | 0..1 | The person's assigned family name. | xs:string |
name | 0..1 | The person's assigned full name (typically their first name followed by their family name separated with a space). | xs:string |
image | 0..1 | A URL to an image for the person. | xs:anyURI |
givenName | 0..1 | The person's assigned first name. | xs:string |
LISStatus
instances are enumerable, and they must be referenced by a simple name. The default vocabulary of simple names for instances of the LISStatus
class are listed in Table 5.
Simple Name | URI / Description |
---|---|
Active | http://purl.imsglobal.org/vocab/lis/v2/status#Active |
Deleted | http://purl.imsglobal.org/vocab/lis/v2/status#Deleted |
Inactive | http://purl.imsglobal.org/vocab/lis/v2/status#Inactive |
{ "status" : "liss:Active", "member" : { ... }, "message" : [ ... ], "role" : [ ... ] }
Property | Mult | Description | Type |
---|---|---|---|
@id | 0..1 | The URI that identifies this Membership instance. |
xs:anyURI |
status | 0..1 | The current status of a membership which applies to all roles. | LISStatus (Simple Name reference)
|
member | 1 | Indicates the Person (or other Agent including Organization) involved in the Membership relationship. | Agent |
message | * | A copy of any parameters which would be included in a message initiated by the person and whose value includes data specific to them. Any custom parameters are included in an element named "custom" and have the "custom_" prefix removed from their name. Similarly any extension parameters are placed in an element named "ext" and the "ext_" prefix is removed from their name. | PropertyMap |
role | 1..* | Indicates the Role that the Agent plays in a Membership relationship with an Organization. | Role (URI reference)
|
Property | Mult | Description | Type |
---|---|---|---|
@id | 0..1 | The URI that identifies this Organization instance. |
xs:anyURI |
membership | * | A membership entity that records the role of some Agent within this Organization. | Membership |
name | 0..1 | The organization's assigned name. | xs:string |
Property | Mult | Description | Type |
---|---|---|---|
@id | 0..1 | The URI that identifies this Person instance. |
xs:anyURI |
familyName | 0..1 | The person's assigned family name. | xs:string |
givenName | 0..1 | The person's assigned first name. | xs:string |
image | 0..1 | A URL to an image for the person. | xs:anyURI |
name | 0..1 | The person's assigned full name (typically their first name followed by their family name separated with a space). | xs:string |
{ "message_type" : "basic-lti-launch-request", "lis_result_sourcedid" : "83873872987329873264783687634", "ext" : { ... }, "custom" : { ... } }
Title: | LISMembershipContainer JSON Binding in the application/vnd.ims.lis.v2.membershipcontainer+json format |
---|---|
Editor: | Stephen Vickers (IMS Global) |
Version: | 2.0 |
Version Date: | 24 May 2016 |
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:
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 |