Help
Subscription Request
The Content Player HTTP POSTs the following XML to an external Subscription Manager's web service URL to obtain permission to display the content to the end-user. See Subscription Response for the expected response XML.
<request>
<context_id>string</context_id>
[<context_label>string</context_label>]
<context_title>string</context_title>
<launch_presentation_locale>string</launch_presentation_locale>
[<lis_person_contact_email_primary>string</lis_person_contact_email_primary>]
[<lis_person_name_family>string</lis_person_name_family>]
[<lis_person_name_full>string</lis_person_name_full>]
[<lis_person_name_given>string</lis_person_name_given>]
<resource_link_id>string</resource_link_id>
<resource_link_title>string</resource_link_title>
<roles>string</roles>
<tool_consumer_instance_guid>string</tool_consumer_instance_guid>
<tool_consumer_instance_name>string</tool_consumer_instance_name>
<tool_consumer_instance_url>string</tool_consumer_instance_url>
<user_id>string</user_id>
</request>
ElementAttributeMeaning
request / context_id
The unique ID of the context (course or section) that contains the content being launched.
request / context_label
The reference field value, if any, for the context.
request / context_title
The title of the context.
request / launch_presentation_locale
The culture name of the current user in the format "<languagecode2>-<country/regioncode2>", where <languagecode2> is a lowercase two-letter code derived from ISO 639-1 and <country/regioncode2> is an uppercase two-letter code derived from ISO 3166. For example, en-US for United States English.
request / lis_person_contact_email_primary
The user's e-mail address. An end-user can choose to not send this information.
request / lis_person_name_family
The user's family name. An end-user can choose to not send this information.
request / lis_person_name_full
The user's full name. An end-user can choose to not send this information.
request / lis_person_name_given
The user's given name. An end-user can choose to not send this information.
request / resource_link_id
A vertical-bar separated ID in the format CourseGUID|ItemID, where CourseGUID is the course's globally unique ID (guid), and ItemID is the ID of the item within the course.
request / resource_link_title
The item title.
request / roles
A comma-separated list of values for this user's role in the course. Possible values include Learner, Instructor, ContentDeveloper, Administrator, and Member.
request / tool_consumer_instance_guid
A unique identifier of the server making the request. The value is typically the DNS host name or IP address of the server making the request.
request / tool_consumer_instance_name
The name of the domain making the request, such as State University.
request / tool_consumer_instance_url
The root URL of the requesting server, such as http://myschool.brainhoney.com.
request / user_id
The unique user ID.
See Also
Subscription Response Subscription Manager Integration