Learning Tools Interoperability Deep Linking

https://www.imsglobal.org/spec/lti-dl/v2p0
Admin
LTI Deep Linking 2.0 is a specification that allows educational platforms to easily integrate...
Tokens:6,343
Snippets:61
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Image Resource Example

Source: https://www.imsglobal.org/spec/lti-dl/v2p0

Represents an image resource that should be rendered directly by the browser agent. Includes optional properties for dimensions and thumbnails.

```json
{
  "type": "image",
  "url": "https://www.example.com/image.png",
  "title": "Example Image",
  "width": 640,
  "height": 480,
  "thumbnail": {
    "url": "https://www.example.com/thumbnail.png",
    "width": 100,
    "height": 75
  }
}
```

--------------------------------

### File Resource Example

Source: https://www.imsglobal.org/spec/lti-dl/v2p0

Represents a file resource transferred from a tool to a platform. The URL may be short-lived and requires prompt processing by the platform.

```json
{
  "type": "file",
  "url": "https://www.example.com/resource.pdf",
  "title": "Example PDF Document",
  "text": "A sample PDF document for demonstration.",
  "icon": {
    "url": "https://www.example.com/icon.png",
    "width": 32,
    "height": 32
  },
  "expiresAt": "2014-03-05T12:34:56Z"
}
```

--------------------------------

### LTI Deep Linking Settings Claim Example

Source: https://www.imsglobal.org/spec/lti-dl/v2p0

This JSON object demonstrates the structure and properties of the `deep_linking_settings` claim, which characterizes the type of deep linking request a platform user is making. It includes accepted types, media types, presentation targets, and other configuration options.

```json
{
  "https://purl.imsglobal.org/spec/lti-dl/claim/deep_linking_settings": {
    "accept_types": ["link", "file", "html", "ltiResourceLink", "image"],
    "accept_media_types": "image/:::asterisk:::,text/html",
    "accept_presentation_document_targets": ["iframe", "window", "embed"],
    "accept_multiple": true,
    "auto_create": true,
    "title": "This is the default title",
    "text": "This is the default text",
    "data": "Some random opaque data that MUST be sent back",
    "deep_link_return_url": "https://platform.example/deep_links"
  }
}
```

--------------------------------

### LTI Deep Linking Request JSON Example

Source: https://www.imsglobal.org/spec/lti-dl/v2p0

This JSON object represents a typical launch request for LTI Deep Linking. It includes standard LTI claims, context information, tool platform details, and specific deep linking settings.

```json
{
  "iss": "https://platform.example.org",
  "sub": "a6d5c443-1f51-4783-ba1a-7686ffe3b54a",
  "aud": ["962fa4d8-bcbf-49a0-94b2-2de05ad274af"],
  "exp": 1510185728,
  "iat": 1510185228,
  "azp": "962fa4d8-bcbf-49a0-94b2-2de05ad274af",
  "nonce": "fc5fdc6d-5dd6-47f4-b2c9-5d1216e9b771",
  "name": "Ms Jane Marie Doe",
  "given_name": "Jane",
  "family_name": "Doe",
  "middle_name": "Marie",
  "picture": "https://example.org/jane.jpg",
  "email": "jane@example.org",
  "locale": "en-US",
  "https://purl.imsglobal.org/spec/lti/claim/deployment_id":
    "07940580-b309-415e-a37c-914d387c1150",
  "https://purl.imsglobal.org/spec/lti/claim/message_type": "LtiDeepLinkingRequest",
  "https://purl.imsglobal.org/spec/lti/claim/version": "1.3.0",
  "https://purl.imsglobal.org/spec/lti/claim/roles": [
    "http://purl.imsglobal.org/vocab/lis/v2/membership#Instructor",
    "http://purl.imsglobal.org/vocab/lis/v2/institution/person#Faculty"
  ],
  "https://purl.imsglobal.org/spec/lti/claim/context": {
    "id": "c1d887f0-a1a3-4bca-ae25-c375edcc131a",
    "label": "ECON 101",
    "title": "Economics as a Social Science",
    "type": ["CourseOffering"]
  },
  "https://purl.imsglobal.org/spec/lti/claim/tool_platform": {
    "contact_email": "support@example.org",
    "description": "An Example Tool Platform",
    "name": "Example Tool Platform",
    "url": "https://example.org",
    "product_family_code": "example.org",
    "version": "1.0"
  },
  "https://purl.imsglobal.org/spec/lti/claim/launch_presentation": {
    "document_target": "iframe",
    "height": 320,
    "width": 240
  },
  "https://purl.imsglobal.org/spec/lti/claim/custom": {
    "myCustom": "123"
  },
  "https://purl.imsglobal.org/spec/lti-dl/claim/deep_linking_settings": {
    "deep_link_return_url": "https://platform.example/deep_links",
    "accept_types": ["link", "file", "html", "ltiResourceLink", "image"],
    "accept_media_types": "image/:::asterisk:::,text/html",
    "accept_presentation_document_targets": ["iframe", "window", "embed"],
    "accept_multiple": true,
    "auto_create": true,
    "title": "This is the default title",
    "text": "This is the default text",
    "data": "csrftoken:c7fbba78-7b75-46e3-9201-11e6d5f36f53"
  }
}
```

--------------------------------

### HTML Fragment Resource Example

Source: https://www.imsglobal.org/spec/lti-dl/v2p0

Represents an HTML fragment to be embedded within a platform's HTML document. The platform is responsible for sanitizing the fragment against XSS attacks.

```json
{
  "type": "html",
  "html": "<h1>Hello World</h1><p>This is an HTML fragment.</p>",
  "title": "Sample HTML Fragment"
}
```

--------------------------------

### LTI Deep Linking Response Example

Source: https://www.imsglobal.org/spec/lti-dl/v2p0

This JSON object represents a typical response from an LTI Deep Linking launch. It includes claims like issuer, audience, expiration, and message type, along with a comprehensive list of content items.

```json
{
  "iss": "962fa4d8-bcbf-49a0-94b2-2de05ad274af",
  "aud": "https://platform.example.org",
  "exp": 1510185728,
  "iat": 1510185228,
  "nonce": "fc5fdc6d-5dd6-47f4-b2c9-5d1216e9b771",
  "azp": "962fa4d8-bcbf-49a0-94b2-2de05ad274af",
  "https://purl.imsglobal.org/spec/lti/claim/deployment_id":
    "07940580-b309-415e-a37c-914d387c1150",
  "https://purl.imsglobal.org/spec/lti/claim/message_type":
    "LtiDeepLinkingResponse",
  "https://purl.imsglobal.org/spec/lti/claim/version": "1.3.0",
  "https://purl.imsglobal.org/spec/lti-dl/claim/content_items": [
    {
      "type": "link",
      "title": "My Home Page",
      "url": "https://something.example.com/page.html",
      "icon": {
        "url": "https://lti.example.com/image.jpg",
        "width": 100,
        "height": 100
      },
      "thumbnail": {
        "url": "https://lti.example.com/thumb.jpg",
        "width": 90,
        "height": 90
      }
    },
    {
      "type": "html",
      "html": "<h1>A Custom Title</h1>"
    },
    {
      "type": "link",
      "url": "https://www.youtube.com/watch?v=corV3-WsIro",
      "embed": {
        "html":
          "<iframe width=\"560\" height=\"315\" src=\"https://www.youtube.com/embed/corV3-WsIro\" frameborder=\"0\" allow=\"autoplay; encrypted-media\" allowfullscreen></iframe>"
      },
      "window": {
        "targetName": "youtube-corV3-WsIro",
        "windowFeatures": "height=560,width=315,menubar=no"
      },
      "iframe": {
        "width": 560,
        "height": 315,
        "src": "https://www.youtube.com/embed/corV3-WsIro"
      }
    },
    {
      "type": "image",
      "url": "https://www.example.com/image.png",
      "https://www.example.com/resourceMetadata": {
        "license": "CCBY4.0"
      }
    },
    {
      "type": "ltiResourceLink",
      "title": "A title",
      "text": "This is a link to an activity that will be graded",
      "url": "https://lti.example.com/launchMe",
      "icon": {
        "url": "https://lti.example.com/image.jpg",
        "width": 100,
        "height": 100
      },
      "thumbnail": {
        "url": "https://lti.example.com/thumb.jpg",
        "width": 90,
        "height": 90
      },
      "lineItem": {
        "scoreMaximum": 87,
        "label": "Chapter 12 quiz",
        "resourceId": "xyzpdq1234",
        "tag": "originality",
        "gradesReleased": true
      },
      "available": {
        "startDateTime": "2018-02-06T20:05:02Z",
        "endDateTime": "2018-03-07T20:05:02Z"
      },
      "submission": {
        "endDateTime": "2018-03-06T20:05:02Z"
      },
      "custom": {
        "quiz_id": "az-123",
        "duedate": "$ResourceLink.submission.endDateTime"
      },
      "window": {
        "targetName": "examplePublisherContent"
      },
      "iframe": {
        "height": 890
      }
    },
    {
      "type": "file",
      "title": "A file like a PDF that is my assignment submissions",
      "url": "https://my.example.com/assignment1.pdf",
      "mediaType": "application/pdf",
      "expiresAt": "2018-03-06T20:05:02Z"
    },
    {
      "type": "https://www.example.com/custom_type",
      "data": "somedata"
    }
  ],
  "https://purl.imsglobal.org/spec/lti-dl/claim/data":
    "csrftoken:c7fbba78-7b75-46e3-9201-11e6d5f36f53"
}
```

--------------------------------

### Extending Resource Type with Custom Property

Source: https://www.imsglobal.org/spec/lti-dl/v2p0

Demonstrates how to enrich a resource type definition with additional custom properties, using a fully qualified URL as the key for the custom metadata.

```json
{
  "type": "image",
  "url": "https://www.example.com/image.png",
  "https://www.example.com/resourceMetadata": {
    "license": "CCBY4.0"
  }
}
```
Tokens:
Raw