Web services API - Revision history

Devdocsbot: Protected "Web services API": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2022-12-31T13:13:54Z

Protected "Web services API": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision	Revision as of 13:13, 31 December 2022
(No difference)

Andrewnicols: Note migration to new docs

2022-12-31T07:25:37Z

Note migration to new docs

← Older revision		Revision as of 07:25, 31 December 2022
Line 1:		Line 1:
			{{Template:Migrated\|newDocId=/docs/apis/subsystems/external/writing-a-service}}
	==Overview==		==Overview==
	The Web services API allows you to expose your plugin's functions (usually [[External functions API\|external functions]]) as Web services.		The Web services API allows you to expose your plugin's functions (usually [[External functions API\|external functions]]) as Web services.

Brendanheywood: /* See also */

2022-03-16T03:07:10Z

See also

← Older revision		Revision as of 03:07, 16 March 2022
Line 1:		Line 1:
	==Overview==		==Overview==

	The Web services API allows you to expose your plugin's functions (usually [[External functions API\|external functions]]) as Web services.		The Web services API allows you to expose your plugin's functions (usually [[External functions API\|external functions]]) as Web services.

Line 6:		Line 5:

	Exposing functions as Web service functions is done in one file called services.php.		Exposing functions as Web service functions is done in one file called services.php.

	== services.php ==		== services.php ==
	* This file can be added to the '''db''' sub-folder of your [[Frankenstyle#Plugin_types\|plugin]].		* This file can be added to the '''db''' sub-folder of your [[Frankenstyle#Plugin_types\|plugin]].
	* This file contains one or two arrays. The first array declares your web service functions. Each of these declarations reference a function in your module (usually [[External functions API\|an external function]]).		* This file contains one or two arrays. The first array declares your web service functions. Each of these declarations reference a function in your module (usually [[External functions API\|an external function]]).

	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	<?php		<?php
Line 27:		Line 24:
	);		);
	</syntaxhighlight>		</syntaxhighlight>

	* The second, optional array declares the pre-built services.		* The second, optional array declares the pre-built services.
	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
Line 43:		Line 39:
	);		);
	</syntaxhighlight>		</syntaxhighlight>

	<p class="note">Don't forget to increment the version number in the version.php file of your plugin whenever services.php changes, otherwise Moodle will not detect the changes.</p>		<p class="note">Don't forget to increment the version number in the version.php file of your plugin whenever services.php changes, otherwise Moodle will not detect the changes.</p>

	== Detailed tutorial ==		== Detailed tutorial ==

	A more detailed tutorial for this system can be found at the following page:		A more detailed tutorial for this system can be found at the following page:
	* [[Adding a web service to a plugin]]		* [[Adding a web service to a plugin]]

	Among other things, that tutorial explains how you define the parameters and return value of your function.		Among other things, that tutorial explains how you define the parameters and return value of your function.

	==See also==		==See also==

	* [[Core APIs]]		* [[Core APIs]]
	* [[External functions API]]		* [[External functions API]]
	* [[Web services API Changes]]		* [[Web services API Changes]]
			* [[Session locks#Read only sessions in web services]]
	[[Category:Web_Services]]		[[Category:Web_Services]]
	[[Category:API]]		[[Category:API]]

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T20:34:31Z
Text replacement - "<code php>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 20:34, 14 July 2021
				
Line 11:
Line 11:
* This file contains one or two arrays. The first array declares your web service functions. Each of these declarations reference a function in your module (usually [[External functions API|an external function]]). * This file contains one or two arrays. The first array declares your web service functions. Each of these declarations reference a function in your module (usually [[External functions API|an external function]]).



<code php> <syntaxhighlight lang="php">
<?php <?php



Line 29:
Line 29:



* The second, optional array declares the pre-built services. * The second, optional array declares the pre-built services.
<code php> <syntaxhighlight lang="php">
// OPTIONAL // OPTIONAL
// During the plugin installation/upgrade, Moodle installs these services as pre-build services.   // During the plugin installation/upgrade, Moodle installs these services as pre-build services.

`Mudrd8mz: Text replacement - "`" to ""

2021-07-14T20:25:13Z

Text replacement - "</code>" to "</syntaxhighlight>"

← Older revision		Revision as of 20:25, 14 July 2021
Line 26:		Line 26:
	)		)
	);		);
	</~~code~~>		</syntaxhighlight>

	* The second, optional array declares the pre-built services.		* The second, optional array declares the pre-built services.
Line 42:		Line 42:
	)		)
	);		);
	</~~code~~>		</syntaxhighlight>

	<p class="note">Don't forget to increment the version number in the version.php file of your plugin whenever services.php changes, otherwise Moodle will not detect the changes.</p>		<p class="note">Don't forget to increment the version number in the version.php file of your plugin whenever services.php changes, otherwise Moodle will not detect the changes.</p>

Mudrd8mz at 10:49, 19 March 2021

2021-03-19T10:49:26Z

← Older revision		Revision as of 10:49, 19 March 2021
Line 52:		Line 52:

	Among other things, that tutorial explains how you define the parameters and return value of your function.		Among other things, that tutorial explains how you define the parameters and return value of your function.

	~~== Example ==~~

	~~You will find an example of a services.php file in the [https://github.com/moodlehq/moodle-local_wstemplate web service template plugin]. This plugin contains a web service hello_world function.~~

	~~Also, to make testing easy for you, the plugin is distributed with a test client in the '''client''' folder.~~

	==See also==		==See also==

Stronk7: MDLSITE-6096 - new location for external function definitions

2020-05-03T17:26:20Z

MDLSITE-6096 - new location for external function definitions

← Older revision		Revision as of 17:26, 3 May 2020
Line 16:		Line 16:
	$functions = array(		$functions = array(
	'local_PLUGINNAME_FUNCTIONNAME' => array( // local_PLUGINNAME_FUNCTIONNAME is the name of the web service function that the client will call.		'local_PLUGINNAME_FUNCTIONNAME' => array( // local_PLUGINNAME_FUNCTIONNAME is the name of the web service function that the client will call.
	'classname' => '~~local_PLUGINNAME_external~~', // create this class in ~~local~~/~~PLUGINNAME~~/~~externallib.php~~		'classname' => 'component\external[\optional\sub\namespaces\classname', // create this class in componentdir/classes/external
	'methodname' => 'FUNCTIONNAME', // implement this function into the above class		'methodname' => 'FUNCTIONNAME', // implement this function into the above class
	~~'classpath' => 'local/PLUGINNAME/externallib.php',~~
	'description' => 'This documentation will be displayed in the generated API documentation		'description' => 'This documentation will be displayed in the generated API documentation
	(Administration > Plugins > Webservices > API documentation)',		(Administration > Plugins > Webservices > API documentation)',

Jleyva: /* services.php */

2019-01-31T09:19:00Z

services.php

← Older revision		Revision as of 09:19, 31 January 2019
Line 23:		Line 23:
	'type' => 'write', // the value is 'write' if your function does any database change, otherwise it is 'read'.		'type' => 'write', // the value is 'write' if your function does any database change, otherwise it is 'read'.
	'ajax' => true, // true/false if you allow this web service function to be callable via ajax		'ajax' => true, // true/false if you allow this web service function to be callable via ajax
	'capabilities' => 'moodle/xxx:yyy, addon/xxx:yyy', // List the capabilities ~~used in~~ the function (missing capabilities are displayed for authorised users and also for manually created tokens in the web interface, this is just informative).		'capabilities' => 'moodle/xxx:yyy, addon/xxx:yyy', // List the capabilities required by the function (those in a require_capability() call) (missing capabilities are displayed for authorised users and also for manually created tokens in the web interface, this is just informative).
	'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE, 'local_mobile') // Optional, only available for Moodle 3.1 onwards. List of built-in services (by shortname) where the function will be included. Services created manually via the Moodle interface are not supported.		'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE, 'local_mobile') // Optional, only available for Moodle 3.1 onwards. List of built-in services (by shortname) where the function will be included. Services created manually via the Moodle interface are not supported.
	)		)

Sarjona: Added local_mobile reference

2018-06-13T09:46:51Z

Added local_mobile reference

← Older revision		Revision as of 09:46, 13 June 2018
Line 24:		Line 24:
	'ajax' => true, // true/false if you allow this web service function to be callable via ajax		'ajax' => true, // true/false if you allow this web service function to be callable via ajax
	'capabilities' => 'moodle/xxx:yyy, addon/xxx:yyy', // List the capabilities used in the function (missing capabilities are displayed for authorised users and also for manually created tokens in the web interface, this is just informative).		'capabilities' => 'moodle/xxx:yyy, addon/xxx:yyy', // List the capabilities used in the function (missing capabilities are displayed for authorised users and also for manually created tokens in the web interface, this is just informative).
	'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE) // Optional, only available for Moodle 3.1 onwards. List of built-in services (by shortname) where the function will be included. Services created manually via the Moodle interface are not supported.		'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE, 'local_mobile') // Optional, only available for Moodle 3.1 onwards. List of built-in services (by shortname) where the function will be included. Services created manually via the Moodle interface are not supported.
	)		)
	);		);

Jhunt: /* services.php */

2018-05-16T05:30:11Z