Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

Creating a web service client: Difference between revisions

From MoodleDocs
No edit summary
No edit summary
Line 1: Line 1:
{{Moodle_2.0}}
{{Moodle_2.0}}
[[Image:Moodle web service function documentation.jpg|thumb]]You need to have previously setup a web service. Read the [https://docs.moodle.org/20/en/Web_Services#Documentation_for_administrators Documentation for administrators].
[[Image:Moodle web service function documentation.jpg|thumb]]You need to have previously setup a web service. Read the [https://docs.moodle.org/20/en/Web_Services#Documentation_for_administrators Documentation for administrators].
TO see the full API Documentation, connect as Admin and go to '''Administration > Plugins > Web services > API Documentation'''
To see the API Documentation, connect as Admin and go to '''Administration > Plugins > Web services > API Documentation'''


= Officially supported protocols=
= Officially supported protocols=

Revision as of 09:39, 15 September 2011

Moodle 2.0


Moodle web service function documentation.jpg

You need to have previously setup a web service. Read the Documentation for administrators.

To see the API Documentation, connect as Admin and go to Administration > Plugins > Web services > API Documentation

Officially supported protocols

  • REST: the Moodle REST server uses POST for parameters and XML for returned values. This server is not RESTfull.
  • SOAP: the Moodle SOAP server is based on the Zend SOAP server (itself based on the PHP SOAP server). Zend publishes a Zend SOAP client. The current server implementation doesn't work with Java/.Net because we didn't generated a fully describe WSDL yet. If you are working on a Java/.Net client, follow or participate to the tracker issues MDL-28988 / MDL-28989
  • XML-RPC: the Moodle XML-RPC server is based on Zend XML-RPC server. Zend also publishes a Zend XML-RPC client.
  • AMF: the Moodle AMF server is based on the Zend AMF server. The test client can be found in Settings blocks > Site Administration > Development > Web service test client > AMF Test client.

PHP client examples

PHP client sample code can be downloaded on Github.