Mobile web services: Difference between revisions
From MoodleDocs
Helen Foster (talk | contribs) m (Category:Mobile) |
Helen Foster (talk | contribs) (Mobile app link, small rewording, 2.1 template) |
||
| Line 1: | Line 1: | ||
Moodle 2.1 comes with a built-in web service designed for mobile applications. It is required to run the official [ | {{Moodle 2.1}}Moodle 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 can enable mobile web services as follows: | |||
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. | |||
The rest of this document explains "behind the scenes" for any further mobile service customisation. | The rest of this document explains "behind the scenes" for any further mobile service customisation. | ||
Enabling the mobile web services will automatically: | Enabling the mobile web services will automatically: | ||
* enable the web services system ('' | * 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 built-in external service called 'Mobile web services' - you should see this new mobile service listed as enabled. | ||
* enable the xml-rpc protocol | * enable the xml-rpc protocol | ||
| Line 17: | Line 20: | ||
It is not possible to edit this mobile service. | It is not possible to edit this mobile service. | ||
== | == Disabling mobile web services == | ||
When you uncheck 'Enable mobile web services', it will automatically: | When you uncheck 'Enable mobile web services', it will automatically: | ||
* disable the external service called 'Mobile web services'. | * disable the external service called 'Mobile web services'. | ||
| Line 23: | Line 26: | ||
** disable the web services system | ** disable the web services system | ||
** disable the xml-rpc protocol | ** disable the xml-rpc protocol | ||
** | ** remove the 'webservice/xmlrpc:use' capability for authenticated user role | ||
[[Category:Web Services]] | [[Category:Web Services]] | ||
[[Category:Mobile]] | [[Category:Mobile]] | ||
Revision as of 10:31, 15 September 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 can enable mobile web services as follows:
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.
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 (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
It is not possible to edit this mobile service.
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
