Pearson
Always Learning

LearningStudio supports basic LTI (version 1.0) for launching third-party tools. By default, we send a standard set of LTI parameters, which supports most configurations. We can assign various data points from LearningStudio to the LTI parameters, and we can accommodate custom parameters that third party tools may require.

Standard LTI Configuration

This table describes what LTI parameters we typically send in a standard launch, and the LearningStudio data points that are normally sent in those parameters. See the LTI 1.0 specification for more information about the parameters and their expected use cases.

Note: LTI 1.1 parameters, such as lis_result_sourcedid and lis_outcome_service_url are not sent as LearningStudio does not support Outcome Exchange.

LTI Parameter Typical Value Detail
context_id Course ID The LearningStudio course ID, which is unique to each section and can be used in API calls.
context_label Display Course Code The course code value, which is not necessarily unique to all sections.
context_title Course title The course title
context_type CourseSection Static value
launch_presentation_locale Language code (for example, en-us). The language code for the user.
launch_presentation_return_url Return URL Where to return the user in case of errors (see LTI specification).
lis_person_contact_email_primary User's email address The user's email address, which could vary if it changes in LearningStudio.
lis_person_name_family User last name The user's last name (which can vary if it changes).
lis_person_name_full User’s full name User’s first and last name combined (which can vary if it changes).
lis_person_name_given User’s first name User’s first name (which can vary if it changes).
lis_message_type basic=lti-launch-request Static value
lis_version LTI-1p0 Static value.
oauth_consumer_key OAuth consumer key This is a shared key you provide us to identify the client on your system. It is combined with the shared secret used to sign the requests for the oauth_signature field.
oauth_nonce Random value The unique random value used in calculating the signature. You need this to calculate a matching signature.
oauth_signature Signature value The calculated OAuth Signature for this request. You can reproduce this to verify the request is coming from LearningStudio.
oauth_signature_method HMAC-SHA1 Static value
We only use HMAC-SHA1 for our signatures.
oauth_timestamp Time in seconds The time value used in calculating the signature. You need this to calculate a matching signature.
oauth_version 1.0 Static value
resource_link_id Arbitrary value An arbitrary value that identifies the specific link in a specific course that triggered the launch. Unless the tool provider requires a unique value, this is likely to be a placeholder value.
resource_link_title Arbitrary value. An arbitrary value that identifies the specific linked text or location in a specific course that triggered the launch. Unless the tool provider requires a unique value, this is likely to be a placeholder value.
roles Role value The role value for this user in this course, as defined in the LTI specification.
tool_consumer_instance_description Campus name The campus name or other text that describes the school to the user
tool_consumer_instance_guid Node sort string Corresponds to the division of the campus the course resides in within the LearningStudio system. For example, if Strata University has a campus division called "Business," LearningStudio could pass a value of strata.bus..
Important: for course node and user node values, LearningStudio does not dictate a uniform organization for campus structures. There can be set-ups in which all courses reside in the same node. For reporting in such a case, the user node value indicates where the user originated.
See Data Model
tool_consumer_instance_name Client string The LearningStudio campus ID. For example, Strata University could have a value of strata passed as a client string value.
See Data Model
user_id User ID The LearningStudio user ID. This value is unique to each user across all clients. It can be used in API calls.

Additional Data Points

In addition to the LearningStudio data points described above, we can also send the following data. These can be swapped out in any of the standard LTI parameters, or sent as custom parameters.

Data Point Description
Course Call Numbers The Institution's catalog identifiers for the course. Because a single LearningStudio course can have multiple call numbers, all call numbers are concatenated into a string, separated by commas.
Parent Course ID This is the ID of the course's "parent" course, or the course from which this one was copied. If this course was not copied, this will be blank. This is useful for institutions that use a "Master Course" model.
Course GUID A GUID that identifies the course; this is part of an older implementation of our LTI system. This uniquely identifies the course but cannot be used with our APIs.
User GUID A GUID that identifies the user; this is part of an older implementation of our LTI system. This uniquely identifies the user but cannot be used with our APIs.
Parent Course GUID This is the GUID of the course's "parent" course, or the course from which this one was copied. If this course was not copied, this will be blank. This is part of an older implementation of our LTI system; it uniquely identifies the course but cannot be used with our APIs.
SMS Course ID A parameter specific to Pearson digital courseware.
Username/Login ID This is the value defined by the institution during the user creation process within LearningStudio. For example the user ID value of "4727856" would be the LearningStudio system generated value where as the user's username could be something like "jsmith". This is the value that an institution would have context of within their system and is valuable for looking up users within the various systems.

Note that with the LTI system, term identifiers and node role identifiers are not available. If you absolutely need these values, you'll need to use the Course APIs to retrieve the missing information (preferred and recommended approach), or integrate using the Proprietary SSO.

Static Values and Custom Parameters

Any parameter sent via LTI can be set to a static value, which will be the same for all users in all courses across all institutions.

You can also specify custom parameters be sent with the LTI launch. Custom parameter names typically begin with custom_, for example, custom_episode_id. Any of the data points above can be assigned to a custom parameter, or custom parameters can have variable values that are built into the course-level link (see next section).

Custom parameters and static values are set up during the integration configuration.

Link-Level Parameter Values

For all LTI launches, you can send up to five link-specific variable custom parameters, where the value is set as part of the link built into the course. These values are helpful when you want to have many links in a course or specify some variable piece of information in a launch, such as an ID for a piece of content in your system.

Link-level values can be assigned to a standard LTI parameter or a custom parameter.

Resource Link ID

If your solution depends on the resource link ID in LTI, this can be configured on a per-link basis when creating the links in the course. This requires no special configuration. See Advanced Use Cases.

3028 reads
Always Learning
Pearson