
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.
An abstract class representing common elements for the different classes related to the various Outcomes services.
| Properties of class AbstractResult | ||
|---|---|---|
|
comment
A comment about this Result suitable for display to the learner. Typically, this is a comment made by the instructor or grader.
| DataValue.Type | 0..1 |
|
gradedBy
The agent who generated the result.
| Agent | 0..1 |
|
resultAgent
The person whose score is recorded in this Result.
| LISPerson | 1 |
|
timestamp
| dateTime | 0..1 |
Possible status values for result resources.
| Simple Name | Description / URI |
|---|---|
| Completed | http://purl.imsglobal.org/vocab/lis/v2/outcomes#Completed |
| InProgress | http://purl.imsglobal.org/vocab/lis/v2/outcomes#InProgress |
| Initialized | http://purl.imsglobal.org/vocab/lis/v2/outcomes#Initialized |
| Started | http://purl.imsglobal.org/vocab/lis/v2/outcomes#Started |
| Submitted | http://purl.imsglobal.org/vocab/lis/v2/outcomes#Submitted |
application/vnd.ims.lis.v2.lineitem+json Format A class representing a column in a gradebook capable of holding result values for different users for a single activity.
| Properties of class LineItem | ||
|---|---|---|
|
dataSource
The resource associated with this line item.
| Resource | 0..1 |
|
label
A human-friendly label for this LineItem suitable for display. For example, this label might be used as the heading of a column in a gradebook.
| normalizedString | 0..1 |
|
lineItemOf
The context to which this LineItem belongs.
| Context | 1 |
|
lineItemScoreMaximum
The maximum value which can be awarded for a score in the line item. The value must be positive.
| decimal | 1 |
|
lineItemType
A string provided by the Tool Provider which allows it to know what type of value the line item is being used for. This is useful when a resource has more than one line item associated with it.
| normalizedString | 1 |
|
resourceId
An ID for the resource with which the line item is associated as provided by the Tool Provider. Its value and uniqueness are left for the Tool Provider to determine.
| normalizedString | 0..1 |
|
resourceLinkId
The Tool Consumer ID for resource link with which the line item is associated.
| normalizedString | 0..1 |
|
result
AResult associated with this LineItem.
| Result | * |
|
score
A Score associated with this LineItem.
| Score | * |
|
scores
The container holding the Scores for this LineItem.
| ScoreContainer | 0..1 |
A container that holds a collection of LineItem resources.
| Properties of class LineItemContainer | ||
|---|---|---|
|
membershipPredicate
Indicates which predicate of the container's subject should be used to determine membership in the container.
This property is restricted and must have the value http://purl.imsglobal.org/vocab/lti/v2/lti#lineItem | Property | 0..1 |
|
membershipSubject
Indicates which resource is the subject for the members of the container.
| Context | 0..1 |
| Properties inherited from Container |
|---|
| membershipPredicate, membershipSubject |
application/vnd.ims.lis.v2.result+json Format A basic result resource.
| Properties of class Result | ||
|---|---|---|
|
resultMaximum
The maximum value out of which the resultScore has been awarded. The value must be positive. The default value is 1.
| Literal | 0..1 |
|
resultOf
The LineItem within which this Result is contained.
| LineItem | 1 |
|
resultScore
The final score that should be displayed in a gradebook for this Result object.
| Literal | 0..1 |
| Properties inherited from AbstractResult |
|---|
| comment, gradedBy, resultAgent, timestamp |
application/vnd.ims.lis.v1.score+json Format A container that holds the result of some scorable activity or assignment.
| Properties of class Score | ||
|---|---|---|
|
activityProgress
The status of the activity associated with the result for this user.
| ActivityProgress | 1 |
|
scoreGiven
The score awarded to the user. The scale used to interpret this value is given by the scoreMaximum value or, if not specified, the lineItemScoreMaximum value of the associated line item. In a GET request, this value must always be the one given by the Tool Provider even if it has been overridden within the Tool Consumer. If the scoreMaximum value has changed the scoreGiven should be re-scaled to reflect this such that the ratio of the two values is immutable.
| decimal | 0..1 |
|
scoreMaximum
The maximum value out of which the scoreGiven has been awarded. The value must be positive. The default value is 1.
| decimal | 0..1 |
|
scoreOf
The LineItem within which this Score is contained.
| LineItem | 1 |
| Properties inherited from AbstractResult |
|---|
| comment, gradedBy, resultAgent, timestamp |
A container that holds a collection of Score resources.
| Properties of class ScoreContainer | ||
|---|---|---|
|
membershipPredicate
Indicates which predicate of the container's subject should be used to determine membership in the container.
This property is restricted and must have the value http://purl.imsglobal.org/vocab/lis/v2/outcomes#score | Property | 0..1 |
|
membershipSubject
Indicates which resource is the subject for the members of the container.
| LineItem | 0..1 |
| Properties inherited from Container |
|---|
| membershipPredicate, membershipSubject |
| Title: | LIS Outcomes |
|---|---|
| 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 |