on-demand release 3.1dev+
[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
638f751a
JP
6=== 3.1 ===
7
633e2643
DP
8* The xmlrpc backend has changed, Zend_XmlRpc has been dropped and there might be slight differences in
9 responses. Fault strings that were generated by Zend_XmlRpc_XXX_Exception exceptions (i.e. 'Method
10 "[methodname]" does not exist') are no longer used which may display a different error message depending
11 on the string returned by the getMessage() method of the thrown exception.
8e2707b9 12* The xmlrpc server is no longer enabled when the Mobile service is activated.
13ae7db2 13* Support for the AMF protocol has been dropped completely.
b5e6ec44 14* As Zend Framework has been removed, the webservice_zend_* classes have also been removed.
13ae7db2 15
6ee188b1
DM
16=== 3.0 ===
17
18* WS protocols webservice/myprotocol:use capabilities were defined with a high riskbitmask value
19 when the fact that a user has that capability does not imply any risk, but other capabilities
20 that the user may have do. If your ws protocol does not imply and risk by itself, you can remove the
21 riskbitmask from your $capabilities array in webservice/myprotocol/db/access.php
9748791b
JL
22* New function for formatting external strings: external_format_strings, it should be used as a replacement of format_string in
23 external functions.
24 All the occurrences of format_strings have been replaced with this new function.
6ee188b1 25
3c1aa6fd
DM
26=== 2.9 ===
27
28* The deprecated functions can not be added to services anymore and
29 a debugging message for developers is triggered when viewing an existing
30 services using them. It is recommended to replace calls to the deprecated
31 functions for calls to the proposed replacements. If you are using a moodle
32 mobile app fork, it is recommended to update your customisations on top of
33 the latest moodle mobile app version.
34
35 The web services functions that will be finally deprecated in the next
36 moodle version are:
37 - moodle_course_create_courses
38 - moodle_course_get_courses
39 - moodle_enrol_get_enrolled_users
40 - moodle_enrol_get_users_courses
41 - moodle_enrol_manual_enrol_users
42 - moodle_file_get_files
43 - moodle_file_upload
44 - moodle_group_add_groupmembers
45 - moodle_group_create_groups
46 - moodle_group_delete_groupmembers
47 - moodle_group_delete_groups
48 - moodle_group_get_course_groups
49 - moodle_group_get_groupmembers
50 - moodle_group_get_groups
51 - moodle_message_send_instantmessages
52 - moodle_notes_create_notes
53 - moodle_role_assign
54 - moodle_role_unassign
55 - moodle_user_create_users
56 - moodle_user_delete_users
57 - moodle_user_get_course_participants_by_id
58 - moodle_user_get_users_by_courseid
59 - moodle_user_get_users_by_id
60 - moodle_user_update_users
61 - core_grade_get_definitions
62 - core_user_get_users_by_id
63 - moodle_webservice_get_siteinfo
64
6d28e2cf
JL
65* External function core_webservice_external::get_site_info now returns additional optional fields:
66 - advancedfeatures: Array listing Moodle advanced features and if enabled or not.
67 - usercanmanageownfiles: Whether the my files option is disabled.
68 - userquota: User storage quota.
69 - usermaxuploadfilesize: Files upload size limit.
70
3c1aa6fd 71
e5d48aad
72=== 2.7 ===
73
74* All webservice server.php and simpleserver.php scripts must define('WS_SERVER', true)
75 before including config.php file.
76
77
106c55fb
DW
78=== 2.6 ===
79
80* webservice/upload.php
81Accepts 2 new post parameters to allow uploading of files to a users draft area.
82 - filearea should be either 'private' (default) or 'draft'
83 - itemid unused if the filearea is 'private', for 'draft' it can be the id of a previously
84 created draft area - or 0 which will generate a new draft area for the files.
85