[Summary view] [Print] [Text view]

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