API Resources

Learner - Placement Launch Controller API

Interfaces

Get the launch URL and data for launching an LTI placement

GET /api/learner/lti_placement_launch

Response Codes

  • 200 OK
  • 404 Not Found

Parameters

  • placement_id String Required

    The id of the LTI placement to launch

Example Response

{
  "placement_id": "1",
  "tool_id": "2",
  "launch_url": "http://example.com/launch",
  "params": {},
  "launch_data": {
     "context_id": "1673cd0f-f043-4d34-bfbc-c13fd5cce99a",
     "context_label": "bridge",
     "custom_field": "value",
     "launch_presentation_document_target": "iframe",
     "launch_presentation_return_url": "http://bridge.local.bridgeops.sh:3000/learner/courses",
     "lis_person_contact_email_primary": "user@example.com",
     "lis_person_name_family": "Last",
     "lis_person_name_full": "First Last",
     "lis_person_name_given": "First",
     "lti_message_type": "basic-lti-launch-request",
     "lti_version": "LTI-1p2",
     "oauth_callback": "about:blank",
     "oauth_consumer_key": "key",
     "oauth_nonce": "534b94655fc5f8ebaa9c97344ea7b953",
     "oauth_signature": "7CgFfsQ14XFAJSM2o8GT6pg8C7w=",
     "oauth_signature_method": "HMAC-SHA1",
     "oauth_timestamp": "1490312905",
     "oauth_version": "1.0",
     "resource_link_description": "This is a Sample Tool Provider.",
     "resource_link_id": "8169f5e122e9dafafd1f02c9e15eb4ab",
     "roles": "learner",
     "tool_consumer_info_product_family_code": "Bridge",
     "tool_consumer_instance_guid": "bridge.local.bridgeops.sh:3000",
     "tool_consumer_instance_name": "Bridge",
     "tool_consumer_instance_url": "http://bridge.local.bridgeops.sh:3000",
     "user_id": "c74cff31-603b-4c01-832e-1810ee54bf91"
  }
}