MDL-51564 webservice: Review the use of external format_string
[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.0 ===
8 * New function for formatting external strings: external_format_strings, it should be used as a replacement of format_string in
9   external functions.
10   All the occurrences of format_strings have been replaced with this new function.
13 === 2.9 ===
15 * The deprecated functions can not be added to services anymore and
16   a debugging message for developers is triggered when viewing an existing
17   services using them. It is recommended to replace calls to the deprecated
18   functions for calls to the proposed replacements. If you are using a moodle
19   mobile app fork, it is recommended to update your customisations on top of
20   the latest moodle mobile app version.
22   The web services functions that will be finally deprecated in the next
23   moodle version are:
24     - moodle_course_create_courses
25     - moodle_course_get_courses
26     - moodle_enrol_get_enrolled_users
27     - moodle_enrol_get_users_courses
28     - moodle_enrol_manual_enrol_users
29     - moodle_file_get_files
30     - moodle_file_upload
31     - moodle_group_add_groupmembers
32     - moodle_group_create_groups
33     - moodle_group_delete_groupmembers
34     - moodle_group_delete_groups
35     - moodle_group_get_course_groups
36     - moodle_group_get_groupmembers
37     - moodle_group_get_groups
38     - moodle_message_send_instantmessages
39     - moodle_notes_create_notes
40     - moodle_role_assign
41     - moodle_role_unassign
42     - moodle_user_create_users
43     - moodle_user_delete_users
44     - moodle_user_get_course_participants_by_id
45     - moodle_user_get_users_by_courseid
46     - moodle_user_get_users_by_id
47     - moodle_user_update_users
48     - core_grade_get_definitions
49     - core_user_get_users_by_id
50     - moodle_webservice_get_siteinfo
52 * External function core_webservice_external::get_site_info now returns additional optional fields:
53    - advancedfeatures: Array listing Moodle advanced features and if enabled or not.
54    - usercanmanageownfiles: Whether the my files option is disabled.
55    - userquota: User storage quota.
56    - usermaxuploadfilesize: Files upload size limit.
59 === 2.7 ===
61 * All webservice server.php and simpleserver.php scripts must define('WS_SERVER', true)
62   before including config.php file.
65 === 2.6 ===
67 * webservice/upload.php
68 Accepts 2 new post parameters to allow uploading of files to a users draft area.
69  - filearea should be either 'private' (default) or 'draft'
70  - itemid unused if the filearea is 'private', for 'draft' it can be the id of a previously
71    created draft area - or 0 which will generate a new draft area for the files.