Webservice protocols

Note: This page is a work-in-progress. Comments and suggestions are welcome! Please use the page comments.

Introduction

Web service protocol plugins are web service servers. These servers let external applications call Moodle web service functions in an specific protocol: REST / AMF / SOAP /XML-RPC / ...

Examples

link to classic examples in the Plugins database

Naming conventions

describe naming conventions

File structure

describe the basic structure of the files and what they are for clarify required vs optional

Interfacing to APIs

list all the callbacks that must be defined, link to relevant API docs list all other optional callbacks as well, linking to relevant API docs

Database tables

describe all the tables that must be implemented describe how to store addtional data

TODO

• Link your pages to type in Frankenstyle page
• Link your pages to type in Plugins page
• Add pages to Plugins category
• This should be done for following plugin's: https://docs.moodle.org/dev/Frankenstyle#Plugin_types