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