Web services: Difference between revisions
No edit summary |
|||
| Line 17: | Line 17: | ||
#The core function can return a result to the web service function. The web service can also return the result to the server. The server return the result to the client | #The core function can return a result to the web service function. The web service can also return the result to the server. The server return the result to the client | ||
=List of functions= | =List of functions= | ||
All callable functions are declared into | All callable functions are declared into each external.php. A "description" array contains all function names, parameter names and types, and return type. | ||
Revision as of 06:13, 23 January 2009
Note: This page is a work-in-progress. Feedback and suggested improvements are welcome. Please join the discussion on moodle.org or use the page comments.
Moodle 2.0
Introduction
This page described the Web Services module implemented for Moodle 2.0
The tracker issue is here: MDL-12886
This module is been implemented by the DFWS Team and Moodle.
Implementation
Web Services module has been conceived in a purpose to be ported on different Moodle version, and also on different project. It has also for purpose to support multiple web service protocols (REST, SOAP, AMF, ...). Adding a new protocol support should be relatively easy.
How does it work
- The client requests a token from the web services server. For that the client sends a username/password.
- The web service server generates a token for this username and send it back to the client
- The client calls a web service (module name, function name, and function parameters) and joins the token to it
- The web service server authenticate the token, then call the matching web service function. The web service function is located in a external.php file. This external.php file contains all web service functions of for a module. The external.php file is located into the module folder.
- The web service function check capability, and call Moodle core function.
- The core function can return a result to the web service function. The web service can also return the result to the server. The server return the result to the client
List of functions
All callable functions are declared into each external.php. A "description" array contains all function names, parameter names and types, and return type.
