Web services FAQ - Revision history

Mits: ja link

2013-12-03T22:14:07Z

ja link

← Older revision		Revision as of 22:14, 3 December 2013
Line 78:		Line 78:
	[[Category:MNet]]		[[Category:MNet]]
	[[Category:FAQ]]		[[Category:FAQ]]

			[[ja:ウェブサービスFAQ]]

Tsala: edits copied from 21 docs

2011-11-30T10:28:07Z

edits copied from 21 docs

← Older revision		Revision as of 10:28, 30 November 2011
Line 66:		Line 66:
	* password expired (most likely happens with external authentication like LDAP)		* password expired (most likely happens with external authentication like LDAP)
	* web service disabled (Administration > Advanced features)		* web service disabled (Administration > Advanced features)
			* user doesn't have the capability to use the used web service protocol (user should have the capability 'webservice/use:xmlrpc'/'webservice/use:rest'/..., on SYSTEM context).
			* the user token doesn't exist
			* the web service function is not included in the service

	Since Moodle 2.2, if the administrator turns Moodle debug mode >= NORMAL, then a explicit error message will be returned.		Since Moodle 2.2, if the administrator turns Moodle debug mode >= NORMAL, then an explicit error message will be returned.

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

Jmouneyrac at 02:36, 29 November 2011

2011-11-29T02:36:27Z

@@ Line 50: / Line 50: @@
 == How to get a user token from an external application? ==
 you can generate and retrieve user tokens with the /login/token.php file => [[:dev:Creating_a_web_service_client#How_to_get_a_user_token|How to get a user token]]
 ==See also==

Jmouneyrac: /* How to get a user token from an external application? */

2011-11-23T05:46:25Z

How to get a user token from an external application?

← Older revision		Revision as of 05:46, 23 November 2011
Line 49:		Line 49:

	== How to get a user token from an external application? ==		== How to get a user token from an external application? ==
	~~In Moodle 2.2~~ you can generate and retrieve user tokens with the /login/token.php file => [[:dev:Creating_a_web_service_client#How_to_get_a_user_token\|How to get a user token]]		you can generate and retrieve user tokens with the /login/token.php file => [[:dev:Creating_a_web_service_client#How_to_get_a_user_token\|How to get a user token]]

	~~The condition being that the service need a shortname. At the moment a service can have a shortname if you:~~
	* create the service as a built-in service (in db/services.php files)
	* add the shortname manually in the DB. Note: we'll add the admin UI for shortname later (MDL-30229)

	~~Just for the info, the file login/token.php exists since 2.1 but for this Moodle version it can only generate token for the mobile service.~~

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

Jmouneyrac at 05:44, 23 November 2011

2011-11-23T05:44:42Z

← Older revision		Revision as of 05:44, 23 November 2011
Line 47:		Line 47:

	Unfortunately the generated WSDL isn't currently compatible with JAVA or .NET. See MDL-28988 and MDL-28989 for plans to create a JAVA-compatible SOAP WSDL.		Unfortunately the generated WSDL isn't currently compatible with JAVA or .NET. See MDL-28988 and MDL-28989 for plans to create a JAVA-compatible SOAP WSDL.

			== How to get a user token from an external application? ==
			In Moodle 2.2 you can generate and retrieve user tokens with the /login/token.php file => [[:dev:Creating_a_web_service_client#How_to_get_a_user_token\|How to get a user token]]

			The condition being that the service need a shortname. At the moment a service can have a shortname if you:
			* create the service as a built-in service (in db/services.php files)
			* add the shortname manually in the DB. Note: we'll add the admin UI for shortname later (MDL-30229)

			Just for the info, the file login/token.php exists since 2.1 but for this Moodle version it can only generate token for the mobile service.

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

Tsala: changes copied from 2.0 wiki

2011-11-09T12:49:37Z

changes copied from 2.0 wiki

← Older revision		Revision as of 12:49, 9 November 2011
Line 18:		Line 18:
	Since different Moodle sites can extend or restrict the API, and the API will evolve over time, the best way to see the exact API for a particular Moodle site is to look at the automatically generated documentation.		Since different Moodle sites can extend or restrict the API, and the API will evolve over time, the best way to see the exact API for a particular Moodle site is to look at the automatically generated documentation.

	# enable web service, create a service and add ~~all existing~~ Moodle functions to it. ~~You can get help from this~~ [~~https://docs.moodle.org/en/How_to_enable_web_services_for_ordinary_users guide~~].		'''Full API documentation'''
	# connect as non admin, and access the service documentation on your [~~https://docs.moodle.org/en/~~How_to_get_a_security_key security page].		# Connect as admin
	~~# for security purpose, you can delete the created service now~~.		# Go to Administration Settings block > Plugins > Web services > API documentation

			'''Specific documentation to a user'''
			# Connect as admin, enable web service, create a service and add some Moodle functions to it. Also see [[How_to_create_and_enable_a_web_service]].
			# connect as non admin, and access the service documentation on your [[How_to_get_a_security_key\|security keys page]].

	== Why are there not many functions in the API? ==		== Why are there not many functions in the API? ==
Line 26:		Line 30:
	We have been very careful when adding new functions because we don't want to be changing the API functions once they are implemented. The ones we have in Moodle 2.0 are the most commonly requested ones (for users, courses, groups and enrolments).		We have been very careful when adding new functions because we don't want to be changing the API functions once they are implemented. The ones we have in Moodle 2.0 are the most commonly requested ones (for users, courses, groups and enrolments).

	We will add more functions to core over time, based on contributions from the community and feature requests. See the ~~Moodle tracker for~~ [~~https~~:~~//docs.moodle.org/~~dev/Web_services_Roadmap a roadmap ~~of future web services~~]. ~~Please contribute with suggestions, votes and code!~~		We will add more functions to core over time, based on contributions from the community and feature requests. See the [[:dev:Web_services_Roadmap\|web service roadmap]].

	You can also extend the API on your own Moodle site by creating your own API functions (see next question).		You can also extend the API on your own Moodle site by creating your own API functions (see next question).
Line 32:		Line 36:
	== How can I create a new web service function? ==		== How can I create a new web service function? ==

	The easiest and recommended way to add a web service is to write a new Moodle local plugin and to implement the web service functions there. The Moodle administrator will just need to add the plugin in Moodle (copy the files in /local/), the web service functions will be automatically added. Please read /local/readme.txt for more information about plugin development. ~~You can also look at the~~ [~~http~~:~~//moodle.org/mod/data/view.php?d=13&rid=4282 Moodle Hub server plugin~~] ~~as an example~~.		The easiest and recommended way to add a web service is to write a new Moodle local plugin and to implement the web service functions there. The Moodle administrator will just need to add the plugin in Moodle (copy the files in /local/), the web service functions will be automatically added. Please read /local/readme.txt for more information about plugin development. Finally read [[:dev:Creating_a_web_service_and_a_web_service_function\|how to implement a web service and a web service function]].

	== How can I set up a web service? ==		== How can I set up a web service? ==

	* See the ~~documents in the~~ [[~~:Category:Web Services~~]].		* See the document [[How_to_create_and_enable_a_web_service\| How to create and enable a web service]].
	* In ''Settings > Site administration > Plugins > Web services > Overview'' two use cases ~~are described~~.		* ''Settings > Site administration > Plugins > Web services > Overview'' explains two use cases.
	* Finally ~~you can go~~ ask ~~question~~ on the [http://moodle.org/mod/forum/view.php?id=6971 Web Services forum]		* Finally ask questions on the [http://moodle.org/mod/forum/view.php?id=6971 Web Services forum]

	== Does the Moodle SOAP server work with JAVA or .NET? ==		== Does the Moodle SOAP server work with JAVA or .NET? ==

	Unfortunately the generated WSDL isn't currently compatible with JAVA or .NET. See MDL-~~20804~~ for plans to create a JAVA-compatible SOAP WSDL ~~and JAVA client~~.		Unfortunately the generated WSDL isn't currently compatible with JAVA or .NET. See MDL-28988 and MDL-28989 for plans to create a JAVA-compatible SOAP WSDL.

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

Jmouneyrac: /* Why are there not many functions in the API? */

2011-11-01T09:17:22Z

Why are there not many functions in the API?

← Older revision		Revision as of 09:17, 1 November 2011
Line 26:		Line 26:
	We have been very careful when adding new functions because we don't want to be changing the API functions once they are implemented. The ones we have in Moodle 2.0 are the most commonly requested ones (for users, courses, groups and enrolments).		We have been very careful when adding new functions because we don't want to be changing the API functions once they are implemented. The ones we have in Moodle 2.0 are the most commonly requested ones (for users, courses, groups and enrolments).

	We will add more functions to core over time, based on contributions from the community and feature requests. See the Moodle tracker for [~~http~~://~~tracker~~.moodle.org/~~secure~~/~~IssueNavigator.jspa?reset=true&&type=4&type=2&pid=10011&resolution=-1&status=1&status=3&component=10425&sorter/field=priority&sorter/order=DESC~~ a ~~rough~~ roadmap of future web services]. Please contribute with suggestions, votes and code!		We will add more functions to core over time, based on contributions from the community and feature requests. See the Moodle tracker for [https://docs.moodle.org/dev/Web_services_Roadmap a roadmap of future web services]. Please contribute with suggestions, votes and code!

	You can also extend the API on your own Moodle site by creating your own API functions (see next question).		You can also extend the API on your own Moodle site by creating your own API functions (see next question).

Tsala: web services template, small edits

2011-10-31T18:06:24Z

web services template, small edits

← Older revision		Revision as of 18:06, 31 October 2011
Line 1:		Line 1:
			{{Web services}}
	This document lists some popular questions from the [http://moodle.org/mod/forum/view.php?id=6971 Web Services forum].		This document lists some popular questions from the [http://moodle.org/mod/forum/view.php?id=6971 Web Services forum].

	== What is the difference between web services and ~~Mnet~~ ==		== What is the difference between web services and MNet ==

	* Mnet is used to authenticate some users from a Moodle A site into a Moodle B site.		[[MNet]] is used to authenticate some users from a Moodle A site into a Moodle B site.
	* Web services are functions that can be called by external applications (via SOAP, XML-RPC, REST or AMF).
			Web services are functions that can be called by external applications (via SOAP, XML-RPC, REST or AMF).

	== I see the term "Web services" used in different ways, what does it mean? ==		== I see the term "Web services" used in different ways, what does it mean? ==
Line 34:		Line 36:
	== How can I set up a web service? ==		== How can I set up a web service? ==

	* See the documents in the [~~https~~:~~//docs.moodle.org/en/~~Category:~~Web_Services web service category~~].		* See the documents in the [[:Category:Web Services]].
	* In ~~Moodle~~ > Site administration > ~~plugins~~ > Web services > Overview, two use cases are described.		* In ''Settings > Site administration > Plugins > Web services > Overview'' two use cases are described.
	* Finally you can go ask question on the [http://moodle.org/mod/forum/view.php?id=6971 Web Services forum]		* Finally you can go ask question on the [http://moodle.org/mod/forum/view.php?id=6971 Web Services forum]

Line 42:		Line 44:
	Unfortunately the generated WSDL isn't currently compatible with JAVA or .NET. See MDL-20804 for plans to create a JAVA-compatible SOAP WSDL and JAVA client.		Unfortunately the generated WSDL isn't currently compatible with JAVA or .NET. See MDL-20804 for plans to create a JAVA-compatible SOAP WSDL and JAVA client.

	[~~[Category~~:Web Services]]		==See also==

			* Using Moodle [http://moodle.org/mod/forum/view.php?id=6971 Web Services forum]

	[[Category:MNet]]		[[Category:MNet]]
	[[Category:FAQ]]		[[Category:FAQ]]

Tsala: removing 2.0 template

2011-10-25T13:37:26Z

removing 2.0 template

← Older revision		Revision as of 13:37, 25 October 2011
Line 1:		Line 1:
	~~{{Moodle_2.0}}~~This document lists some popular questions from the [http://moodle.org/mod/forum/view.php?id=6971 Web Services forum].		This document lists some popular questions from the [http://moodle.org/mod/forum/view.php?id=6971 Web Services forum].

	== What is the difference between web services and Mnet ==		== What is the difference between web services and Mnet ==
Line 5:		Line 5:
	* Mnet is used to authenticate some users from a Moodle A site into a Moodle B site.		* Mnet is used to authenticate some users from a Moodle A site into a Moodle B site.
	* Web services are functions that can be called by external applications (via SOAP, XML-RPC, REST or AMF).		* Web services are functions that can be called by external applications (via SOAP, XML-RPC, REST or AMF).


	== I see the term "Web services" used in different ways, what does it mean? ==		== I see the term "Web services" used in different ways, what does it mean? ==
Line 12:		Line 11:
	# A particular action (like creating a user) is known as a Web service '''function'''.		# A particular action (like creating a user) is known as a Web service '''function'''.
	# The admin can enable groups of these functions for outside use, and these are known as a "Web service".		# The admin can enable groups of these functions for outside use, and these are known as a "Web service".


	== Where is the Web Service API documented? ==		== Where is the Web Service API documented? ==

Tsala: /* Does Moodle SOAP server work with JAVA/.NET? */ rewording

2010-12-20T10:05:05Z

Does Moodle SOAP server work with JAVA/.NET?: rewording

← Older revision		Revision as of 10:05, 20 December 2010
Line 40:		Line 40:
	* Finally you can go ask question on the [http://moodle.org/mod/forum/view.php?id=6971 Web Services forum]		* Finally you can go ask question on the [http://moodle.org/mod/forum/view.php?id=6971 Web Services forum]

	== Does Moodle SOAP server work with JAVA/.NET? ==		== Does the Moodle SOAP server work with JAVA or .NET? ==

	Unfortunately~~, at the moment,~~ the generated WSDL isn't compatible with JAVA/.NET. ~~Help us contributing to or following the related tracker issue:~~ MDL-20804.		Unfortunately the generated WSDL isn't currently compatible with JAVA or .NET. See MDL-20804 for plans to create a JAVA-compatible SOAP WSDL and JAVA client.

	[[Category:Web Services]]		[[Category:Web Services]]
	[[Category:MNet]]		[[Category:MNet]]
	[[Category:FAQ]]		[[Category:FAQ]]