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

Mobile web services: Difference between revisions

From MoodleDocs
m (Fixed typo)
Line 26: Line 26:


[[Category:Web Services]]
[[Category:Web Services]]
[[Category:Mobile]]

Revision as of 10:24, 15 September 2011

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! No other steps required.

The rest of this document explains "behind the scenes" for any further mobile service customisation.

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 will automatically:

  • disable the external service called 'Mobile web services'.
  • if 'Mobile web services' was 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