Custom parameter substitutions

For a specific set of custom parameters we support substitution, and in the following section you will find a list with the message variable names we support substitution for, and the value we substitute them with. Any other parameters, if provided, will be passed along without any substitution done as is described in the specification.

LTI User variables

Message variable name

Substituted value

Example value

$User.id

Unique User Identifier

4 (NB! This is userid from Platform, not personid from itslearning)

LIS Person variables

Message variable name

Substituted value

Example value

$Person.name.full

Person full name
Only provided if privacy level is set to Public or NameOnly

Ola Nordmann

$Person.name.family

Person family name
Only provided if privacy level is set to Public or NameOnly

Nordmann

$Person.name.given

Person given name
Only provided if privacy level is set to Public or NameOnly

Ola

$Person.address.locality

Person locale

en-GB

$Person.address.timezone

Person windows timezone 

GMT Standard Time

$Person.email.primary

Person primary e-mail address
Only provided if privacy level is set to Public or EmailOnly

[email protected]

LIS Course Offering Variables

Message variable name

Substituted value

Example value

$CourseOffering.sourcedId

Identifier for course 

ltitest.itslearning.com:MYCA

$CourseOffering.title

Course title 

Course A

$CourseOffering.courseNumber

Course code 

MYCA

LIS Course Section Variables

Message variable name

Substituted value

Example value

$CourseSection.sourcedId

Identifier for Learning tool instance in course 

ltitest.itslearning.com:MYCA-104454

$CourseSection.title

Learning tool instance title 

LTI tool

$CourseSection.shortDescription

Max 200 characters of learning tool instance description

A short description describing the learning tool instance

$CourseSection.longDescription

Learning tool instance description

A long description elaborately describing the learning tool instance and possible some more details

$CourseSection.courseNumber

Course code 

MYCA

$CourseSection.timeFrame.begin

Time the learning tool instance is active from 

01.01.1900 23:59:59

$CourseSection.timeFrame.end

Time the learning tool instance is active to 

31.12.9999 23:59:59

$CourseSection.sourceSectionId

Learning tool instance ID 

104454

LIS Result Variables

Message variable name

Substituted value

Example value

$Result.sourcedGUID

Unique result identifier 

mzkaxjv4rwgjrt55eov0tj55;104454;114662;18619

$Result.resultScore

Result in format valid according to LTI specs

0.6

itslearning Person Variables

Message variable name

Substituted value

Example value

$Person.customerId

Customer\site Identifier the Person belong to

2

itslearning Context Variables

Message variable name

Substituted value

Example value

$Context.courseId

course ID for course this instance is placed in

<CustomerId>-<CourseId>, Example: 23002-6

$Context.organisationId

course organisation ID for course this instance is placed in

1233

$Context.organisationSyncKey

course organisation SyncKey for course this instance is placed in

ASD1234

itslearning Instance Variables

Message variable name

Substituted value

Example value

$Instance.creatorOrganisationIds

list of organisation IDs for creator of this instance in course

123, 423, 3423

$Instance.creatorOrganisationSyncKeys

list of organisation SyncKeys for creator of this instance in course

ADE123, DSE423, DSE3423