LTI Tools API

This local module provides a suite of web services for working with LTI tools on a Moodle installation. These web services are grouped in the "LTI Tools API" external service.

Configuration

To use this service you will need the following:

1. A user with sufficient permissions to use the web services
2. A token for that user

See Using web services in the Moodle documentation for information about creating and enabling web services. The user will need the following capabilities in addition to whichever protocol you enable:

• mod/lti:addinstance
• moodle/course:manageactivities

Functions

The LTI Tools API external service includes five functions:

• local_lti_tools_api_add_lti_instance: Add an LTI tool instance to a course
• local_lti_tools_api_get_lti_tool_by_name: Get LTI tool type ID by name
• local_lti_tools_api_get_lti_tool_details: Get detailed information about a specific LTI tool
• local_lti_tools_api_get_lti_tools: Get available LTI tools
• local_lti_tools_api_set_lti_availability: Set or update availability restrictions for an existing LTI instance

Requirements

• Moodle 4.1 (build 2022112800 or later)

Installation

Copy the lti_tools_api folder into your /local directory and visit your Admin Notification page to complete the installation.

Author

Daniel Landau (dlandau@reed.edu)