Merge branch 'MDL-69649-master' of git://github.com/rezaies/moodle
[moodle.git] / lib / db / services.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Core external functions and service definitions.
20  *
21  * The functions and services defined on this file are
22  * processed and registered into the Moodle DB after any
23  * install or upgrade operation. All plugins support this.
24  *
25  * For more information, take a look to the documentation available:
26  *     - Webservices API: {@link http://docs.moodle.org/dev/Web_services_API}
27  *     - External API: {@link http://docs.moodle.org/dev/External_functions_API}
28  *     - Upgrade API: {@link http://docs.moodle.org/dev/Upgrade_API}
29  *
30  * @package    core_webservice
31  * @category   webservice
32  * @copyright  2009 Petr Skodak
33  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34  */
36 $functions = array(
37     'core_auth_confirm_user' => array(
38         'classname'   => 'core_auth_external',
39         'methodname'  => 'confirm_user',
40         'description' => 'Confirm a user account.',
41         'type'        => 'write',
42         'ajax'          => true,
43         'loginrequired' => false,
44     ),
45     'core_auth_request_password_reset' => array(
46         'classname'   => 'core_auth_external',
47         'methodname'  => 'request_password_reset',
48         'description' => 'Requests a password reset.',
49         'type'        => 'write',
50         'ajax'          => true,
51         'loginrequired' => false,
52     ),
53     'core_auth_is_minor' => array(
54         'classname'   => 'core_auth_external',
55         'methodname'  => 'is_minor',
56         'description' => 'Requests a check if a user is a digital minor.',
57         'type'        => 'read',
58         'ajax'          => true,
59         'loginrequired' => false,
60     ),
61     'core_auth_is_age_digital_consent_verification_enabled' => array(
62         'classname'   => 'core_auth_external',
63         'methodname'  => 'is_age_digital_consent_verification_enabled',
64         'description' => 'Checks if age digital consent verification is enabled.',
65         'type'        => 'read',
66         'ajax'          => true,
67         'loginrequired' => false,
68     ),
69     'core_auth_resend_confirmation_email' => array(
70         'classname'   => 'core_auth_external',
71         'methodname'  => 'resend_confirmation_email',
72         'description' => 'Resend confirmation email.',
73         'type'        => 'write',
74         'ajax'          => true,
75         'loginrequired' => false,
76     ),
77     'core_backup_get_async_backup_progress' => array(
78         'classname'   => 'core_backup_external',
79         'classpath' => 'backup/externallib.php',
80         'methodname'  => 'get_async_backup_progress',
81         'description' => 'Get the progress of an Asyncronhous backup.',
82         'type'        => 'read',
83         'ajax'          => true,
84         'loginrequired' => true,
85     ),
86     'core_backup_get_async_backup_links_backup' => array(
87         'classname'   => 'core_backup_external',
88         'classpath' => 'backup/externallib.php',
89         'methodname'  => 'get_async_backup_links_backup',
90         'description' => 'Gets the data to use when updating the status table row in the UI for when an async backup completes.',
91         'type'        => 'read',
92         'ajax'          => true,
93         'loginrequired' => true,
94    ),
95    'core_backup_get_async_backup_links_restore' => array(
96         'classname'   => 'core_backup_external',
97         'classpath' => 'backup/externallib.php',
98         'methodname'  => 'get_async_backup_links_restore',
99         'description' => 'Gets the data to use when updating the status table row in the UI for when an async restore completes.',
100         'type'        => 'read',
101         'ajax'          => true,
102         'loginrequired' => true,
103     ),
104     'core_backup_get_copy_progress' => array(
105         'classname'   => 'core_backup_external',
106         'classpath' => 'backup/externallib.php',
107         'methodname'  => 'get_copy_progress',
108         'description' => 'Gets the progress of course copy operations.',
109         'type'        => 'read',
110         'ajax'          => true,
111         'loginrequired' => true,
112     ),
113     'core_backup_submit_copy_form' => array(
114         'classname'   => 'core_backup_external',
115         'classpath' => 'backup/externallib.php',
116         'methodname'  => 'submit_copy_form',
117         'description' => 'Handles ajax submission of course copy form.',
118         'type'        => 'read',
119         'ajax'          => true,
120         'loginrequired' => true,
121     ),
122     'core_badges_get_user_badges' => array(
123         'classname'     => 'core_badges_external',
124         'methodname'    => 'get_user_badges',
125         'description'   => 'Returns the list of badges awarded to a user.',
126         'type'          => 'read',
127         'capabilities'  => 'moodle/badges:viewotherbadges',
128         'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
129     ),
130     'core_blog_get_entries' => array(
131         'classname'   => 'core_blog\external',
132         'methodname'  => 'get_entries',
133         'description' => 'Returns blog entries.',
134         'type'        => 'read',
135         'services'    => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
136         'ajax'          => true,
137         'loginrequired' => false,
138     ),
139     'core_blog_view_entries' => array(
140         'classname'   => 'core_blog\external',
141         'methodname'  => 'view_entries',
142         'description' => 'Trigger the blog_entries_viewed event.',
143         'type'        => 'read',
144         'services'    => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
145         'ajax'          => true,
146         'loginrequired' => false,
147     ),
148     'core_calendar_get_calendar_monthly_view' => array(
149         'classname' => 'core_calendar_external',
150         'methodname' => 'get_calendar_monthly_view',
151         'description' => 'Fetch the monthly view data for a calendar',
152         'classpath' => 'calendar/externallib.php',
153         'type' => 'read',
154         'capabilities' => '',
155         'ajax' => true,
156         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
157     ),
158     'core_calendar_get_calendar_day_view' => array(
159         'classname' => 'core_calendar_external',
160         'methodname' => 'get_calendar_day_view',
161         'description' => 'Fetch the day view data for a calendar',
162         'classpath' => 'calendar/externallib.php',
163         'type' => 'read',
164         'capabilities' => '',
165         'ajax' => true,
166         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
167     ),
168     'core_calendar_get_calendar_upcoming_view' => array(
169         'classname' => 'core_calendar_external',
170         'methodname' => 'get_calendar_upcoming_view',
171         'description' => 'Fetch the upcoming view data for a calendar',
172         'classpath' => 'calendar/externallib.php',
173         'type' => 'read',
174         'capabilities' => '',
175         'ajax' => true,
176         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
177     ),
178     'core_calendar_update_event_start_day' => array(
179         'classname' => 'core_calendar_external',
180         'methodname' => 'update_event_start_day',
181         'description' => 'Update the start day (but not time) for an event.',
182         'classpath' => 'calendar/externallib.php',
183         'type' => 'write',
184         'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries',
185         'ajax' => true,
186         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
187     ),
188     'core_calendar_create_calendar_events' => array(
189         'classname' => 'core_calendar_external',
190         'methodname' => 'create_calendar_events',
191         'description' => 'Create calendar events',
192         'classpath' => 'calendar/externallib.php',
193         'type' => 'write',
194         'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries',
195         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
196     ),
197     'core_calendar_delete_calendar_events' => array(
198         'classname' => 'core_calendar_external',
199         'methodname' => 'delete_calendar_events',
200         'description' => 'Delete calendar events',
201         'classpath' => 'calendar/externallib.php',
202         'type' => 'write',
203         'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries',
204         'ajax' => true,
205         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
206     ),
207     'core_calendar_get_calendar_events' => array(
208         'classname' => 'core_calendar_external',
209         'methodname' => 'get_calendar_events',
210         'description' => 'Get calendar events',
211         'classpath' => 'calendar/externallib.php',
212         'type' => 'read',
213         'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries',
214         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
215     ),
216     'core_calendar_get_action_events_by_timesort' => array(
217         'classname' => 'core_calendar_external',
218         'methodname' => 'get_calendar_action_events_by_timesort',
219         'description' => 'Get calendar action events by tiemsort',
220         'classpath' => 'calendar/externallib.php',
221         'type' => 'read',
222         'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries',
223         'ajax' => true,
224         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
225     ),
226     'core_calendar_get_action_events_by_course' => array(
227         'classname' => 'core_calendar_external',
228         'methodname' => 'get_calendar_action_events_by_course',
229         'description' => 'Get calendar action events by course',
230         'classpath' => 'calendar/externallib.php',
231         'type' => 'read',
232         'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries',
233         'ajax' => true,
234         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
235     ),
236     'core_calendar_get_action_events_by_courses' => array(
237         'classname' => 'core_calendar_external',
238         'methodname' => 'get_calendar_action_events_by_courses',
239         'description' => 'Get calendar action events by courses',
240         'classpath' => 'calendar/externallib.php',
241         'type' => 'read',
242         'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries',
243         'ajax' => true,
244         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
245     ),
246     'core_calendar_get_calendar_event_by_id' => array(
247         'classname' => 'core_calendar_external',
248         'methodname' => 'get_calendar_event_by_id',
249         'description' => 'Get calendar event by id',
250         'classpath' => 'calendar/externallib.php',
251         'type' => 'read',
252         'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries',
253         'ajax' => true,
254         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
255     ),
256     'core_calendar_submit_create_update_form' => array(
257         'classname' => 'core_calendar_external',
258         'methodname' => 'submit_create_update_form',
259         'description' => 'Submit form data for event form',
260         'classpath' => 'calendar/externallib.php',
261         'type' => 'write',
262         'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries',
263         'ajax' => true,
264         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
265     ),
266     'core_calendar_get_calendar_access_information' => array(
267         'classname' => 'core_calendar_external',
268         'methodname' => 'get_calendar_access_information',
269         'description' => 'Convenience function to retrieve some permissions/access information for the given course calendar.',
270         'classpath' => 'calendar/externallib.php',
271         'type' => 'read',
272         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
273     ),
274     'core_calendar_get_allowed_event_types' => array(
275         'classname' => 'core_calendar_external',
276         'methodname' => 'get_allowed_event_types',
277         'description' => 'Get the type of events a user can create in the given course.',
278         'classpath' => 'calendar/externallib.php',
279         'type' => 'read',
280         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
281     ),
282     'core_calendar_get_timestamps' => [
283         'classname'     => 'core_calendar_external',
284         'methodname'    => 'get_timestamps',
285         'description'   => 'Fetch unix timestamps for given date times.',
286         'classpath' => 'calendar/externallib.php',
287         'type'          => 'read',
288         'ajax'          => true,
289     ],
290     'core_calendar_get_calendar_export_token' => [
291         'classname'     => 'core_calendar\external\export\token',
292         'methodname'    => 'execute',
293         'description'   => 'Return the auth token required for exporting a calendar.',
294         'type'          => 'read',
295         'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
296     ],
297     'core_cohort_add_cohort_members' => array(
298         'classname' => 'core_cohort_external',
299         'methodname' => 'add_cohort_members',
300         'classpath' => 'cohort/externallib.php',
301         'description' => 'Adds cohort members.',
302         'type' => 'write',
303         'capabilities' => 'moodle/cohort:assign'
304     ),
305     'core_cohort_create_cohorts' => array(
306         'classname' => 'core_cohort_external',
307         'methodname' => 'create_cohorts',
308         'classpath' => 'cohort/externallib.php',
309         'description' => 'Creates new cohorts.',
310         'type' => 'write',
311         'capabilities' => 'moodle/cohort:manage'
312     ),
313     'core_cohort_delete_cohort_members' => array(
314         'classname' => 'core_cohort_external',
315         'methodname' => 'delete_cohort_members',
316         'classpath' => 'cohort/externallib.php',
317         'description' => 'Deletes cohort members.',
318         'type' => 'write',
319         'capabilities' => 'moodle/cohort:assign'
320     ),
321     'core_cohort_delete_cohorts' => array(
322         'classname' => 'core_cohort_external',
323         'methodname' => 'delete_cohorts',
324         'classpath' => 'cohort/externallib.php',
325         'description' => 'Deletes all specified cohorts.',
326         'type' => 'write',
327         'capabilities' => 'moodle/cohort:manage'
328     ),
329     'core_cohort_get_cohort_members' => array(
330         'classname' => 'core_cohort_external',
331         'methodname' => 'get_cohort_members',
332         'classpath' => 'cohort/externallib.php',
333         'description' => 'Returns cohort members.',
334         'type' => 'read',
335         'capabilities' => 'moodle/cohort:view'
336     ),
337     'core_cohort_search_cohorts' => array(
338         'classname' => 'core_cohort_external',
339         'methodname' => 'search_cohorts',
340         'classpath' => 'cohort/externallib.php',
341         'description' => 'Search for cohorts.',
342         'type' => 'read',
343         'ajax' => true,
344         'capabilities' => 'moodle/cohort:view'
345     ),
346     'core_cohort_get_cohorts' => array(
347         'classname' => 'core_cohort_external',
348         'methodname' => 'get_cohorts',
349         'classpath' => 'cohort/externallib.php',
350         'description' => 'Returns cohort details.',
351         'type' => 'read',
352         'capabilities' => 'moodle/cohort:view'
353     ),
354     'core_cohort_update_cohorts' => array(
355         'classname' => 'core_cohort_external',
356         'methodname' => 'update_cohorts',
357         'classpath' => 'cohort/externallib.php',
358         'description' => 'Updates existing cohorts.',
359         'type' => 'write',
360         'capabilities' => 'moodle/cohort:manage'
361     ),
362     'core_comment_get_comments' => array(
363         'classname' => 'core_comment_external',
364         'methodname' => 'get_comments',
365         'description' => 'Returns comments.',
366         'type' => 'read',
367         'capabilities' => 'moodle/comment:view',
368         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
369     ),
370     'core_comment_add_comments' => array(
371         'classname' => 'core_comment_external',
372         'methodname' => 'add_comments',
373         'description' => 'Adds a comment or comments.',
374         'type' => 'write',
375         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
376     ),
377     'core_comment_delete_comments' => array(
378         'classname' => 'core_comment_external',
379         'methodname' => 'delete_comments',
380         'description' => 'Deletes a comment or comments.',
381         'type' => 'write',
382         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
383     ),
384     'core_completion_get_activities_completion_status' => array(
385         'classname' => 'core_completion_external',
386         'methodname' => 'get_activities_completion_status',
387         'description' => 'Return the activities completion status for a user in a course.',
388         'type' => 'read',
389         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
390     ),
391     'core_completion_get_course_completion_status' => array(
392         'classname' => 'core_completion_external',
393         'methodname' => 'get_course_completion_status',
394         'description' => 'Returns course completion status.',
395         'type' => 'read',
396         'capabilities' => 'report/completion:view',
397         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
398     ),
399     'core_completion_mark_course_self_completed' => array(
400         'classname' => 'core_completion_external',
401         'methodname' => 'mark_course_self_completed',
402         'description' => 'Update the course completion status for the current user (if course self-completion is enabled).',
403         'type' => 'write',
404         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
405     ),
406     'core_completion_update_activity_completion_status_manually' => array(
407         'classname' => 'core_completion_external',
408         'methodname' => 'update_activity_completion_status_manually',
409         'description' => 'Update completion status for the current user in an activity, only for activities with manual tracking.',
410         'type' => 'write',
411         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
412     ),
413     'core_completion_override_activity_completion_status' => array(
414         'classname'     => 'core_completion_external',
415         'methodname'    => 'override_activity_completion_status',
416         'description'   => 'Update completion status for a user in an activity by overriding it.',
417         'type'          => 'write',
418         'capabilities'  => 'moodle/course:overridecompletion',
419         'ajax'          => true,
420     ),
421     'core_course_create_categories' => array(
422         'classname' => 'core_course_external',
423         'methodname' => 'create_categories',
424         'classpath' => 'course/externallib.php',
425         'description' => 'Create course categories',
426         'type' => 'write',
427         'capabilities' => 'moodle/category:manage'
428     ),
429     'core_course_create_courses' => array(
430         'classname' => 'core_course_external',
431         'methodname' => 'create_courses',
432         'classpath' => 'course/externallib.php',
433         'description' => 'Create new courses',
434         'type' => 'write',
435         'capabilities' => 'moodle/course:create, moodle/course:visibility'
436     ),
437     'core_course_delete_categories' => array(
438         'classname' => 'core_course_external',
439         'methodname' => 'delete_categories',
440         'classpath' => 'course/externallib.php',
441         'description' => 'Delete course categories',
442         'type' => 'write',
443         'capabilities' => 'moodle/category:manage'
444     ),
445     'core_course_delete_courses' => array(
446         'classname' => 'core_course_external',
447         'methodname' => 'delete_courses',
448         'classpath' => 'course/externallib.php',
449         'description' => 'Deletes all specified courses',
450         'type' => 'write',
451         'capabilities' => 'moodle/course:delete'
452     ),
453     'core_course_delete_modules' => array(
454         'classname' => 'core_course_external',
455         'methodname' => 'delete_modules',
456         'classpath' => 'course/externallib.php',
457         'description' => 'Deletes all specified module instances',
458         'type' => 'write',
459         'capabilities' => 'moodle/course:manageactivities'
460     ),
461     'core_course_duplicate_course' => array(
462         'classname' => 'core_course_external',
463         'methodname' => 'duplicate_course',
464         'classpath' => 'course/externallib.php',
465         'description' => 'Duplicate an existing course (creating a new one).',
466         'type' => 'write',
467         'capabilities' => 'moodle/backup:backupcourse, moodle/restore:restorecourse, moodle/course:create'
468     ),
469     'core_course_get_categories' => array(
470         'classname' => 'core_course_external',
471         'methodname' => 'get_categories',
472         'classpath' => 'course/externallib.php',
473         'description' => 'Return category details',
474         'type' => 'read',
475         'capabilities' => 'moodle/category:viewhiddencategories',
476         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
477     ),
478     'core_course_get_contents' => array(
479         'classname' => 'core_course_external',
480         'methodname' => 'get_course_contents',
481         'classpath' => 'course/externallib.php',
482         'description' => 'Get course contents',
483         'type' => 'read',
484         'capabilities' => 'moodle/course:update, moodle/course:viewhiddencourses',
485         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
486     ),
487     'core_course_get_course_module' => array(
488         'classname' => 'core_course_external',
489         'methodname' => 'get_course_module',
490         'classpath' => 'course/externallib.php',
491         'description' => 'Return information about a course module',
492         'type' => 'read',
493         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
494     ),
495     'core_course_get_course_module_by_instance' => array(
496         'classname' => 'core_course_external',
497         'methodname' => 'get_course_module_by_instance',
498         'classpath' => 'course/externallib.php',
499         'description' => 'Return information about a given module name and instance id',
500         'type' => 'read',
501         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
502     ),
503     'core_course_get_module' => array(
504         'classname'   => 'core_course_external',
505         'methodname'  => 'get_module',
506         'classpath'   => 'course/externallib.php',
507         'description' => 'Returns html with one activity module on course page',
508         'type'        => 'read',
509         'ajax'        => true,
510     ),
511     'core_course_edit_module' => array(
512         'classname'   => 'core_course_external',
513         'methodname'  => 'edit_module',
514         'classpath'   => 'course/externallib.php',
515         'description' => 'Performs an action on course module (change visibility, duplicate, delete, etc.)',
516         'type'        => 'write',
517         'ajax'        => true,
518     ),
519     'core_course_edit_section' => array(
520         'classname'   => 'core_course_external',
521         'methodname'  => 'edit_section',
522         'classpath'   => 'course/externallib.php',
523         'description' => 'Performs an action on course section (change visibility, set marker, delete)',
524         'type'        => 'write',
525         'ajax'        => true,
526     ),
527     'core_course_get_courses' => array(
528         'classname' => 'core_course_external',
529         'methodname' => 'get_courses',
530         'classpath' => 'course/externallib.php',
531         'description' => 'Return course details',
532         'type' => 'read',
533         'capabilities' => 'moodle/course:view, moodle/course:update, moodle/course:viewhiddencourses',
534         'ajax' => true,
535         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
536     ),
537     'core_course_import_course' => array(
538         'classname' => 'core_course_external',
539         'methodname' => 'import_course',
540         'classpath' => 'course/externallib.php',
541         'description' => 'Import course data from a course into another course. Does not include any user data.',
542         'type' => 'write',
543         'capabilities' => 'moodle/backup:backuptargetimport, moodle/restore:restoretargetimport'
544     ),
545     'core_course_search_courses' => array(
546         'classname' => 'core_course_external',
547         'methodname' => 'search_courses',
548         'classpath' => 'course/externallib.php',
549         'description' => 'Search courses by (name, module, block, tag)',
550         'type' => 'read',
551         'ajax' => true,
552         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
553     ),
554     'core_course_update_categories' => array(
555         'classname' => 'core_course_external',
556         'methodname' => 'update_categories',
557         'classpath' => 'course/externallib.php',
558         'description' => 'Update categories',
559         'type' => 'write',
560         'capabilities' => 'moodle/category:manage',
561     ),
562     'core_course_update_courses' => array(
563         'classname' => 'core_course_external',
564         'methodname' => 'update_courses',
565         'classpath' => 'course/externallib.php',
566         'description' => 'Update courses',
567         'type' => 'write',
568         'capabilities' => 'moodle/course:update, moodle/course:changecategory, moodle/course:changefullname, '
569             . 'moodle/course:changeshortname, moodle/course:changeidnumber, moodle/course:changesummary, moodle/course:visibility'
570     ),
571     'core_course_view_course' => array(
572         'classname' => 'core_course_external',
573         'methodname' => 'view_course',
574         'classpath' => 'course/externallib.php',
575         'description' => 'Log that the course was viewed',
576         'type' => 'write',
577         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
578     ),
579     'core_course_get_user_navigation_options' => array(
580         'classname' => 'core_course_external',
581         'methodname' => 'get_user_navigation_options',
582         'classpath' => 'course/externallib.php',
583         'description' => 'Return a list of navigation options in a set of courses that are avaialable or not for the current user.',
584         'type' => 'read',
585         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
586     ),
587     'core_course_get_user_administration_options' => array(
588         'classname' => 'core_course_external',
589         'methodname' => 'get_user_administration_options',
590         'classpath' => 'course/externallib.php',
591         'description' => 'Return a list of administration options in a set of courses that are avaialable or not for the current
592                             user.',
593         'type' => 'read',
594         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
595     ),
596     'core_course_get_courses_by_field' => array(
597         'classname' => 'core_course_external',
598         'methodname' => 'get_courses_by_field',
599         'classpath' => 'course/externallib.php',
600         'description' => 'Get courses matching a specific field (id/s, shortname, idnumber, category)',
601         'type' => 'read',
602         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
603     ),
604     'core_course_check_updates' => array(
605         'classname' => 'core_course_external',
606         'methodname' => 'check_updates',
607         'classpath' => 'course/externallib.php',
608         'description' => 'Check if there is updates affecting the user for the given course and contexts.',
609         'type' => 'read',
610         'ajax' => true,
611         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
612     ),
613     'core_course_get_updates_since' => array(
614         'classname' => 'core_course_external',
615         'methodname' => 'get_updates_since',
616         'classpath' => 'course/externallib.php',
617         'description' => 'Check if there are updates affecting the user for the given course since the given time stamp.',
618         'type' => 'read',
619         'ajax' => true,
620         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
621     ),
622     'core_course_get_enrolled_courses_by_timeline_classification' => array(
623         'classname' => 'core_course_external',
624         'methodname' => 'get_enrolled_courses_by_timeline_classification',
625         'classpath' => 'course/externallib.php',
626         'description' => 'List of enrolled courses for the given timeline classification (past, inprogress, or future).',
627         'type' => 'read',
628         'ajax' => true,
629         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
630     ),
631     'core_course_get_recent_courses' => array(
632         'classname' => 'core_course_external',
633         'methodname' => 'get_recent_courses',
634         'classpath' => 'course/externallib.php',
635         'description' => 'List of courses a user has accessed most recently.',
636         'type' => 'read',
637         'ajax' => true,
638         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
639     ),
640     'core_course_set_favourite_courses' => array(
641         'classname' => 'core_course_external',
642         'methodname' => 'set_favourite_courses',
643         'classpath' => 'course/externallib.php',
644         'description' => 'Add a list of courses to the list of favourite courses.',
645         'type' => 'read',
646         'ajax' => true,
647         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
648     ),
649     'core_course_get_enrolled_users_by_cmid' => array(
650         'classname' => 'core_course_external',
651         'methodname' => 'get_enrolled_users_by_cmid',
652         'classpath' => 'course/externallib.php',
653         'description' => 'List users by course module id & filter by group id.',
654         'type' => 'read',
655         'ajax' => true,
656     ),
657     'core_course_add_content_item_to_user_favourites' => array(
658         'classname' => 'core_course_external',
659         'methodname' => 'add_content_item_to_user_favourites',
660         'classpath' => 'course/externallib.php',
661         'description' => 'Adds a content item (activity, resource or their subtypes) to the favourites for the user.',
662         'type' => 'write',
663         'ajax' => true,
664     ),
665     'core_course_remove_content_item_from_user_favourites' => array(
666         'classname' => 'core_course_external',
667         'methodname' => 'remove_content_item_from_user_favourites',
668         'classpath' => 'course/externallib.php',
669         'description' => 'Removes a content item (activity, resource or their subtypes) from the favourites for the user.',
670         'type' => 'write',
671         'ajax' => true,
672     ),
673     'core_course_get_course_content_items' => array(
674         'classname' => 'core_course_external',
675         'methodname' => 'get_course_content_items',
676         'classpath' => 'course/externallib.php',
677         'description' => 'Fetch all the content items (activities, resources and their subtypes) for the activity picker',
678         'type' => 'read',
679         'ajax' => true,
680     ),
681     'core_course_get_activity_chooser_footer' => array(
682         'classname' => 'core_course_external',
683         'methodname' => 'get_activity_chooser_footer',
684         'classpath' => 'course/externallib.php',
685         'description' => 'Fetch the data for the activity chooser footer.',
686         'type' => 'read',
687         'ajax' => true,
688     ),
689     'core_course_toggle_activity_recommendation' => array(
690         'classname' => 'core_course_external',
691         'methodname' => 'toggle_activity_recommendation',
692         'classpath' => 'course/externallib.php',
693         'description' => 'Adds or removes an activity as a recommendation in the activity chooser.',
694         'type' => 'write',
695         'ajax' => true,
696     ),
697     'core_enrol_get_course_enrolment_methods' => array(
698         'classname' => 'core_enrol_external',
699         'methodname' => 'get_course_enrolment_methods',
700         'classpath' => 'enrol/externallib.php',
701         'description' => 'Get the list of course enrolment methods',
702         'type' => 'read',
703         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
704     ),
705     'core_enrol_get_enrolled_users' => array(
706         'classname' => 'core_enrol_external',
707         'methodname' => 'get_enrolled_users',
708         'classpath' => 'enrol/externallib.php',
709         'description' => 'Get enrolled users by course id.',
710         'type' => 'read',
711         'capabilities' => 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update, '
712             . 'moodle/site:accessallgroups',
713         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
714     ),
715     'core_enrol_get_enrolled_users_with_capability' => array(
716         'classname' => 'core_enrol_external',
717         'methodname' => 'get_enrolled_users_with_capability',
718         'classpath' => 'enrol/externallib.php',
719         'description' => 'For each course and capability specified, return a list of the users that are enrolled in the course
720                                   and have that capability',
721         'type' => 'read',
722     ),
723     'core_enrol_get_potential_users' => array(
724         'classname' => 'core_enrol_external',
725         'methodname' => 'get_potential_users',
726         'classpath' => 'enrol/externallib.php',
727         'description' => 'Get the list of potential users to enrol',
728         'ajax' => true,
729         'type' => 'read',
730         'capabilities' => 'moodle/course:enrolreview'
731     ),
732     'core_enrol_search_users' => [
733         'classname' => 'core_enrol_external',
734         'methodname' => 'search_users',
735         'classpath' => 'enrol/externallib.php',
736         'description' => 'Search within the list of course participants',
737         'ajax' => true,
738         'type' => 'read',
739         'capabilities' => 'moodle/course:viewparticipants',
740         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
741     ],
742     'core_enrol_get_users_courses' => array(
743         'classname' => 'core_enrol_external',
744         'methodname' => 'get_users_courses',
745         'classpath' => 'enrol/externallib.php',
746         'description' => 'Get the list of courses where a user is enrolled in',
747         'type' => 'read',
748         'capabilities' => 'moodle/course:viewparticipants',
749         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
750     ),
751     'core_enrol_edit_user_enrolment' => array(
752         'classname' => 'core_enrol_external',
753         'methodname' => 'edit_user_enrolment',
754         'classpath' => 'enrol/externallib.php',
755         'description' => '** DEPRECATED ** Please do not call this function any more.
756                           External function that updates a given user enrolment',
757         'type' => 'write',
758         'ajax' => true,
759     ),
760     'core_enrol_submit_user_enrolment_form' => array(
761         'classname' => 'core_enrol_external',
762         'methodname' => 'submit_user_enrolment_form',
763         'classpath' => 'enrol/externallib.php',
764         'description' => 'Submit form data for enrolment form',
765         'type' => 'write',
766         'ajax' => true,
767     ),
768     'core_enrol_unenrol_user_enrolment' => array(
769         'classname' => 'core_enrol_external',
770         'methodname' => 'unenrol_user_enrolment',
771         'classpath' => 'enrol/externallib.php',
772         'description' => 'External function that unenrols a given user enrolment',
773         'type' => 'write',
774         'ajax' => true,
775     ),
776     'core_fetch_notifications' => array(
777         'classname' => 'core_external',
778         'methodname' => 'fetch_notifications',
779         'classpath' => 'lib/external/externallib.php',
780         'description' => 'Return a list of notifications for the current session',
781         'type' => 'read',
782         'loginrequired' => false,
783         'ajax' => true,
784         'readonlysession' => false, // Fetching removes from stack.
785     ),
786     'core_session_touch' => array(
787         'classname' => 'core\session\external',
788         'methodname' => 'touch_session',
789         'description' => 'Keep the users session alive',
790         'type' => 'read',
791         'loginrequired' => true,
792         'ajax' => true,
793     ),
794     'core_session_time_remaining' => array(
795         'classname' => 'core\session\external',
796         'methodname' => 'time_remaining',
797         'description' => 'Count the seconds remaining in this session',
798         'type' => 'read',
799         'loginrequired' => true,
800         'ajax' => true,
801     ),
802     'core_files_get_files' => array(
803         'classname' => 'core_files_external',
804         'methodname' => 'get_files',
805         'description' => 'browse moodle files',
806         'type' => 'read',
807         'classpath' => 'files/externallib.php',
808         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
809     ),
810     'core_files_upload' => array(
811         'classname' => 'core_files_external',
812         'methodname' => 'upload',
813         'description' => 'upload a file to moodle',
814         'type'        => 'write',
815         'classpath'   => 'files/externallib.php',
816     ),
817     'core_form_get_filetypes_browser_data' => array(
818         'classname' => 'core_form\external',
819         'methodname' => 'get_filetypes_browser_data',
820         'classpath' => '',
821         'description' => 'Provides data for the filetypes element browser.',
822         'type' => 'read',
823         'loginrequired' => false,
824         'ajax' => true,
825     ),
826     'core_get_component_strings' => array(
827         'classname' => 'core_external',
828         'methodname' => 'get_component_strings',
829         'classpath' => 'lib/external/externallib.php',
830         'description' => 'Return all raw strings (with {$a->xxx}), for a specific component ' .
831             '- similar to core get_component_strings(), call',
832         'type' => 'read',
833         'loginrequired' => false,
834         'ajax' => true,
835         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
836     ),
837     'core_get_fragment' => array(
838         'classname' => 'core_external',
839         'methodname' => 'get_fragment',
840         'classpath' => 'lib/external/externallib.php',
841         'description' => 'Return a fragment for inclusion, such as a JavaScript page.',
842         'type' => 'read',
843         'ajax' => true,
844     ),
845     'core_get_string' => array(
846         'classname' => 'core_external',
847         'methodname' => 'get_string',
848         'classpath' => 'lib/external/externallib.php',
849         'description' => 'Return a translated string - similar to core get_string(), call',
850         'type' => 'read',
851         'loginrequired' => false,
852         'ajax' => true,
853     ),
854     'core_get_strings' => array(
855         'classname' => 'core_external',
856         'methodname' => 'get_strings',
857         'classpath' => 'lib/external/externallib.php',
858         'description' => 'Return some translated strings - like several core get_string(), calls',
859         'type' => 'read',
860         'loginrequired' => false,
861         'ajax' => true,
862     ),
863     'core_get_user_dates' => array(
864         'classname' => 'core_external',
865         'methodname' => 'get_user_dates',
866         'classpath' => 'lib/external/externallib.php',
867         'description' => 'Return formatted timestamps',
868         'type' => 'read',
869         'ajax' => true,
870     ),
871     'core_grades_get_grades' => array(
872         'classname' => 'core_grades_external',
873         'methodname' => 'get_grades',
874         'description' => '** DEPRECATED ** Please do not call this function any more.
875                                      Returns student course total grade and grades for activities.
876                                      This function does not return category or manual items.
877                                      This function is suitable for managers or teachers not students.',
878         'type' => 'read',
879         'capabilities' => 'moodle/grade:view, moodle/grade:viewall, moodle/grade:viewhidden'
880     ),
881     'core_grades_update_grades' => array(
882         'classname' => 'core_grades_external',
883         'methodname' => 'update_grades',
884         'description' => 'Update a grade item and associated student grades.',
885         'type' => 'write',
886     ),
887     'core_grades_grader_gradingpanel_point_fetch' => [
888         'classname' => 'core_grades\\grades\\grader\\gradingpanel\\point\\external\\fetch',
889         'methodname' => 'execute',
890         'description' => 'Fetch the data required to display the grader grading panel for simple grading, ' .
891             'creating the grade item if required',
892         'type' => 'write',
893         'ajax' => true,
894         'services' => [MOODLE_OFFICIAL_MOBILE_SERVICE],
895     ],
896     'core_grades_grader_gradingpanel_point_store' => [
897         'classname' => 'core_grades\\grades\\grader\\gradingpanel\\point\\external\\store',
898         'methodname' => 'execute',
899         'description' => 'Store the data required to display the grader grading panel for simple grading',
900         'type' => 'write',
901         'ajax' => true,
902         'services' => [MOODLE_OFFICIAL_MOBILE_SERVICE],
903     ],
904     'core_grades_grader_gradingpanel_scale_fetch' => [
905         'classname' => 'core_grades\\grades\\grader\\gradingpanel\\scale\\external\\fetch',
906         'methodname' => 'execute',
907         'description' => 'Fetch the data required to display the grader grading panel for scale-based grading, ' .
908             'creating the grade item if required',
909         'type' => 'write',
910         'ajax' => true,
911         'services' => [MOODLE_OFFICIAL_MOBILE_SERVICE],
912     ],
913     'core_grades_grader_gradingpanel_scale_store' => [
914         'classname' => 'core_grades\\grades\\grader\\gradingpanel\\scale\\external\\store',
915         'methodname' => 'execute',
916         'description' => 'Store the data required to display the grader grading panel for scale-based grading',
917         'type' => 'write',
918         'ajax' => true,
919         'services' => [MOODLE_OFFICIAL_MOBILE_SERVICE],
920     ],
921     'core_grades_create_gradecategory' => array (
922         'classname' => 'core_grades_external',
923         'methodname' => 'create_gradecategory',
924         'description' => 'Create a grade category inside a course gradebook.',
925         'type' => 'write',
926         'capabilities' => 'moodle/grade:manage',
927     ),
928     'core_grading_get_definitions' => array(
929         'classname' => 'core_grading_external',
930         'methodname' => 'get_definitions',
931         'description' => 'Get grading definitions',
932         'type' => 'read',
933     ),
934     'core_grading_get_gradingform_instances' => array(
935         'classname' => 'core_grading_external',
936         'methodname' => 'get_gradingform_instances',
937         'description' => 'Get grading form instances',
938         'type' => 'read',
939     ),
940     'core_grading_save_definitions' => array(
941         'classname' => 'core_grading_external',
942         'methodname' => 'save_definitions',
943         'description' => 'Save grading definitions',
944         'type' => 'write',
945     ),
946     'core_group_add_group_members' => array(
947         'classname' => 'core_group_external',
948         'methodname' => 'add_group_members',
949         'classpath' => 'group/externallib.php',
950         'description' => 'Adds group members.',
951         'type' => 'write',
952         'capabilities' => 'moodle/course:managegroups',
953     ),
954     'core_group_assign_grouping' => array(
955         'classname' => 'core_group_external',
956         'methodname' => 'assign_grouping',
957         'classpath' => 'group/externallib.php',
958         'description' => 'Assing groups from groupings',
959         'type' => 'write',
960     ),
961     'core_group_create_groupings' => array(
962         'classname' => 'core_group_external',
963         'methodname' => 'create_groupings',
964         'classpath' => 'group/externallib.php',
965         'description' => 'Creates new groupings',
966         'type' => 'write',
967     ),
968     'core_group_create_groups' => array(
969         'classname' => 'core_group_external',
970         'methodname' => 'create_groups',
971         'classpath' => 'group/externallib.php',
972         'description' => 'Creates new groups.',
973         'type' => 'write',
974         'capabilities' => 'moodle/course:managegroups'
975     ),
976     'core_group_delete_group_members' => array(
977         'classname' => 'core_group_external',
978         'methodname' => 'delete_group_members',
979         'classpath' => 'group/externallib.php',
980         'description' => 'Deletes group members.',
981         'type' => 'write',
982         'capabilities' => 'moodle/course:managegroups'
983     ),
984     'core_group_delete_groupings' => array(
985         'classname' => 'core_group_external',
986         'methodname' => 'delete_groupings',
987         'classpath' => 'group/externallib.php',
988         'description' => 'Deletes all specified groupings.',
989         'type' => 'write',
990     ),
991     'core_group_delete_groups' => array(
992         'classname' => 'core_group_external',
993         'methodname' => 'delete_groups',
994         'classpath' => 'group/externallib.php',
995         'description' => 'Deletes all specified groups.',
996         'type' => 'write',
997         'capabilities' => 'moodle/course:managegroups'
998     ),
999     'core_group_get_activity_allowed_groups' => array(
1000         'classname' => 'core_group_external',
1001         'methodname' => 'get_activity_allowed_groups',
1002         'classpath' => 'group/externallib.php',
1003         'description' => 'Gets a list of groups that the user is allowed to access within the specified activity.',
1004         'type' => 'read',
1005         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1006     ),
1007     'core_group_get_activity_groupmode' => array(
1008         'classname' => 'core_group_external',
1009         'methodname' => 'get_activity_groupmode',
1010         'classpath' => 'group/externallib.php',
1011         'description' => 'Returns effective groupmode used in a given activity.',
1012         'type' => 'read',
1013         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1014     ),
1015     'core_group_get_course_groupings' => array(
1016         'classname' => 'core_group_external',
1017         'methodname' => 'get_course_groupings',
1018         'classpath' => 'group/externallib.php',
1019         'description' => 'Returns all groupings in specified course.',
1020         'type' => 'read',
1021         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1022     ),
1023     'core_group_get_course_groups' => array(
1024         'classname' => 'core_group_external',
1025         'methodname' => 'get_course_groups',
1026         'classpath' => 'group/externallib.php',
1027         'description' => 'Returns all groups in specified course.',
1028         'type' => 'read',
1029         'ajax' => true,
1030         'capabilities' => 'moodle/course:managegroups',
1031         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1032     ),
1033     'core_group_get_course_user_groups' => array(
1034         'classname' => 'core_group_external',
1035         'methodname' => 'get_course_user_groups',
1036         'classpath' => 'group/externallib.php',
1037         'description' => 'Returns all groups in specified course for the specified user.',
1038         'type' => 'read',
1039         'capabilities' => 'moodle/course:managegroups',
1040         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1041     ),
1042     'core_group_get_group_members' => array(
1043         'classname' => 'core_group_external',
1044         'methodname' => 'get_group_members',
1045         'classpath' => 'group/externallib.php',
1046         'description' => 'Returns group members.',
1047         'type' => 'read',
1048         'capabilities' => 'moodle/course:managegroups'
1049     ),
1050     'core_group_get_groupings' => array(
1051         'classname' => 'core_group_external',
1052         'methodname' => 'get_groupings',
1053         'classpath' => 'group/externallib.php',
1054         'description' => 'Returns groupings details.',
1055         'type' => 'read',
1056     ),
1057     'core_group_get_groups' => array(
1058         'classname' => 'core_group_external',
1059         'methodname' => 'get_groups',
1060         'classpath' => 'group/externallib.php',
1061         'description' => 'Returns group details.',
1062         'type' => 'read',
1063         'capabilities' => 'moodle/course:managegroups'
1064     ),
1065     'core_group_unassign_grouping' => array(
1066         'classname' => 'core_group_external',
1067         'methodname' => 'unassign_grouping',
1068         'classpath' => 'group/externallib.php',
1069         'description' => 'Unassing groups from groupings',
1070         'type' => 'write',
1071     ),
1072     'core_group_update_groupings' => array(
1073         'classname' => 'core_group_external',
1074         'methodname' => 'update_groupings',
1075         'classpath' => 'group/externallib.php',
1076         'description' => 'Updates existing groupings',
1077         'type' => 'write',
1078     ),
1079     'core_group_update_groups' => array(
1080         'classname' => 'core_group_external',
1081         'methodname' => 'update_groups',
1082         'classpath' => 'group/externallib.php',
1083         'description' => 'Updates existing groups.',
1084         'type' => 'write',
1085         'capabilities' => 'moodle/course:managegroups'
1086     ),
1087     'core_message_mute_conversations' => array(
1088         'classname' => 'core_message_external',
1089         'methodname' => 'mute_conversations',
1090         'classpath' => 'message/externallib.php',
1091         'description' => 'Mutes a list of conversations',
1092         'type' => 'write',
1093         'ajax' => true,
1094         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1095     ),
1096     'core_message_unmute_conversations' => array(
1097         'classname' => 'core_message_external',
1098         'methodname' => 'unmute_conversations',
1099         'classpath' => 'message/externallib.php',
1100         'description' => 'Unmutes a list of conversations',
1101         'type' => 'write',
1102         'ajax' => true,
1103         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1104     ),
1105     'core_message_block_user' => array(
1106         'classname' => 'core_message_external',
1107         'methodname' => 'block_user',
1108         'classpath' => 'message/externallib.php',
1109         'description' => 'Blocks a user',
1110         'type' => 'write',
1111         'ajax' => true,
1112         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1113     ),
1114     'core_message_get_contact_requests' => array(
1115         'classname' => 'core_message_external',
1116         'methodname' => 'get_contact_requests',
1117         'classpath' => 'message/externallib.php',
1118         'description' => 'Returns contact requests for a user',
1119         'type' => 'read',
1120         'ajax' => true,
1121         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1122     ),
1123     'core_message_create_contact_request' => array(
1124         'classname' => 'core_message_external',
1125         'methodname' => 'create_contact_request',
1126         'classpath' => 'message/externallib.php',
1127         'description' => 'Creates a contact request',
1128         'type' => 'write',
1129         'ajax' => true,
1130         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1131     ),
1132     'core_message_confirm_contact_request' => array(
1133         'classname' => 'core_message_external',
1134         'methodname' => 'confirm_contact_request',
1135         'classpath' => 'message/externallib.php',
1136         'description' => 'Confirms a contact request',
1137         'type' => 'write',
1138         'ajax' => true,
1139         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1140     ),
1141     'core_message_decline_contact_request' => array(
1142         'classname' => 'core_message_external',
1143         'methodname' => 'decline_contact_request',
1144         'classpath' => 'message/externallib.php',
1145         'description' => 'Declines a contact request',
1146         'type' => 'write',
1147         'ajax' => true,
1148         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1149     ),
1150     'core_message_get_received_contact_requests_count' => array(
1151         'classname' => 'core_message_external',
1152         'methodname' => 'get_received_contact_requests_count',
1153         'classpath' => 'message/externallib.php',
1154         'description' => 'Gets the number of received contact requests',
1155         'type' => 'read',
1156         'ajax' => true,
1157         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1158     ),
1159     'core_message_delete_contacts' => array(
1160         'classname' => 'core_message_external',
1161         'methodname' => 'delete_contacts',
1162         'classpath' => 'message/externallib.php',
1163         'description' => 'Remove contacts from the contact list',
1164         'type' => 'write',
1165         'ajax' => true,
1166         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1167     ),
1168     'core_message_delete_conversations_by_id' => array(
1169         'classname' => 'core_message_external',
1170         'methodname' => 'delete_conversations_by_id',
1171         'classpath' => 'message/externallib.php',
1172         'description' => 'Deletes a list of conversations.',
1173         'type' => 'write',
1174         'capabilities' => 'moodle/site:deleteownmessage',
1175         'ajax' => true,
1176         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1177     ),
1178     'core_message_delete_message' => array(
1179         'classname' => 'core_message_external',
1180         'methodname' => 'delete_message',
1181         'classpath' => 'message/externallib.php',
1182         'description' => 'Deletes a message.',
1183         'type' => 'write',
1184         'capabilities' => 'moodle/site:deleteownmessage',
1185         'ajax' => true,
1186         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1187     ),
1188     'core_message_get_blocked_users' => array(
1189         'classname' => 'core_message_external',
1190         'methodname' => 'get_blocked_users',
1191         'classpath' => 'message/externallib.php',
1192         'description' => 'Retrieve a list of users blocked',
1193         'type' => 'read',
1194         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1195     ),
1196     'core_message_data_for_messagearea_search_messages' => array(
1197         'classname' => 'core_message_external',
1198         'methodname' => 'data_for_messagearea_search_messages',
1199         'classpath' => 'message/externallib.php',
1200         'description' => 'Retrieve the template data for searching for messages',
1201         'type' => 'read',
1202         'ajax' => true,
1203         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1204     ),
1205     'core_message_message_search_users' => array(
1206         'classname' => 'core_message_external',
1207         'methodname' => 'message_search_users',
1208         'classpath' => 'message/externallib.php',
1209         'description' => 'Retrieve the data for searching for people',
1210         'type' => 'read',
1211         'ajax' => true,
1212         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1213     ),
1214     'core_message_get_user_contacts' => array(
1215         'classname' => 'core_message_external',
1216         'methodname' => 'get_user_contacts',
1217         'classpath' => 'message/externallib.php',
1218         'description' => 'Retrieve the contact list',
1219         'type' => 'read',
1220         'ajax' => true,
1221         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1222     ),
1223     'core_message_get_conversations' => array(
1224         'classname' => 'core_message_external',
1225         'methodname' => 'get_conversations',
1226         'classpath' => 'message/externallib.php',
1227         'description' => 'Retrieve a list of conversations for a user',
1228         'type' => 'read',
1229         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1230         'ajax' => true
1231     ),
1232     'core_message_get_conversation' => array(
1233         'classname' => 'core_message_external',
1234         'methodname' => 'get_conversation',
1235         'classpath' => 'message/externallib.php',
1236         'description' => 'Retrieve a conversation for a user',
1237         'type' => 'read',
1238         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1239         'ajax' => true
1240     ),
1241     'core_message_get_conversation_between_users' => array(
1242         'classname' => 'core_message_external',
1243         'methodname' => 'get_conversation_between_users',
1244         'classpath' => 'message/externallib.php',
1245         'description' => 'Retrieve a conversation for a user between another user',
1246         'type' => 'read',
1247         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1248         'ajax' => true
1249     ),
1250     'core_message_get_self_conversation' => array(
1251         'classname' => 'core_message_external',
1252         'methodname' => 'get_self_conversation',
1253         'classpath' => 'message/externallib.php',
1254         'description' => 'Retrieve a self-conversation for a user',
1255         'type' => 'read',
1256         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1257         'ajax' => true
1258     ),
1259     'core_message_get_messages' => array(
1260         'classname' => 'core_message_external',
1261         'methodname' => 'get_messages',
1262         'classpath' => 'message/externallib.php',
1263         'description' => 'Retrieve a list of messages sent and received by a user (conversations, notifications or both)',
1264         'type' => 'read',
1265         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1266         'ajax' => true,
1267     ),
1268     'core_message_get_conversation_counts' => array(
1269         'classname' => 'core_message_external',
1270         'methodname' => 'get_conversation_counts',
1271         'classpath' => 'message/externallib.php',
1272         'description' => 'Retrieve a list of conversation counts, indexed by type.',
1273         'type' => 'read',
1274         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1275         'ajax' => true,
1276     ),
1277     'core_message_get_unread_conversation_counts' => array(
1278         'classname' => 'core_message_external',
1279         'methodname' => 'get_unread_conversation_counts',
1280         'classpath' => 'message/externallib.php',
1281         'description' => 'Retrieve a list of unread conversation counts, indexed by type.',
1282         'type' => 'read',
1283         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1284         'ajax' => true,
1285     ),
1286     'core_message_get_conversation_members' => array(
1287         'classname' => 'core_message_external',
1288         'methodname' => 'get_conversation_members',
1289         'classpath' => 'message/externallib.php',
1290         'description' => 'Retrieve a list of members in a conversation',
1291         'type' => 'read',
1292         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1293         'ajax' => true,
1294     ),
1295     'core_message_get_member_info' => array(
1296         'classname' => 'core_message_external',
1297         'methodname' => 'get_member_info',
1298         'classpath' => 'message/externallib.php',
1299         'description' => 'Retrieve a user message profiles',
1300         'type' => 'read',
1301         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1302         'ajax' => true,
1303     ),
1304     'core_message_get_unread_conversations_count' => array(
1305         'classname' => 'core_message_external',
1306         'methodname' => 'get_unread_conversations_count',
1307         'classpath' => 'message/externallib.php',
1308         'description' => 'Retrieve the count of unread conversations for a given user',
1309         'type' => 'read',
1310         'ajax' => true,
1311         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1312         'readonlysession' => true, // We don't modify the session.
1313     ),
1314     'core_message_mark_all_notifications_as_read' => array(
1315         'classname' => 'core_message_external',
1316         'methodname' => 'mark_all_notifications_as_read',
1317         'classpath' => 'message/externallib.php',
1318         'description' => 'Mark all notifications as read for a given user',
1319         'type' => 'write',
1320         'ajax' => true,
1321         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1322     ),
1323     'core_message_mark_all_conversation_messages_as_read' => array(
1324         'classname' => 'core_message_external',
1325         'methodname' => 'mark_all_conversation_messages_as_read',
1326         'classpath' => 'message/externallib.php',
1327         'description' => 'Mark all conversation messages as read for a given user',
1328         'type' => 'write',
1329         'ajax' => true,
1330         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1331     ),
1332     'core_message_mark_message_read' => array(
1333         'classname' => 'core_message_external',
1334         'methodname' => 'mark_message_read',
1335         'classpath' => 'message/externallib.php',
1336         'description' => 'Mark a single message as read, trigger message_viewed event.',
1337         'type' => 'write',
1338         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1339         'ajax' => true,
1340     ),
1341     'core_message_mark_notification_read' => array(
1342         'classname' => 'core_message_external',
1343         'methodname' => 'mark_notification_read',
1344         'classpath' => 'message/externallib.php',
1345         'description' => 'Mark a single notification as read, trigger notification_viewed event.',
1346         'type' => 'write',
1347         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1348         'ajax' => true,
1349     ),
1350     'core_message_message_processor_config_form' => array(
1351         'classname' => 'core_message_external',
1352         'methodname' => 'message_processor_config_form',
1353         'classpath' => 'message/externallib.php',
1354         'description' => 'Process the message processor config form',
1355         'type' => 'write',
1356         'ajax' => true,
1357         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1358     ),
1359     'core_message_get_message_processor' => array(
1360         'classname' => 'core_message_external',
1361         'methodname' => 'get_message_processor',
1362         'classpath' => 'message/externallib.php',
1363         'description' => 'Get a message processor',
1364         'type' => 'read',
1365         'ajax' => true,
1366     ),
1367     'core_message_search_contacts' => array(
1368         'classname' => 'core_message_external',
1369         'methodname' => 'search_contacts',
1370         'classpath' => 'message/externallib.php',
1371         'description' => 'Search for contacts',
1372         'type' => 'read',
1373         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1374     ),
1375     'core_message_send_instant_messages' => array(
1376         'classname' => 'core_message_external',
1377         'methodname' => 'send_instant_messages',
1378         'classpath' => 'message/externallib.php',
1379         'description' => 'Send instant messages',
1380         'type' => 'write',
1381         'capabilities' => 'moodle/site:sendmessage',
1382         'ajax' => true,
1383         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1384     ),
1385     'core_message_send_messages_to_conversation' => array(
1386         'classname' => 'core_message_external',
1387         'methodname' => 'send_messages_to_conversation',
1388         'classpath' => 'message/externallib.php',
1389         'description' => 'Send messages to an existing conversation between users',
1390         'type' => 'write',
1391         'capabilities' => 'moodle/site:sendmessage',
1392         'ajax' => true,
1393         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1394     ),
1395     'core_message_get_conversation_messages' => array(
1396         'classname' => 'core_message_external',
1397         'methodname' => 'get_conversation_messages',
1398         'classpath' => 'message/externallib.php',
1399         'description' => 'Retrieve the conversation messages and relevant member information',
1400         'type' => 'read',
1401         'ajax' => true,
1402         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1403     ),
1404     'core_message_unblock_user' => array(
1405         'classname' => 'core_message_external',
1406         'methodname' => 'unblock_user',
1407         'classpath' => 'message/externallib.php',
1408         'description' => 'Unblocks a user',
1409         'type' => 'write',
1410         'ajax' => true,
1411         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1412     ),
1413     'core_message_get_user_notification_preferences' => array(
1414         'classname' => 'core_message_external',
1415         'methodname' => 'get_user_notification_preferences',
1416         'classpath' => 'message/externallib.php',
1417         'description' => 'Get the notification preferences for a given user.',
1418         'type' => 'read',
1419         'capabilities' => 'moodle/user:editownmessageprofile',
1420         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1421     ),
1422     'core_message_get_user_message_preferences' => array(
1423         'classname' => 'core_message_external',
1424         'methodname' => 'get_user_message_preferences',
1425         'classpath' => 'message/externallib.php',
1426         'description' => 'Get the message preferences for a given user.',
1427         'type' => 'read',
1428         'capabilities' => 'moodle/user:editownmessageprofile',
1429         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1430         'ajax' => true
1431     ),
1432     'core_message_set_favourite_conversations' => array(
1433         'classname' => 'core_message_external',
1434         'methodname' => 'set_favourite_conversations',
1435         'classpath' => 'message/externallib.php',
1436         'description' => 'Mark a conversation or group of conversations as favourites/starred conversations.',
1437         'type' => 'write',
1438         'ajax' => true,
1439         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1440     ),
1441     'core_message_unset_favourite_conversations' => array(
1442         'classname' => 'core_message_external',
1443         'methodname' => 'unset_favourite_conversations',
1444         'classpath' => 'message/externallib.php',
1445         'description' => 'Unset a conversation or group of conversations as favourites/starred conversations.',
1446         'type' => 'write',
1447         'ajax' => true,
1448         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1449     ),
1450     'core_message_delete_message_for_all_users' => array(
1451         'classname' => 'core_message_external',
1452         'methodname' => 'delete_message_for_all_users',
1453         'classpath' => 'message/externallib.php',
1454         'description' => 'Deletes a message for all users.',
1455         'type' => 'write',
1456         'capabilities' => 'moodle/site:deleteanymessage',
1457         'ajax' => true,
1458         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1459     ),
1460     'core_notes_create_notes' => array(
1461         'classname' => 'core_notes_external',
1462         'methodname' => 'create_notes',
1463         'classpath' => 'notes/externallib.php',
1464         'description' => 'Create notes',
1465         'type' => 'write',
1466         'ajax' => true,
1467         'capabilities' => 'moodle/notes:manage',
1468         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1469     ),
1470     'core_notes_delete_notes' => array(
1471         'classname' => 'core_notes_external',
1472         'methodname' => 'delete_notes',
1473         'classpath' => 'notes/externallib.php',
1474         'description' => 'Delete notes',
1475         'type' => 'write',
1476         'capabilities' => 'moodle/notes:manage',
1477         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1478     ),
1479     'core_notes_get_course_notes' => array(
1480         'classname' => 'core_notes_external',
1481         'methodname' => 'get_course_notes',
1482         'classpath' => 'notes/externallib.php',
1483         'description' => 'Returns all notes in specified course (or site), for the specified user.',
1484         'type' => 'read',
1485         'capabilities' => 'moodle/notes:view',
1486         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1487     ),
1488     'core_notes_get_notes' => array(
1489         'classname' => 'core_notes_external',
1490         'methodname' => 'get_notes',
1491         'classpath' => 'notes/externallib.php',
1492         'description' => 'Get notes',
1493         'type' => 'read',
1494         'capabilities' => 'moodle/notes:view'
1495     ),
1496     'core_notes_update_notes' => array(
1497         'classname' => 'core_notes_external',
1498         'methodname' => 'update_notes',
1499         'classpath' => 'notes/externallib.php',
1500         'description' => 'Update notes',
1501         'type' => 'write',
1502         'capabilities' => 'moodle/notes:manage'
1503     ),
1504     'core_notes_view_notes' => array(
1505         'classname' => 'core_notes_external',
1506         'methodname' => 'view_notes',
1507         'classpath' => 'notes/externallib.php',
1508         'description' => 'Simulates the web interface view of notes/index.php: trigger events.',
1509         'type' => 'write',
1510         'capabilities' => 'moodle/notes:view',
1511         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1512     ),
1513     'core_output_load_template' => array(
1514         'classname' => 'core\output\external',
1515         'methodname' => 'load_template',
1516         'description' => 'Load a template for a renderable',
1517         'type' => 'read',
1518         'loginrequired' => false,
1519         'ajax' => true,
1520     ),
1521     'core_output_load_template_with_dependencies' => array(
1522         'classname' => 'core\output\external',
1523         'methodname' => 'load_template_with_dependencies',
1524         'description' => 'Load a template and its dependencies for a renderable',
1525         'type' => 'read',
1526         'loginrequired' => false,
1527         'ajax' => true,
1528     ),
1529     'core_output_load_fontawesome_icon_map' => array(
1530         'classname' => 'core\output\external',
1531         'methodname' => 'load_fontawesome_icon_map',
1532         'description' => 'Load the mapping of names to icons',
1533         'type' => 'read',
1534         'loginrequired' => false,
1535         'ajax' => true,
1536     ),
1537     'core_output_load_fontawesome_icon_system_map' => array(
1538         'classname' => 'core\external\output\icon_system\load_fontawesome_map',
1539         'methodname' => 'execute',
1540         'description' => 'Load the mapping of moodle pix names to fontawesome icon names',
1541         'type' => 'read',
1542         'loginrequired' => false,
1543         'ajax' => true,
1544     ),
1545     // Question related functions.
1546     'core_question_update_flag' => array(
1547         'classname'     => 'core_question_external',
1548         'methodname'    => 'update_flag',
1549         'description'   => 'Update the flag state of a question attempt.',
1550         'type'          => 'write',
1551         'capabilities'  => 'moodle/question:flag',
1552         'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1553     ),
1554     'core_question_submit_tags_form' => array(
1555         'classname'     => 'core_question_external',
1556         'methodname'    => 'submit_tags_form',
1557         'description'   => 'Update the question tags.',
1558         'type'          => 'write',
1559         'ajax' => true,
1560     ),
1561     'core_question_get_random_question_summaries' => array(
1562         'classname' => 'core_question_external',
1563         'methodname' => 'get_random_question_summaries',
1564         'description' => 'Get the random question set for a criteria',
1565         'type' => 'read',
1566         'ajax' => true,
1567     ),
1568     'core_rating_get_item_ratings' => array(
1569         'classname' => 'core_rating_external',
1570         'methodname' => 'get_item_ratings',
1571         'description' => 'Retrieve all the ratings for an item.',
1572         'type' => 'read',
1573         'capabilities' => 'moodle/rating:view',
1574         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1575     ),
1576     'core_rating_add_rating' => array(
1577         'classname' => 'core_rating_external',
1578         'methodname' => 'add_rating',
1579         'description' => 'Rates an item.',
1580         'type' => 'write',
1581         'capabilities' => 'moodle/rating:rate',
1582         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1583     ),
1584     'core_role_assign_roles' => array(
1585         'classname' => 'core_role_external',
1586         'methodname' => 'assign_roles',
1587         'classpath' => 'enrol/externallib.php',
1588         'description' => 'Manual role assignments.',
1589         'type' => 'write',
1590         'capabilities' => 'moodle/role:assign'
1591     ),
1592     'core_role_unassign_roles' => array(
1593         'classname' => 'core_role_external',
1594         'methodname' => 'unassign_roles',
1595         'classpath' => 'enrol/externallib.php',
1596         'description' => 'Manual role unassignments.',
1597         'type' => 'write',
1598         'capabilities' => 'moodle/role:assign'
1599     ),
1600     'core_search_get_relevant_users' => array(
1601         'classname' => '\core_search\external',
1602         'methodname' => 'get_relevant_users',
1603         'description' => 'Gets relevant users for a search request.',
1604         'type' => 'read',
1605         'ajax' => true
1606     ),
1607     'core_tag_get_tagindex' => array(
1608         'classname' => 'core_tag_external',
1609         'methodname' => 'get_tagindex',
1610         'description' => 'Gets tag index page for one tag and one tag area',
1611         'type' => 'read',
1612         'ajax' => true,
1613         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1614     ),
1615     'core_tag_get_tags' => array(
1616         'classname' => 'core_tag_external',
1617         'methodname' => 'get_tags',
1618         'description' => 'Gets tags by their ids',
1619         'type' => 'read',
1620         'ajax' => true,
1621     ),
1622     'core_tag_update_tags' => array(
1623         'classname' => 'core_tag_external',
1624         'methodname' => 'update_tags',
1625         'description' => 'Updates tags',
1626         'type' => 'write',
1627         'ajax' => true,
1628     ),
1629     'core_tag_get_tagindex_per_area' => array(
1630         'classname' => 'core_tag_external',
1631         'methodname' => 'get_tagindex_per_area',
1632         'description' => 'Gets tag index page per different areas.',
1633         'type' => 'read',
1634         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1635     ),
1636     'core_tag_get_tag_areas' => array(
1637         'classname' => 'core_tag_external',
1638         'methodname' => 'get_tag_areas',
1639         'description' => 'Retrieves existing tag areas.',
1640         'type' => 'read',
1641         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1642     ),
1643     'core_tag_get_tag_collections' => array(
1644         'classname' => 'core_tag_external',
1645         'methodname' => 'get_tag_collections',
1646         'description' => 'Retrieves existing tag collections.',
1647         'type' => 'read',
1648         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1649     ),
1650     'core_tag_get_tag_cloud' => array(
1651         'classname' => 'core_tag_external',
1652         'methodname' => 'get_tag_cloud',
1653         'description' => 'Retrieves a tag cloud for the given collection and/or query search.',
1654         'type' => 'read',
1655         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1656     ),
1657     'core_update_inplace_editable' => array(
1658         'classname' => 'core_external',
1659         'methodname' => 'update_inplace_editable',
1660         'classpath' => 'lib/external/externallib.php',
1661         'description' => 'Generic service to update title',
1662         'type' => 'write',
1663         'loginrequired' => true,
1664         'ajax' => true,
1665     ),
1666     'core_user_add_user_device' => array(
1667         'classname' => 'core_user_external',
1668         'methodname' => 'add_user_device',
1669         'classpath' => 'user/externallib.php',
1670         'description' => 'Store mobile user devices information for PUSH Notifications.',
1671         'type' => 'write',
1672         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1673     ),
1674     'core_user_add_user_private_files' => array(
1675         'classname' => 'core_user_external',
1676         'methodname' => 'add_user_private_files',
1677         'classpath' => 'user/externallib.php',
1678         'description' => 'Copy files from a draft area to users private files area.',
1679         'type' => 'write',
1680         'capabilities' => 'moodle/user:manageownfiles',
1681         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1682     ),
1683     'core_user_create_users' => array(
1684         'classname' => 'core_user_external',
1685         'methodname' => 'create_users',
1686         'classpath' => 'user/externallib.php',
1687         'description' => 'Create users.',
1688         'type' => 'write',
1689         'capabilities' => 'moodle/user:create'
1690     ),
1691     'core_user_delete_users' => array(
1692         'classname' => 'core_user_external',
1693         'methodname' => 'delete_users',
1694         'classpath' => 'user/externallib.php',
1695         'description' => 'Delete users.',
1696         'type' => 'write',
1697         'capabilities' => 'moodle/user:delete'
1698     ),
1699     'core_user_get_course_user_profiles' => array(
1700         'classname' => 'core_user_external',
1701         'methodname' => 'get_course_user_profiles',
1702         'classpath' => 'user/externallib.php',
1703         'description' => 'Get course user profiles (each of the profils matching a course id and a user id),.',
1704         'type' => 'read',
1705         'capabilities' => 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update, '
1706             . 'moodle/site:accessallgroups',
1707         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1708     ),
1709     'core_user_get_users' => array(
1710         'classname' => 'core_user_external',
1711         'methodname' => 'get_users',
1712         'classpath' => 'user/externallib.php',
1713         'description' => 'search for users matching the parameters',
1714         'type' => 'read',
1715         'capabilities' => 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update'
1716     ),
1717     'core_user_get_users_by_field' => array(
1718         'classname' => 'core_user_external',
1719         'methodname' => 'get_users_by_field',
1720         'classpath' => 'user/externallib.php',
1721         'description' => 'Retrieve users\' information for a specified unique field - If you want to do a user search, use '
1722             . 'core_user_get_users()',
1723         'type' => 'read',
1724         'capabilities' => 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update',
1725         'ajax' => true,
1726         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1727     ),
1728     'core_user_remove_user_device' => array(
1729         'classname' => 'core_user_external',
1730         'methodname' => 'remove_user_device',
1731         'classpath' => 'user/externallib.php',
1732         'description' => 'Remove a user device from the Moodle database.',
1733         'type' => 'write',
1734         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1735     ),
1736     'core_user_update_users' => array(
1737         'classname' => 'core_user_external',
1738         'methodname' => 'update_users',
1739         'classpath' => 'user/externallib.php',
1740         'description' => 'Update users.',
1741         'type' => 'write',
1742         'capabilities' => 'moodle/user:update',
1743         'ajax' => true,
1744     ),
1745     'core_user_update_user_preferences' => array(
1746         'classname' => 'core_user_external',
1747         'methodname' => 'update_user_preferences',
1748         'classpath' => 'user/externallib.php',
1749         'description' => 'Update a user\'s preferences',
1750         'type' => 'write',
1751         'capabilities' => 'moodle/user:editownmessageprofile, moodle/user:editmessageprofile',
1752         'ajax' => true,
1753         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1754     ),
1755     'core_user_view_user_list' => array(
1756         'classname' => 'core_user_external',
1757         'methodname' => 'view_user_list',
1758         'classpath' => 'user/externallib.php',
1759         'description' => 'Simulates the web-interface view of user/index.php (triggering events),.',
1760         'type' => 'write',
1761         'capabilities' => 'moodle/course:viewparticipants',
1762         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1763     ),
1764     'core_user_view_user_profile' => array(
1765         'classname' => 'core_user_external',
1766         'methodname' => 'view_user_profile',
1767         'classpath' => 'user/externallib.php',
1768         'description' => 'Simulates the web-interface view of user/view.php and user/profile.php (triggering events),.',
1769         'type' => 'write',
1770         'capabilities' => 'moodle/user:viewdetails',
1771         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1772     ),
1773     'core_user_get_user_preferences' => array(
1774         'classname' => 'core_user_external',
1775         'methodname' => 'get_user_preferences',
1776         'classpath' => 'user/externallib.php',
1777         'description' => 'Return user preferences.',
1778         'type' => 'read',
1779         'ajax' => true,
1780         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1781     ),
1782     'core_user_update_picture' => array(
1783         'classname' => 'core_user_external',
1784         'methodname' => 'update_picture',
1785         'classpath' => 'user/externallib.php',
1786         'description' => 'Update or delete the user picture in the site',
1787         'type' => 'write',
1788         'capabilities' => 'moodle/user:editownprofile, moodle/user:editprofile',
1789         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1790     ),
1791     'core_user_set_user_preferences' => array(
1792         'classname' => 'core_user_external',
1793         'methodname' => 'set_user_preferences',
1794         'classpath' => 'user/externallib.php',
1795         'description' => 'Set user preferences.',
1796         'type' => 'write',
1797         'capabilities' => 'moodle/site:config',
1798         'ajax' => true,
1799         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1800     ),
1801     'core_user_agree_site_policy' => array(
1802         'classname' => 'core_user_external',
1803         'methodname' => 'agree_site_policy',
1804         'classpath' => 'user/externallib.php',
1805         'description' => 'Agree the site policy for the current user.',
1806         'type' => 'write',
1807         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1808     ),
1809     'core_user_get_private_files_info' => array(
1810         'classname' => 'core_user_external',
1811         'methodname' => 'get_private_files_info',
1812         'classpath' => 'user/externallib.php',
1813         'description' => 'Returns general information about files in the user private files area.',
1814         'type' => 'read',
1815         'capabilities' => 'moodle/user:manageownfiles',
1816         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1817     ),
1819     // Competencies functions.
1820     'core_competency_create_competency_framework' => array(
1821         'classname'    => 'core_competency\external',
1822         'methodname'   => 'create_competency_framework',
1823         'classpath'    => '',
1824         'description'  => 'Creates new competency frameworks.',
1825         'type'         => 'write',
1826         'capabilities' => 'moodle/competency:competencymanage',
1827         'ajax'         => true,
1828     ),
1829     'core_competency_read_competency_framework' => array(
1830         'classname'    => 'core_competency\external',
1831         'methodname'   => 'read_competency_framework',
1832         'classpath'    => '',
1833         'description'  => 'Load a summary of a competency framework.',
1834         'type'         => 'read',
1835         'capabilities' => 'moodle/competency:competencyview',
1836         'ajax'         => true,
1837     ),
1838     'core_competency_duplicate_competency_framework' => array(
1839         'classname'    => 'core_competency\external',
1840         'methodname'   => 'duplicate_competency_framework',
1841         'classpath'    => '',
1842         'description'  => 'Duplicate a competency framework.',
1843         'type'         => 'write',
1844         'capabilities' => 'moodle/competency:competencymanage',
1845         'ajax'         => true,
1846     ),
1847     'core_competency_delete_competency_framework' => array(
1848         'classname'    => 'core_competency\external',
1849         'methodname'   => 'delete_competency_framework',
1850         'classpath'    => '',
1851         'description'  => 'Delete a competency framework.',
1852         'type'         => 'write',
1853         'capabilities' => 'moodle/competency:competencymanage',
1854         'ajax'         => true,
1855     ),
1856     'core_competency_update_competency_framework' => array(
1857         'classname'    => 'core_competency\external',
1858         'methodname'   => 'update_competency_framework',
1859         'classpath'    => '',
1860         'description'  => 'Update a competency framework.',
1861         'type'         => 'write',
1862         'capabilities' => 'moodle/competency:competencymanage',
1863         'ajax'         => true,
1864     ),
1865     'core_competency_list_competency_frameworks' => array(
1866         'classname'    => 'core_competency\external',
1867         'methodname'   => 'list_competency_frameworks',
1868         'classpath'    => '',
1869         'description'  => 'Load a list of a competency frameworks.',
1870         'type'         => 'read',
1871         'capabilities' => 'moodle/competency:competencyview',
1872         'ajax'         => true,
1873     ),
1874     'core_competency_count_competency_frameworks' => array(
1875         'classname'    => 'core_competency\external',
1876         'methodname'   => 'count_competency_frameworks',
1877         'classpath'    => '',
1878         'description'  => 'Count a list of a competency frameworks.',
1879         'type'         => 'read',
1880         'capabilities' => 'moodle/competency:competencyview',
1881         'ajax'         => true,
1882     ),
1883     'core_competency_competency_framework_viewed' => array(
1884         'classname'    => 'core_competency\external',
1885         'methodname'   => 'competency_framework_viewed',
1886         'classpath'    => '',
1887         'description'  => 'Log event competency framework viewed',
1888         'type'         => 'read',
1889         'capabilities' => 'moodle/competency:competencyview',
1890         'ajax'         => true,
1891     ),
1892     'core_competency_create_competency' => array(
1893         'classname'    => 'core_competency\external',
1894         'methodname'   => 'create_competency',
1895         'classpath'    => '',
1896         'description'  => 'Creates new competencies.',
1897         'type'         => 'write',
1898         'capabilities' => 'moodle/competency:competencymanage',
1899         'ajax'         => true,
1900     ),
1901     'core_competency_read_competency' => array(
1902         'classname'    => 'core_competency\external',
1903         'methodname'   => 'read_competency',
1904         'classpath'    => '',
1905         'description'  => 'Load a summary of a competency.',
1906         'type'         => 'read',
1907         'capabilities' => 'moodle/competency:competencyview',
1908         'ajax'         => true,
1909     ),
1910     'core_competency_competency_viewed' => array(
1911         'classname'    => 'core_competency\external',
1912         'methodname'   => 'competency_viewed',
1913         'classpath'    => '',
1914         'description'  => 'Log event competency viewed',
1915         'type'         => 'read',
1916         'capabilities' => 'moodle/competency:competencyview',
1917         'ajax'         => true,
1918         'services'     => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1919     ),
1920     'core_competency_delete_competency' => array(
1921         'classname'    => 'core_competency\external',
1922         'methodname'   => 'delete_competency',
1923         'classpath'    => '',
1924         'description'  => 'Delete a competency.',
1925         'type'         => 'write',
1926         'capabilities' => 'moodle/competency:competencymanage',
1927         'ajax'         => true,
1928     ),
1929     'core_competency_update_competency' => array(
1930         'classname'    => 'core_competency\external',
1931         'methodname'   => 'update_competency',
1932         'classpath'    => '',
1933         'description'  => 'Update a competency.',
1934         'type'         => 'write',
1935         'capabilities' => 'moodle/competency:competencymanage',
1936         'ajax'         => true,
1937     ),
1938     'core_competency_list_competencies' => array(
1939         'classname'    => 'core_competency\external',
1940         'methodname'   => 'list_competencies',
1941         'classpath'    => '',
1942         'description'  => 'Load a list of a competencies.',
1943         'type'         => 'read',
1944         'capabilities' => 'moodle/competency:competencyview',
1945         'ajax'         => true,
1946     ),
1947     'core_competency_list_competencies_in_template' => array(
1948         'classname'    => 'core_competency\external',
1949         'methodname'   => 'list_competencies_in_template',
1950         'classpath'    => '',
1951         'description'  => 'Load a list of a competencies for a given template.',
1952         'type'         => 'read',
1953         'capabilities' => 'moodle/competency:competencyview',
1954         'ajax'         => true,
1955     ),
1956     'core_competency_count_competencies' => array(
1957         'classname'    => 'core_competency\external',
1958         'methodname'   => 'count_competencies',
1959         'classpath'    => '',
1960         'description'  => 'Count a list of a competencies.',
1961         'type'         => 'read',
1962         'capabilities' => 'moodle/competency:competencyview',
1963         'ajax'         => true,
1964     ),
1965     'core_competency_count_competencies_in_template' => array(
1966         'classname'    => 'core_competency\external',
1967         'methodname'   => 'count_competencies_in_template',
1968         'classpath'    => '',
1969         'description'  => 'Count a list of a competencies for a given template.',
1970         'type'         => 'read',
1971         'capabilities' => 'moodle/competency:competencyview',
1972         'ajax'         => true,
1973     ),
1974     'core_competency_search_competencies' => array(
1975         'classname'    => 'core_competency\external',
1976         'methodname'   => 'search_competencies',
1977         'classpath'    => '',
1978         'description'  => 'Search a list of a competencies.',
1979         'type'         => 'read',
1980         'capabilities' => 'moodle/competency:competencyview',
1981         'ajax'         => true,
1982     ),
1983     'core_competency_set_parent_competency' => array(
1984         'classname'    => 'core_competency\external',
1985         'methodname'   => 'set_parent_competency',
1986         'classpath'    => '',
1987         'description'  => 'Set a new parent for a competency.',
1988         'type'         => 'write',
1989         'capabilities' => 'moodle/competency:competencymanage',
1990         'ajax'         => true,
1991     ),
1992     'core_competency_move_up_competency' => array(
1993         'classname'    => 'core_competency\external',
1994         'methodname'   => 'move_up_competency',
1995         'classpath'    => '',
1996         'description'  => 'Re-order a competency.',
1997         'type'         => 'write',
1998         'capabilities' => 'moodle/competency:competencymanage',
1999         'ajax'         => true,
2000     ),
2001     'core_competency_move_down_competency' => array(
2002         'classname'    => 'core_competency\external',
2003         'methodname'   => 'move_down_competency',
2004         'classpath'    => '',
2005         'description'  => 'Re-order a competency.',
2006         'type'         => 'write',
2007         'capabilities' => 'moodle/competency:competencymanage',
2008         'ajax'         => true,
2009     ),
2010     'core_competency_list_course_module_competencies' => array(
2011         'classname'    => 'core_competency\external',
2012         'methodname'   => 'list_course_module_competencies',
2013         'classpath'    => '',
2014         'description'  => 'List the competencies in a course module',
2015         'type'         => 'read',
2016         'capabilities' => 'moodle/competency:coursecompetencyview',
2017         'ajax'         => true,
2018     ),
2019     'core_competency_count_course_module_competencies' => array(
2020         'classname'    => 'core_competency\external',
2021         'methodname'   => 'count_course_module_competencies',
2022         'classpath'    => '',
2023         'description'  => 'Count the competencies in a course module',
2024         'type'         => 'read',
2025         'capabilities' => 'moodle/competency:coursecompetencyview',
2026         'ajax'         => true,
2027     ),
2028     'core_competency_list_course_competencies' => array(
2029         'classname'    => 'core_competency\external',
2030         'methodname'   => 'list_course_competencies',
2031         'classpath'    => '',
2032         'description'  => 'List the competencies in a course',
2033         'type'         => 'read',
2034         'capabilities' => 'moodle/competency:coursecompetencyview',
2035         'ajax'         => true,
2036         'services'     => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
2037     ),
2038     'core_competency_count_competencies_in_course' => array(
2039         'classname'    => 'core_competency\external',
2040         'methodname'   => 'count_competencies_in_course',
2041         'classpath'    => '',
2042         'description'  => 'List the competencies in a course',
2043         'type'         => 'read',
2044         'capabilities' => 'moodle/competency:coursecompetencyview',
2045         'ajax'         => true,
2046     ),
2047     'core_competency_count_courses_using_competency' => array(
2048         'classname'    => 'core_competency\external',
2049         'methodname'   => 'count_courses_using_competency',
2050         'classpath'    => '',
2051         'description'  => 'List the courses using a competency',
2052         'type'         => 'read',
2053         'capabilities' => 'moodle/competency:coursecompetencyview',
2054         'ajax'         => true,
2055     ),
2056     'core_competency_add_competency_to_course' => array(
2057         'classname'    => 'core_competency\external',
2058         'methodname'   => 'add_competency_to_course',
2059         'classpath'    => '',
2060         'description'  => 'Add the competency to a course',
2061         'type'         => 'write',
2062         'capabilities' => 'moodle/competency:coursecompetencymanage',
2063         'ajax'         => true,
2064     ),
2065     'core_competency_add_competency_to_template' => array(
2066         'classname'    => 'core_competency\external',
2067         'methodname'   => 'add_competency_to_template',
2068         'classpath'    => '',
2069         'description'  => 'Add the competency to a template',
2070         'type'         => 'write',
2071         'capabilities' => 'moodle/competency:templatemanage',
2072         'ajax'         => true,
2073     ),
2074     'core_competency_remove_competency_from_course' => array(
2075         'classname'    => 'core_competency\external',
2076         'methodname'   => 'remove_competency_from_course',
2077         'classpath'    => '',
2078         'description'  => 'Remove a competency from a course',
2079         'type'         => 'write',
2080         'capabilities' => 'moodle/competency:coursecompetencymanage',
2081         'ajax'         => true,
2082     ),
2083     'core_competency_set_course_competency_ruleoutcome' => array(
2084         'classname'    => 'core_competency\external',
2085         'methodname'   => 'set_course_competency_ruleoutcome',
2086         'classpath'    => '',
2087         'description'  => 'Modify the ruleoutcome value for course competency',
2088         'type'         => 'write',
2089         'capabilities' => 'moodle/competency:coursecompetencymanage',
2090         'ajax'         => true,
2091     ),
2092     'core_competency_remove_competency_from_template' => array(
2093         'classname'    => 'core_competency\external',
2094         'methodname'   => 'remove_competency_from_template',
2095         'classpath'    => '',
2096         'description'  => 'Remove a competency from a template',
2097         'type'         => 'write',
2098         'capabilities' => 'moodle/competency:templatemanage',
2099         'ajax'         => true,
2100     ),
2101     'core_competency_reorder_course_competency' => array(
2102         'classname'    => 'core_competency\external',
2103         'methodname'   => 'reorder_course_competency',
2104         'classpath'    => '',
2105         'description'  => 'Move a course competency to a new relative sort order.',
2106         'type'         => 'write',
2107         'capabilities' => 'moodle/competency:coursecompetencymanage',
2108         'ajax'         => true,
2109     ),
2110     'core_competency_reorder_template_competency' => array(
2111         'classname'    => 'core_competency\external',
2112         'methodname'   => 'reorder_template_competency',
2113         'classpath'    => '',
2114         'description'  => 'Move a template competency to a new relative sort order.',
2115         'type'         => 'write',
2116         'capabilities' => 'moodle/competency:templatemanage',
2117         'ajax'         => true,
2118     ),
2119     'core_competency_create_template' => array(
2120         'classname'    => 'core_competency\external',
2121         'methodname'   => 'create_template',
2122         'classpath'    => '',
2123         'description'  => 'Creates new learning plan templates.',
2124         'type'         => 'write',
2125         'capabilities' => 'moodle/competency:templatemanage',
2126         'ajax'         => true,
2127     ),
2128     'core_competency_duplicate_template' => array(
2129         'classname'    => 'core_competency\external',
2130         'methodname'   => 'duplicate_template',
2131         'classpath'    => '',
2132         'description'  => 'Duplicate learning plan template.',
2133         'type'         => 'write',
2134         'capabilities' => 'moodle/competency:templatemanage',
2135         'ajax'         => true,
2136     ),
2137     'core_competency_read_template' => array(
2138         'classname'    => 'core_competency\external',
2139         'methodname'   => 'read_template',
2140         'classpath'    => '',
2141         'description'  => 'Load a summary of a learning plan template.',
2142         'type'         => 'read',
2143         'capabilities' => 'moodle/competency:templateview',
2144         'ajax'         => true,
2145     ),
2146     'core_competency_delete_template' => array(
2147         'classname'    => 'core_competency\external',
2148         'methodname'   => 'delete_template',
2149         'classpath'    => '',
2150         'description'  => 'Delete a learning plan template.',
2151         'type'         => 'write',
2152         'capabilities' => 'moodle/competency:templatemanage',
2153         'ajax'         => true,
2154     ),
2155     'core_competency_update_template' => array(
2156         'classname'    => 'core_competency\external',
2157         'methodname'   => 'update_template',
2158         'classpath'    => '',
2159         'description'  => 'Update a learning plan template.',
2160         'type'         => 'write',
2161         'capabilities' => 'moodle/competency:templatemanage',
2162         'ajax'         => true,
2163     ),
2164     'core_competency_list_templates' => array(
2165         'classname'    => 'core_competency\external',
2166         'methodname'   => 'list_templates',
2167         'classpath'    => '',
2168         'description'  => 'Load a list of a learning plan templates.',
2169         'type'         => 'read',
2170         'capabilities' => 'moodle/competency:templateview',
2171         'ajax'         => true,
2172     ),
2173     'core_competency_list_templates_using_competency' => array(
2174         'classname'    => 'core_competency\external',
2175         'methodname'   => 'list_templates_using_competency',
2176         'classpath'    => '',
2177         'description'  => 'Load a list of a learning plan templates for a given competency.',
2178         'type'         => 'read',
2179         'capabilities' => 'moodle/competency:templateview',
2180         'ajax'         => true,
2181     ),
2182     'core_competency_count_templates' => array(
2183         'classname'    => 'core_competency\external',
2184         'methodname'   => 'count_templates',
2185         'classpath'    => '',
2186         'description'  => 'Count a list of a learning plan templates.',
2187         'type'         => 'read',
2188         'capabilities' => 'moodle/competency:templateview',
2189         'ajax'         => true,
2190     ),
2191     'core_competency_count_templates_using_competency' => array(
2192         'classname'    => 'core_competency\external',
2193         'methodname'   => 'count_templates_using_competency',
2194         'classpath'    => '',
2195         'description'  => 'Count a list of a learning plan templates for a given competency.',
2196         'type'         => 'read',
2197         'capabilities' => 'moodle/competency:templateview',
2198         'ajax'         => true,
2199     ),
2200     'core_competency_create_plan' => array(
2201         'classname'    => 'core_competency\external',
2202         'methodname'   => 'create_plan',
2203         'classpath'    => '',
2204         'description'  => 'Creates a learning plan.',
2205         'type'         => 'write',
2206         'capabilities' => 'moodle/competency:planmanage',
2207         'ajax'         => true,
2208     ),
2209     'core_competency_update_plan' => array(
2210         'classname'    => 'core_competency\external',
2211         'methodname'   => 'update_plan',
2212         'classpath'    => '',
2213         'description'  => 'Updates a learning plan.',
2214         'type'         => 'write',
2215         'capabilities' => 'moodle/competency:planmanage',
2216         'ajax'         => true,
2217     ),
2218     'core_competency_complete_plan' => array(
2219         'classname'    => 'core_competency\external',
2220         'methodname'   => 'complete_plan',
2221         'classpath'    => '',
2222         'description'  => 'Complete learning plan.',
2223         'type'         => 'write',
2224         'capabilities' => 'moodle/competency:planmanage',
2225         'ajax'         => true,
2226     ),
2227     'core_competency_reopen_plan' => array(
2228         'classname'    => 'core_competency\external',
2229         'methodname'   => 'reopen_plan',
2230         'classpath'    => '',
2231         'description'  => 'Reopen learning plan.',
2232         'type'         => 'write',
2233         'capabilities' => 'moodle/competency:planmanage',
2234         'ajax'         => true,
2235     ),
2236     'core_competency_read_plan' => array(
2237         'classname'    => 'core_competency\external',
2238         'methodname'   => 'read_plan',
2239         'classpath'    => '',
2240         'description'  => 'Load a learning plan.',
2241         'type'         => 'read',
2242         'capabilities' => 'moodle/competency:planviewown',
2243         'ajax'         => true,
2244     ),
2245     'core_competency_delete_plan' => array(
2246         'classname'    => 'core_competency\external',
2247         'methodname'   => 'delete_plan',
2248         'classpath'    => '',
2249         'description'  => 'Delete a learning plan.',
2250         'type'         => 'write',
2251         'capabilities' => 'moodle/competency:planmanage',
2252         'ajax'         => true,
2253     ),
2254     'core_competency_list_user_plans' => array(
2255         'classname'    => 'core_competency\external',
2256         'methodname'   => 'list_user_plans',
2257         'classpath'    => '',
2258         'description'  => 'List a user\'s learning plans.',
2259         'type'         => 'read',
2260         'capabilities' => 'moodle/competency:planviewown',
2261         'ajax'         => true,
2262     ),
2263     'core_competency_list_plan_competencies' => array(
2264         'classname'    => 'core_competency\external',
2265         'methodname'   => 'list_plan_competencies',
2266         'classpath'    => '',
2267         'description'  => 'List the competencies in a plan',
2268         'type'         => 'read',
2269         'capabilities' => 'moodle/competency:planviewown',
2270         'ajax'         => true,
2271     ),
2272     'core_competency_add_competency_to_plan' => array(
2273         'classname'    => 'core_competency\external',
2274         'methodname'   => 'add_competency_to_plan',
2275         'classpath'    => '',
2276         'description'  => 'Add the competency to a learning plan',
2277         'type'         => 'write',
2278         'capabilities' => 'moodle/competency:planmanage',
2279         'ajax'         => true,
2280     ),
2281     'core_competency_remove_competency_from_plan' => array(
2282         'classname'    => 'core_competency\external',
2283         'methodname'   => 'remove_competency_from_plan',
2284         'classpath'    => '',
2285         'description'  => 'Remove the competency from a learning plan',
2286         'type'         => 'write',
2287         'capabilities' => 'moodle/competency:planmanage',
2288         'ajax'         => true,
2289     ),
2290     'core_competency_reorder_plan_competency' => array(
2291         'classname'    => 'core_competency\external',
2292         'methodname'   => 'reorder_plan_competency',
2293         'classpath'    => '',
2294         'description'  => 'Move a plan competency to a new relative sort order.',
2295         'type'         => 'write',
2296         'capabilities' => 'moodle/competency:planmanage',
2297         'ajax'         => true,
2298     ),
2299     'core_competency_plan_request_review' => array(
2300         'classname'    => 'core_competency\external',
2301         'methodname'   => 'plan_request_review',
2302         'classpath'    => '',
2303         'description'  => 'Request for a plan to be reviewed.',
2304         'type'         => 'write',
2305         'capabilities' => 'moodle/competency:planmanagedraft',
2306         'ajax'         => true,
2307     ),
2308     'core_competency_plan_start_review' => array(
2309         'classname'    => 'core_competency\external',
2310         'methodname'   => 'plan_start_review',
2311         'classpath'    => '',
2312         'description'  => 'Start the review of a plan.',
2313         'type'         => 'write',
2314         'capabilities' => 'moodle/competency:planmanage',
2315         'ajax'         => true,
2316     ),
2317     'core_competency_plan_stop_review' => array(
2318         'classname'    => 'core_competency\external',
2319         'methodname'   => 'plan_stop_review',
2320         'classpath'    => '',
2321         'description'  => 'Stop the review of a plan.',
2322         'type'         => 'write',
2323         'capabilities' => 'moodle/competency:planmanage',
2324         'ajax'         => true,
2325     ),
2326     'core_competency_plan_cancel_review_request' => array(
2327         'classname'    => 'core_competency\external',
2328         'methodname'   => 'plan_cancel_review_request',
2329         'classpath'    => '',
2330         'description'  => 'Cancel the review of a plan.',
2331         'type'         => 'write',
2332         'capabilities' => 'moodle/competency:planmanagedraft',
2333         'ajax'         => true,
2334     ),
2335     'core_competency_approve_plan' => array(
2336         'classname'    => 'core_competency\external',
2337         'methodname'   => 'approve_plan',
2338         'classpath'    => '',
2339         'description'  => 'Approve a plan.',
2340         'type'         => 'write',
2341         'capabilities' => 'moodle/competency:planmanage',
2342         'ajax'         => true,
2343     ),
2344     'core_competency_unapprove_plan' => array(
2345         'classname'    => 'core_competency\external',
2346         'methodname'   => 'unapprove_plan',
2347         'classpath'    => '',
2348         'description'  => 'Unapprove a plan.',
2349         'type'         => 'write',
2350         'capabilities' => 'moodle/competency:planmanage',
2351         'ajax'         => true,
2352     ),
2353      'core_competency_template_has_related_data' => array(
2354         'classname'    => 'core_competency\external',
2355         'methodname'   => 'template_has_related_data',
2356         'classpath'    => '',
2357         'description'  => 'Check if a template has related data',
2358         'type'         => 'read',
2359         'capabilities' => 'moodle/competency:templateview',
2360         'ajax'         => true,
2361     ),
2362     'core_competency_get_scale_values' => array(
2363         'classname'    => 'core_competency\external',
2364         'methodname'   => 'get_scale_values',
2365         'classpath'    => '',
2366         'description'  => 'Fetch the values for a specific scale',
2367         'type'         => 'read',
2368         'capabilities' => 'moodle/competency:competencymanage',
2369         'ajax'         => true,
2370         'services'     => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
2371     ),
2372     'core_competency_add_related_competency' => array(
2373         'classname'    => 'core_competency\external',
2374         'methodname'   => 'add_related_competency',
2375         'classpath'    => '',
2376         'description'  => 'Adds a related competency',
2377         'type'         => 'write',
2378         'capabilities' => 'moodle/competency:competencymanage',
2379         'ajax'         => true,
2380     ),
2381     'core_competency_remove_related_competency' => array(
2382         'classname'    => 'core_competency\external',
2383         'methodname'   => 'remove_related_competency',
2384         'classpath'    => '',
2385         'description'  => 'Remove a related competency',
2386         'type'         => 'write',
2387         'capabilities' => 'moodle/competency:competencymanage',
2388         'ajax'         => true,
2389     ),
2390     'core_competency_read_user_evidence' => array(
2391         'classname'    => 'core_competency\external',
2392         'methodname'   => 'read_user_evidence',
2393         'classpath'    => '',
2394         'description'  => 'Read an evidence of prior learning.',
2395         'type'         => 'read',
2396         'capabilities' => 'moodle/competency:userevidenceview',
2397         'ajax'         => true,
2398     ),
2399     'core_competency_delete_user_evidence' => array(
2400         'classname'    => 'core_competency\external',
2401         'methodname'   => 'delete_user_evidence',
2402         'classpath'    => '',
2403         'description'  => 'Delete an evidence of prior learning.',
2404         'type'         => 'write',
2405         'capabilities' => 'moodle/competency:userevidencemanageown',
2406         'ajax'         => true,
2407     ),
2408     'core_competency_create_user_evidence_competency' => array(
2409         'classname'    => 'core_competency\external',
2410         'methodname'   => 'create_user_evidence_competency',
2411         'classpath'    => '',
2412         'description'  => 'Create an evidence of prior learning relationship with a competency.',
2413         'type'         => 'read',
2414         'capabilities' => 'moodle/competency:userevidencemanageown, moodle/competency:competencyview',
2415         'ajax'         => true,
2416     ),
2417     'core_competency_delete_user_evidence_competency' => array(
2418         'classname'    => 'core_competency\external',
2419         'methodname'   => 'delete_user_evidence_competency',
2420         'classpath'    => '',
2421         'description'  => 'Delete an evidence of prior learning relationship with a competency.',
2422         'type'         => 'write',
2423         'capabilities' => 'moodle/competency:userevidencemanageown',
2424         'ajax'         => true,
2425     ),
2426     'core_competency_user_competency_cancel_review_request' => array(
2427         'classname'    => 'core_competency\external',
2428         'methodname'   => 'user_competency_cancel_review_request',
2429         'classpath'    => '',
2430         'description'  => 'Cancel a review request.',
2431         'type'         => 'write',
2432         'capabilities' => 'moodle/competency:userevidencemanageown',
2433         'ajax'         => true,
2434     ),
2435     'core_competency_user_competency_request_review' => array(
2436         'classname'    => 'core_competency\external',
2437         'methodname'   => 'user_competency_request_review',
2438         'classpath'    => '',
2439         'description'  => 'Request a review.',
2440         'type'         => 'write',
2441         'capabilities' => 'moodle/competency:userevidencemanageown',
2442         'ajax'         => true,
2443     ),
2444     'core_competency_user_competency_start_review' => array(
2445         'classname'    => 'core_competency\external',
2446         'methodname'   => 'user_competency_start_review',
2447         'classpath'    => '',
2448         'description'  => 'Start a review.',
2449         'type'         => 'write',
2450         'capabilities' => 'moodle/competency:competencygrade',
2451         'ajax'         => true,
2452     ),
2453     'core_competency_user_competency_stop_review' => array(
2454         'classname'    => 'core_competency\external',
2455         'methodname'   => 'user_competency_stop_review',
2456         'classpath'    => '',
2457         'description'  => 'Stop a review.',
2458         'type'         => 'write',
2459         'capabilities' => 'moodle/competency:competencygrade',
2460         'ajax'         => true,
2461     ),
2462     'core_competency_user_competency_viewed' => array(
2463         'classname'    => 'core_competency\external',
2464         'methodname'   => 'user_competency_viewed',
2465         'classpath'    => '',
2466         'description'  => 'Log the user competency viewed event.',
2467         'type'         => 'read',
2468         'capabilities' => 'moodle/competency:usercompetencyview',
2469         'ajax'         => true,
2470         'services'     => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
2471     ),
2472     'core_competency_user_competency_viewed_in_plan' => array(
2473         'classname'    => 'core_competency\external',
2474         'methodname'   => 'user_competency_viewed_in_plan',
2475         'classpath'    => '',
2476         'description'  => 'Log the user competency viewed in plan event.',
2477         'type'         => 'read',
2478         'capabilities' => 'moodle/competency:usercompetencyview',
2479         'ajax'         => true,
2480         'services'     => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
2481     ),
2482     'core_competency_user_competency_viewed_in_course' => array(
2483         'classname'    => 'core_competency\external',
2484         'methodname'   => 'user_competency_viewed_in_course',
2485         'classpath'    => '',
2486         'description'  => 'Log the user competency viewed in course event',
2487         'type'         => 'read',
2488         'capabilities' => 'moodle/competency:usercompetencyview',
2489         'ajax'         => true,
2490         'services'     => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
2491     ),
2492     'core_competency_user_competency_plan_viewed' => array(
2493         'classname'    => 'core_competency\external',
2494         'methodname'   => 'user_competency_plan_viewed',
2495         'classpath'    => '',
2496         'description'  => 'Log the user competency plan viewed event.',
2497         'type'         => 'read',
2498         'capabilities' => 'moodle/competency:usercompetencyview',
2499         'ajax'         => true,
2500         'services'     => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
2501     ),
2502     'core_competency_grade_competency' => array(
2503         'classname'    => 'core_competency\external',
2504         'methodname'   => 'grade_competency',
2505         'classpath'    => '',
2506         'description'  => 'Grade a competency.',
2507         'type'         => 'write',
2508         'capabilities' => 'moodle/competency:competencygrade',
2509         'ajax'         => true,
2510     ),
2511     'core_competency_grade_competency_in_plan' => array(
2512         'classname'    => 'core_competency\external',
2513         'methodname'   => 'grade_competency_in_plan',
2514         'classpath'    => '',
2515         'description'  => 'Grade a competency from the user plan page.',
2516         'type'         => 'write',
2517         'capabilities' => 'moodle/competency:competencygrade',
2518         'ajax'         => true,
2519     ),
2520     'core_competency_grade_competency_in_course' => array(
2521         'classname'    => 'core_competency\external',
2522         'methodname'   => 'grade_competency_in_course',
2523         'classpath'    => '',
2524         'description'  => 'Grade a competency from the course page.',
2525         'type'         => 'write',
2526         'capabilities' => 'moodle/competency:competencygrade',
2527         'ajax'         => true,
2528         'services'     => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
2529     ),
2530     'core_competency_unlink_plan_from_template' => array(
2531         'classname'    => 'core_competency\external',
2532         'methodname'   => 'unlink_plan_from_template',
2533         'classpath'    => '',
2534         'description'  => 'Unlink a plan form it template.',
2535         'type'         => 'write',
2536         'capabilities' => 'moodle/competency:planmanage',
2537         'ajax'         => true,
2538     ),
2539     'core_competency_template_viewed' => array(
2540         'classname'     => 'core_competency\external',
2541         'methodname'    => 'template_viewed',
2542         'classpath'     => '',
2543         'description'   => 'Log event template viewed',
2544         'type'          => 'read',
2545         'capabilities'  => 'moodle/competency:templateview',
2546         'ajax'          => true,
2547     ),
2548     'core_competency_request_review_of_user_evidence_linked_competencies' => array(
2549         'classname'     => 'core_competency\external',
2550         'methodname'    => 'request_review_of_user_evidence_linked_competencies',
2551         'classpath'     => '',
2552         'description'   => 'Send user evidence competencies in review',
2553         'type'          => 'write',
2554         'capabilities'  => 'moodle/competency:userevidencemanageown',
2555         'ajax'          => true,
2556     ),
2557     'core_competency_update_course_competency_settings' => array(
2558         'classname'     => 'core_competency\external',
2559         'methodname'    => 'update_course_competency_settings',
2560         'classpath'     => '',
2561         'description'   => 'Update the course competency settings',
2562         'type'          => 'write',
2563         'capabilities'  => 'moodle/competency:coursecompetencyconfigure',
2564         'ajax'          => true,
2565     ),
2566     'core_competency_delete_evidence' => array(
2567         'classname'     => 'core_competency\external',
2568         'methodname'    => 'delete_evidence',
2569         'classpath'     => '',
2570         'description'   => 'Delete an evidence',
2571         'type'          => 'write',
2572         'capabilities'  => 'moodle/competency:evidencedelete',
2573         'ajax'          => true,
2574         'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
2575     ),
2577     'core_webservice_get_site_info' => array(
2578         'classname' => 'core_webservice_external',
2579         'methodname' => 'get_site_info',
2580         'classpath' => 'webservice/externallib.php',
2581         'description' => 'Return some site info / user info / list web service functions',
2582         'type' => 'read',
2583         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
2584     ),
2586     // Blocks functions.
2587     'core_block_get_course_blocks' => array(
2588         'classname'     => 'core_block_external',
2589         'methodname'    => 'get_course_blocks',
2590         'description'   => 'Returns blocks information for a course.',
2591         'type'          => 'read',
2592         'capabilities'  => '',
2593         'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
2594     ),
2596     'core_block_get_dashboard_blocks' => array(
2597         'classname'     => 'core_block_external',
2598         'methodname'    => 'get_dashboard_blocks',
2599         'description'   => 'Returns blocks information for the given user dashboard.',
2600         'type'          => 'read',
2601         'capabilities'  => '',
2602         'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
2603     ),
2605     // Filters functions.
2606     'core_filters_get_available_in_context' => array(
2607         'classname'   => 'core_filters\external',
2608         'methodname'  => 'get_available_in_context',
2609         'description' => 'Returns the filters available in the given contexts.',
2610         'type'        => 'read',
2611         'services'    => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
2612     ),
2613     'core_customfield_delete_field' => array(
2614         'classname'   => 'core_customfield_external',
2615         'methodname'  => 'delete_field',
2616         'classpath'   => 'customfield/externallib.php',
2617         'description' => 'Deletes an entry',
2618         'type'        => 'write',
2619         'ajax'        => 'true'
2620     ),
2621     'core_customfield_reload_template' => array(
2622         'classname'   => 'core_customfield_external',
2623         'methodname'  => 'reload_template',
2624         'classpath'   => 'customfield/externallib.php',
2625         'description' => 'Reloads template',
2626         'type'        => 'read',
2627         'ajax'        => 'true'
2628     ),
2629     'core_customfield_create_category' => array(
2630         'classname'   => 'core_customfield_external',
2631         'methodname'  => 'create_category',
2632         'classpath'   => 'customfield/externallib.php',
2633         'description' => 'Creates a new category',
2634         'type'        => 'write',
2635         'ajax'        => 'true'
2636     ),
2637     'core_customfield_delete_category' => array(
2638         'classname'   => 'core_customfield_external',
2639         'methodname'  => 'delete_category',
2640         'classpath'   => 'customfield/externallib.php',
2641         'description' => 'Deletes a category',
2642         'type'        => 'write',
2643         'ajax'        => 'true'
2644     ),
2645     'core_customfield_move_field'   => array(
2646         'classname'   => 'core_customfield_external',
2647         'methodname'  => 'move_field',
2648         'classpath'   => 'customfield/externallib.php',
2649         'description' => 'Drag and drop',
2650         'type'        => 'write',
2651         'ajax'        => 'true'
2652     ),
2653     'core_customfield_move_category' => array(
2654         'classname'   => 'core_customfield_external',
2655         'methodname'  => 'move_category',
2656         'classpath'   => 'customfield/externallib.php',
2657         'description' => 'Drag and drop categories',
2658         'type'        => 'write',
2659         'ajax'        => 'true'
2660     ),
2661     'core_h5p_get_trusted_h5p_file' => [
2662         'classname'     => 'core_h5p\external',
2663         'methodname'    => 'get_trusted_h5p_file',
2664         'classpath'     => '',
2665         'description'   => 'Get the H5P file cleaned for Mobile App.',
2666         'type'          => 'read',
2667         'ajax'          => 'true',
2668         'capabilities'  => '',
2669         'services'      => [MOODLE_OFFICIAL_MOBILE_SERVICE],
2670     ],
2671     'core_table_get_dynamic_table_content' => [
2672         'classname' => 'core_table\external\dynamic\get',
2673         'methodname' => 'execute',
2674         'description' => 'Get the dynamic table content raw html',
2675         'type' => 'read',
2676         'ajax' => true,
2677         'services' => [MOODLE_OFFICIAL_MOBILE_SERVICE],
2678     ],
2679     'core_xapi_statement_post' => [
2680         'classname'     => 'core_xapi\external\post_statement',
2681         'methodname'    => 'execute',
2682         'classpath'     => '',
2683         'description'   => 'Post an xAPI statement.',
2684         'type'          => 'write',
2685         'ajax'          => 'true',
2686         'capabilities'  => '',
2687         'services'      => [MOODLE_OFFICIAL_MOBILE_SERVICE],
2688     ],
2689     'core_contentbank_delete_content' => [
2690         'classname'     => 'core_contentbank\external\delete_content',
2691         'methodname'    => 'execute',
2692         'classpath'     => '',
2693         'description'   => 'Delete a content from the content bank.',
2694         'type'          => 'write',
2695         'ajax'          => 'true',
2696         'capabilities'  => 'moodle/contentbank:deleteanycontent',
2697     ],
2698     'core_contentbank_rename_content' => [
2699         'classname'     => 'core_contentbank\external\rename_content',
2700         'methodname'    => 'execute',
2701         'classpath'     => '',
2702         'description'   => 'Rename a content in the content bank.',
2703         'type'          => 'write',
2704         'ajax'          => 'true',
2705         'capabilities'  => 'moodle/contentbank:manageowncontent',
2706     ],
2707     'core_create_userfeedback_action_record' => [
2708         'classname'     => 'core\external\record_userfeedback_action',
2709         'methodname'    => 'execute',
2710         'classpath'     => '',
2711         'description'   => 'Record the action that the user takes in the user feedback notification for future use.',
2712         'type'          => 'write',
2713         'ajax'          => 'true',
2714         'capabilities'  => '',
2715     ],
2716 );
2718 $services = array(
2719    'Moodle mobile web service'  => array(
2720         'functions' => array(), // Unused as we add the service in each function definition, third party services would use this.
2721         'enabled' => 0,
2722         'restrictedusers' => 0,
2723         'shortname' => MOODLE_OFFICIAL_MOBILE_SERVICE,
2724         'downloadfiles' => 1,
2725         'uploadfiles' => 1
2726     ),
2727 );