Merge branch 'MDL-54671-master' of git://github.com/danpoltawski/moodle
[moodle.git] / webservice / upgrade.txt
1 This files describes API changes in /webservice/*
2 information provided here is intended especially for developers.
4 This information is intended for authors of webservices, not people writing webservice clients.
6 === 3.2 ===
8 * webservice->get_external_functions now returns the external function list ordered by name ASC.
9 * The filearea optional parameter has been removed from webservice/upload.php.
10   Since Moodle 3.1 all the uploads go to the draft area.
12 === 3.1 ===
14 * The xmlrpc backend has changed, Zend_XmlRpc has been dropped and there might be slight differences in
15   responses. Fault strings that were generated by Zend_XmlRpc_XXX_Exception exceptions (i.e. 'Method
16   "[methodname]" does not exist') are no longer used which may display a different error message depending
17   on the string returned by the getMessage() method of the thrown exception.
18 * The xmlrpc server is no longer enabled when the Mobile service is activated.
19 * Support for the AMF protocol has been dropped completely.
20 * As Zend Framework has been removed, the webservice_zend_* classes have also been removed.
21 * Zend_SOAP has been dropped. The native PHP SoapClient and SoapServer classes are now being used instead. WSDL is now
22   generated by the new class webservice_soap_wsdl. For fault strings, a different error message might be shown depending
23   on the string returned by the getMessage() method of the thrown exception.
24 * With Zend_SOAP dropped, moodle_zend_soap_server is now also deprecated.
25 * As mentioned in the 2.9 notes, deprecated web service functions have now been removed.
26 * Since our new XML-RPC server implementation does not support introspection, it is critical that all clients send
27   parameters in the correct order.
28 * File uploading to the user private file area via the webservice/upload.php script is not supported anymore.
29   Only uploads to the draft area are allowed.
31 === 3.0 ===
33 * WS protocols webservice/myprotocol:use capabilities were defined with a high riskbitmask value
34   when the fact that a user has that capability does not imply any risk, but other capabilities
35   that the user may have do. If your ws protocol does not imply and risk by itself, you can remove the
36   riskbitmask from your $capabilities array in webservice/myprotocol/db/access.php
37 * New function for formatting external strings: external_format_strings, it should be used as a replacement of format_string in
38   external functions.
39   All the occurrences of format_strings have been replaced with this new function.
41 === 2.9 ===
43 * The deprecated functions can not be added to services anymore and
44   a debugging message for developers is triggered when viewing an existing
45   services using them. It is recommended to replace calls to the deprecated
46   functions for calls to the proposed replacements. If you are using a moodle
47   mobile app fork, it is recommended to update your customisations on top of
48   the latest moodle mobile app version.
50   The web services functions that will be finally deprecated in the next
51   moodle version are:
52     - moodle_course_create_courses
53     - moodle_course_get_courses
54     - moodle_enrol_get_enrolled_users
55     - moodle_enrol_get_users_courses
56     - moodle_enrol_manual_enrol_users
57     - moodle_file_get_files
58     - moodle_file_upload
59     - moodle_group_add_groupmembers
60     - moodle_group_create_groups
61     - moodle_group_delete_groupmembers
62     - moodle_group_delete_groups
63     - moodle_group_get_course_groups
64     - moodle_group_get_groupmembers
65     - moodle_group_get_groups
66     - moodle_message_send_instantmessages
67     - moodle_notes_create_notes
68     - moodle_role_assign
69     - moodle_role_unassign
70     - moodle_user_create_users
71     - moodle_user_delete_users
72     - moodle_user_get_course_participants_by_id
73     - moodle_user_get_users_by_courseid
74     - moodle_user_get_users_by_id
75     - moodle_user_update_users
76     - core_grade_get_definitions
77     - core_user_get_users_by_id
78     - moodle_webservice_get_siteinfo
80 * External function core_webservice_external::get_site_info now returns additional optional fields:
81    - advancedfeatures: Array listing Moodle advanced features and if enabled or not.
82    - usercanmanageownfiles: Whether the my files option is disabled.
83    - userquota: User storage quota.
84    - usermaxuploadfilesize: Files upload size limit.
87 === 2.7 ===
89 * All webservice server.php and simpleserver.php scripts must define('WS_SERVER', true)
90   before including config.php file.
93 === 2.6 ===
95 * webservice/upload.php
96 Accepts 2 new post parameters to allow uploading of files to a users draft area.
97  - filearea should be either 'private' (default) or 'draft'
98  - itemid unused if the filearea is 'private', for 'draft' it can be the id of a previously
99    created draft area - or 0 which will generate a new draft area for the files.