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.
Custom parameter substitution variables.
| Simple Name | Description / URI |
|---|---|
| Context.id | Corresponds to the context_id launch parameter. This is the local identifier for the context within the Tool Consumer system. http://purl.imsglobal.org/vocab/lti/v2/variable#Context.id |
| Context.label | A short label for the context. Corresponds to the context_label launch parameter. http://purl.imsglobal.org/vocab/lti/v2/variable#Context.label |
| Context.org | A URI describing the organisational properties of the context from which a launch request originates (typically a CourseSection); for example, an ldap:// URI such as ldap://host.com:6666/cid=abc123,ou=dept,dc=plainjoe,dc=org. If more than one format of organisational URI is specified, each should be separated with a space. http://purl.imsglobal.org/vocab/lti/v2/variable#Context.org |
| Context.title | The title for the context. Corresponds to the context_title launch parameter. http://purl.imsglobal.org/vocab/lti/v2/variable#Context.title |
| Context.type | A comma-separated list of URN values that identify the type of context. Corresponds to the context_type launch parameter. http://purl.imsglobal.org/vocab/lti/v2/variable#Context.type |
| CourseOffering.academicSession | The text data that is used to describe the academic session for the course offering. In the LIS Database, this value corresponds to courseOfferingRecord/courseOffering/defaultCredits/textString http://purl.imsglobal.org/vocab/lti/v2/variable#CourseOffering.academicSession |
| CourseOffering.credits | The default credits set for this Course Offering In the LIS Database, this value corresponds to courseOfferingRecord/courseOffering/defaultCredits/textString http://purl.imsglobal.org/vocab/lti/v2/variable#CourseOffering.credits |
| CourseOffering.label | A human readable label for the Course Offering In the LIS Database, this value corresponds to courseOfferingRecord/courseOffering/label http://purl.imsglobal.org/vocab/lti/v2/variable#CourseOffering.label |
| CourseOffering.longDescription | A long description of the Course Offering. In the LIS Database, this value corresponds to courseOfferingRecord/courseOffering/catalogDescription/longDescription http://purl.imsglobal.org/vocab/lti/v2/variable#CourseOffering.longDescription |
| CourseOffering.shortDescription | A short description of the Course Offering. In the LIS Database, this value corresponds to courseOfferingRecord/courseOffering/catalogDescription/shortDescription http://purl.imsglobal.org/vocab/lti/v2/variable#CourseOffering.shortDescription |
| CourseOffering.sourcedId | The LIS identifier for the Course Offering. In the LIS Database, this value corresponds to courseOfferingRecord/sourcedId http://purl.imsglobal.org/vocab/lti/v2/variable#CourseOffering.sourcedId |
| CourseOffering.title | The title of the Course Offering. In the LIS Database, this value corresponds to courseOfferingRecord/courseOffering/title http://purl.imsglobal.org/vocab/lti/v2/variable#CourseOffering.title |
| CourseSection.courseNumber | The course number, such as "Biology 101". In general, this number is not just a numeric value. In the LIS Database, this value corresponds to courseSectionRecord/courseSection/courseNumber/textString http://purl.imsglobal.org/vocab/lti/v2/variable#CourseSection.courseNumber |
| CourseSection.credits | The default credits set for the Course Section. In the LIS Database, this value corresponds to courseSectionRecord/courseSection/defaultCredits/textString http://purl.imsglobal.org/vocab/lti/v2/variable#CourseSection.credits |
| CourseSection.dataSource | An identifier for the original source system of the CourseSection object. In the LIS Database, this value corresponds to courseSectionRecord/courseSection/dataSource http://purl.imsglobal.org/vocab/lti/v2/variable#CourseSection.dataSource |
| CourseSection.dept | The department within which the Course Section is offered. In the LIS Database, this value corresponds to courseSectionRecord/courseSection/org[type/textString="Dept"]/orgName/textString http://purl.imsglobal.org/vocab/lti/v2/variable#CourseSection.dept |
| CourseSection.enrollControl.allowed | A boolean value that specifies whether the Tool Provider can enroll people in the Course Section. The value In the LIS Database, this value corresponds to courseSectionRecord/courseSection/enrollControl/enrollAllowed http://purl.imsglobal.org/vocab/lti/v2/variable#CourseSection.enrollControl.allowed |
| CourseSection.enrollControll.accept | A boolean value that specifies whether the Course Section is accepting enrollments. In the LIS Database, this value corresponds to courseSectionRecord/courseSection/enrollControl/enrollAccept http://purl.imsglobal.org/vocab/lti/v2/variable#CourseSection.enrollControll.accept |
| CourseSection.label | A human readable label for the Course Section. In the LIS Database, this value corresponds to courseSectionRecord/courseSection/label http://purl.imsglobal.org/vocab/lti/v2/variable#CourseSection.label |
| CourseSection.longDescription | A long description of the Course Section. In the LIS Database, this value corresponds to courseSectionRecord/courseSection/catalogDescription/longDescription http://purl.imsglobal.org/vocab/lti/v2/variable#CourseSection.longDescription |
| CourseSection.maxNumberofStudents | The maximum number of students that can be enrolled in the Course Section. In the LIS Database, this value corresponds to courseSectionRecord/courseSection/maxNumberofStudents http://purl.imsglobal.org/vocab/lti/v2/variable#CourseSection.maxNumberofStudents |
| CourseSection.numberofStudents | The number of students who are enrolled in the Course Section. In the LIS Database, this value corresponds to courseSectionRecord/courseSection/numberofStudents http://purl.imsglobal.org/vocab/lti/v2/variable#CourseSection.numberofStudents |
| CourseSection.shortDescription | A short description of the Course Section. In the LIS Database, this value corresponds to courseSectionRecord/courseSection/catalogDescription/shortDescription http://purl.imsglobal.org/vocab/lti/v2/variable#CourseSection.shortDescription |
| CourseSection.sourceSectionId | The identifier for the source Course Section from which the target Course Section was cloned. In the LIS Database, this value corresponds to createCourseSectionFromCourseSectionRequest/sourcedId http://purl.imsglobal.org/vocab/lti/v2/variable#CourseSection.sourceSectionId |
| CourseSection.sourcedId | The LIS identifier for the Course Section In the LIS Database, this value corresponds to courseSection/sourcedId http://purl.imsglobal.org/vocab/lti/v2/variable#CourseSection.sourcedId |
| CourseSection.timeFrame.begin | The date and time when the Course Section becomes available. In the LIS Database, this value corresponds to courseSectionRecord/courseSection/timeFrame/begin http://purl.imsglobal.org/vocab/lti/v2/variable#CourseSection.timeFrame.begin |
| CourseSection.timeFrame.end | The date and time after which the Course Section is no longer available. In the LIS Database, this value corresponds to courseSectionRecord/courseSection/timeFrame/end http://purl.imsglobal.org/vocab/lti/v2/variable#CourseSection.timeFrame.end |
| CourseSection.title | The title of the Course Section. In the LIS Database, this value corresponds to courseSectionRecord/courseSection/title http://purl.imsglobal.org/vocab/lti/v2/variable#CourseSection.title |
| CourseTemplate.courseNumber | The course number, such as "Biology 101". In general, this number is not just a numeric value. In the LIS Database, this value corresponds to courseTemplateRecord/courseTemplate/courseNumber/textString http://purl.imsglobal.org/vocab/lti/v2/variable#CourseTemplate.courseNumber |
| CourseTemplate.credits | The default credits set for this Course Template. In the LIS Database, this value corresponds to courseTemplateRecord/courseTemplate/defaultCredits/textString http://purl.imsglobal.org/vocab/lti/v2/variable#CourseTemplate.credits |
| CourseTemplate.label | A human readable label used to help identify the Course Template. In the LIS Database, this value corresponds to courseTemplateRecord/courseTemplate/label/textString http://purl.imsglobal.org/vocab/lti/v2/variable#CourseTemplate.label |
| CourseTemplate.longDescription | A long description of the Course Template. In the LIS Database, this value corresponds to courseTemplateRecord/courseTemplate/catalogDescription/longDescription http://purl.imsglobal.org/vocab/lti/v2/variable#CourseTemplate.longDescription |
| CourseTemplate.shortDescription | A short description of the Course Template. In the LIS Database, this value corresponds to courseTemplateRecord/courseTemplate/catalogDescription/shortDescription http://purl.imsglobal.org/vocab/lti/v2/variable#CourseTemplate.shortDescription |
| CourseTemplate.sourcedId | The LIS identifier for the Course Template. In the LIS Database, this value corresponds to courseTemplateRecord/sourcedId http://purl.imsglobal.org/vocab/lti/v2/variable#CourseTemplate.sourcedId |
| CourseTemplate.title | The title of the Course Template. In the LIS Database, this value corresponds to courseTemplateRecord/courseTemplate/title/textString http://purl.imsglobal.org/vocab/lti/v2/variable#CourseTemplate.title |
| Group.email | An email address used for posting messages to members of the group. In the LIS Database, this value corresponds to groupRecord/group/email http://purl.imsglobal.org/vocab/lti/v2/variable#Group.email |
| Group.enrollControl.accept | A boolean value that specifies whether the Group is accepting enrollments. In the LIS Database, this value corresponds to groupRecord/group/enrollControl/enrollAccept http://purl.imsglobal.org/vocab/lti/v2/variable#Group.enrollControl.accept |
| Group.enrollControl.allowed | A boolean value that specifies whether the Tool Provider can enroll people in the Group. The value In the LIS Database, this value corresponds to groupRecord/group/enrollControl/enrollAllowed http://purl.imsglobal.org/vocab/lti/v2/variable#Group.enrollControl.allowed |
| Group.grouptype | A URI that uniquely identifies the type of group. This convention differs from the LIS convention of using a structured object to describe the type of a group. Ideally, the URI should resolve to JSON-LD document that describes the group type. However, any URI that uniquely identifies the group type in accordance with the rules of the grouptype scheme is acceptable. http://purl.imsglobal.org/vocab/lti/v2/variable#Group.grouptype |
| Group.longDescription | A long description of the Group. In the LIS Database, this value corresponds to groupRecord/group/description/longDescription http://purl.imsglobal.org/vocab/lti/v2/variable#Group.longDescription |
| Group.parentId | An identifier for the parent group within which the target group is nested. In the LIS Database, this value corresponds to groupRecord/group/relationship[relation="Parent"]/sourcedId http://purl.imsglobal.org/vocab/lti/v2/variable#Group.parentId |
| Group.shortDescription | A short description of the Group. In the LIS Database, this value corresponds to groupRecord/group/description/shortDescription http://purl.imsglobal.org/vocab/lti/v2/variable#Group.shortDescription |
| Group.sourcedId | The LIS identifier for the Group. In the LIS Database, this value corresponds to groupRecord/sourcedId http://purl.imsglobal.org/vocab/lti/v2/variable#Group.sourcedId |
| Group.timeFrame.begin | The date and time when access to Group resources begins. In the LIS Database, this value corresponds to groupRecord/group/timeframe/begin http://purl.imsglobal.org/vocab/lti/v2/variable#Group.timeFrame.begin |
| Group.timeFrame.end | The date and time when access to Group resources ends. In the LIS Database, this value corresponds to groupRecord/group/timeframe/end http://purl.imsglobal.org/vocab/lti/v2/variable#Group.timeFrame.end |
| Group.url | The web address of the Group. In the LIS Database, this value corresponds to groupRecord/group/url http://purl.imsglobal.org/vocab/lti/v2/variable#Group.url |
| LineItemZZZ.dataSource | An identifier for the original source system of the LineItem record. In the LIS Database, this value corresponds to lineItemRecord/lineItem/dataSource http://purl.imsglobal.org/vocab/lti/v2/variable#LineItemZZZ.dataSource |
| LineItemZZZ.resultValue.max | The maximum numeric score that a learner may earn on the assignment associated with this LineItem. In the LIS Database, this value corresponds to resultValueRecord/resultValue/valueRange/max where resultValueRecord.sourcedId = lineItemRecord/lineItem/resultValueSourcedId
|
| LineItemZZZ.sourcedId | The LIS identifier for the LineItem In the LIS Database, this value corresponds to lineItemRecord/sourcedId http://purl.imsglobal.org/vocab/lti/v2/variable#LineItemZZZ.sourcedId |
| LineItemZZZ.type | A URI that uniquely identifies the LineItem type. This convention differs from the LIS convention of using a structured object to describe LineItem types. The URI should resolve to a JSON-LD resource that describes the LineItem type. As a best practice the URI should start with a base URL that identifies the LineItemType vocabulary and end with a relative URL for a type within that vocabulary. In the LIS Database, the LineItem type is given by lineItemRecord/lineItem/lineItemType http://purl.imsglobal.org/vocab/lti/v2/variable#LineItemZZZ.type |
| LineItemZZZ.type.displayName | The display name for the LineItemType. In the LIS Database, this value corresponds to lineItemTypeRecord/lineItemType/displayName http://purl.imsglobal.org/vocab/lti/v2/variable#LineItemZZZ.type.displayName |
| LtiLink.custom.url | The endpoint URL for accessing link-level tool settings. http://purl.imsglobal.org/vocab/lti/v2/variable#LtiLink.custom.url |
| Membership.collectionSourcedId | The LIS identifier for the organizational unit (Course Section, Group, etc.) to which the Membership pertains. In the LIS Database, this value corresponds to membershipRecord/membership/collectionSourcedId http://purl.imsglobal.org/vocab/lti/v2/variable#Membership.collectionSourcedId |
| Membership.createdTimestamp | The date and time when the membership role was created. If the Person has more than one role within the organizational unit, then this value is a comma separated list corresponding to the roles listed by the Membership.role variable. In the LIS Database, this value corresponds to membershipRecord/membership/member/role/dateTime http://purl.imsglobal.org/vocab/lti/v2/variable#Membership.createdTimestamp |
| Membership.dataSource | An identifier for the original source system of the Membership record. In the LIS Database, this value corresponds to membershipRecord/membership/member/role/dataSource http://purl.imsglobal.org/vocab/lti/v2/variable#Membership.dataSource |
| Membership.personSourcedId | The LIS identifier for the Person associated with the Membership. In the LIS Database, this value corresponds to membershipRecord/membership/member/personSourcedId http://purl.imsglobal.org/vocab/lti/v2/variable#Membership.personSourcedId |
| Membership.role | A comma separated list of roles that the Person has within the organizational unit. In the LIS Database, this value corresponds to membershipRecord/membership/member/role/roleType http://purl.imsglobal.org/vocab/lti/v2/variable#Membership.role |
| Membership.sourcedId | The LIS identifier for the Membership. In the LIS Database, this value corresponds to membershipRecord/sourcedId http://purl.imsglobal.org/vocab/lti/v2/variable#Membership.sourcedId |
| Membership.status | Indicates if the membership is active or inactive. In accordance with the LIS specification, the value should be either In the LIS Database, this value corresponds to membershipRecord/membership/member/role/status http://purl.imsglobal.org/vocab/lti/v2/variable#Membership.status |
| Person.address.country | The country within the user's address. In the LIS Database, this value corresponds to personRecord/person/address/[addressType/instanceValue/text="Preferred"]addressPart /nameValuePair /[instanceName/text="Country"]/instanceValue/text http://purl.imsglobal.org/vocab/lti/v2/variable#Person.address.country |
| Person.address.locality | The city, town, or other locality within the user's address. In the LIS Database, this value corresponds to personRecord/person/address/[addressType/instanceValue/text="Preferred"]addressPart /nameValuePair /[instanceName/text="Locality"]/instanceValue/text http://purl.imsglobal.org/vocab/lti/v2/variable#Person.address.locality |
| Person.address.postcode | The postal code within the user's address. In the LIS Database, this value corresponds to personRecord/person/address/[addressType/instanceValue/text="Preferred"]addressPart /nameValuePair /[instanceName/text="Postcode"]/instanceValue/text http://purl.imsglobal.org/vocab/lti/v2/variable#Person.address.postcode |
| Person.address.statepr | The state or province within the user's address. In the LIS Database, this value corresponds to personRecord/person/address/[addressType/instanceValue/text="Preferred"]addressPart /nameValuePair/[instanceName/text="Statepr"]/instanceValue/text http://purl.imsglobal.org/vocab/lti/v2/variable#Person.address.statepr |
| Person.address.street1 | The first line of the user's street address. In the LIS Database, this value corresponds to personRecord/person/address/[addressType/instanceValue/text="Preferred"]addressPart /nameValuePair /[instanceName/text="NonFieldedStreetAddress1"]/instanceValue /text http://purl.imsglobal.org/vocab/lti/v2/variable#Person.address.street1 |
| Person.address.street2 | The second line of the user's street address. In the LIS Database, this value corresponds to personRecord/person/address/[addressType/instanceValue/text="Preferred"] addressPart /nameValuePair[instanceName/text="NonFieldedStreetAddress2"] /instanceValue/text http://purl.imsglobal.org/vocab/lti/v2/variable#Person.address.street2 |
| Person.address.street3 | The third line of the user's street address. In the LIS Database, this value corresponds to personRecord/person/address/[addressType/instanceValue/text="Preferred"]addressPart /nameValuePair /[instanceName/text="NonFieldedStreetAddress3"] /instanceValue/text http://purl.imsglobal.org/vocab/lti/v2/variable#Person.address.street3 |
| Person.address.street4 | The fourth line of the user's street address. In the LIS Database, this value corresponds to personRecord/person/address/[addressType/instanceValue/text="Preferred"]addressPart /nameValuePair /[instanceName/text="NonFieldedStreetAddress4"] /instanceValue/text http://purl.imsglobal.org/vocab/lti/v2/variable#Person.address.street4 |
| Person.address.timezone | The user's time zone. In the LIS Database, this value corresponds to personRecord/person/address/[addressType/instanceValue/text="Preferred"]addressPart /nameValuePair /[instanceName/text="Timezone"]/instanceValue/text http://purl.imsglobal.org/vocab/lti/v2/variable#Person.address.timezone |
| Person.email.personal | The user's personal email address In the LIS Database, this value corresponds to person/contactinfo[contactinfoType/instanceValue/text="Email_Personal"]/contactinfoValue /text http://purl.imsglobal.org/vocab/lti/v2/variable#Person.email.personal |
| Person.email.primary | The user's primary email address. In the LIS Database, this value corresponds to personRecord/person/contactinfo[contactinfoType/instanceValue/text="Email_Primary"] /contactinfoValue/text http://purl.imsglobal.org/vocab/lti/v2/variable#Person.email.primary |
| Person.name.family | The family name of the user. In the LIS Database, this value corresponds to personRecord/person/name/partName[instanceName/text="Family”]/instanceValue/text http://purl.imsglobal.org/vocab/lti/v2/variable#Person.name.family |
| Person.name.full | The full name of the user. In the LIS Database, this value corresponds to personRecord/person/formname/[formnameType/instanceValue/text="Full"] /formattedName/text http://purl.imsglobal.org/vocab/lti/v2/variable#Person.name.full |
| Person.name.given | The given name of the user. In the LIS Database, this value corresponds to personRecord/person/name/partName[instanceName/text="Given”]/instanceValue/text http://purl.imsglobal.org/vocab/lti/v2/variable#Person.name.given |
| Person.name.middle | The middle name of the user. In the LIS Database, this value corresponds to personRecord/person/name/partName[instanceName/text="Middle”]/instanceValue/text http://purl.imsglobal.org/vocab/lti/v2/variable#Person.name.middle |
| Person.name.prefix | The prefix for the user's name, such as Dr., Mr., Ms. etc. In the LIS Database, this value corresponds to personRecord/person/name/partName[instanceName/text="Prefix”]/instanceValue/text http://purl.imsglobal.org/vocab/lti/v2/variable#Person.name.prefix |
| Person.name.suffix | The suffix for the user's name, such as Jr., II, etc. In the LIS Database, this value corresponds to personRecord/person/name/partName[instanceName/text="Suffix”]/instanceValue/text http://purl.imsglobal.org/vocab/lti/v2/variable#Person.name.suffix |
| Person.phone.home | The user's home phone number In the LIS Database, this value corresponds to personRecord/person/contactinfo [contactinfoType/instanceValue/text="Telephone_Home"]/contactinfoValue /text http://purl.imsglobal.org/vocab/lti/v2/variable#Person.phone.home |
| Person.phone.mobile | The user's mobile phone number In the LIS Database, this value corresponds to personRecord/person/contactinfo[contactinfoType/instanceValue/text="Mobile"] /contactInfoValue/text http://purl.imsglobal.org/vocab/lti/v2/variable#Person.phone.mobile |
| Person.phone.primary | The user's primary phone number In the LIS Database, this value corresponds to personRecord/person/contactinfo [contactinfoType/instanceValue/text="Telephone_Primary"]/contactinfoValue /text http://purl.imsglobal.org/vocab/lti/v2/variable#Person.phone.primary |
| Person.phone.work | The user's work phone number. In the LIS Database, this value corresponds to personRecord/person/contactinfo [contactinfoType/instanceValue/text="Telephone_Work"]/contactinfoValue /text http://purl.imsglobal.org/vocab/lti/v2/variable#Person.phone.work |
| Person.sms | The number at which the user prefers to receive SMS text messages. In the LIS Database, this value corresponds to personRecord/person/contactinfo[contactinfoType/instanceValue/text="SMS"] /contactinfoValue/text http://purl.imsglobal.org/vocab/lti/v2/variable#Person.sms |
| Person.sourcedId | The LIS identifier for the user. In the LIS Database, this value corresponds to http://purl.imsglobal.org/vocab/lti/v2/variable#Person.sourcedId |
| Person.webaddress | The user's web address. This could be a facebook address, a blog, or any other web address linked to the user. The value should be a URL. In the LIS Database, this value corresponds to personRecord/person/contactinfo[contactinfoType/instanceValue/text="Web-Address"] /contactinfoValue/text http://purl.imsglobal.org/vocab/lti/v2/variable#Person.webaddress |
| ResourceLink.description | A plain text description of the link’s destination, suitable for display alongside the link. http://purl.imsglobal.org/vocab/lti/v2/variable#ResourceLink.description |
| ResourceLink.id | This is the local identifier for the resource link within the Tool Consumer system from which the launch occurred. Corresponds to the resource_link_id launch parameter. http://purl.imsglobal.org/vocab/lti/v2/variable#ResourceLink.id |
| ResourceLink.title | A plain text title for the resource. http://purl.imsglobal.org/vocab/lti/v2/variable#ResourceLink.title |
| Result.comment | A comment associated with the outcome which may be made visible to the student. http://purl.imsglobal.org/vocab/lti/v2/variable#Result.comment |
| Result.createdTimestamp | The date and time when the Result was created. In the LIS Database, this value corresponds to http://purl.imsglobal.org/vocab/lti/v2/variable#Result.createdTimestamp |
| Result.dataSource | An identifier for the original source system of the Result record. In the LIS Database, this value corresponds to resultRecord/result/dataSource http://purl.imsglobal.org/vocab/lti/v2/variable#Result.dataSource |
| Result.resultScore | The score that the learner earned on the assignment or activity to which this Result pertains. In the LIS Database, this value corresponds to resultRecord/result/resultScore/textString http://purl.imsglobal.org/vocab/lti/v2/variable#Result.resultScore |
| Result.sourcedId | The LIS identifier for the Result resource. In the LIS Database, this value corresponds to http://purl.imsglobal.org/vocab/lti/v2/variable#Result.sourcedId |
| Result.status | A URI for the status of the Result. As a best practice, the URI should resolve to a JSON-LD description of the status value or a term in a VDEX file. The vocabulary for Result status values is extensible. The set of standard values includes:
http://purl.imsglobal.org/vocab/lti/v2/variable#Result.status |
| Result.url | The URL of the Result resource. Client applications may issue an HTTP request to read, update or delete the resource at this URL. http://purl.imsglobal.org/vocab/lti/v2/variable#Result.url |
| ToolProxy.custom.url | The endpoint URL for accessing system-wide tool settings. http://purl.imsglobal.org/vocab/lti/v2/variable#ToolProxy.custom.url |
| ToolProxyBinding.custom.url | The endpoint URL for accessing context-level tool settings. http://purl.imsglobal.org/vocab/lti/v2/variable#ToolProxyBinding.custom.url |
| User.id | Corresponds to the user_id launch parameterfrom the http://purl.imsglobal.org/vocab/lti/v2/variable#User.id |
| User.image | The URL for an image of the user suitable for use as a profile picture or avatar. http://purl.imsglobal.org/vocab/lti/v2/variable#User.image |
| User.org | A URI describing the user's organisational properties; for example, an ldap:// URI such as ldap://host.com:6666/uid=user,ou=people,dc=example,dc=com. If more than one format of organisational URI is specified, each should be separated with a space. http://purl.imsglobal.org/vocab/lti/v2/variable#User.org |
| User.scope.mentor | A comma-separated list of user ID values which the current user can access as a mentor. Corresponds to the role_scope_mentor launch parameter. http://purl.imsglobal.org/vocab/lti/v2/variable#User.scope.mentor |
| User.username | The username that identifies the user within the Tool Consumer system. http://purl.imsglobal.org/vocab/lti/v2/variable#User.username |
| Title: | LTI Variables |
|---|---|
| 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 |