moodle-external-api-development

Topics in the source

• Moodle External API Development
• When to Use This Skill
• Core Architecture Pattern
• Step-by-Step Implementation
• Step 1: Create the External API Class File
• Step 2: Define Input Parameters
• Step 3: Implement Business Logic
• Step 4: Define Return Structure

This skill guides you through creating custom external web service APIs for Moodle LMS, following Moodle's external API framework and coding standards. Creating custom web services for Moodle plugins Implementing REST/AJAX endpoints for course management Building APIs for quiz operations, user tracking, or reporting Exposing Moodle functionality to external applications Developing mobile app backends using Moodle Moodle external APIs follow a strict three-method pattern: 1. executeparameters() - Defines input parameter structure 2. execute() - Contains business logic 3. executereturns() - Defines return structure Location: /local/yourplugin/classes/external/yourapiname.php Key Points: Class must extend externalapi Namespace follows: localpluginname\external or modmodname\external Include the security check: defined('MOODLEINTERNAL') || die(); Require externallib.php for base classes Common Parameter Types: PARAMINT - Integers PARAMTEXT - Plain text (HTML stripped) PARAMRAW - Raw text (no cleaning) PARAMBOOL - Boolean values PARAMFLOAT - Floating point numbers PARAMALPHANUMEXT - Alphanumeric with extended chars Structures: externalvalue - Single value externalsinglestructure - Objec

This is an excerpt. Refer to the complete source and its current requirements.