Custom parameter substitutions

$User.id

Platform user entity id (not sync key in any case)
Note: This is platform user id, and not the itslearning person id.

E.g.: 400012

(Same as for user_id from LTI standard parameters)

$User.username

User's username.
Only provided if privacy level is set to Public.

E.g.: adamsmith

$Person.name.full

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

E.g.: [email protected]

(Same as for lis_person_name_full from LTI standard parameters )

$Person.name.family

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

E.g.: Smith

(Same as for lis_person_name_family from LTI standard parameters )

$Person.name.given

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

E.g.: Adam Smith

(Same as for lis_person_name_given from LTI standard parameters )

$Person.address.locality

Person locale

E.g. : en-GB

(Same as for launch_presentation_locale from LTI standard parameters )

$Person.address.timezone

Person windows timezone

E.g: GMT Standard Time

$Person.email.primary

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

E.g : [email protected]

(Same as for lis_person_contact_email_primary from LTI standard parameters )

$CourseOffering.sourcedId

Identifier for course

E.g. : ltitest.itslearning.com:MYCA

(Same as for lis_course_offering_sourcedid from LTI standard parameters

$CourseOffering.title

Course title

E.g.: Course A

(Same as for context_title from LTI standard parameters

$CourseOffering.courseNumber

Course code

E.g. : MYCA

(Same as for context_label from LTI standard parameters

$CourseSection.sourcedId

Identifier for Learning tool instance in course

E.g.: ltitest.itslearning.com:MYCA-104454

(Same as for lis_course_section_sourcedid from LTI standard parameters

$CourseSection.title

Learning tool instance title

E.g.: LTI tool title

$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

E.g. : MYCA

(Same as for context_label from LTI standard parameters

$CourseSection.timeFrame.begin

Time the learning tool instance is active from

E.g. : 01.01.1900 23:59:59

$CourseSection.timeFrame.end

Time the learning tool instance is active to

E.g. : 31.12.9999 23:59:59

$CourseSection.sourceSectionId

Learning tool instance ID

E.g. : 104454

$Result.sourcedGUID

Unique result identifier

E.g. : mzkaxjv4rwgjrt55eov0tj55;104454;114662;18619

(Same as for lis_result_sourcedid from LTI standard parameters

$Result.resultScore

Result in format valid according to LTI specs

E.g: 0.6

$Context.courseId

Course ID for course this instance is placed in

Format: <CustomerId>-<CourseId>

E.g. 23002-6

$Context.organisationId

Course organisation ID for course this instance is placed in

E.g. 1233

$Context.organisationSyncKey

Course organisation SyncKey for course this instance is placed in

E.g. ASD1234

$Context.organisationLegalId

Course organisation LegalID for course this instance is placed in

E.g. ASD123

$Instance.creatorOrganisationIds

List of organisation IDs for creator of this instance in course

E.g. : 123, 423, 3423

$Instance.creatorOrganisationSyncKeys

List of organisation SyncKeys for creator of this instance in course

E.g. : ADE123, DSE423, DSE3423

$ToolConsumerProfile.url

An endpoint where TP could go to read description of itslearning as LTI Tool Consumer (a TC profile)

E.g: https://ltitest.itslearning.com/api/toolConsumerProfile

LTI 1.1

$Person.customerId

Customer\site Identifier the Person belong to

E.g. : 2

(Same as for tool_consumer_instance_guid from LTI standard parameters

$Person.customField1

The value in the first custom field

Note! Will only be passed if Privacy Level is set to "Public" or "CustomOnly"

Note! Not transferred for the Ad-hoc LTI Tool (blue puzzle on course add page)

E.g. 123

Example: sis_number=$person.customfield1

$Person.customField2

The value in the second custom field

Note! Will only be passed if Privacy Level is set to "Public" or "CustomOnly"

Note! Not transferred for the Ad-hoc LTI Tool (blue puzzle on course add page)

E.g. 123

Example: custom_user_attribute=$person.customfield2

$Person.customField3

The value in the third custom field

Note! Will only be passed if Privacy Level is set to "Public" or "CustomOnly"

Note! Not transferred for the Ad-hoc LTI Tool (blue puzzle on course add page)

E.g. 123

Example: system_data=$person.customfield3

$Person.customField4

The value in the fourth custom field

Note! Will only be passed if Privacy Level is set to "Public" or "CustomOnly"

Note! Not transferred for the Ad-hoc LTI Tool (blue puzzle on course add page)

E.g. 123

Example: tool_identifier=$person.customfield4

$Person.customField5

The value in the fifth custom field

Note! Will only be passed if Privacy Level is set to "Public" or "CustomOnly"

Note! Not transferred for the Ad-hoc LTI Tool (blue puzzle on course add page)

E.g. 123

Example: local_area_code=$person.customfield5

LTI 1.3

$Person.eckId

Unique identity for daily use of digital teaching material.

Note! Will only passed if the customer setting ' Enable ECK iD support ' is ON and the extension has access to EckId.

E.g. 123

Example: eckId=$Person.eckId

$Person.digiDeliveryId

ECK digital delivery address

Note! Will only passed if the customer setting ' Enable DigiDeliveryID support ' is ON and the extension has access to EckId.

E.g. 123

Example: digiDeliveryId=$Person.digiDeliveryId

$ToolConsumerProfile.url

An endpoint where TP could go to read description of itslearning as LTI Tool Consumer (a TC profile)

E.g: https://ltitest.itslearning.com/api/toolConsumerProfile

$Plugin.editContent

HTML of plugged in content. Only applicable for image/* media type.

E.g: <img src="https://equatio-api.texthelp.com/svg/1%2B%5C%20x%5C%20%2B%5C%20y%5C%20%2B%5C%20z%5C%20%2B%5C%205" alt="1 plus x plus y plus z plus 5">