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