Note: You are currently viewing documentation for Moodle 3.1. Up-to-date documentation for the latest stable version of Moodle is probably available here: Mobile web services.

Mobile web services: Difference between revisions

From MoodleDocs
(Created page with "'''NOT IMPLEMENTED YET''' Tracker issue: MDL-27551 Moodle 2.1 comes with a built-in web service designed for mobile applications. It is required to run the official [http://docs...")
 
No edit summary
Line 14: Line 14:
* enable the web services system (''Administration block > Advanced features'')
* enable the web services system (''Administration block > Advanced features'')
* enable the built-in external service called 'Mobile web services' - you should see this new mobile service listed as enabled.
* enable the built-in external service called 'Mobile web services' - you should see this new mobile service listed as enabled.
* enable the xml-rpc protocol
* allow the 'webservice/xmlrpc:use' capability for authenticated user role


It is not possible to edit this mobile service.
It is not possible to edit this mobile service.
Line 19: Line 21:
== Disable the mobile web services ==
== Disable the mobile web services ==
When you uncheck 'Enable mobile web services', it wil automaticallyl:
When you uncheck 'Enable mobile web services', it wil automaticallyl:
* disable the external service called 'Mobile web services'.
* disable the external service called 'Mobile web services'.<br/>
* disable the web services system if 'Mobile web services' is the only external service enabled.
if 'Mobile web services' is the only external service enabled:<br/>
* disable the web services system
* disable the xml-rpc protocol
* disallow the 'webservice/xmlrpc:use' capability for authenticated user role

Revision as of 07:16, 8 June 2011

NOT IMPLEMENTED YET Tracker issue: MDL-27551

Moodle 2.1 comes with a built-in web service designed for mobile applications. It is required to run the official Moodle app. Enable it only if you want people to use the official app or if third party app explicitly requires it.

Enable the mobile web services

Go to Administration block > Plugins > Web services > External services. Check Enable mobile web services and Save.

That's it! Not other steps required. The rest of this document has for purpose to explain you the "behind the scene" for any further mobile service customization.


Enabling the mobile web services will automatically:

  • enable the web services system (Administration block > Advanced features)
  • enable the built-in external service called 'Mobile web services' - you should see this new mobile service listed as enabled.
  • enable the xml-rpc protocol
  • allow the 'webservice/xmlrpc:use' capability for authenticated user role

It is not possible to edit this mobile service.

Disable the mobile web services

When you uncheck 'Enable mobile web services', it wil automaticallyl:

  • disable the external service called 'Mobile web services'.

if 'Mobile web services' is the only external service enabled:

  • disable the web services system
  • disable the xml-rpc protocol
  • disallow the 'webservice/xmlrpc:use' capability for authenticated user role