MDL-6074 blocks: Hide user in online users block
[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_badges_get_user_badges' => array(
70         'classname'     => 'core_badges_external',
71         'methodname'    => 'get_user_badges',
72         'description'   => 'Returns the list of badges awarded to a user.',
73         'type'          => 'read',
74         'capabilities'  => 'moodle/badges:viewotherbadges',
75         'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
76     ),
77     'core_calendar_get_calendar_monthly_view' => array(
78         'classname' => 'core_calendar_external',
79         'methodname' => 'get_calendar_monthly_view',
80         'description' => 'Fetch the monthly view data for a calendar',
81         'classpath' => 'calendar/externallib.php',
82         'type' => 'read',
83         'capabilities' => '',
84         'ajax' => true,
85         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
86     ),
87     'core_calendar_get_calendar_day_view' => array(
88         'classname' => 'core_calendar_external',
89         'methodname' => 'get_calendar_day_view',
90         'description' => 'Fetch the day view data for a calendar',
91         'classpath' => 'calendar/externallib.php',
92         'type' => 'read',
93         'capabilities' => '',
94         'ajax' => true,
95         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
96     ),
97     'core_calendar_get_calendar_upcoming_view' => array(
98         'classname' => 'core_calendar_external',
99         'methodname' => 'get_calendar_upcoming_view',
100         'description' => 'Fetch the upcoming view data for a calendar',
101         'classpath' => 'calendar/externallib.php',
102         'type' => 'read',
103         'capabilities' => '',
104         'ajax' => true,
105         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
106     ),
107     'core_calendar_update_event_start_day' => array(
108         'classname' => 'core_calendar_external',
109         'methodname' => 'update_event_start_day',
110         'description' => 'Update the start day (but not time) for an event.',
111         'classpath' => 'calendar/externallib.php',
112         'type' => 'write',
113         'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries',
114         'ajax' => true,
115     ),
116     'core_calendar_create_calendar_events' => array(
117         'classname' => 'core_calendar_external',
118         'methodname' => 'create_calendar_events',
119         'description' => 'Create calendar events',
120         'classpath' => 'calendar/externallib.php',
121         'type' => 'write',
122         'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries',
123         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
124     ),
125     'core_calendar_delete_calendar_events' => array(
126         'classname' => 'core_calendar_external',
127         'methodname' => 'delete_calendar_events',
128         'description' => 'Delete calendar events',
129         'classpath' => 'calendar/externallib.php',
130         'type' => 'write',
131         'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries',
132         'ajax' => true,
133         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
134     ),
135     'core_calendar_get_calendar_events' => array(
136         'classname' => 'core_calendar_external',
137         'methodname' => 'get_calendar_events',
138         'description' => 'Get calendar events',
139         'classpath' => 'calendar/externallib.php',
140         'type' => 'read',
141         'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries',
142         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
143     ),
144     'core_calendar_get_action_events_by_timesort' => array(
145         'classname' => 'core_calendar_external',
146         'methodname' => 'get_calendar_action_events_by_timesort',
147         'description' => 'Get calendar action events by tiemsort',
148         'classpath' => 'calendar/externallib.php',
149         'type' => 'read',
150         'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries',
151         'ajax' => true,
152         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
153     ),
154     'core_calendar_get_action_events_by_course' => array(
155         'classname' => 'core_calendar_external',
156         'methodname' => 'get_calendar_action_events_by_course',
157         'description' => 'Get calendar action events by course',
158         'classpath' => 'calendar/externallib.php',
159         'type' => 'read',
160         'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries',
161         'ajax' => true,
162         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
163     ),
164     'core_calendar_get_action_events_by_courses' => array(
165         'classname' => 'core_calendar_external',
166         'methodname' => 'get_calendar_action_events_by_courses',
167         'description' => 'Get calendar action events by courses',
168         'classpath' => 'calendar/externallib.php',
169         'type' => 'read',
170         'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries',
171         'ajax' => true,
172         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
173     ),
174     'core_calendar_get_calendar_event_by_id' => array(
175         'classname' => 'core_calendar_external',
176         'methodname' => 'get_calendar_event_by_id',
177         'description' => 'Get calendar event by id',
178         'classpath' => 'calendar/externallib.php',
179         'type' => 'read',
180         'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries',
181         'ajax' => true,
182         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
183     ),
184     'core_calendar_submit_create_update_form' => array(
185         'classname' => 'core_calendar_external',
186         'methodname' => 'submit_create_update_form',
187         'description' => 'Submit form data for event form',
188         'classpath' => 'calendar/externallib.php',
189         'type' => 'write',
190         'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries',
191         'ajax' => true,
192     ),
193     'core_cohort_add_cohort_members' => array(
194         'classname' => 'core_cohort_external',
195         'methodname' => 'add_cohort_members',
196         'classpath' => 'cohort/externallib.php',
197         'description' => 'Adds cohort members.',
198         'type' => 'write',
199         'capabilities' => 'moodle/cohort:assign'
200     ),
201     'core_cohort_create_cohorts' => array(
202         'classname' => 'core_cohort_external',
203         'methodname' => 'create_cohorts',
204         'classpath' => 'cohort/externallib.php',
205         'description' => 'Creates new cohorts.',
206         'type' => 'write',
207         'capabilities' => 'moodle/cohort:manage'
208     ),
209     'core_cohort_delete_cohort_members' => array(
210         'classname' => 'core_cohort_external',
211         'methodname' => 'delete_cohort_members',
212         'classpath' => 'cohort/externallib.php',
213         'description' => 'Deletes cohort members.',
214         'type' => 'write',
215         'capabilities' => 'moodle/cohort:assign'
216     ),
217     'core_cohort_delete_cohorts' => array(
218         'classname' => 'core_cohort_external',
219         'methodname' => 'delete_cohorts',
220         'classpath' => 'cohort/externallib.php',
221         'description' => 'Deletes all specified cohorts.',
222         'type' => 'write',
223         'capabilities' => 'moodle/cohort:manage'
224     ),
225     'core_cohort_get_cohort_members' => array(
226         'classname' => 'core_cohort_external',
227         'methodname' => 'get_cohort_members',
228         'classpath' => 'cohort/externallib.php',
229         'description' => 'Returns cohort members.',
230         'type' => 'read',
231         'capabilities' => 'moodle/cohort:view'
232     ),
233     'core_cohort_search_cohorts' => array(
234         'classname' => 'core_cohort_external',
235         'methodname' => 'search_cohorts',
236         'classpath' => 'cohort/externallib.php',
237         'description' => 'Search for cohorts.',
238         'type' => 'read',
239         'ajax' => true,
240         'capabilities' => 'moodle/cohort:view'
241     ),
242     'core_cohort_get_cohorts' => array(
243         'classname' => 'core_cohort_external',
244         'methodname' => 'get_cohorts',
245         'classpath' => 'cohort/externallib.php',
246         'description' => 'Returns cohort details.',
247         'type' => 'read',
248         'capabilities' => 'moodle/cohort:view'
249     ),
250     'core_cohort_update_cohorts' => array(
251         'classname' => 'core_cohort_external',
252         'methodname' => 'update_cohorts',
253         'classpath' => 'cohort/externallib.php',
254         'description' => 'Updates existing cohorts.',
255         'type' => 'write',
256         'capabilities' => 'moodle/cohort:manage'
257     ),
258     'core_comment_get_comments' => array(
259         'classname' => 'core_comment_external',
260         'methodname' => 'get_comments',
261         'description' => 'Returns comments.',
262         'type' => 'read',
263         'capabilities' => 'moodle/comment:view',
264         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
265     ),
266     'core_completion_get_activities_completion_status' => array(
267         'classname' => 'core_completion_external',
268         'methodname' => 'get_activities_completion_status',
269         'description' => 'Return the activities completion status for a user in a course.',
270         'type' => 'read',
271         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
272     ),
273     'core_completion_get_course_completion_status' => array(
274         'classname' => 'core_completion_external',
275         'methodname' => 'get_course_completion_status',
276         'description' => 'Returns course completion status.',
277         'type' => 'read',
278         'capabilities' => 'report/completion:view',
279         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
280     ),
281     'core_completion_mark_course_self_completed' => array(
282         'classname' => 'core_completion_external',
283         'methodname' => 'mark_course_self_completed',
284         'description' => 'Update the course completion status for the current user (if course self-completion is enabled).',
285         'type' => 'write',
286         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
287     ),
288     'core_completion_update_activity_completion_status_manually' => array(
289         'classname' => 'core_completion_external',
290         'methodname' => 'update_activity_completion_status_manually',
291         'description' => 'Update completion status for the current user in an activity, only for activities with manual tracking.',
292         'type' => 'write',
293         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
294     ),
295     'core_completion_override_activity_completion_status' => array(
296         'classname'     => 'core_completion_external',
297         'methodname'    => 'override_activity_completion_status',
298         'description'   => 'Update completion status for a user in an activity by overriding it.',
299         'type'          => 'write',
300         'capabilities'  => 'moodle/course:overridecompletion',
301         'ajax'          => true,
302     ),
303     'core_course_create_categories' => array(
304         'classname' => 'core_course_external',
305         'methodname' => 'create_categories',
306         'classpath' => 'course/externallib.php',
307         'description' => 'Create course categories',
308         'type' => 'write',
309         'capabilities' => 'moodle/category:manage'
310     ),
311     'core_course_create_courses' => array(
312         'classname' => 'core_course_external',
313         'methodname' => 'create_courses',
314         'classpath' => 'course/externallib.php',
315         'description' => 'Create new courses',
316         'type' => 'write',
317         'capabilities' => 'moodle/course:create, moodle/course:visibility'
318     ),
319     'core_course_delete_categories' => array(
320         'classname' => 'core_course_external',
321         'methodname' => 'delete_categories',
322         'classpath' => 'course/externallib.php',
323         'description' => 'Delete course categories',
324         'type' => 'write',
325         'capabilities' => 'moodle/category:manage'
326     ),
327     'core_course_delete_courses' => array(
328         'classname' => 'core_course_external',
329         'methodname' => 'delete_courses',
330         'classpath' => 'course/externallib.php',
331         'description' => 'Deletes all specified courses',
332         'type' => 'write',
333         'capabilities' => 'moodle/course:delete'
334     ),
335     'core_course_delete_modules' => array(
336         'classname' => 'core_course_external',
337         'methodname' => 'delete_modules',
338         'classpath' => 'course/externallib.php',
339         'description' => 'Deletes all specified module instances',
340         'type' => 'write',
341         'capabilities' => 'moodle/course:manageactivities'
342     ),
343     'core_course_duplicate_course' => array(
344         'classname' => 'core_course_external',
345         'methodname' => 'duplicate_course',
346         'classpath' => 'course/externallib.php',
347         'description' => 'Duplicate an existing course (creating a new one).',
348         'type' => 'write',
349         'capabilities' => 'moodle/backup:backupcourse, moodle/restore:restorecourse, moodle/course:create'
350     ),
351     'core_course_get_categories' => array(
352         'classname' => 'core_course_external',
353         'methodname' => 'get_categories',
354         'classpath' => 'course/externallib.php',
355         'description' => 'Return category details',
356         'type' => 'read',
357         'capabilities' => 'moodle/category:viewhiddencategories',
358         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
359     ),
360     'core_course_get_contents' => array(
361         'classname' => 'core_course_external',
362         'methodname' => 'get_course_contents',
363         'classpath' => 'course/externallib.php',
364         'description' => 'Get course contents',
365         'type' => 'read',
366         'capabilities' => 'moodle/course:update, moodle/course:viewhiddencourses',
367         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
368     ),
369     'core_course_get_course_module' => array(
370         'classname' => 'core_course_external',
371         'methodname' => 'get_course_module',
372         'classpath' => 'course/externallib.php',
373         'description' => 'Return information about a course module',
374         'type' => 'read',
375         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
376     ),
377     'core_course_get_course_module_by_instance' => array(
378         'classname' => 'core_course_external',
379         'methodname' => 'get_course_module_by_instance',
380         'classpath' => 'course/externallib.php',
381         'description' => 'Return information about a given module name and instance id',
382         'type' => 'read',
383         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
384     ),
385     'core_course_get_module' => array(
386         'classname'   => 'core_course_external',
387         'methodname'  => 'get_module',
388         'classpath'   => 'course/externallib.php',
389         'description' => 'Returns html with one activity module on course page',
390         'type'        => 'read',
391         'ajax'        => true,
392     ),
393     'core_course_edit_module' => array(
394         'classname'   => 'core_course_external',
395         'methodname'  => 'edit_module',
396         'classpath'   => 'course/externallib.php',
397         'description' => 'Performs an action on course module (change visibility, duplicate, delete, etc.)',
398         'type'        => 'write',
399         'ajax'        => true,
400     ),
401     'core_course_edit_section' => array(
402         'classname'   => 'core_course_external',
403         'methodname'  => 'edit_section',
404         'classpath'   => 'course/externallib.php',
405         'description' => 'Performs an action on course section (change visibility, set marker, delete)',
406         'type'        => 'write',
407         'ajax'        => true,
408     ),
409     'core_course_get_courses' => array(
410         'classname' => 'core_course_external',
411         'methodname' => 'get_courses',
412         'classpath' => 'course/externallib.php',
413         'description' => 'Return course details',
414         'type' => 'read',
415         'capabilities' => 'moodle/course:view, moodle/course:update, moodle/course:viewhiddencourses',
416         'ajax' => true,
417         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
418     ),
419     'core_course_import_course' => array(
420         'classname' => 'core_course_external',
421         'methodname' => 'import_course',
422         'classpath' => 'course/externallib.php',
423         'description' => 'Import course data from a course into another course. Does not include any user data.',
424         'type' => 'write',
425         'capabilities' => 'moodle/backup:backuptargetimport, moodle/restore:restoretargetimport'
426     ),
427     'core_course_search_courses' => array(
428         'classname' => 'core_course_external',
429         'methodname' => 'search_courses',
430         'classpath' => 'course/externallib.php',
431         'description' => 'Search courses by (name, module, block, tag)',
432         'type' => 'read',
433         'ajax' => true,
434         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
435     ),
436     'core_course_update_categories' => array(
437         'classname' => 'core_course_external',
438         'methodname' => 'update_categories',
439         'classpath' => 'course/externallib.php',
440         'description' => 'Update categories',
441         'type' => 'write',
442         'capabilities' => 'moodle/category:manage',
443     ),
444     'core_course_update_courses' => array(
445         'classname' => 'core_course_external',
446         'methodname' => 'update_courses',
447         'classpath' => 'course/externallib.php',
448         'description' => 'Update courses',
449         'type' => 'write',
450         'capabilities' => 'moodle/course:update, moodle/course:changecategory, moodle/course:changefullname, '
451             . 'moodle/course:changeshortname, moodle/course:changeidnumber, moodle/course:changesummary, moodle/course:visibility'
452     ),
453     'core_course_view_course' => array(
454         'classname' => 'core_course_external',
455         'methodname' => 'view_course',
456         'classpath' => 'course/externallib.php',
457         'description' => 'Log that the course was viewed',
458         'type' => 'write',
459         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
460     ),
461     'core_course_get_activities_overview' => array(
462         'classname' => 'core_course_external',
463         'methodname' => 'get_activities_overview',
464         'classpath' => 'course/externallib.php',
465         'description' => '** DEPRECATED ** Please do not call this function any more.
466                           Return activities overview for the given courses.',
467         'type' => 'read',
468         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
469     ),
470     'core_course_get_user_navigation_options' => array(
471         'classname' => 'core_course_external',
472         'methodname' => 'get_user_navigation_options',
473         'classpath' => 'course/externallib.php',
474         'description' => 'Return a list of navigation options in a set of courses that are avaialable or not for the current user.',
475         'type' => 'read',
476         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
477     ),
478     'core_course_get_user_administration_options' => array(
479         'classname' => 'core_course_external',
480         'methodname' => 'get_user_administration_options',
481         'classpath' => 'course/externallib.php',
482         'description' => 'Return a list of administration options in a set of courses that are avaialable or not for the current
483                             user.',
484         'type' => 'read',
485         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
486     ),
487     'core_course_get_courses_by_field' => array(
488         'classname' => 'core_course_external',
489         'methodname' => 'get_courses_by_field',
490         'classpath' => 'course/externallib.php',
491         'description' => 'Get courses matching a specific field (id/s, shortname, idnumber, category)',
492         'type' => 'read',
493         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
494     ),
495     'core_course_check_updates' => array(
496         'classname' => 'core_course_external',
497         'methodname' => 'check_updates',
498         'classpath' => 'course/externallib.php',
499         'description' => 'Check if there is updates affecting the user for the given course and contexts.',
500         'type' => 'read',
501         'ajax' => true,
502         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
503     ),
504     'core_course_get_updates_since' => array(
505         'classname' => 'core_course_external',
506         'methodname' => 'get_updates_since',
507         'classpath' => 'course/externallib.php',
508         'description' => 'Check if there are updates affecting the user for the given course since the given time stamp.',
509         'type' => 'read',
510         'ajax' => true,
511         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
512     ),
513     'core_enrol_get_course_enrolment_methods' => array(
514         'classname' => 'core_enrol_external',
515         'methodname' => 'get_course_enrolment_methods',
516         'classpath' => 'enrol/externallib.php',
517         'description' => 'Get the list of course enrolment methods',
518         'type' => 'read',
519         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
520     ),
521     'core_enrol_get_enrolled_users' => array(
522         'classname' => 'core_enrol_external',
523         'methodname' => 'get_enrolled_users',
524         'classpath' => 'enrol/externallib.php',
525         'description' => 'Get enrolled users by course id.',
526         'type' => 'read',
527         'capabilities' => 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update, '
528             . 'moodle/site:accessallgroups',
529         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
530     ),
531     'core_enrol_get_enrolled_users_with_capability' => array(
532         'classname' => 'core_enrol_external',
533         'methodname' => 'get_enrolled_users_with_capability',
534         'classpath' => 'enrol/externallib.php',
535         'description' => 'For each course and capability specified, return a list of the users that are enrolled in the course
536                                   and have that capability',
537         'type' => 'read',
538     ),
539     'core_enrol_get_potential_users' => array(
540         'classname' => 'core_enrol_external',
541         'methodname' => 'get_potential_users',
542         'classpath' => 'enrol/externallib.php',
543         'description' => 'Get the list of potential users to enrol',
544         'ajax' => true,
545         'type' => 'read',
546         'capabilities' => 'moodle/course:enrolreview'
547     ),
548     'core_enrol_get_users_courses' => array(
549         'classname' => 'core_enrol_external',
550         'methodname' => 'get_users_courses',
551         'classpath' => 'enrol/externallib.php',
552         'description' => 'Get the list of courses where a user is enrolled in',
553         'type' => 'read',
554         'capabilities' => 'moodle/course:viewparticipants',
555         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
556     ),
557     'core_enrol_edit_user_enrolment' => array(
558         'classname' => 'core_enrol_external',
559         'methodname' => 'edit_user_enrolment',
560         'classpath' => 'enrol/externallib.php',
561         'description' => 'External function that updates a given user enrolment',
562         'type' => 'write',
563         'ajax' => true,
564     ),
565     'core_enrol_unenrol_user_enrolment' => array(
566         'classname' => 'core_enrol_external',
567         'methodname' => 'unenrol_user_enrolment',
568         'classpath' => 'enrol/externallib.php',
569         'description' => 'External function that unenrols a given user enrolment',
570         'type' => 'write',
571         'ajax' => true,
572     ),
573     'core_fetch_notifications' => array(
574         'classname' => 'core_external',
575         'methodname' => 'fetch_notifications',
576         'classpath' => 'lib/external/externallib.php',
577         'description' => 'Return a list of notifications for the current session',
578         'type' => 'read',
579         'loginrequired' => false,
580         'ajax' => true,
581     ),
582     'core_files_get_files' => array(
583         'classname' => 'core_files_external',
584         'methodname' => 'get_files',
585         'description' => 'browse moodle files',
586         'type' => 'read',
587         'classpath' => 'files/externallib.php',
588         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
589     ),
590     'core_files_upload' => array(
591         'classname' => 'core_files_external',
592         'methodname' => 'upload',
593         'description' => 'upload a file to moodle',
594         'type'        => 'write',
595         'classpath'   => 'files/externallib.php',
596     ),
597     'core_form_get_filetypes_browser_data' => array(
598         'classname' => 'core_form\external',
599         'methodname' => 'get_filetypes_browser_data',
600         'classpath' => '',
601         'description' => 'Provides data for the filetypes element browser.',
602         'type' => 'read',
603         'loginrequired' => false,
604         'ajax' => true,
605     ),
606     'core_get_component_strings' => array(
607         'classname' => 'core_external',
608         'methodname' => 'get_component_strings',
609         'classpath' => 'lib/external/externallib.php',
610         'description' => 'Return all raw strings (with {$a->xxx}), for a specific component ' .
611             '- similar to core get_component_strings(), call',
612         'type' => 'read',
613         'loginrequired' => false,
614         'ajax' => true,
615         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
616     ),
617     'core_get_fragment' => array(
618         'classname' => 'core_external',
619         'methodname' => 'get_fragment',
620         'classpath' => 'lib/external/externallib.php',
621         'description' => 'Return a fragment for inclusion, such as a JavaScript page.',
622         'type' => 'read',
623         'ajax' => true,
624     ),
625     'core_get_string' => array(
626         'classname' => 'core_external',
627         'methodname' => 'get_string',
628         'classpath' => 'lib/external/externallib.php',
629         'description' => 'Return a translated string - similar to core get_string(), call',
630         'type' => 'read',
631         'loginrequired' => false,
632         'ajax' => true,
633     ),
634     'core_get_strings' => array(
635         'classname' => 'core_external',
636         'methodname' => 'get_strings',
637         'classpath' => 'lib/external/externallib.php',
638         'description' => 'Return some translated strings - like several core get_string(), calls',
639         'type' => 'read',
640         'loginrequired' => false,
641         'ajax' => true,
642     ),
643     'core_get_user_dates' => array(
644         'classname' => 'core_external',
645         'methodname' => 'get_user_dates',
646         'classpath' => 'lib/external/externallib.php',
647         'description' => 'Return formatted timestamps',
648         'type' => 'read',
649         'ajax' => true,
650     ),
651     'core_grades_get_grades' => array(
652         'classname' => 'core_grades_external',
653         'methodname' => 'get_grades',
654         'description' => '** DEPRECATED ** Please do not call this function any more.
655                                      Returns student course total grade and grades for activities.
656                                      This function does not return category or manual items.
657                                      This function is suitable for managers or teachers not students.',
658         'type' => 'read',
659         'capabilities' => 'moodle/grade:view, moodle/grade:viewall, moodle/grade:viewhidden'
660     ),
661     'core_grades_update_grades' => array(
662         'classname' => 'core_grades_external',
663         'methodname' => 'update_grades',
664         'description' => 'Update a grade item and associated student grades.',
665         'type' => 'write',
666     ),
667     'core_grading_get_definitions' => array(
668         'classname' => 'core_grading_external',
669         'methodname' => 'get_definitions',
670         'description' => 'Get grading definitions',
671         'type' => 'read',
672     ),
673     'core_grading_get_gradingform_instances' => array(
674         'classname' => 'core_grading_external',
675         'methodname' => 'get_gradingform_instances',
676         'description' => 'Get grading form instances',
677         'type' => 'read',
678     ),
679     'core_grading_save_definitions' => array(
680         'classname' => 'core_grading_external',
681         'methodname' => 'save_definitions',
682         'description' => 'Save grading definitions',
683         'type' => 'write',
684     ),
685     'core_group_add_group_members' => array(
686         'classname' => 'core_group_external',
687         'methodname' => 'add_group_members',
688         'classpath' => 'group/externallib.php',
689         'description' => 'Adds group members.',
690         'type' => 'write',
691         'capabilities' => 'moodle/course:managegroups',
692     ),
693     'core_group_assign_grouping' => array(
694         'classname' => 'core_group_external',
695         'methodname' => 'assign_grouping',
696         'classpath' => 'group/externallib.php',
697         'description' => 'Assing groups from groupings',
698         'type' => 'write',
699     ),
700     'core_group_create_groupings' => array(
701         'classname' => 'core_group_external',
702         'methodname' => 'create_groupings',
703         'classpath' => 'group/externallib.php',
704         'description' => 'Creates new groupings',
705         'type' => 'write',
706     ),
707     'core_group_create_groups' => array(
708         'classname' => 'core_group_external',
709         'methodname' => 'create_groups',
710         'classpath' => 'group/externallib.php',
711         'description' => 'Creates new groups.',
712         'type' => 'write',
713         'capabilities' => 'moodle/course:managegroups'
714     ),
715     'core_group_delete_group_members' => array(
716         'classname' => 'core_group_external',
717         'methodname' => 'delete_group_members',
718         'classpath' => 'group/externallib.php',
719         'description' => 'Deletes group members.',
720         'type' => 'write',
721         'capabilities' => 'moodle/course:managegroups'
722     ),
723     'core_group_delete_groupings' => array(
724         'classname' => 'core_group_external',
725         'methodname' => 'delete_groupings',
726         'classpath' => 'group/externallib.php',
727         'description' => 'Deletes all specified groupings.',
728         'type' => 'write',
729     ),
730     'core_group_delete_groups' => array(
731         'classname' => 'core_group_external',
732         'methodname' => 'delete_groups',
733         'classpath' => 'group/externallib.php',
734         'description' => 'Deletes all specified groups.',
735         'type' => 'write',
736         'capabilities' => 'moodle/course:managegroups'
737     ),
738     'core_group_get_activity_allowed_groups' => array(
739         'classname' => 'core_group_external',
740         'methodname' => 'get_activity_allowed_groups',
741         'classpath' => 'group/externallib.php',
742         'description' => 'Gets a list of groups that the user is allowed to access within the specified activity.',
743         'type' => 'read',
744         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
745     ),
746     'core_group_get_activity_groupmode' => array(
747         'classname' => 'core_group_external',
748         'methodname' => 'get_activity_groupmode',
749         'classpath' => 'group/externallib.php',
750         'description' => 'Returns effective groupmode used in a given activity.',
751         'type' => 'read',
752         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
753     ),
754     'core_group_get_course_groupings' => array(
755         'classname' => 'core_group_external',
756         'methodname' => 'get_course_groupings',
757         'classpath' => 'group/externallib.php',
758         'description' => 'Returns all groupings in specified course.',
759         'type' => 'read',
760     ),
761     'core_group_get_course_groups' => array(
762         'classname' => 'core_group_external',
763         'methodname' => 'get_course_groups',
764         'classpath' => 'group/externallib.php',
765         'description' => 'Returns all groups in specified course.',
766         'type' => 'read',
767         'capabilities' => 'moodle/course:managegroups'
768     ),
769     'core_group_get_course_user_groups' => array(
770         'classname' => 'core_group_external',
771         'methodname' => 'get_course_user_groups',
772         'classpath' => 'group/externallib.php',
773         'description' => 'Returns all groups in specified course for the specified user.',
774         'type' => 'read',
775         'capabilities' => 'moodle/course:managegroups',
776         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
777     ),
778     'core_group_get_group_members' => array(
779         'classname' => 'core_group_external',
780         'methodname' => 'get_group_members',
781         'classpath' => 'group/externallib.php',
782         'description' => 'Returns group members.',
783         'type' => 'read',
784         'capabilities' => 'moodle/course:managegroups'
785     ),
786     'core_group_get_groupings' => array(
787         'classname' => 'core_group_external',
788         'methodname' => 'get_groupings',
789         'classpath' => 'group/externallib.php',
790         'description' => 'Returns groupings details.',
791         'type' => 'read',
792     ),
793     'core_group_get_groups' => array(
794         'classname' => 'core_group_external',
795         'methodname' => 'get_groups',
796         'classpath' => 'group/externallib.php',
797         'description' => 'Returns group details.',
798         'type' => 'read',
799         'capabilities' => 'moodle/course:managegroups'
800     ),
801     'core_group_unassign_grouping' => array(
802         'classname' => 'core_group_external',
803         'methodname' => 'unassign_grouping',
804         'classpath' => 'group/externallib.php',
805         'description' => 'Unassing groups from groupings',
806         'type' => 'write',
807     ),
808     'core_group_update_groupings' => array(
809         'classname' => 'core_group_external',
810         'methodname' => 'update_groupings',
811         'classpath' => 'group/externallib.php',
812         'description' => 'Updates existing groupings',
813         'type' => 'write',
814     ),
815     'core_message_block_contacts' => array(
816         'classname' => 'core_message_external',
817         'methodname' => 'block_contacts',
818         'classpath' => 'message/externallib.php',
819         'description' => 'Block contacts',
820         'type' => 'write',
821         'ajax' => true,
822         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
823     ),
824     'core_message_create_contacts' => array(
825         'classname' => 'core_message_external',
826         'methodname' => 'create_contacts',
827         'classpath' => 'message/externallib.php',
828         'description' => 'Add contacts to the contact list',
829         'type' => 'write',
830         'ajax' => true,
831         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
832         'ajax' => true,
833     ),
834     'core_message_delete_contacts' => array(
835         'classname' => 'core_message_external',
836         'methodname' => 'delete_contacts',
837         'classpath' => 'message/externallib.php',
838         'description' => 'Remove contacts from the contact list',
839         'type' => 'write',
840         'ajax' => true,
841         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
842         'ajax' => true,
843     ),
844     'core_message_delete_conversation' => array(
845         'classname' => 'core_message_external',
846         'methodname' => 'delete_conversation',
847         'classpath' => 'message/externallib.php',
848         'description' => 'Deletes a conversation.',
849         'type' => 'write',
850         'capabilities' => 'moodle/site:deleteownmessage',
851         'ajax' => true,
852         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
853     ),
854     'core_message_delete_message' => array(
855         'classname' => 'core_message_external',
856         'methodname' => 'delete_message',
857         'classpath' => 'message/externallib.php',
858         'description' => 'Deletes a message.',
859         'type' => 'write',
860         'capabilities' => 'moodle/site:deleteownmessage',
861         'ajax' => true,
862         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
863     ),
864     'core_message_get_blocked_users' => array(
865         'classname' => 'core_message_external',
866         'methodname' => 'get_blocked_users',
867         'classpath' => 'message/externallib.php',
868         'description' => 'Retrieve a list of users blocked',
869         'type' => 'read',
870         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
871     ),
872     'core_message_data_for_messagearea_search_messages' => array(
873         'classname' => 'core_message_external',
874         'methodname' => 'data_for_messagearea_search_messages',
875         'classpath' => 'message/externallib.php',
876         'description' => 'Retrieve the template data for searching for messages',
877         'type' => 'read',
878         'ajax' => true,
879         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
880     ),
881     'core_message_data_for_messagearea_search_users' => array(
882         'classname' => 'core_message_external',
883         'methodname' => 'data_for_messagearea_search_users',
884         'classpath' => 'message/externallib.php',
885         'description' => 'Retrieve the template data for searching for people',
886         'type' => 'read',
887         'ajax' => true,
888     ),
889     'core_message_data_for_messagearea_search_users_in_course' => array(
890         'classname' => 'core_message_external',
891         'methodname' => 'data_for_messagearea_search_users_in_course',
892         'classpath' => 'message/externallib.php',
893         'description' => 'Retrieve the template data for searching for people in a course',
894         'type' => 'read',
895         'ajax' => true,
896     ),
897     'core_message_data_for_messagearea_conversations' => array(
898         'classname' => 'core_message_external',
899         'methodname' => 'data_for_messagearea_conversations',
900         'classpath' => 'message/externallib.php',
901         'description' => 'Retrieve the template data for the conversation list',
902         'type' => 'read',
903         'ajax' => true,
904         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
905     ),
906     'core_message_data_for_messagearea_contacts' => array(
907         'classname' => 'core_message_external',
908         'methodname' => 'data_for_messagearea_contacts',
909         'classpath' => 'message/externallib.php',
910         'description' => 'Retrieve the template data for the contact list',
911         'type' => 'read',
912         'ajax' => true,
913         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
914     ),
915     'core_message_data_for_messagearea_messages' => array(
916         'classname' => 'core_message_external',
917         'methodname' => 'data_for_messagearea_messages',
918         'classpath' => 'message/externallib.php',
919         'description' => 'Retrieve the template data for the messages',
920         'type' => 'read',
921         'ajax' => true,
922         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
923     ),
924     'core_message_data_for_messagearea_get_most_recent_message' => array(
925         'classname' => 'core_message_external',
926         'methodname' => 'data_for_messagearea_get_most_recent_message',
927         'classpath' => 'message/externallib.php',
928         'description' => 'Retrieve the template data for the most recent message',
929         'type' => 'read',
930         'ajax' => true,
931     ),
932     'core_message_data_for_messagearea_get_profile' => array(
933         'classname' => 'core_message_external',
934         'methodname' => 'data_for_messagearea_get_profile',
935         'classpath' => 'message/externallib.php',
936         'description' => 'Retrieve the template data for the users\'s profile',
937         'type' => 'read',
938         'ajax' => true,
939     ),
940     'core_message_get_contacts' => array(
941         'classname' => 'core_message_external',
942         'methodname' => 'get_contacts',
943         'classpath' => 'message/externallib.php',
944         'description' => 'Retrieve the contact list',
945         'type' => 'read',
946         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
947     ),
948     'core_message_get_messages' => array(
949         'classname' => 'core_message_external',
950         'methodname' => 'get_messages',
951         'classpath' => 'message/externallib.php',
952         'description' => 'Retrieve a list of messages sent and received by a user (conversations, notifications or both)',
953         'type' => 'read',
954         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
955         'ajax' => true,
956     ),
957     'core_message_get_unread_conversations_count' => array(
958         'classname' => 'core_message_external',
959         'methodname' => 'get_unread_conversations_count',
960         'classpath' => 'message/externallib.php',
961         'description' => 'Retrieve the count of unread conversations for a given user',
962         'type' => 'read',
963         'ajax' => true,
964         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
965     ),
966     'core_message_mark_all_notifications_as_read' => array(
967         'classname' => 'core_message_external',
968         'methodname' => 'mark_all_notifications_as_read',
969         'classpath' => 'message/externallib.php',
970         'description' => 'Mark all notifications as read for a given user',
971         'type' => 'write',
972         'ajax' => true,
973         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
974     ),
975     'core_message_mark_all_messages_as_read' => array(
976         'classname' => 'core_message_external',
977         'methodname' => 'mark_all_messages_as_read',
978         'classpath' => 'message/externallib.php',
979         'description' => 'Mark all messages as read for a given user',
980         'type' => 'write',
981         'ajax' => true,
982         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
983     ),
984     'core_message_mark_message_read' => array(
985         'classname' => 'core_message_external',
986         'methodname' => 'mark_message_read',
987         'classpath' => 'message/externallib.php',
988         'description' => 'Mark a single message as read, trigger message_viewed event.',
989         'type' => 'write',
990         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
991         'ajax' => true,
992     ),
993     'core_message_mark_notification_read' => array(
994         'classname' => 'core_message_external',
995         'methodname' => 'mark_notification_read',
996         'classpath' => 'message/externallib.php',
997         'description' => 'Mark a single notification as read, trigger notification_viewed event.',
998         'type' => 'write',
999         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1000         'ajax' => true,
1001     ),
1002     'core_message_message_processor_config_form' => array(
1003         'classname' => 'core_message_external',
1004         'methodname' => 'message_processor_config_form',
1005         'classpath' => 'message/externallib.php',
1006         'description' => 'Process the message processor config form',
1007         'type' => 'write',
1008         'ajax' => true,
1009         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1010     ),
1011     'core_message_get_message_processor' => array(
1012         'classname' => 'core_message_external',
1013         'methodname' => 'get_message_processor',
1014         'classpath' => 'message/externallib.php',
1015         'description' => 'Get a message processor',
1016         'type' => 'read',
1017         'ajax' => true,
1018     ),
1019     'core_message_search_contacts' => array(
1020         'classname' => 'core_message_external',
1021         'methodname' => 'search_contacts',
1022         'classpath' => 'message/externallib.php',
1023         'description' => 'Search for contacts',
1024         'type' => 'read',
1025         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1026     ),
1027     'core_message_send_instant_messages' => array(
1028         'classname' => 'core_message_external',
1029         'methodname' => 'send_instant_messages',
1030         'classpath' => 'message/externallib.php',
1031         'description' => 'Send instant messages',
1032         'type' => 'write',
1033         'capabilities' => 'moodle/site:sendmessage',
1034         'ajax' => true,
1035         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1036     ),
1037     'core_message_unblock_contacts' => array(
1038         'classname' => 'core_message_external',
1039         'methodname' => 'unblock_contacts',
1040         'classpath' => 'message/externallib.php',
1041         'description' => 'Unblock contacts',
1042         'type' => 'write',
1043         'ajax' => true,
1044         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1045     ),
1046     'core_message_get_user_notification_preferences' => array(
1047         'classname' => 'core_message_external',
1048         'methodname' => 'get_user_notification_preferences',
1049         'classpath' => 'message/externallib.php',
1050         'description' => 'Get the notification preferences for a given user.',
1051         'type' => 'read',
1052         'capabilities' => 'moodle/user:editownmessageprofile',
1053         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1054     ),
1055     'core_message_get_user_message_preferences' => array(
1056         'classname' => 'core_message_external',
1057         'methodname' => 'get_user_message_preferences',
1058         'classpath' => 'message/externallib.php',
1059         'description' => 'Get the message preferences for a given user.',
1060         'type' => 'read',
1061         'capabilities' => 'moodle/user:editownmessageprofile',
1062         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1063     ),
1064     'core_notes_create_notes' => array(
1065         'classname' => 'core_notes_external',
1066         'methodname' => 'create_notes',
1067         'classpath' => 'notes/externallib.php',
1068         'description' => 'Create notes',
1069         'type' => 'write',
1070         'ajax' => true,
1071         'capabilities' => 'moodle/notes:manage',
1072         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1073     ),
1074     'core_notes_delete_notes' => array(
1075         'classname' => 'core_notes_external',
1076         'methodname' => 'delete_notes',
1077         'classpath' => 'notes/externallib.php',
1078         'description' => 'Delete notes',
1079         'type' => 'write',
1080         'capabilities' => 'moodle/notes:manage',
1081         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1082     ),
1083     'core_notes_get_course_notes' => array(
1084         'classname' => 'core_notes_external',
1085         'methodname' => 'get_course_notes',
1086         'classpath' => 'notes/externallib.php',
1087         'description' => 'Returns all notes in specified course (or site), for the specified user.',
1088         'type' => 'read',
1089         'capabilities' => 'moodle/notes:view',
1090         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1091     ),
1092     'core_notes_get_notes' => array(
1093         'classname' => 'core_notes_external',
1094         'methodname' => 'get_notes',
1095         'classpath' => 'notes/externallib.php',
1096         'description' => 'Get notes',
1097         'type' => 'read',
1098         'capabilities' => 'moodle/notes:view'
1099     ),
1100     'core_notes_update_notes' => array(
1101         'classname' => 'core_notes_external',
1102         'methodname' => 'update_notes',
1103         'classpath' => 'notes/externallib.php',
1104         'description' => 'Update notes',
1105         'type' => 'write',
1106         'capabilities' => 'moodle/notes:manage'
1107     ),
1108     'core_notes_view_notes' => array(
1109         'classname' => 'core_notes_external',
1110         'methodname' => 'view_notes',
1111         'classpath' => 'notes/externallib.php',
1112         'description' => 'Simulates the web interface view of notes/index.php: trigger events.',
1113         'type' => 'write',
1114         'capabilities' => 'moodle/notes:view',
1115         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1116     ),
1117     'core_output_load_template' => array(
1118         'classname' => 'core\output\external',
1119         'methodname' => 'load_template',
1120         'description' => 'Load a template for a renderable',
1121         'type' => 'read',
1122         'loginrequired' => false,
1123         'ajax' => true,
1124     ),
1125     'core_output_load_fontawesome_icon_map' => array(
1126         'classname' => 'core\output\external',
1127         'methodname' => 'load_fontawesome_icon_map',
1128         'description' => 'Load the mapping of names to icons',
1129         'type' => 'read',
1130         'loginrequired' => false,
1131         'ajax' => true,
1132     ),
1133     // Question related functions.
1134     'core_question_update_flag' => array(
1135         'classname'     => 'core_question_external',
1136         'methodname'    => 'update_flag',
1137         'description'   => 'Update the flag state of a question attempt.',
1138         'type'          => 'write',
1139         'capabilities'  => 'moodle/question:flag',
1140         'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1141     ),
1142     'core_question_submit_tags_form' => array(
1143         'classname'     => 'core_question_external',
1144         'methodname'    => 'submit_tags_form',
1145         'description'   => 'Update the question tags.',
1146         'type'          => 'write',
1147         'ajax' => true,
1148     ),
1149     'core_question_get_random_question_summaries' => array(
1150         'classname' => 'core_question_external',
1151         'methodname' => 'get_random_question_summaries',
1152         'description' => 'Get the random question set for a criteria',
1153         'type' => 'read',
1154         'ajax' => true,
1155     ),
1156     'core_rating_get_item_ratings' => array(
1157         'classname' => 'core_rating_external',
1158         'methodname' => 'get_item_ratings',
1159         'description' => 'Retrieve all the ratings for an item.',
1160         'type' => 'read',
1161         'capabilities' => 'moodle/rating:view',
1162         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1163     ),
1164     'core_rating_add_rating' => array(
1165         'classname' => 'core_rating_external',
1166         'methodname' => 'add_rating',
1167         'description' => 'Rates an item.',
1168         'type' => 'write',
1169         'capabilities' => 'moodle/rating:rate',
1170         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1171     ),
1172     'core_role_assign_roles' => array(
1173         'classname' => 'core_role_external',
1174         'methodname' => 'assign_roles',
1175         'classpath' => 'enrol/externallib.php',
1176         'description' => 'Manual role assignments.',
1177         'type' => 'write',
1178         'capabilities' => 'moodle/role:assign'
1179     ),
1180     'core_role_unassign_roles' => array(
1181         'classname' => 'core_role_external',
1182         'methodname' => 'unassign_roles',
1183         'classpath' => 'enrol/externallib.php',
1184         'description' => 'Manual role unassignments.',
1185         'type' => 'write',
1186         'capabilities' => 'moodle/role:assign'
1187     ),
1188     'core_search_get_relevant_users' => array(
1189         'classname' => '\core_search\external',
1190         'methodname' => 'get_relevant_users',
1191         'description' => 'Gets relevant users for a search request.',
1192         'type' => 'read',
1193         'ajax' => true
1194     ),
1195     'core_tag_get_tagindex' => array(
1196         'classname' => 'core_tag_external',
1197         'methodname' => 'get_tagindex',
1198         'description' => 'Gets tag index page for one tag and one tag area',
1199         'type' => 'read',
1200         'ajax' => true,
1201     ),
1202     'core_tag_get_tags' => array(
1203         'classname' => 'core_tag_external',
1204         'methodname' => 'get_tags',
1205         'description' => 'Gets tags by their ids',
1206         'type' => 'read',
1207         'ajax' => true,
1208     ),
1209     'core_tag_update_tags' => array(
1210         'classname' => 'core_tag_external',
1211         'methodname' => 'update_tags',
1212         'description' => 'Updates tags',
1213         'type' => 'write',
1214         'ajax' => true,
1215     ),
1216     'core_update_inplace_editable' => array(
1217         'classname' => 'core_external',
1218         'methodname' => 'update_inplace_editable',
1219         'classpath' => 'lib/external/externallib.php',
1220         'description' => 'Generic service to update title',
1221         'type' => 'write',
1222         'loginrequired' => true,
1223         'ajax' => true,
1224     ),
1225     'core_user_add_user_device' => array(
1226         'classname' => 'core_user_external',
1227         'methodname' => 'add_user_device',
1228         'classpath' => 'user/externallib.php',
1229         'description' => 'Store mobile user devices information for PUSH Notifications.',
1230         'type' => 'write',
1231         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1232     ),
1233     'core_user_add_user_private_files' => array(
1234         'classname' => 'core_user_external',
1235         'methodname' => 'add_user_private_files',
1236         'classpath' => 'user/externallib.php',
1237         'description' => 'Copy files from a draft area to users private files area.',
1238         'type' => 'write',
1239         'capabilities' => 'moodle/user:manageownfiles',
1240         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1241     ),
1242     'core_user_create_users' => array(
1243         'classname' => 'core_user_external',
1244         'methodname' => 'create_users',
1245         'classpath' => 'user/externallib.php',
1246         'description' => 'Create users.',
1247         'type' => 'write',
1248         'capabilities' => 'moodle/user:create'
1249     ),
1250     'core_user_delete_users' => array(
1251         'classname' => 'core_user_external',
1252         'methodname' => 'delete_users',
1253         'classpath' => 'user/externallib.php',
1254         'description' => 'Delete users.',
1255         'type' => 'write',
1256         'capabilities' => 'moodle/user:delete'
1257     ),
1258     'core_user_get_course_user_profiles' => array(
1259         'classname' => 'core_user_external',
1260         'methodname' => 'get_course_user_profiles',
1261         'classpath' => 'user/externallib.php',
1262         'description' => 'Get course user profiles (each of the profils matching a course id and a user id),.',
1263         'type' => 'read',
1264         'capabilities' => 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update, '
1265             . 'moodle/site:accessallgroups',
1266         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1267     ),
1268     'core_user_get_users' => array(
1269         'classname' => 'core_user_external',
1270         'methodname' => 'get_users',
1271         'classpath' => 'user/externallib.php',
1272         'description' => 'search for users matching the parameters',
1273         'type' => 'read',
1274         'capabilities' => 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update'
1275     ),
1276     'core_user_get_users_by_field' => array(
1277         'classname' => 'core_user_external',
1278         'methodname' => 'get_users_by_field',
1279         'classpath' => 'user/externallib.php',
1280         'description' => 'Retrieve users\' information for a specified unique field - If you want to do a user search, use '
1281             . 'core_user_get_users()',
1282         'type' => 'read',
1283         'capabilities' => 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update',
1284         'ajax' => true,
1285         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1286     ),
1287     'core_user_remove_user_device' => array(
1288         'classname' => 'core_user_external',
1289         'methodname' => 'remove_user_device',
1290         'classpath' => 'user/externallib.php',
1291         'description' => 'Remove a user device from the Moodle database.',
1292         'type' => 'write',
1293         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1294     ),
1295     'core_user_update_users' => array(
1296         'classname' => 'core_user_external',
1297         'methodname' => 'update_users',
1298         'classpath' => 'user/externallib.php',
1299         'description' => 'Update users.',
1300         'type' => 'write',
1301         'capabilities' => 'moodle/user:update',
1302         'ajax' => true,
1303     ),
1304     'core_user_update_user_preferences' => array(
1305         'classname' => 'core_user_external',
1306         'methodname' => 'update_user_preferences',
1307         'classpath' => 'user/externallib.php',
1308         'description' => 'Update a user\'s preferences',
1309         'type' => 'write',
1310         'capabilities' => 'moodle/user:editownmessageprofile, moodle/user:editmessageprofile',
1311         'ajax' => true,
1312         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1313     ),
1314     'core_user_view_user_list' => array(
1315         'classname' => 'core_user_external',
1316         'methodname' => 'view_user_list',
1317         'classpath' => 'user/externallib.php',
1318         'description' => 'Simulates the web-interface view of user/index.php (triggering events),.',
1319         'type' => 'write',
1320         'capabilities' => 'moodle/course:viewparticipants',
1321         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1322     ),
1323     'core_user_view_user_profile' => array(
1324         'classname' => 'core_user_external',
1325         'methodname' => 'view_user_profile',
1326         'classpath' => 'user/externallib.php',
1327         'description' => 'Simulates the web-interface view of user/view.php and user/profile.php (triggering events),.',
1328         'type' => 'write',
1329         'capabilities' => 'moodle/user:viewdetails',
1330         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1331     ),
1332     'core_user_get_user_preferences' => array(
1333         'classname' => 'core_user_external',
1334         'methodname' => 'get_user_preferences',
1335         'classpath' => 'user/externallib.php',
1336         'description' => 'Return user preferences.',
1337         'type' => 'read',
1338         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1339     ),
1340     'core_user_update_picture' => array(
1341         'classname' => 'core_user_external',
1342         'methodname' => 'update_picture',
1343         'classpath' => 'user/externallib.php',
1344         'description' => 'Update or delete the user picture in the site',
1345         'type' => 'write',
1346         'capabilities' => 'moodle/user:editownprofile, moodle/user:editprofile',
1347         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1348     ),
1349     'core_user_set_user_preferences' => array(
1350         'classname' => 'core_user_external',
1351         'methodname' => 'set_user_preferences',
1352         'classpath' => 'user/externallib.php',
1353         'description' => 'Set user preferences.',
1354         'type' => 'write',
1355         'capabilities' => 'moodle/site:config',
1356         'ajax' => true
1357     ),
1358     'core_user_agree_site_policy' => array(
1359         'classname' => 'core_user_external',
1360         'methodname' => 'agree_site_policy',
1361         'classpath' => 'user/externallib.php',
1362         'description' => 'Agree the site policy for the current user.',
1363         'type' => 'write',
1364         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1365     ),
1366     'core_user_get_private_files_info' => array(
1367         'classname' => 'core_user_external',
1368         'methodname' => 'get_private_files_info',
1369         'classpath' => 'user/externallib.php',
1370         'description' => 'Returns general information about files in the user private files area.',
1371         'type' => 'read',
1372         'capabilities' => 'moodle/user:manageownfiles',
1373         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1374     ),
1376     // Competencies functions.
1377     'core_competency_create_competency_framework' => array(
1378         'classname'    => 'core_competency\external',
1379         'methodname'   => 'create_competency_framework',
1380         'classpath'    => '',
1381         'description'  => 'Creates new competency frameworks.',
1382         'type'         => 'write',
1383         'capabilities' => 'moodle/competency:competencymanage',
1384         'ajax'         => true,
1385     ),
1386     'core_competency_read_competency_framework' => array(
1387         'classname'    => 'core_competency\external',
1388         'methodname'   => 'read_competency_framework',
1389         'classpath'    => '',
1390         'description'  => 'Load a summary of a competency framework.',
1391         'type'         => 'read',
1392         'capabilities' => 'moodle/competency:competencyview',
1393         'ajax'         => true,
1394     ),
1395     'core_competency_duplicate_competency_framework' => array(
1396         'classname'    => 'core_competency\external',
1397         'methodname'   => 'duplicate_competency_framework',
1398         'classpath'    => '',
1399         'description'  => 'Duplicate a competency framework.',
1400         'type'         => 'write',
1401         'capabilities' => 'moodle/competency:competencymanage',
1402         'ajax'         => true,
1403     ),
1404     'core_competency_delete_competency_framework' => array(
1405         'classname'    => 'core_competency\external',
1406         'methodname'   => 'delete_competency_framework',
1407         'classpath'    => '',
1408         'description'  => 'Delete a competency framework.',
1409         'type'         => 'write',
1410         'capabilities' => 'moodle/competency:competencymanage',
1411         'ajax'         => true,
1412     ),
1413     'core_competency_update_competency_framework' => array(
1414         'classname'    => 'core_competency\external',
1415         'methodname'   => 'update_competency_framework',
1416         'classpath'    => '',
1417         'description'  => 'Update a competency framework.',
1418         'type'         => 'write',
1419         'capabilities' => 'moodle/competency:competencymanage',
1420         'ajax'         => true,
1421     ),
1422     'core_competency_list_competency_frameworks' => array(
1423         'classname'    => 'core_competency\external',
1424         'methodname'   => 'list_competency_frameworks',
1425         'classpath'    => '',
1426         'description'  => 'Load a list of a competency frameworks.',
1427         'type'         => 'read',
1428         'capabilities' => 'moodle/competency:competencyview',
1429         'ajax'         => true,
1430     ),
1431     'core_competency_count_competency_frameworks' => array(
1432         'classname'    => 'core_competency\external',
1433         'methodname'   => 'count_competency_frameworks',
1434         'classpath'    => '',
1435         'description'  => 'Count a list of a competency frameworks.',
1436         'type'         => 'read',
1437         'capabilities' => 'moodle/competency:competencyview',
1438         'ajax'         => true,
1439     ),
1440     'core_competency_competency_framework_viewed' => array(
1441         'classname'    => 'core_competency\external',
1442         'methodname'   => 'competency_framework_viewed',
1443         'classpath'    => '',
1444         'description'  => 'Log event competency framework viewed',
1445         'type'         => 'read',
1446         'capabilities' => 'moodle/competency:competencyview',
1447         'ajax'         => true,
1448     ),
1449     'core_competency_create_competency' => array(
1450         'classname'    => 'core_competency\external',
1451         'methodname'   => 'create_competency',
1452         'classpath'    => '',
1453         'description'  => 'Creates new competencies.',
1454         'type'         => 'write',
1455         'capabilities' => 'moodle/competency:competencymanage',
1456         'ajax'         => true,
1457     ),
1458     'core_competency_read_competency' => array(
1459         'classname'    => 'core_competency\external',
1460         'methodname'   => 'read_competency',
1461         'classpath'    => '',
1462         'description'  => 'Load a summary of a competency.',
1463         'type'         => 'read',
1464         'capabilities' => 'moodle/competency:competencyview',
1465         'ajax'         => true,
1466     ),
1467     'core_competency_competency_viewed' => array(
1468         'classname'    => 'core_competency\external',
1469         'methodname'   => 'competency_viewed',
1470         'classpath'    => '',
1471         'description'  => 'Log event competency viewed',
1472         'type'         => 'read',
1473         'capabilities' => 'moodle/competency:competencyview',
1474         'ajax'         => true,
1475         'services'     => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1476     ),
1477     'core_competency_delete_competency' => array(
1478         'classname'    => 'core_competency\external',
1479         'methodname'   => 'delete_competency',
1480         'classpath'    => '',
1481         'description'  => 'Delete a competency.',
1482         'type'         => 'write',
1483         'capabilities' => 'moodle/competency:competencymanage',
1484         'ajax'         => true,
1485     ),
1486     'core_competency_update_competency' => array(
1487         'classname'    => 'core_competency\external',
1488         'methodname'   => 'update_competency',
1489         'classpath'    => '',
1490         'description'  => 'Update a competency.',
1491         'type'         => 'write',
1492         'capabilities' => 'moodle/competency:competencymanage',
1493         'ajax'         => true,
1494     ),
1495     'core_competency_list_competencies' => array(
1496         'classname'    => 'core_competency\external',
1497         'methodname'   => 'list_competencies',
1498         'classpath'    => '',
1499         'description'  => 'Load a list of a competencies.',
1500         'type'         => 'read',
1501         'capabilities' => 'moodle/competency:competencyview',
1502         'ajax'         => true,
1503     ),
1504     'core_competency_list_competencies_in_template' => array(
1505         'classname'    => 'core_competency\external',
1506         'methodname'   => 'list_competencies_in_template',
1507         'classpath'    => '',
1508         'description'  => 'Load a list of a competencies for a given template.',
1509         'type'         => 'read',
1510         'capabilities' => 'moodle/competency:competencyview',
1511         'ajax'         => true,
1512     ),
1513     'core_competency_count_competencies' => array(
1514         'classname'    => 'core_competency\external',
1515         'methodname'   => 'count_competencies',
1516         'classpath'    => '',
1517         'description'  => 'Count a list of a competencies.',
1518         'type'         => 'read',
1519         'capabilities' => 'moodle/competency:competencyview',
1520         'ajax'         => true,
1521     ),
1522     'core_competency_count_competencies_in_template' => array(
1523         'classname'    => 'core_competency\external',
1524         'methodname'   => 'count_competencies_in_template',
1525         'classpath'    => '',
1526         'description'  => 'Count a list of a competencies for a given template.',
1527         'type'         => 'read',
1528         'capabilities' => 'moodle/competency:competencyview',
1529         'ajax'         => true,
1530     ),
1531     'core_competency_search_competencies' => array(
1532         'classname'    => 'core_competency\external',
1533         'methodname'   => 'search_competencies',
1534         'classpath'    => '',
1535         'description'  => 'Search a list of a competencies.',
1536         'type'         => 'read',
1537         'capabilities' => 'moodle/competency:competencyview',
1538         'ajax'         => true,
1539     ),
1540     'core_competency_set_parent_competency' => array(
1541         'classname'    => 'core_competency\external',
1542         'methodname'   => 'set_parent_competency',
1543         'classpath'    => '',
1544         'description'  => 'Set a new parent for a competency.',
1545         'type'         => 'write',
1546         'capabilities' => 'moodle/competency:competencymanage',
1547         'ajax'         => true,
1548     ),
1549     'core_competency_move_up_competency' => array(
1550         'classname'    => 'core_competency\external',
1551         'methodname'   => 'move_up_competency',
1552         'classpath'    => '',
1553         'description'  => 'Re-order a competency.',
1554         'type'         => 'write',
1555         'capabilities' => 'moodle/competency:competencymanage',
1556         'ajax'         => true,
1557     ),
1558     'core_competency_move_down_competency' => array(
1559         'classname'    => 'core_competency\external',
1560         'methodname'   => 'move_down_competency',
1561         'classpath'    => '',
1562         'description'  => 'Re-order a competency.',
1563         'type'         => 'write',
1564         'capabilities' => 'moodle/competency:competencymanage',
1565         'ajax'         => true,
1566     ),
1567     'core_competency_list_course_competencies' => array(
1568         'classname'    => 'core_competency\external',
1569         'methodname'   => 'list_course_competencies',
1570         'classpath'    => '',
1571         'description'  => 'List the competencies in a course',
1572         'type'         => 'read',
1573         'capabilities' => 'moodle/competency:coursecompetencyview',
1574         'ajax'         => true,
1575         'services'     => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1576     ),
1577     'core_competency_count_competencies_in_course' => array(
1578         'classname'    => 'core_competency\external',
1579         'methodname'   => 'count_competencies_in_course',
1580         'classpath'    => '',
1581         'description'  => 'List the competencies in a course',
1582         'type'         => 'read',
1583         'capabilities' => 'moodle/competency:coursecompetencyview',
1584         'ajax'         => true,
1585     ),
1586     'core_competency_count_courses_using_competency' => array(
1587         'classname'    => 'core_competency\external',
1588         'methodname'   => 'count_courses_using_competency',
1589         'classpath'    => '',
1590         'description'  => 'List the courses using a competency',
1591         'type'         => 'read',
1592         'capabilities' => 'moodle/competency:coursecompetencyview',
1593         'ajax'         => true,
1594     ),
1595     'core_competency_add_competency_to_course' => array(
1596         'classname'    => 'core_competency\external',
1597         'methodname'   => 'add_competency_to_course',
1598         'classpath'    => '',
1599         'description'  => 'Add the competency to a course',
1600         'type'         => 'write',
1601         'capabilities' => 'moodle/competency:coursecompetencymanage',
1602         'ajax'         => true,
1603     ),
1604     'core_competency_add_competency_to_template' => array(
1605         'classname'    => 'core_competency\external',
1606         'methodname'   => 'add_competency_to_template',
1607         'classpath'    => '',
1608         'description'  => 'Add the competency to a template',
1609         'type'         => 'write',
1610         'capabilities' => 'moodle/competency:templatemanage',
1611         'ajax'         => true,
1612     ),
1613     'core_competency_remove_competency_from_course' => array(
1614         'classname'    => 'core_competency\external',
1615         'methodname'   => 'remove_competency_from_course',
1616         'classpath'    => '',
1617         'description'  => 'Remove a competency from a course',
1618         'type'         => 'write',
1619         'capabilities' => 'moodle/competency:coursecompetencymanage',
1620         'ajax'         => true,
1621     ),
1622     'core_competency_set_course_competency_ruleoutcome' => array(
1623         'classname'    => 'core_competency\external',
1624         'methodname'   => 'set_course_competency_ruleoutcome',
1625         'classpath'    => '',
1626         'description'  => 'Modify the ruleoutcome value for course competency',
1627         'type'         => 'write',
1628         'capabilities' => 'moodle/competency:coursecompetencymanage',
1629         'ajax'         => true,
1630     ),
1631     'core_competency_remove_competency_from_template' => array(
1632         'classname'    => 'core_competency\external',
1633         'methodname'   => 'remove_competency_from_template',
1634         'classpath'    => '',
1635         'description'  => 'Remove a competency from a template',
1636         'type'         => 'write',
1637         'capabilities' => 'moodle/competency:templatemanage',
1638         'ajax'         => true,
1639     ),
1640     'core_competency_reorder_course_competency' => array(
1641         'classname'    => 'core_competency\external',
1642         'methodname'   => 'reorder_course_competency',
1643         'classpath'    => '',
1644         'description'  => 'Move a course competency to a new relative sort order.',
1645         'type'         => 'write',
1646         'capabilities' => 'moodle/competency:coursecompetencymanage',
1647         'ajax'         => true,
1648     ),
1649     'core_competency_reorder_template_competency' => array(
1650         'classname'    => 'core_competency\external',
1651         'methodname'   => 'reorder_template_competency',
1652         'classpath'    => '',
1653         'description'  => 'Move a template competency to a new relative sort order.',
1654         'type'         => 'write',
1655         'capabilities' => 'moodle/competency:templatemanage',
1656         'ajax'         => true,
1657     ),
1658     'core_competency_create_template' => array(
1659         'classname'    => 'core_competency\external',
1660         'methodname'   => 'create_template',
1661         'classpath'    => '',
1662         'description'  => 'Creates new learning plan templates.',
1663         'type'         => 'write',
1664         'capabilities' => 'moodle/competency:templatemanage',
1665         'ajax'         => true,
1666     ),
1667     'core_competency_duplicate_template' => array(
1668         'classname'    => 'core_competency\external',
1669         'methodname'   => 'duplicate_template',
1670         'classpath'    => '',
1671         'description'  => 'Duplicate learning plan template.',
1672         'type'         => 'write',
1673         'capabilities' => 'moodle/competency:templatemanage',
1674         'ajax'         => true,
1675     ),
1676     'core_competency_read_template' => array(
1677         'classname'    => 'core_competency\external',
1678         'methodname'   => 'read_template',
1679         'classpath'    => '',
1680         'description'  => 'Load a summary of a learning plan template.',
1681         'type'         => 'read',
1682         'capabilities' => 'moodle/competency:templateview',
1683         'ajax'         => true,
1684     ),
1685     'core_competency_delete_template' => array(
1686         'classname'    => 'core_competency\external',
1687         'methodname'   => 'delete_template',
1688         'classpath'    => '',
1689         'description'  => 'Delete a learning plan template.',
1690         'type'         => 'write',
1691         'capabilities' => 'moodle/competency:templatemanage',
1692         'ajax'         => true,
1693     ),
1694     'core_competency_update_template' => array(
1695         'classname'    => 'core_competency\external',
1696         'methodname'   => 'update_template',
1697         'classpath'    => '',
1698         'description'  => 'Update a learning plan template.',
1699         'type'         => 'write',
1700         'capabilities' => 'moodle/competency:templatemanage',
1701         'ajax'         => true,
1702     ),
1703     'core_competency_list_templates' => array(
1704         'classname'    => 'core_competency\external',
1705         'methodname'   => 'list_templates',
1706         'classpath'    => '',
1707         'description'  => 'Load a list of a learning plan templates.',
1708         'type'         => 'read',
1709         'capabilities' => 'moodle/competency:templateview',
1710         'ajax'         => true,
1711     ),
1712     'core_competency_list_templates_using_competency' => array(
1713         'classname'    => 'core_competency\external',
1714         'methodname'   => 'list_templates_using_competency',
1715         'classpath'    => '',
1716         'description'  => 'Load a list of a learning plan templates for a given competency.',
1717         'type'         => 'read',
1718         'capabilities' => 'moodle/competency:templateview',
1719         'ajax'         => true,
1720     ),
1721     'core_competency_count_templates' => array(
1722         'classname'    => 'core_competency\external',
1723         'methodname'   => 'count_templates',
1724         'classpath'    => '',
1725         'description'  => 'Count a list of a learning plan templates.',
1726         'type'         => 'read',
1727         'capabilities' => 'moodle/competency:templateview',
1728         'ajax'         => true,
1729     ),
1730     'core_competency_count_templates_using_competency' => array(
1731         'classname'    => 'core_competency\external',
1732         'methodname'   => 'count_templates_using_competency',
1733         'classpath'    => '',
1734         'description'  => 'Count a list of a learning plan templates for a given competency.',
1735         'type'         => 'read',
1736         'capabilities' => 'moodle/competency:templateview',
1737         'ajax'         => true,
1738     ),
1739     'core_competency_create_plan' => array(
1740         'classname'    => 'core_competency\external',
1741         'methodname'   => 'create_plan',
1742         'classpath'    => '',
1743         'description'  => 'Creates a learning plan.',
1744         'type'         => 'write',
1745         'capabilities' => 'moodle/competency:planmanage',
1746         'ajax'         => true,
1747     ),
1748     'core_competency_update_plan' => array(
1749         'classname'    => 'core_competency\external',
1750         'methodname'   => 'update_plan',
1751         'classpath'    => '',
1752         'description'  => 'Updates a learning plan.',
1753         'type'         => 'write',
1754         'capabilities' => 'moodle/competency:planmanage',
1755         'ajax'         => true,
1756     ),
1757     'core_competency_complete_plan' => array(
1758         'classname'    => 'core_competency\external',
1759         'methodname'   => 'complete_plan',
1760         'classpath'    => '',
1761         'description'  => 'Complete learning plan.',
1762         'type'         => 'write',
1763         'capabilities' => 'moodle/competency:planmanage',
1764         'ajax'         => true,
1765     ),
1766     'core_competency_reopen_plan' => array(
1767         'classname'    => 'core_competency\external',
1768         'methodname'   => 'reopen_plan',
1769         'classpath'    => '',
1770         'description'  => 'Reopen learning plan.',
1771         'type'         => 'write',
1772         'capabilities' => 'moodle/competency:planmanage',
1773         'ajax'         => true,
1774     ),
1775     'core_competency_read_plan' => array(
1776         'classname'    => 'core_competency\external',
1777         'methodname'   => 'read_plan',
1778         'classpath'    => '',
1779         'description'  => 'Load a learning plan.',
1780         'type'         => 'read',
1781         'capabilities' => 'moodle/competency:planviewown',
1782         'ajax'         => true,
1783     ),
1784     'core_competency_delete_plan' => array(
1785         'classname'    => 'core_competency\external',
1786         'methodname'   => 'delete_plan',
1787         'classpath'    => '',
1788         'description'  => 'Delete a learning plan.',
1789         'type'         => 'write',
1790         'capabilities' => 'moodle/competency:planmanage',
1791         'ajax'         => true,
1792     ),
1793     'core_competency_list_user_plans' => array(
1794         'classname'    => 'core_competency\external',
1795         'methodname'   => 'list_user_plans',
1796         'classpath'    => '',
1797         'description'  => 'List a user\'s learning plans.',
1798         'type'         => 'read',
1799         'capabilities' => 'moodle/competency:planviewown',
1800         'ajax'         => true,
1801     ),
1802     'core_competency_list_plan_competencies' => array(
1803         'classname'    => 'core_competency\external',
1804         'methodname'   => 'list_plan_competencies',
1805         'classpath'    => '',
1806         'description'  => 'List the competencies in a plan',
1807         'type'         => 'read',
1808         'capabilities' => 'moodle/competency:planviewown',
1809         'ajax'         => true,
1810     ),
1811     'core_competency_add_competency_to_plan' => array(
1812         'classname'    => 'core_competency\external',
1813         'methodname'   => 'add_competency_to_plan',
1814         'classpath'    => '',
1815         'description'  => 'Add the competency to a learning plan',
1816         'type'         => 'write',
1817         'capabilities' => 'moodle/competency:planmanage',
1818         'ajax'         => true,
1819     ),
1820     'core_competency_remove_competency_from_plan' => array(
1821         'classname'    => 'core_competency\external',
1822         'methodname'   => 'remove_competency_from_plan',
1823         'classpath'    => '',
1824         'description'  => 'Remove the competency from a learning plan',
1825         'type'         => 'write',
1826         'capabilities' => 'moodle/competency:planmanage',
1827         'ajax'         => true,
1828     ),
1829     'core_competency_reorder_plan_competency' => array(
1830         'classname'    => 'core_competency\external',
1831         'methodname'   => 'reorder_plan_competency',
1832         'classpath'    => '',
1833         'description'  => 'Move a plan competency to a new relative sort order.',
1834         'type'         => 'write',
1835         'capabilities' => 'moodle/competency:planmanage',
1836         'ajax'         => true,
1837     ),
1838     'core_competency_plan_request_review' => array(
1839         'classname'    => 'core_competency\external',
1840         'methodname'   => 'plan_request_review',
1841         'classpath'    => '',
1842         'description'  => 'Request for a plan to be reviewed.',
1843         'type'         => 'write',
1844         'capabilities' => 'moodle/competency:planmanagedraft',
1845         'ajax'         => true,
1846     ),
1847     'core_competency_plan_start_review' => array(
1848         'classname'    => 'core_competency\external',
1849         'methodname'   => 'plan_start_review',
1850         'classpath'    => '',
1851         'description'  => 'Start the review of a plan.',
1852         'type'         => 'write',
1853         'capabilities' => 'moodle/competency:planmanage',
1854         'ajax'         => true,
1855     ),
1856     'core_competency_plan_stop_review' => array(
1857         'classname'    => 'core_competency\external',
1858         'methodname'   => 'plan_stop_review',
1859         'classpath'    => '',
1860         'description'  => 'Stop the review of a plan.',
1861         'type'         => 'write',
1862         'capabilities' => 'moodle/competency:planmanage',
1863         'ajax'         => true,
1864     ),
1865     'core_competency_plan_cancel_review_request' => array(
1866         'classname'    => 'core_competency\external',
1867         'methodname'   => 'plan_cancel_review_request',
1868         'classpath'    => '',
1869         'description'  => 'Cancel the review of a plan.',
1870         'type'         => 'write',
1871         'capabilities' => 'moodle/competency:planmanagedraft',
1872         'ajax'         => true,
1873     ),
1874     'core_competency_approve_plan' => array(
1875         'classname'    => 'core_competency\external',
1876         'methodname'   => 'approve_plan',
1877         'classpath'    => '',
1878         'description'  => 'Approve a plan.',
1879         'type'         => 'write',
1880         'capabilities' => 'moodle/competency:planmanage',
1881         'ajax'         => true,
1882     ),
1883     'core_competency_unapprove_plan' => array(
1884         'classname'    => 'core_competency\external',
1885         'methodname'   => 'unapprove_plan',
1886         'classpath'    => '',
1887         'description'  => 'Unapprove a plan.',
1888         'type'         => 'write',
1889         'capabilities' => 'moodle/competency:planmanage',
1890         'ajax'         => true,
1891     ),
1892      'core_competency_template_has_related_data' => array(
1893         'classname'    => 'core_competency\external',
1894         'methodname'   => 'template_has_related_data',
1895         'classpath'    => '',
1896         'description'  => 'Check if a template has related data',
1897         'type'         => 'read',
1898         'capabilities' => 'moodle/competency:templateview',
1899         'ajax'         => true,
1900     ),
1901     'core_competency_get_scale_values' => array(
1902         'classname'    => 'core_competency\external',
1903         'methodname'   => 'get_scale_values',
1904         'classpath'    => '',
1905         'description'  => 'Fetch the values for a specific scale',
1906         'type'         => 'read',
1907         'capabilities' => 'moodle/competency:competencymanage',
1908         'ajax'         => true,
1909         'services'     => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1910     ),
1911     'core_competency_add_related_competency' => array(
1912         'classname'    => 'core_competency\external',
1913         'methodname'   => 'add_related_competency',
1914         'classpath'    => '',
1915         'description'  => 'Adds a related competency',
1916         'type'         => 'write',
1917         'capabilities' => 'moodle/competency:competencymanage',
1918         'ajax'         => true,
1919     ),
1920     'core_competency_remove_related_competency' => array(
1921         'classname'    => 'core_competency\external',
1922         'methodname'   => 'remove_related_competency',
1923         'classpath'    => '',
1924         'description'  => 'Remove a related competency',
1925         'type'         => 'write',
1926         'capabilities' => 'moodle/competency:competencymanage',
1927         'ajax'         => true,
1928     ),
1929     'core_competency_read_user_evidence' => array(
1930         'classname'    => 'core_competency\external',
1931         'methodname'   => 'read_user_evidence',
1932         'classpath'    => '',
1933         'description'  => 'Read an evidence of prior learning.',
1934         'type'         => 'read',
1935         'capabilities' => 'moodle/competency:userevidenceview',
1936         'ajax'         => true,
1937     ),
1938     'core_competency_delete_user_evidence' => array(
1939         'classname'    => 'core_competency\external',
1940         'methodname'   => 'delete_user_evidence',
1941         'classpath'    => '',
1942         'description'  => 'Delete an evidence of prior learning.',
1943         'type'         => 'write',
1944         'capabilities' => 'moodle/competency:userevidencemanageown',
1945         'ajax'         => true,
1946     ),
1947     'core_competency_create_user_evidence_competency' => array(
1948         'classname'    => 'core_competency\external',
1949         'methodname'   => 'create_user_evidence_competency',
1950         'classpath'    => '',
1951         'description'  => 'Create an evidence of prior learning relationship with a competency.',
1952         'type'         => 'read',
1953         'capabilities' => 'moodle/competency:userevidencemanageown, moodle/competency:competencyview',
1954         'ajax'         => true,
1955     ),
1956     'core_competency_delete_user_evidence_competency' => array(
1957         'classname'    => 'core_competency\external',
1958         'methodname'   => 'delete_user_evidence_competency',
1959         'classpath'    => '',
1960         'description'  => 'Delete an evidence of prior learning relationship with a competency.',
1961         'type'         => 'write',
1962         'capabilities' => 'moodle/competency:userevidencemanageown',
1963         'ajax'         => true,
1964     ),
1965     'core_competency_user_competency_cancel_review_request' => array(
1966         'classname'    => 'core_competency\external',
1967         'methodname'   => 'user_competency_cancel_review_request',
1968         'classpath'    => '',
1969         'description'  => 'Cancel a review request.',
1970         'type'         => 'write',
1971         'capabilities' => 'moodle/competency:userevidencemanageown',
1972         'ajax'         => true,
1973     ),
1974     'core_competency_user_competency_request_review' => array(
1975         'classname'    => 'core_competency\external',
1976         'methodname'   => 'user_competency_request_review',
1977         'classpath'    => '',
1978         'description'  => 'Request a review.',
1979         'type'         => 'write',
1980         'capabilities' => 'moodle/competency:userevidencemanageown',
1981         'ajax'         => true,
1982     ),
1983     'core_competency_user_competency_start_review' => array(
1984         'classname'    => 'core_competency\external',
1985         'methodname'   => 'user_competency_start_review',
1986         'classpath'    => '',
1987         'description'  => 'Start a review.',
1988         'type'         => 'write',
1989         'capabilities' => 'moodle/competency:competencygrade',
1990         'ajax'         => true,
1991     ),
1992     'core_competency_user_competency_stop_review' => array(
1993         'classname'    => 'core_competency\external',
1994         'methodname'   => 'user_competency_stop_review',
1995         'classpath'    => '',
1996         'description'  => 'Stop a review.',
1997         'type'         => 'write',
1998         'capabilities' => 'moodle/competency:competencygrade',
1999         'ajax'         => true,
2000     ),
2001     'core_competency_user_competency_viewed' => array(
2002         'classname'    => 'core_competency\external',
2003         'methodname'   => 'user_competency_viewed',
2004         'classpath'    => '',
2005         'description'  => 'Log the user competency viewed event.',
2006         'type'         => 'read',
2007         'capabilities' => 'moodle/competency:usercompetencyview',
2008         'ajax'         => true,
2009         'services'     => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
2010     ),
2011     'core_competency_user_competency_viewed_in_plan' => array(
2012         'classname'    => 'core_competency\external',
2013         'methodname'   => 'user_competency_viewed_in_plan',
2014         'classpath'    => '',
2015         'description'  => 'Log the user competency viewed in plan event.',
2016         'type'         => 'read',
2017         'capabilities' => 'moodle/competency:usercompetencyview',
2018         'ajax'         => true,
2019         'services'     => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
2020     ),
2021     'core_competency_user_competency_viewed_in_course' => array(
2022         'classname'    => 'core_competency\external',
2023         'methodname'   => 'user_competency_viewed_in_course',
2024         'classpath'    => '',
2025         'description'  => 'Log the user competency viewed in course event',
2026         'type'         => 'read',
2027         'capabilities' => 'moodle/competency:usercompetencyview',
2028         'ajax'         => true,
2029         'services'     => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
2030     ),
2031     'core_competency_user_competency_plan_viewed' => array(
2032         'classname'    => 'core_competency\external',
2033         'methodname'   => 'user_competency_plan_viewed',
2034         'classpath'    => '',
2035         'description'  => 'Log the user competency plan viewed event.',
2036         'type'         => 'read',
2037         'capabilities' => 'moodle/competency:usercompetencyview',
2038         'ajax'         => true,
2039         'services'     => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
2040     ),
2041     'core_competency_grade_competency' => array(
2042         'classname'    => 'core_competency\external',
2043         'methodname'   => 'grade_competency',
2044         'classpath'    => '',
2045         'description'  => 'Grade a competency.',
2046         'type'         => 'write',
2047         'capabilities' => 'moodle/competency:competencygrade',
2048         'ajax'         => true,
2049     ),
2050     'core_competency_grade_competency_in_plan' => array(
2051         'classname'    => 'core_competency\external',
2052         'methodname'   => 'grade_competency_in_plan',
2053         'classpath'    => '',
2054         'description'  => 'Grade a competency from the user plan page.',
2055         'type'         => 'write',
2056         'capabilities' => 'moodle/competency:competencygrade',
2057         'ajax'         => true,
2058     ),
2059     'core_competency_grade_competency_in_course' => array(
2060         'classname'    => 'core_competency\external',
2061         'methodname'   => 'grade_competency_in_course',
2062         'classpath'    => '',
2063         'description'  => 'Grade a competency from the course page.',
2064         'type'         => 'write',
2065         'capabilities' => 'moodle/competency:competencygrade',
2066         'ajax'         => true,
2067         'services'     => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
2068     ),
2069     'core_competency_unlink_plan_from_template' => array(
2070         'classname'    => 'core_competency\external',
2071         'methodname'   => 'unlink_plan_from_template',
2072         'classpath'    => '',
2073         'description'  => 'Unlink a plan form it template.',
2074         'type'         => 'write',
2075         'capabilities' => 'moodle/competency:planmanage',
2076         'ajax'         => true,
2077     ),
2078     'core_competency_template_viewed' => array(
2079         'classname'     => 'core_competency\external',
2080         'methodname'    => 'template_viewed',
2081         'classpath'     => '',
2082         'description'   => 'Log event template viewed',
2083         'type'          => 'read',
2084         'capabilities'  => 'moodle/competency:templateview',
2085         'ajax'          => true,
2086     ),
2087     'core_competency_request_review_of_user_evidence_linked_competencies' => array(
2088         'classname'     => 'core_competency\external',
2089         'methodname'    => 'request_review_of_user_evidence_linked_competencies',
2090         'classpath'     => '',
2091         'description'   => 'Send user evidence competencies in review',
2092         'type'          => 'write',
2093         'capabilities'  => 'moodle/competency:userevidencemanageown',
2094         'ajax'          => true,
2095     ),
2096     'core_competency_update_course_competency_settings' => array(
2097         'classname'     => 'core_competency\external',
2098         'methodname'    => 'update_course_competency_settings',
2099         'classpath'     => '',
2100         'description'   => 'Update the course competency settings',
2101         'type'          => 'write',
2102         'capabilities'  => 'moodle/competency:coursecompetencyconfigure',
2103         'ajax'          => true,
2104     ),
2105     'core_competency_delete_evidence' => array(
2106         'classname'     => 'core_competency\external',
2107         'methodname'    => 'delete_evidence',
2108         'classpath'     => '',
2109         'description'   => 'Delete an evidence',
2110         'type'          => 'write',
2111         'capabilities'  => 'moodle/competency:evidencedelete',
2112         'ajax'          => true,
2113         'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
2114     ),
2116     'core_webservice_get_site_info' => array(
2117         'classname' => 'core_webservice_external',
2118         'methodname' => 'get_site_info',
2119         'classpath' => 'webservice/externallib.php',
2120         'description' => 'Return some site info / user info / list web service functions',
2121         'type' => 'read',
2122         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
2123     ),
2125     // Blocks functions.
2126     'core_block_get_course_blocks' => array(
2127         'classname'     => 'core_block_external',
2128         'methodname'    => 'get_course_blocks',
2129         'description'   => 'Returns blocks information for a course.',
2130         'type'          => 'read',
2131         'capabilities'  => '',
2132         'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
2133     ),
2135     // Filters functions.
2136     'core_filters_get_available_in_context' => array(
2137         'classname'   => 'core_filters\external',
2138         'methodname'  => 'get_available_in_context',
2139         'description' => 'Returns the filters available in the given contexts.',
2140         'type'        => 'read',
2141         'services'    => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
2142     )
2143 );
2145 $services = array(
2146    'Moodle mobile web service'  => array(
2147         'functions' => array(), // Unused as we add the service in each function definition, third party services would use this.
2148         'enabled' => 0,
2149         'restrictedusers' => 0,
2150         'shortname' => MOODLE_OFFICIAL_MOBILE_SERVICE,
2151         'downloadfiles' => 1,
2152         'uploadfiles' => 1
2153     ),
2154 );