Note: This documentation is for Moodle 2.7. For up-to-date documentation see Mobile web services.

Mobile web services: Difference between revisions

From MoodleDocs
m (category)
(link edit)
 
(25 intermediate revisions by 8 users not shown)
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 [https://docs.moodle.org/en/Development:Mobile_app Moodle app]. Enable it only if you want people to use the official app or if third party app explicitly requires it.
{{Web services}}
Moodle 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.


== Enable the mobile web services ==
== Enabling 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.
A site administrator first must enable mobile web services:


*In ''Administration > Site administration > Plugins > Web services > Mobile''
*Check "Enable mobile web services" and then
*Click Save.


That's it! No other steps required.
The rest of this document explains the "behind the scenes".
== 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 (''Administration block > Advanced features'')
* enable the web services system (''Administration > 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 (for backward compatibility with unmaintained My Moodle app)
* enable the rest protocol
* allow the 'webservice/xmlrpc:use' capability for authenticated user role
* allow the 'webservice/xmlrpc:use' capability for authenticated user role
* allow the 'webservice/rest: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 mobile web services ==
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'.
*if 'Mobile web services' is the only external service enabled:
*if 'Mobile web services' was the only external service enabled:
** disable the web services system
** disable the web services system
** disable the xml-rpc protocol
** disable the xml-rpc protocol
** disallow the 'webservice/xmlrpc:use' capability for authenticated user role
** disable the rest protocol
** remove the 'webservice/xmlrpc:use' capability for authenticated user role
** remove the 'webservice/rest:use' capability for authenticated user role
 
==See also==
* [[Mobile app]]
 
[[Category:Mobile]]


[[Category:Web Services]]
[[de:Mobile Webservices]]
[[ja:モバイルウェブサービス]]
[[es:Servicios web para móviles]]

Latest revision as of 10:11, 25 February 2014

Moodle 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 Administration > Site administration > Plugins > Web services > Mobile
  • Check "Enable mobile web services" and then
  • Click Save.

That's it! No other steps required.

The rest of this document explains the "behind the scenes".

What happens when the service is enabled

Enabling the mobile web services will automatically:

  • enable the web services system (Administration > 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 (for backward compatibility with unmaintained My Moodle app)
  • enable the rest protocol
  • allow the 'webservice/xmlrpc:use' capability for authenticated user role
  • allow the 'webservice/rest: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
    • disable the rest protocol
    • remove the 'webservice/xmlrpc:use' capability for authenticated user role
    • remove the 'webservice/rest:use' capability for authenticated user role

See also