Web service API functions - Revision history

Stronk7: Note about Moodle 4.1 and XMLRPC extension/webservice added

2023-01-02T10:34:50Z

Note about Moodle 4.1 and XMLRPC extension/webservice added

← Older revision		Revision as of 10:34, 2 January 2023
Line 28:		Line 28:
	\| style="background:#ffdead;" \| SOAP\|\| style="background:#ffdead;" \| 2.0 \|\| style="background:#ffdead;" \| Very important for interoperating with Java and .Net applications. There was a partial implementation JAVA/.Net in Moodle 2.0, but it does not work for anything but the most trivial functions. It is fully working with PHP clients.\|\| Not supported \|\| MDL-20804, MDL-28988, MDL-28989		\| style="background:#ffdead;" \| SOAP\|\| style="background:#ffdead;" \| 2.0 \|\| style="background:#ffdead;" \| Very important for interoperating with Java and .Net applications. There was a partial implementation JAVA/.Net in Moodle 2.0, but it does not work for anything but the most trivial functions. It is fully working with PHP clients.\|\| Not supported \|\| MDL-20804, MDL-28988, MDL-28989
	\|-		\|-
	\| style="background:#D4FFDF;" \| XMLRPC\|\| style="background:#D4FFDF;" \| 2.0 \|\| style="background:#D4FFDF;" \| XML remote-procedure call. \|\| Not supported \|\|		\| style="background:#D4FFDF;" \| XMLRPC\|\| style="background:#D4FFDF;" \| 2.0 \|\| style="background:#D4FFDF;" \| XML remote-procedure call. {{Template:XMLRPC Note Moodle 4.1}} \|\| Not supported \|\|
	\|}		\|}

2021-06-03T07:01:26Z

Bump version number

2021-06-03T06:57:16Z

Add WS for 3.9, 3.10, 3.11

2020-10-28T13:27:55Z

Naming convention: Better format and clarify the naming style

← Older revision		Revision as of 13:27, 28 October 2020
Line 35:		Line 35:
	=== Naming convention ===		=== Naming convention ===

	~~We updated (regularised) the naming convention in Moodle 2.2. See MDL-29106 for those details.~~		All functions should be named as

	~~All functions should be named as follows~~:		<tt>{fullcomponent}_{methodname}</tt> - example: <tt>core_user_get_user_preferences</tt>

	* wsfunction = fullcomponent_methodname		where
	* fullcomponent = [~~https://docs.moodle.org/dev/~~Frankenstyle frankenstyle] ~~(eg core_xxxx~~ or ~~mod_xxx etc)~~
	* methodname ~~= verb_noun(s)~~		* <tt>{fullcomponent}</tt> is the full [[Frankenstyle\|frankenstyle]] name or the component such as <tt>core_user</tt> here
	* verb ~~= e.g.~~ get, create, delete, update or eventually other that well describes the action		* <tt>{methodname}</tt> is the name of the method in the form of <tt>{verb}_{noun}</tt> such as <tt>get_user_preferences</tt> here
	* noun = moodle objects, usually plural ~~(eg~~ posts, discussions, users, courses etc)		** <tt>{verb}</tt> - preferably one of <tt>get, create, delete, update</tt> or eventually other that well describes the action
			** <tt>{noun}</tt> - moodle objects, usually plural such as <tt>user_preferences</tt> here, or e.g. <tt>posts, discussions, users, courses</tt> etc.

			This naming convention has been in place since Moodle 2.2. See MDL-29106 for more details.

	=== Core web service functions ===		=== Core web service functions ===

2020-10-28T11:05:29Z

Naming convention

← Older revision		Revision as of 11:05, 28 October 2020
Line 42:		Line 42:
	* fullcomponent = [https://docs.moodle.org/dev/Frankenstyle frankenstyle] (eg core_xxxx or mod_xxx etc)		* fullcomponent = [https://docs.moodle.org/dev/Frankenstyle frankenstyle] (eg core_xxxx or mod_xxx etc)
	* methodname = verb_noun(s)		* methodname = verb_noun(s)
	* verb = get\|create\|delete\|update		* verb = e.g. get, create, delete, update or eventually other that well describes the action
	* noun = moodle objects, usually plural (eg posts, discussions, users, courses etc)		* noun = moodle objects, usually plural (eg posts, discussions, users, courses etc)

2020-02-25T09:41:23Z

Core web service functions

2019-02-15T08:16:29Z

Core web service functions

← Older revision		Revision as of 08:16, 15 February 2019
Line 382:		Line 382:
	\| core_get \|\| core_get_user_dates \|\| 3.3 \|\| Return formatted timestamps \|\| Yes \|\| Yes \|\|		\| core_get \|\| core_get_user_dates \|\| 3.3 \|\| Return formatted timestamps \|\| Yes \|\| Yes \|\|
	\|-		\|-
	\| ~~core_grade~~ \|\| core_grades_update_grades \|\| 2.7 \|\| Update a grade item and associated student grades. \|\| No \|\| Yes \|\|		\| core_grades \|\| core_grades_update_grades \|\| 2.7 \|\| Update a grade item and associated student grades. \|\| No \|\| Yes \|\|
	\|-		\|-
	\| core_grades \|\| core_grades_get_grades \|\| 2.7 \|\| Returns student course total grade and grades for activities. This function does not return category or manual items. This function is suitable for managers or teachers not students. \|\| No \|\| Yes \|\|		\| core_grades \|\| core_grades_get_grades \|\| 2.7 \|\| Returns student course total grade and grades for activities. This function does not return category or manual items. This function is suitable for managers or teachers not students. \|\| No \|\| Yes \|\|

2019-02-15T08:15:53Z

Core web service functions

← Older revision		Revision as of 08:15, 15 February 2019
Line 382:		Line 382:
	\| core_get \|\| core_get_user_dates \|\| 3.3 \|\| Return formatted timestamps \|\| Yes \|\| Yes \|\|		\| core_get \|\| core_get_user_dates \|\| 3.3 \|\| Return formatted timestamps \|\| Yes \|\| Yes \|\|
	\|-		\|-
	\| core_grade \|\| ~~core_grade_update_grades~~ \|\| 2.7 \|\| Update a grade item and associated student grades. \|\| No \|\| Yes \|\|		\| core_grade \|\| core_grades_update_grades \|\| 2.7 \|\| Update a grade item and associated student grades. \|\| No \|\| Yes \|\|
	\|-		\|-
	\| core_grades \|\| core_grades_get_grades \|\| 2.7 \|\| Returns student course total grade and grades for activities. This function does not return category or manual items. This function is suitable for managers or teachers not students. \|\| No \|\| Yes \|\|		\| core_grades \|\| core_grades_get_grades \|\| 2.7 \|\| Returns student course total grade and grades for activities. This function does not return category or manual items. This function is suitable for managers or teachers not students. \|\| No \|\| Yes \|\|

2018-12-13T10:52:07Z

Core web service functions

← Older revision		Revision as of 10:52, 13 December 2018
Line 59:		Line 59:
	\|-		\|-
	\| core_auth \|\| core_auth_confirm_user \|\| 3.2 \|\| Confirm a user account. \|\| Yes \|\| No \|\|		\| core_auth \|\| core_auth_confirm_user \|\| 3.2 \|\| Confirm a user account. \|\| Yes \|\| No \|\|
			\|-
			\| core_auth \|\| core_auth_is_age_digital_consent_verification_enabled \|\| 3.5 \|\| Checks if age digital consent verification is enabled. \|\| Yes \|\| No \|\|
			\|-
			\| core_auth \|\| core_auth_is_minor \|\| 3.5 \|\| Requests a check if a user is a digital minor. \|\| Yes \|\| No \|\|
	\|-		\|-
	\| core_auth \|\| core_auth_request_password_reset \|\| 3.4 \|\| Requests a password reset. \|\| Yes \|\| No \|\|		\| core_auth \|\| core_auth_request_password_reset \|\| 3.4 \|\| Requests a password reset. \|\| Yes \|\| No \|\|

2018-12-13T10:48:34Z

Core web service functions: Updates with 3.5 and 3.6