webservice/upgrade.txt

   1 This files describes API changes in /webservice/*
   2 information provided here is intended especially for developers.
   3
   4 This information is intended for authors of webservices, not people writing webservice clients.
   5
   6 === 4.0 ===
   7
   8 * User access related exceptions have been changed to use the moodle_exception class instead of the generic webservice_access_exception,
   9   the main reason for this change is to allow clients to implement some code logic against an access error.
  10
  11 === 3.11 ===
  12
  13 * The method webservice::get_user_capabilities() is deprecated now without a replacement. It has been used
  14   internally only to populate the list of missing capabilities. That functionality has been improved so that
  15   it no longer needs this standalone method.
  16
  17 === 3.10 ===
  18
  19 * The class externallib_advanced_testcase, used in unit tests, has a new function called "configure_filters" to easily configure filters for external functions testing.
  20
  21 === 3.8 ===
  22
  23 * Ajax calls can now specify a cache key. This allows for better caching capabilities on servers. If a cache key
  24   is passed and the web service call does not require the user to be logged in we will attempt to use GET for the
  25   request. This allows for things like proxy caching on URLs. The cache key must be changed if we do not want to
  26   retrieve what has been cached and want to perform the request again.
  27 * External function core_webservice_external::get_site_info() now returns the user private access key "userprivateaccesskey".
  28   This key could be used for fetching files via the tokenpluginfile.php script instead webservice/pluginfile.php to avoid
  29   multiple GET requests that include the WS token as a visible parameter.
  30 * External function core_webservice_external::get_site_info() now returns a new field "userissiteadmin" indicating if
  31   the current user is a site administrator.
  32
  33 === 3.7 ===
  34
  35 * External function core_webservice_external::get_site_info() now returns the current site theme (for the user).
  36
  37 === 3.4 ===
  38
  39 * External function core_webservice_external::get_site_info() now returns the calendar type used in the site and
  40   by the user in the sitecalendartype and usercalendartype fields.
  41 * Implementations of forms for test clients now must follow naming schema: WSFUNCTIONNAME_testclient_form
  42   The old naming schema WSFUNCTIONNAME_form caused conflicts with existing classes.
  43   New class webservice_test_client_base_form can be used as a base class for such forms.
  44
  45 === 3.2 ===
  46
  47 * webservice->get_external_functions now returns the external function list ordered by name ASC.
  48 * The filearea optional parameter has been removed from webservice/upload.php.
  49   Since Moodle 3.1 all the uploads go to the draft area.
  50 * external_format_text() function: component, filearea and itemid are now optional parameters.
  51   In some contexts those parameteres are not necessary because is not required to do a file rewrite via
  52   file_rewrite_pluginfile_urls.
  53 * External function get_site_info now returns the site course ID. This new field is marked as VALUE_OPTIONAL for backwards compatibility.
  54 * A new field "privatetoken" has been added to the "external_tokens" table.
  55   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
  56   must be double-checked.
  57   This token should not be passed via GET paramaters and it must be transmitted only via https.
  58   This token is generated only in login/token.php after the user credential has been confirmed. It can't be generated by admins.
  59
  60 === 3.1 ===
  61
  62 * The xmlrpc backend has changed, Zend_XmlRpc has been dropped and there might be slight differences in
  63   responses. Fault strings that were generated by Zend_XmlRpc_XXX_Exception exceptions (i.e. 'Method
  64   "[methodname]" does not exist') are no longer used which may display a different error message depending
  65   on the string returned by the getMessage() method of the thrown exception.
  66 * The xmlrpc server is no longer enabled when the Mobile service is activated.
  67 * Support for the AMF protocol has been dropped completely.
  68 * As Zend Framework has been removed, the webservice_zend_* classes have also been removed.
  69 * Zend_SOAP has been dropped. The native PHP SoapClient and SoapServer classes are now being used instead. WSDL is now
  70   generated by the new class webservice_soap_wsdl. For fault strings, a different error message might be shown depending
  71   on the string returned by the getMessage() method of the thrown exception.
  72 * With Zend_SOAP dropped, moodle_zend_soap_server is now also deprecated.
  73 * As mentioned in the 2.9 notes, deprecated web service functions have now been removed.
  74 * Since our new XML-RPC server implementation does not support introspection, it is critical that all clients send
  75   parameters in the correct order.
  76 * File uploading to the user private file area via the webservice/upload.php script is not supported anymore.
  77   Only uploads to the draft area are allowed.
  78
  79 === 3.0 ===
  80
  81 * WS protocols webservice/myprotocol:use capabilities were defined with a high riskbitmask value
  82   when the fact that a user has that capability does not imply any risk, but other capabilities
  83   that the user may have do. If your ws protocol does not imply and risk by itself, you can remove the
  84   riskbitmask from your $capabilities array in webservice/myprotocol/db/access.php
  85 * New function for formatting external strings: external_format_strings, it should be used as a replacement of format_string in
  86   external functions.
  87   All the occurrences of format_strings have been replaced with this new function.
  88
  89 === 2.9 ===
  90
  91 * The deprecated functions can not be added to services anymore and
  92   a debugging message for developers is triggered when viewing an existing
  93   services using them. It is recommended to replace calls to the deprecated
  94   functions for calls to the proposed replacements. If you are using a moodle
  95   mobile app fork, it is recommended to update your customisations on top of
  96   the latest moodle mobile app version.
  97
  98   The web services functions that will be finally deprecated in the next
  99   moodle version are:
 100     - moodle_course_create_courses
 101     - moodle_course_get_courses
 102     - moodle_enrol_get_enrolled_users
 103     - moodle_enrol_get_users_courses
 104     - moodle_enrol_manual_enrol_users
 105     - moodle_file_get_files
 106     - moodle_file_upload
 107     - moodle_group_add_groupmembers
 108     - moodle_group_create_groups
 109     - moodle_group_delete_groupmembers
 110     - moodle_group_delete_groups
 111     - moodle_group_get_course_groups
 112     - moodle_group_get_groupmembers
 113     - moodle_group_get_groups
 114     - moodle_message_send_instantmessages
 115     - moodle_notes_create_notes
 116     - moodle_role_assign
 117     - moodle_role_unassign
 118     - moodle_user_create_users
 119     - moodle_user_delete_users
 120     - moodle_user_get_course_participants_by_id
 121     - moodle_user_get_users_by_courseid
 122     - moodle_user_get_users_by_id
 123     - moodle_user_update_users
 124     - core_grade_get_definitions
 125     - core_user_get_users_by_id
 126     - moodle_webservice_get_siteinfo
 127
 128 * External function core_webservice_external::get_site_info now returns additional optional fields:
 129    - advancedfeatures: Array listing Moodle advanced features and if enabled or not.
 130    - usercanmanageownfiles: Whether the my files option is disabled.
 131    - userquota: User storage quota.
 132    - usermaxuploadfilesize: Files upload size limit.
 133
 134
 135 === 2.7 ===
 136
 137 * All webservice server.php and simpleserver.php scripts must define('WS_SERVER', true)
 138   before including config.php file.
 139
 140
 141 === 2.6 ===
 142
 143 * webservice/upload.php
 144 Accepts 2 new post parameters to allow uploading of files to a users draft area.
 145  - filearea should be either 'private' (default) or 'draft'
 146  - itemid unused if the filearea is 'private', for 'draft' it can be the id of a previously
 147    created draft area - or 0 which will generate a new draft area for the files.
 148