Errors

Code Description
403 You are not authorized to access this page.

Examples

{
        'example_request_params': {
            'tool_name':'Some new name',
            'nonce': 1527500365,
            'timestamp': 1527500365052,
            'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
        },
        'example_response': {
            'lti_resource': {
                'id':1,
                'lti_resource_link_id':null,
                'tool_provider_id':'1',
                'lti_resource_link_name':'some new name',
                'exam_id':1,
                'created_at': '2020-11-25T17:21:59.485+01:00',
                'updated_at': '2020-11-25T17:21:59.485+01:00',
                'lti_resource_launch_url':'http://localhost:5001/link1',
                'lti_custom_data':'',
                'open_in_new_tab':false,
                'placeholder': 'LTI_EXAM_1'
            }
        }
    }

Params

Param name Description
id
optional

ID of the lti resource.

Validations:

  • Must be a number.

lti_resource_link_name
optional

Name of the lti resource

Validations:

  • Must be a String

exam_id
optional

ID of the exam to attach the lti resource to

Validations:

  • Must be a number.

tool_provider_id
optional

ID of the tool provider to create the lti resource from

Validations:

  • Must be a number.

lti_resource_launch_url
optional

LTI launch url of the external platform (default to the tool provider url)

Validations:

  • Must be a String

open_in_new_tab
optional

If set to true the link will be opened in a new tab on click

Validations:

  • Must be one of: true, false, 1, 0.

lti_custom_data
optional

Json as a string that will add custom data to the LTI request (default to the tool provider lti_custom_data)

Validations:

  • Must be a String

timestamp
required

Timestamp of the request in milliseconds.

Validations:

  • Must be a number.

nonce
required

Random number unique between the api calls made in the previous 24 hours.

Validations:

  • Must be a number.

signature
required

HMAC sha256 hex encoded hash, using the user secret_key as key, of the query string build with all the other parameters in the format ‘name=value’ joined by ‘?’ and ordered alphabethically by name. Do not use encoding scheme on the values you use to calculate the string

Validations:

  • Must be a String