MDL-67264 core_course: Begin set up for Activity chooser
[moodle.git] / webservice / upgrade.txt
CommitLineData
106c55fb
DW
1This files describes API changes in /webservice/*
2information provided here is intended especially for developers.
3
4This information is intended for authors of webservices, not people writing webservice clients.
5
6a1ad7c6
MN
6=== 3.8 ===
7
8* Ajax calls can now specify a cache key. This allows for better caching capabilities on servers. If a cache key
9 is passed and the web service call does not require the user to be logged in we will attempt to use GET for the
10 request. This allows for things like proxy caching on URLs. The cache key must be changed if we do not want to
11 retrieve what has been cached and want to perform the request again.
cd43240d
JL
12* External function core_webservice_external::get_site_info() now returns the user private access key "userprivateaccesskey".
13 This key could be used for fetching files via the tokenpluginfile.php script instead webservice/pluginfile.php to avoid
14 multiple GET requests that include the WS token as a visible parameter.
20570e5d
JL
15* External function core_webservice_external::get_site_info() now returns a new field "userissiteadmin" indicating if
16 the current user is a site administrator.
6a1ad7c6 17
355c37b8
JL
18=== 3.7 ===
19
20* External function core_webservice_external::get_site_info() now returns the current site theme (for the user).
21
bef5777f
JL
22=== 3.4 ===
23
24* External function core_webservice_external::get_site_info() now returns the calendar type used in the site and
25 by the user in the sitecalendartype and usercalendartype fields.
2c1080ef
MG
26* Implementations of forms for test clients now must follow naming schema: WSFUNCTIONNAME_testclient_form
27 The old naming schema WSFUNCTIONNAME_form caused conflicts with existing classes.
28 New class webservice_test_client_base_form can be used as a base class for such forms.
bef5777f 29
89823b1a
JL
30=== 3.2 ===
31
32* webservice->get_external_functions now returns the external function list ordered by name ASC.
ff092320
JL
33* The filearea optional parameter has been removed from webservice/upload.php.
34 Since Moodle 3.1 all the uploads go to the draft area.
af8b948e 35* external_format_text() function: component, filearea and itemid are now optional parameters.
833be5e4
JL
36 In some contexts those parameteres are not necessary because is not required to do a file rewrite via
37 file_rewrite_pluginfile_urls.
43695b6a 38* External function get_site_info now returns the site course ID. This new field is marked as VALUE_OPTIONAL for backwards compatibility.
69cbe359
JL
39* A new field "privatetoken" has been added to the "external_tokens" table.
40 This private token must be safely stored (or not stored at all) by the client because it will be used in places where a request
41 must be double-checked.
42 This token should not be passed via GET paramaters and it must be transmitted only via https.
43 This token is generated only in login/token.php after the user credential has been confirmed. It can't be generated by admins.
89823b1a 44
638f751a
JP
45=== 3.1 ===
46
633e2643
DP
47* The xmlrpc backend has changed, Zend_XmlRpc has been dropped and there might be slight differences in
48 responses. Fault strings that were generated by Zend_XmlRpc_XXX_Exception exceptions (i.e. 'Method
49 "[methodname]" does not exist') are no longer used which may display a different error message depending
50 on the string returned by the getMessage() method of the thrown exception.
8e2707b9 51* The xmlrpc server is no longer enabled when the Mobile service is activated.
13ae7db2 52* Support for the AMF protocol has been dropped completely.
b5e6ec44 53* As Zend Framework has been removed, the webservice_zend_* classes have also been removed.
f23e9b6b
CB
54* Zend_SOAP has been dropped. The native PHP SoapClient and SoapServer classes are now being used instead. WSDL is now
55 generated by the new class webservice_soap_wsdl. For fault strings, a different error message might be shown depending
56 on the string returned by the getMessage() method of the thrown exception.
57* With Zend_SOAP dropped, moodle_zend_soap_server is now also deprecated.
58* As mentioned in the 2.9 notes, deprecated web service functions have now been removed.
ad1bfe6a
CB
59* Since our new XML-RPC server implementation does not support introspection, it is critical that all clients send
60 parameters in the correct order.
ff092320
JL
61* File uploading to the user private file area via the webservice/upload.php script is not supported anymore.
62 Only uploads to the draft area are allowed.
13ae7db2 63
6ee188b1
DM
64=== 3.0 ===
65
66* WS protocols webservice/myprotocol:use capabilities were defined with a high riskbitmask value
67 when the fact that a user has that capability does not imply any risk, but other capabilities
68 that the user may have do. If your ws protocol does not imply and risk by itself, you can remove the
69 riskbitmask from your $capabilities array in webservice/myprotocol/db/access.php
9748791b
JL
70* New function for formatting external strings: external_format_strings, it should be used as a replacement of format_string in
71 external functions.
72 All the occurrences of format_strings have been replaced with this new function.
6ee188b1 73
3c1aa6fd
DM
74=== 2.9 ===
75
76* The deprecated functions can not be added to services anymore and
77 a debugging message for developers is triggered when viewing an existing
78 services using them. It is recommended to replace calls to the deprecated
79 functions for calls to the proposed replacements. If you are using a moodle
80 mobile app fork, it is recommended to update your customisations on top of
81 the latest moodle mobile app version.
82
83 The web services functions that will be finally deprecated in the next
84 moodle version are:
85 - moodle_course_create_courses
86 - moodle_course_get_courses
87 - moodle_enrol_get_enrolled_users
88 - moodle_enrol_get_users_courses
89 - moodle_enrol_manual_enrol_users
90 - moodle_file_get_files
91 - moodle_file_upload
92 - moodle_group_add_groupmembers
93 - moodle_group_create_groups
94 - moodle_group_delete_groupmembers
95 - moodle_group_delete_groups
96 - moodle_group_get_course_groups
97 - moodle_group_get_groupmembers
98 - moodle_group_get_groups
99 - moodle_message_send_instantmessages
100 - moodle_notes_create_notes
101 - moodle_role_assign
102 - moodle_role_unassign
103 - moodle_user_create_users
104 - moodle_user_delete_users
105 - moodle_user_get_course_participants_by_id
106 - moodle_user_get_users_by_courseid
107 - moodle_user_get_users_by_id
108 - moodle_user_update_users
109 - core_grade_get_definitions
110 - core_user_get_users_by_id
111 - moodle_webservice_get_siteinfo
112
6d28e2cf
JL
113* External function core_webservice_external::get_site_info now returns additional optional fields:
114 - advancedfeatures: Array listing Moodle advanced features and if enabled or not.
115 - usercanmanageownfiles: Whether the my files option is disabled.
116 - userquota: User storage quota.
117 - usermaxuploadfilesize: Files upload size limit.
118
3c1aa6fd 119
e5d48aad
120=== 2.7 ===
121
122* All webservice server.php and simpleserver.php scripts must define('WS_SERVER', true)
123 before including config.php file.
124
125
106c55fb
DW
126=== 2.6 ===
127
128* webservice/upload.php
129Accepts 2 new post parameters to allow uploading of files to a users draft area.
130 - filearea should be either 'private' (default) or 'draft'
131 - itemid unused if the filearea is 'private', for 'draft' it can be the id of a previously
132 created draft area - or 0 which will generate a new draft area for the files.
133