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