Note: You are currently viewing documentation for Moodle 3.0. 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
Line 12: Line 12:
That's it! No other steps required.
That's it! No other steps required.


== What happens after enabled ==
== What happens when the service is enabled ==
Enabling the mobile web services will automatically:
Enabling the mobile web services will automatically:
* enable the web services system (''Settings > Site administration > Advanced features'')
* enable the web services system (''Settings > Site administration > Advanced features'')
Line 18: Line 18:
* enable the xml-rpc protocol
* enable the xml-rpc protocol
* allow the 'webservice/xmlrpc:use' capability for authenticated user role
* allow the 'webservice/xmlrpc:use' capability for authenticated user role
The rest of this document explains "behind the scenes" for any further mobile service customization.


== Disabling mobile web services ==
== Disabling mobile web services ==

Revision as of 08:41, 1 November 2011

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

Enabling mobile web services

A site administrator first must enable mobile web services:

  • In Settings > Site administration > Plugins > Web services > External services
  • Check "Enable mobile web services" and then
  • Click Save.

That's it! No other steps required.

What happens when the service is enabled

Enabling the mobile web services will automatically:

  • enable the web services system (Settings > Site administration > 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

Disabling 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
    • remove the 'webservice/xmlrpc:use' capability for authenticated user role

See also