695623616c0dafb497cf030b77750dde7b9b8873
[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_badges_get_user_badges' => array(
38         'classname'     => 'core_badges_external',
39         'methodname'    => 'get_user_badges',
40         'description'   => 'Returns the list of badges awarded to a user.',
41         'type'          => 'read',
42         'capabilities'  => 'moodle/badges:viewotherbadges'
43     ),
44     'core_calendar_create_calendar_events' => array(
45         'classname' => 'core_calendar_external',
46         'methodname' => 'create_calendar_events',
47         'description' => 'Create calendar events',
48         'classpath' => 'calendar/externallib.php',
49         'type' => 'write',
50         'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries'
51     ),
52     'core_calendar_delete_calendar_events' => array(
53         'classname' => 'core_calendar_external',
54         'methodname' => 'delete_calendar_events',
55         'description' => 'Delete calendar events',
56         'classpath' => 'calendar/externallib.php',
57         'type' => 'write',
58         'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries'
59     ),
60     'core_calendar_get_calendar_events' => array(
61         'classname' => 'core_calendar_external',
62         'methodname' => 'get_calendar_events',
63         'description' => 'Get calendar events',
64         'classpath' => 'calendar/externallib.php',
65         'type' => 'read',
66         'capabilities' => 'moodle/calendar:manageentries, moodle/calendar:manageownentries, moodle/calendar:managegroupentries'
67     ),
68     'core_cohort_add_cohort_members' => array(
69         'classname' => 'core_cohort_external',
70         'methodname' => 'add_cohort_members',
71         'classpath' => 'cohort/externallib.php',
72         'description' => 'Adds cohort members.',
73         'type' => 'write',
74         'capabilities' => 'moodle/cohort:assign'
75     ),
76     'core_cohort_create_cohorts' => array(
77         'classname' => 'core_cohort_external',
78         'methodname' => 'create_cohorts',
79         'classpath' => 'cohort/externallib.php',
80         'description' => 'Creates new cohorts.',
81         'type' => 'write',
82         'capabilities' => 'moodle/cohort:manage'
83     ),
84     'core_cohort_delete_cohort_members' => array(
85         'classname' => 'core_cohort_external',
86         'methodname' => 'delete_cohort_members',
87         'classpath' => 'cohort/externallib.php',
88         'description' => 'Deletes cohort members.',
89         'type' => 'delete',
90         'capabilities' => 'moodle/cohort:assign'
91     ),
92     'core_cohort_delete_cohorts' => array(
93         'classname' => 'core_cohort_external',
94         'methodname' => 'delete_cohorts',
95         'classpath' => 'cohort/externallib.php',
96         'description' => 'Deletes all specified cohorts.',
97         'type' => 'delete',
98         'capabilities' => 'moodle/cohort:manage'
99     ),
100     'core_cohort_get_cohort_members' => array(
101         'classname' => 'core_cohort_external',
102         'methodname' => 'get_cohort_members',
103         'classpath' => 'cohort/externallib.php',
104         'description' => 'Returns cohort members.',
105         'type' => 'read',
106         'capabilities' => 'moodle/cohort:view'
107     ),
108     'core_cohort_get_cohorts' => array(
109         'classname' => 'core_cohort_external',
110         'methodname' => 'get_cohorts',
111         'classpath' => 'cohort/externallib.php',
112         'description' => 'Returns cohort details.',
113         'type' => 'read',
114         'capabilities' => 'moodle/cohort:view'
115     ),
116     'core_cohort_update_cohorts' => array(
117         'classname' => 'core_cohort_external',
118         'methodname' => 'update_cohorts',
119         'classpath' => 'cohort/externallib.php',
120         'description' => 'Updates existing cohorts.',
121         'type' => 'write',
122         'capabilities' => 'moodle/cohort:manage'
123     ),
124     'core_comment_get_comments' => array(
125         'classname' => 'core_comment_external',
126         'methodname' => 'get_comments',
127         'description' => 'Returns comments.',
128         'type' => 'read',
129         'capabilities' => 'moodle/comment:view'
130     ),
131     'core_completion_get_activities_completion_status' => array(
132         'classname' => 'core_completion_external',
133         'methodname' => 'get_activities_completion_status',
134         'description' => 'Return the activities completion status for a user in a course.',
135         'type' => 'read',
136     ),
137     'core_completion_get_course_completion_status' => array(
138         'classname' => 'core_completion_external',
139         'methodname' => 'get_course_completion_status',
140         'description' => 'Returns course completion status.',
141         'type' => 'read',
142         'capabilities' => 'report/completion:view'
143     ),
144     'core_completion_mark_course_self_completed' => array(
145         'classname' => 'core_completion_external',
146         'methodname' => 'mark_course_self_completed',
147         'description' => 'Update the course completion status for the current user (if course self-completion is enabled).',
148         'type' => 'write',
149     ),
150     'core_completion_update_activity_completion_status_manually' => array(
151         'classname' => 'core_completion_external',
152         'methodname' => 'update_activity_completion_status_manually',
153         'description' => 'Update completion status for the current user in an activity, only for activities with manual tracking.',
154         'type' => 'write',
155     ),
156     'core_course_create_categories' => array(
157         'classname' => 'core_course_external',
158         'methodname' => 'create_categories',
159         'classpath' => 'course/externallib.php',
160         'description' => 'Create course categories',
161         'type' => 'write',
162         'capabilities' => 'moodle/category:manage'
163     ),
164     'core_course_create_courses' => array(
165         'classname' => 'core_course_external',
166         'methodname' => 'create_courses',
167         'classpath' => 'course/externallib.php',
168         'description' => 'Create new courses',
169         'type' => 'write',
170         'capabilities' => 'moodle/course:create, moodle/course:visibility'
171     ),
172     'core_course_delete_categories' => array(
173         'classname' => 'core_course_external',
174         'methodname' => 'delete_categories',
175         'classpath' => 'course/externallib.php',
176         'description' => 'Delete course categories',
177         'type' => 'write',
178         'capabilities' => 'moodle/category:manage'
179     ),
180     'core_course_delete_courses' => array(
181         'classname' => 'core_course_external',
182         'methodname' => 'delete_courses',
183         'classpath' => 'course/externallib.php',
184         'description' => 'Deletes all specified courses',
185         'type' => 'write',
186         'capabilities' => 'moodle/course:delete'
187     ),
188     'core_course_delete_modules' => array(
189         'classname' => 'core_course_external',
190         'methodname' => 'delete_modules',
191         'classpath' => 'course/externallib.php',
192         'description' => 'Deletes all specified module instances',
193         'type' => 'write',
194         'capabilities' => 'moodle/course:manageactivities'
195     ),
196     'core_course_duplicate_course' => array(
197         'classname' => 'core_course_external',
198         'methodname' => 'duplicate_course',
199         'classpath' => 'course/externallib.php',
200         'description' => 'Duplicate an existing course (creating a new one), without user data',
201         'type' => 'write',
202         'capabilities' => 'moodle/backup:backupcourse, moodle/restore:restorecourse, moodle/course:create'
203     ),
204     'core_course_get_categories' => array(
205         'classname' => 'core_course_external',
206         'methodname' => 'get_categories',
207         'classpath' => 'course/externallib.php',
208         'description' => 'Return category details',
209         'type' => 'read',
210         'capabilities' => 'moodle/category:viewhiddencategories'
211     ),
212     'core_course_get_contents' => array(
213         'classname' => 'core_course_external',
214         'methodname' => 'get_course_contents',
215         'classpath' => 'course/externallib.php',
216         'description' => 'Get course contents',
217         'type' => 'read',
218         'capabilities' => 'moodle/course:update, moodle/course:viewhiddencourses'
219     ),
220     'core_course_get_course_module' => array(
221         'classname' => 'core_course_external',
222         'methodname' => 'get_course_module',
223         'classpath' => 'course/externallib.php',
224         'description' => 'Return information about a course module',
225         'type' => 'read',
226     ),
227     'core_course_get_course_module_by_instance' => array(
228         'classname' => 'core_course_external',
229         'methodname' => 'get_course_module_by_instance',
230         'classpath' => 'course/externallib.php',
231         'description' => 'Return information about a given module name and instance id',
232         'type' => 'read',
233     ),
234     'core_course_get_courses' => array(
235         'classname' => 'core_course_external',
236         'methodname' => 'get_courses',
237         'classpath' => 'course/externallib.php',
238         'description' => 'Return course details',
239         'type' => 'read',
240         'capabilities' => 'moodle/course:view, moodle/course:update, moodle/course:viewhiddencourses',
241         'ajax' => true,
242     ),
243     'core_course_import_course' => array(
244         'classname' => 'core_course_external',
245         'methodname' => 'import_course',
246         'classpath' => 'course/externallib.php',
247         'description' => 'Import course data from a course into another course. Does not include any user data.',
248         'type' => 'write',
249         'capabilities' => 'moodle/backup:backuptargetimport, moodle/restore:restoretargetimport'
250     ),
251     'core_course_search_courses' => array(
252         'classname' => 'core_course_external',
253         'methodname' => 'search_courses',
254         'classpath' => 'course/externallib.php',
255         'description' => 'Search courses by (name, module, block, tag)',
256         'type' => 'read',
257         'ajax' => true,
258     ),
259     'core_course_update_categories' => array(
260         'classname' => 'core_course_external',
261         'methodname' => 'update_categories',
262         'classpath' => 'course/externallib.php',
263         'description' => 'Update categories',
264         'type' => 'write',
265         'capabilities' => 'moodle/category:manage',
266     ),
267     'core_course_update_courses' => array(
268         'classname' => 'core_course_external',
269         'methodname' => 'update_courses',
270         'classpath' => 'course/externallib.php',
271         'description' => 'Update courses',
272         'type' => 'write',
273         'capabilities' => 'moodle/course:update, moodle/course:changecategory, moodle/course:changefullname, '
274             . 'moodle/course:changeshortname, moodle/course:changeidnumber, moodle/course:changesummary, moodle/course:visibility'
275     ),
276     'core_course_view_course' => array(
277         'classname' => 'core_course_external',
278         'methodname' => 'view_course',
279         'classpath' => 'course/externallib.php',
280         'description' => 'Log that the course was viewed',
281         'type' => 'write',
282     ),
283     'core_enrol_get_course_enrolment_methods' => array(
284         'classname' => 'core_enrol_external',
285         'methodname' => 'get_course_enrolment_methods',
286         'classpath' => 'enrol/externallib.php',
287         'description' => 'Get the list of course enrolment methods',
288         'type' => 'read',
289     ),
290     'core_enrol_get_enrolled_users' => array(
291         'classname' => 'core_enrol_external',
292         'methodname' => 'get_enrolled_users',
293         'classpath' => 'enrol/externallib.php',
294         'description' => 'Get enrolled users by course id.',
295         'type' => 'read',
296         'capabilities' => 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update, '
297             . 'moodle/site:accessallgroups'
298     ),
299     'core_enrol_get_enrolled_users_with_capability' => array(
300         'classname' => 'core_enrol_external',
301         'methodname' => 'get_enrolled_users_with_capability',
302         'classpath' => 'enrol/externallib.php',
303         'description' => 'For each course and capability specified, return a list of the users that are enrolled in the course
304                                   and have that capability',
305         'type' => 'read',
306     ),
307     'core_enrol_get_users_courses' => array(
308         'classname' => 'core_enrol_external',
309         'methodname' => 'get_users_courses',
310         'classpath' => 'enrol/externallib.php',
311         'description' => 'Get the list of courses where a user is enrolled in',
312         'type' => 'read',
313         'capabilities' => 'moodle/course:viewparticipants'
314     ),
315     'core_fetch_notifications' => array(
316         'classname' => 'core_external',
317         'methodname' => 'fetch_notifications',
318         'classpath' => 'lib/external/externallib.php',
319         'description' => 'Return a list of notifications for the current session',
320         'type' => 'read',
321         'loginrequired' => false,
322         'ajax' => true,
323     ),
324     'core_files_get_files' => array(
325         'classname' => 'core_files_external',
326         'methodname' => 'get_files',
327         'description' => 'browse moodle files',
328         'type' => 'read',
329         'classpath' => 'files/externallib.php',
330     ),
331     'core_files_upload' => array(
332         'classname' => 'core_files_external',
333         'methodname' => 'upload',
334         'description' => 'upload a file to moodle',
335         'type'        => 'write',
336         'classpath'   => 'files/externallib.php',
337     ),
338     'core_get_component_strings' => array(
339         'classname' => 'core_external',
340         'methodname' => 'get_component_strings',
341         'classpath' => 'lib/external/externallib.php',
342         'description' => 'Return all raw strings (with {$a->xxx}), for a specific component ' .
343             '- similar to core get_component_strings(), call',
344         'type' => 'read',
345         'loginrequired' => false,
346         'ajax' => true,
347     ),
348     'core_get_fragment' => array(
349         'classname' => 'core_external',
350         'methodname' => 'get_fragment',
351         'classpath' => 'lib/external/externallib.php',
352         'description' => 'Return a fragment for inclusion, such as a JavaScript page.',
353         'type' => 'read',
354         'ajax' => true,
355     ),
356     'core_get_string' => array(
357         'classname' => 'core_external',
358         'methodname' => 'get_string',
359         'classpath' => 'lib/external/externallib.php',
360         'description' => 'Return a translated string - similar to core get_string(), call',
361         'type' => 'read',
362         'loginrequired' => false,
363         'ajax' => true,
364     ),
365     'core_get_strings' => array(
366         'classname' => 'core_external',
367         'methodname' => 'get_strings',
368         'classpath' => 'lib/external/externallib.php',
369         'description' => 'Return some translated strings - like several core get_string(), calls',
370         'type' => 'read',
371         'loginrequired' => false,
372         'ajax' => true,
373     ),
374     'core_grades_get_grades' => array(
375         'classname' => 'core_grades_external',
376         'methodname' => 'get_grades',
377         'description' => 'Returns student course total grade and grades for activities.
378                                      This function does not return category or manual items.
379                                      This function is suitable for managers or teachers not students.',
380         'type' => 'read',
381         'capabilities' => 'moodle/grade:view, moodle/grade:viewall, moodle/grade:viewhidden'
382     ),
383     'core_grades_update_grades' => array(
384         'classname' => 'core_grades_external',
385         'methodname' => 'update_grades',
386         'description' => 'Update a grade item and associated student grades.',
387         'type' => 'write',
388     ),
389     'core_grading_get_definitions' => array(
390         'classname' => 'core_grading_external',
391         'methodname' => 'get_definitions',
392         'description' => 'Get grading definitions',
393         'type' => 'read',
394     ),
395     'core_grading_get_gradingform_instances' => array(
396         'classname' => 'core_grading_external',
397         'methodname' => 'get_gradingform_instances',
398         'description' => 'Get grading form instances',
399         'type' => 'read',
400     ),
401     'core_grading_save_definitions' => array(
402         'classname' => 'core_grading_external',
403         'methodname' => 'save_definitions',
404         'description' => 'Save grading definitions',
405         'type' => 'write',
406     ),
407     'core_group_add_group_members' => array(
408         'classname' => 'core_group_external',
409         'methodname' => 'add_group_members',
410         'classpath' => 'group/externallib.php',
411         'description' => 'Adds group members.',
412         'type' => 'write',
413         'capabilities' => 'moodle/course:managegroups',
414     ),
415     'core_group_assign_grouping' => array(
416         'classname' => 'core_group_external',
417         'methodname' => 'assign_grouping',
418         'classpath' => 'group/externallib.php',
419         'description' => 'Assing groups from groupings',
420         'type' => 'write',
421     ),
422     'core_group_create_groupings' => array(
423         'classname' => 'core_group_external',
424         'methodname' => 'create_groupings',
425         'classpath' => 'group/externallib.php',
426         'description' => 'Creates new groupings',
427         'type' => 'write',
428     ),
429     'core_group_create_groups' => array(
430         'classname' => 'core_group_external',
431         'methodname' => 'create_groups',
432         'classpath' => 'group/externallib.php',
433         'description' => 'Creates new groups.',
434         'type' => 'write',
435         'capabilities' => 'moodle/course:managegroups'
436     ),
437     'core_group_delete_group_members' => array(
438         'classname' => 'core_group_external',
439         'methodname' => 'delete_group_members',
440         'classpath' => 'group/externallib.php',
441         'description' => 'Deletes group members.',
442         'type' => 'delete',
443         'capabilities' => 'moodle/course:managegroups'
444     ),
445     'core_group_delete_groupings' => array(
446         'classname' => 'core_group_external',
447         'methodname' => 'delete_groupings',
448         'classpath' => 'group/externallib.php',
449         'description' => 'Deletes all specified groupings.',
450         'type' => 'write',
451     ),
452     'core_group_delete_groups' => array(
453         'classname' => 'core_group_external',
454         'methodname' => 'delete_groups',
455         'classpath' => 'group/externallib.php',
456         'description' => 'Deletes all specified groups.',
457         'type' => 'delete',
458         'capabilities' => 'moodle/course:managegroups'
459     ),
460     'core_group_get_activity_allowed_groups' => array(
461         'classname' => 'core_group_external',
462         'methodname' => 'get_activity_allowed_groups',
463         'classpath' => 'group/externallib.php',
464         'description' => 'Gets a list of groups that the user is allowed to access within the specified activity.',
465         'type' => 'read',
466     ),
467     'core_group_get_activity_groupmode' => array(
468         'classname' => 'core_group_external',
469         'methodname' => 'get_activity_groupmode',
470         'classpath' => 'group/externallib.php',
471         'description' => 'Returns effective groupmode used in a given activity.',
472         'type' => 'read',
473     ),
474     'core_group_get_course_groupings' => array(
475         'classname' => 'core_group_external',
476         'methodname' => 'get_course_groupings',
477         'classpath' => 'group/externallib.php',
478         'description' => 'Returns all groupings in specified course.',
479         'type' => 'read',
480     ),
481     'core_group_get_course_groups' => array(
482         'classname' => 'core_group_external',
483         'methodname' => 'get_course_groups',
484         'classpath' => 'group/externallib.php',
485         'description' => 'Returns all groups in specified course.',
486         'type' => 'read',
487         'capabilities' => 'moodle/course:managegroups'
488     ),
489     'core_group_get_course_user_groups' => array(
490         'classname' => 'core_group_external',
491         'methodname' => 'get_course_user_groups',
492         'classpath' => 'group/externallib.php',
493         'description' => 'Returns all groups in specified course for the specified user.',
494         'type' => 'read',
495         'capabilities' => 'moodle/course:managegroups'
496     ),
497     'core_group_get_group_members' => array(
498         'classname' => 'core_group_external',
499         'methodname' => 'get_group_members',
500         'classpath' => 'group/externallib.php',
501         'description' => 'Returns group members.',
502         'type' => 'read',
503         'capabilities' => 'moodle/course:managegroups'
504     ),
505     'core_group_get_groupings' => array(
506         'classname' => 'core_group_external',
507         'methodname' => 'get_groupings',
508         'classpath' => 'group/externallib.php',
509         'description' => 'Returns groupings details.',
510         'type' => 'read',
511     ),
512     'core_group_get_groups' => array(
513         'classname' => 'core_group_external',
514         'methodname' => 'get_groups',
515         'classpath' => 'group/externallib.php',
516         'description' => 'Returns group details.',
517         'type' => 'read',
518         'capabilities' => 'moodle/course:managegroups'
519     ),
520     'core_group_unassign_grouping' => array(
521         'classname' => 'core_group_external',
522         'methodname' => 'unassign_grouping',
523         'classpath' => 'group/externallib.php',
524         'description' => 'Unassing groups from groupings',
525         'type' => 'write',
526     ),
527     'core_group_update_groupings' => array(
528         'classname' => 'core_group_external',
529         'methodname' => 'update_groupings',
530         'classpath' => 'group/externallib.php',
531         'description' => 'Updates existing groupings',
532         'type' => 'write',
533     ),
534     'core_message_block_contacts' => array(
535         'classname' => 'core_message_external',
536         'methodname' => 'block_contacts',
537         'classpath' => 'message/externallib.php',
538         'description' => 'Block contacts',
539         'type' => 'write',
540     ),
541     'core_message_create_contacts' => array(
542         'classname' => 'core_message_external',
543         'methodname' => 'create_contacts',
544         'classpath' => 'message/externallib.php',
545         'description' => 'Add contacts to the contact list',
546         'type' => 'write',
547     ),
548     'core_message_delete_contacts' => array(
549         'classname' => 'core_message_external',
550         'methodname' => 'delete_contacts',
551         'classpath' => 'message/externallib.php',
552         'description' => 'Remove contacts from the contact list',
553         'type' => 'write',
554     ),
555     'core_message_delete_message' => array(
556         'classname' => 'core_message_external',
557         'methodname' => 'delete_message',
558         'classpath' => 'message/externallib.php',
559         'description' => 'Deletes a message.',
560         'type' => 'write',
561         'capabilities' => 'moodle/site:deleteownmessage'
562     ),
563     'core_message_get_blocked_users' => array(
564         'classname' => 'core_message_external',
565         'methodname' => 'get_blocked_users',
566         'classpath' => 'message/externallib.php',
567         'description' => 'Retrieve a list of users blocked',
568         'type' => 'read',
569     ),
570     'core_message_get_contacts' => array(
571         'classname' => 'core_message_external',
572         'methodname' => 'get_contacts',
573         'classpath' => 'message/externallib.php',
574         'description' => 'Retrieve the contact list',
575         'type' => 'read',
576     ),
577     'core_message_get_messages' => array(
578         'classname' => 'core_message_external',
579         'methodname' => 'get_messages',
580         'classpath' => 'message/externallib.php',
581         'description' => 'Retrieve a list of messages sent and received by a user (conversations, notifications or both)',
582         'type' => 'read',
583     ),
584     'core_message_mark_message_read' => array(
585         'classname' => 'core_message_external',
586         'methodname' => 'mark_message_read',
587         'classpath' => 'message/externallib.php',
588         'description' => 'Mark a single message as read, trigger message_viewed event.',
589         'type' => 'write',
590     ),
591     'core_message_search_contacts' => array(
592         'classname' => 'core_message_external',
593         'methodname' => 'search_contacts',
594         'classpath' => 'message/externallib.php',
595         'description' => 'Search for contacts',
596         'type' => 'read',
597     ),
598     'core_message_send_instant_messages' => array(
599         'classname' => 'core_message_external',
600         'methodname' => 'send_instant_messages',
601         'classpath' => 'message/externallib.php',
602         'description' => 'Send instant messages',
603         'type' => 'write',
604         'capabilities' => 'moodle/site:sendmessage'
605     ),
606     'core_message_unblock_contacts' => array(
607         'classname' => 'core_message_external',
608         'methodname' => 'unblock_contacts',
609         'classpath' => 'message/externallib.php',
610         'description' => 'Unblock contacts',
611         'type' => 'write',
612     ),
613     'core_notes_create_notes' => array(
614         'classname' => 'core_notes_external',
615         'methodname' => 'create_notes',
616         'classpath' => 'notes/externallib.php',
617         'description' => 'Create notes',
618         'type' => 'write',
619         'capabilities' => 'moodle/notes:manage'
620     ),
621     'core_notes_delete_notes' => array(
622         'classname' => 'core_notes_external',
623         'methodname' => 'delete_notes',
624         'classpath' => 'notes/externallib.php',
625         'description' => 'Delete notes',
626         'type' => 'write',
627         'capabilities' => 'moodle/notes:manage'
628     ),
629     'core_notes_get_course_notes' => array(
630         'classname' => 'core_notes_external',
631         'methodname' => 'get_course_notes',
632         'classpath' => 'notes/externallib.php',
633         'description' => 'Returns all notes in specified course (or site), for the specified user.',
634         'type' => 'read',
635         'capabilities' => 'moodle/notes:view'
636     ),
637     'core_notes_get_notes' => array(
638         'classname' => 'core_notes_external',
639         'methodname' => 'get_notes',
640         'classpath' => 'notes/externallib.php',
641         'description' => 'Get notes',
642         'type' => 'read',
643         'capabilities' => 'moodle/notes:view'
644     ),
645     'core_notes_update_notes' => array(
646         'classname' => 'core_notes_external',
647         'methodname' => 'update_notes',
648         'classpath' => 'notes/externallib.php',
649         'description' => 'Update notes',
650         'type' => 'write',
651         'capabilities' => 'moodle/notes:manage'
652     ),
653     'core_notes_view_notes' => array(
654         'classname' => 'core_notes_external',
655         'methodname' => 'view_notes',
656         'classpath' => 'notes/externallib.php',
657         'description' => 'Simulates the web interface view of notes/index.php: trigger events.',
658         'type' => 'write',
659         'capabilities' => 'moodle/notes:view'
660     ),
661     'core_output_load_template' => array(
662         'classname' => 'core\output\external',
663         'methodname' => 'load_template',
664         'description' => 'Load a template for a renderable',
665         'type' => 'read',
666         'loginrequired' => false,
667         'ajax' => true,
668     ),
669     // Question related functions.
670     'core_question_update_flag' => array(
671         'classname'     => 'core_question_external',
672         'methodname'    => 'update_flag',
673         'description'   => 'Update the flag state of a question attempt.',
674         'type'          => 'write',
675         'capabilities'  => 'moodle/question:flag',
676     ),
677     'core_rating_get_item_ratings' => array(
678         'classname' => 'core_rating_external',
679         'methodname' => 'get_item_ratings',
680         'description' => 'Retrieve all the ratings for an item.',
681         'type' => 'read',
682         'capabilities' => 'moodle/rating:view'
683     ),
684     'core_role_assign_roles' => array(
685         'classname' => 'core_role_external',
686         'methodname' => 'assign_roles',
687         'classpath' => 'enrol/externallib.php',
688         'description' => 'Manual role assignments.',
689         'type' => 'write',
690         'capabilities' => 'moodle/role:assign'
691     ),
692     'core_role_unassign_roles' => array(
693         'classname' => 'core_role_external',
694         'methodname' => 'unassign_roles',
695         'classpath' => 'enrol/externallib.php',
696         'description' => 'Manual role unassignments.',
697         'type' => 'write',
698         'capabilities' => 'moodle/role:assign'
699     ),
700     'core_tag_get_tagindex' => array(
701         'classname' => 'core_tag_external',
702         'methodname' => 'get_tagindex',
703         'description' => 'Gets tag index page for one tag and one tag area',
704         'type' => 'read',
705         'ajax' => true,
706     ),
707     'core_tag_get_tags' => array(
708         'classname' => 'core_tag_external',
709         'methodname' => 'get_tags',
710         'description' => 'Gets tags by their ids',
711         'type' => 'read',
712         'ajax' => true,
713     ),
714     'core_tag_update_tags' => array(
715         'classname' => 'core_tag_external',
716         'methodname' => 'update_tags',
717         'description' => 'Updates tags',
718         'type' => 'write',
719         'ajax' => true,
720     ),
721     'core_update_inplace_editable' => array(
722         'classname' => 'core_external',
723         'methodname' => 'update_inplace_editable',
724         'classpath' => 'lib/external/externallib.php',
725         'description' => 'Generic service to update title',
726         'type' => 'write',
727         'loginrequired' => true,
728         'ajax' => true,
729     ),
730     'core_user_add_user_device' => array(
731         'classname' => 'core_user_external',
732         'methodname' => 'add_user_device',
733         'classpath' => 'user/externallib.php',
734         'description' => 'Store mobile user devices information for PUSH Notifications.',
735         'type' => 'write',
736     ),
737     'core_user_add_user_private_files' => array(
738         'classname' => 'core_user_external',
739         'methodname' => 'add_user_private_files',
740         'classpath' => 'user/externallib.php',
741         'description' => 'Copy files from a draft area to users private files area.',
742         'type' => 'write',
743         'capabilities' => 'moodle/user:manageownfiles'
744     ),
745     'core_user_create_users' => array(
746         'classname' => 'core_user_external',
747         'methodname' => 'create_users',
748         'classpath' => 'user/externallib.php',
749         'description' => 'Create users.',
750         'type' => 'write',
751         'capabilities' => 'moodle/user:create'
752     ),
753     'core_user_delete_users' => array(
754         'classname' => 'core_user_external',
755         'methodname' => 'delete_users',
756         'classpath' => 'user/externallib.php',
757         'description' => 'Delete users.',
758         'type' => 'write',
759         'capabilities' => 'moodle/user:delete'
760     ),
761     'core_user_get_course_user_profiles' => array(
762         'classname' => 'core_user_external',
763         'methodname' => 'get_course_user_profiles',
764         'classpath' => 'user/externallib.php',
765         'description' => 'Get course user profiles (each of the profils matching a course id and a user id),.',
766         'type' => 'read',
767         'capabilities' => 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update, '
768             . 'moodle/site:accessallgroups'
769     ),
770     'core_user_get_users' => array(
771         'classname' => 'core_user_external',
772         'methodname' => 'get_users',
773         'classpath' => 'user/externallib.php',
774         'description' => 'search for users matching the parameters',
775         'type' => 'read',
776         'capabilities' => 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update'
777     ),
778     'core_user_get_users_by_field' => array(
779         'classname' => 'core_user_external',
780         'methodname' => 'get_users_by_field',
781         'classpath' => 'user/externallib.php',
782         'description' => 'Retrieve users\' information for a specified unique field - If you want to do a user search, use '
783             . 'core_user_get_users()',
784         'type' => 'read',
785         'ajax' => true,
786         'capabilities' => 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update'
787     ),
788     'core_user_remove_user_device' => array(
789         'classname' => 'core_user_external',
790         'methodname' => 'remove_user_device',
791         'classpath' => 'user/externallib.php',
792         'description' => 'Remove a user device from the Moodle database.',
793         'type' => 'write',
794     ),
795     'core_user_update_users' => array(
796         'classname' => 'core_user_external',
797         'methodname' => 'update_users',
798         'classpath' => 'user/externallib.php',
799         'description' => 'Update users.',
800         'type' => 'write',
801         'capabilities' => 'moodle/user:update',
802     ),
803     'core_user_view_user_list' => array(
804         'classname' => 'core_user_external',
805         'methodname' => 'view_user_list',
806         'classpath' => 'user/externallib.php',
807         'description' => 'Simulates the web-interface view of user/index.php (triggering events),.',
808         'type' => 'write',
809         'capabilities' => 'moodle/course:viewparticipants',
810     ),
811     'core_user_view_user_profile' => array(
812         'classname' => 'core_user_external',
813         'methodname' => 'view_user_profile',
814         'classpath' => 'user/externallib.php',
815         'description' => 'Simulates the web-interface view of user/view.php and user/profile.php (triggering events),.',
816         'type' => 'write',
817         'capabilities' => 'moodle/user:viewdetails',
818     ),
820     // Competencies functions.
821     'core_competency_create_competency_framework' => array(
822         'classname'    => 'core_competency\external',
823         'methodname'   => 'create_competency_framework',
824         'classpath'    => '',
825         'description'  => 'Creates new competency frameworks.',
826         'type'         => 'write',
827         'capabilities' => 'moodle/competency:competencymanage',
828         'ajax'         => true,
829     ),
830     'core_competency_read_competency_framework' => array(
831         'classname'    => 'core_competency\external',
832         'methodname'   => 'read_competency_framework',
833         'classpath'    => '',
834         'description'  => 'Load a summary of a competency framework.',
835         'type'         => 'read',
836         'capabilities' => 'moodle/competency:competencyview',
837         'ajax'         => true,
838     ),
839     'core_competency_duplicate_competency_framework' => array(
840         'classname'    => 'core_competency\external',
841         'methodname'   => 'duplicate_competency_framework',
842         'classpath'    => '',
843         'description'  => 'Duplicate a competency framework.',
844         'type'         => 'write',
845         'capabilities' => 'moodle/competency:competencymanage',
846         'ajax'         => true,
847     ),
848     'core_competency_delete_competency_framework' => array(
849         'classname'    => 'core_competency\external',
850         'methodname'   => 'delete_competency_framework',
851         'classpath'    => '',
852         'description'  => 'Delete a competency framework.',
853         'type'         => 'write',
854         'capabilities' => 'moodle/competency:competencymanage',
855         'ajax'         => true,
856     ),
857     'core_competency_update_competency_framework' => array(
858         'classname'    => 'core_competency\external',
859         'methodname'   => 'update_competency_framework',
860         'classpath'    => '',
861         'description'  => 'Update a competency framework.',
862         'type'         => 'write',
863         'capabilities' => 'moodle/competency:competencymanage',
864         'ajax'         => true,
865     ),
866     'core_competency_list_competency_frameworks' => array(
867         'classname'    => 'core_competency\external',
868         'methodname'   => 'list_competency_frameworks',
869         'classpath'    => '',
870         'description'  => 'Load a list of a competency frameworks.',
871         'type'         => 'read',
872         'capabilities' => 'moodle/competency:competencyview',
873         'ajax'         => true,
874     ),
875     'core_competency_count_competency_frameworks' => array(
876         'classname'    => 'core_competency\external',
877         'methodname'   => 'count_competency_frameworks',
878         'classpath'    => '',
879         'description'  => 'Count a list of a competency frameworks.',
880         'type'         => 'read',
881         'capabilities' => 'moodle/competency:competencyview',
882         'ajax'         => true,
883     ),
884     'core_competency_competency_framework_viewed' => array(
885         'classname'    => 'core_competency\external',
886         'methodname'   => 'competency_framework_viewed',
887         'classpath'    => '',
888         'description'  => 'Log event competency framework viewed',
889         'type'         => 'read',
890         'capabilities' => 'moodle/competency:competencyview',
891         'ajax'         => true,
892     ),
893     'core_competency_create_competency' => array(
894         'classname'    => 'core_competency\external',
895         'methodname'   => 'create_competency',
896         'classpath'    => '',
897         'description'  => 'Creates new competencies.',
898         'type'         => 'write',
899         'capabilities' => 'moodle/competency:competencymanage',
900         'ajax'         => true,
901     ),
902     'core_competency_read_competency' => array(
903         'classname'    => 'core_competency\external',
904         'methodname'   => 'read_competency',
905         'classpath'    => '',
906         'description'  => 'Load a summary of a competency.',
907         'type'         => 'read',
908         'capabilities' => 'moodle/competency:competencyview',
909         'ajax'         => true,
910     ),
911     'core_competency_competency_viewed' => array(
912         'classname'    => 'core_competency\external',
913         'methodname'   => 'competency_viewed',
914         'classpath'    => '',
915         'description'  => 'Log event competency viewed',
916         'type'         => 'read',
917         'capabilities' => 'moodle/competency:competencyview',
918         'ajax'         => true,
919     ),
920     'core_competency_delete_competency' => array(
921         'classname'    => 'core_competency\external',
922         'methodname'   => 'delete_competency',
923         'classpath'    => '',
924         'description'  => 'Delete a competency.',
925         'type'         => 'write',
926         'capabilities' => 'moodle/competency:competencymanage',
927         'ajax'         => true,
928     ),
929     'core_competency_update_competency' => array(
930         'classname'    => 'core_competency\external',
931         'methodname'   => 'update_competency',
932         'classpath'    => '',
933         'description'  => 'Update a competency.',
934         'type'         => 'write',
935         'capabilities' => 'moodle/competency:competencymanage',
936         'ajax'         => true,
937     ),
938     'core_competency_list_competencies' => array(
939         'classname'    => 'core_competency\external',
940         'methodname'   => 'list_competencies',
941         'classpath'    => '',
942         'description'  => 'Load a list of a competencies.',
943         'type'         => 'read',
944         'capabilities' => 'moodle/competency:competencyview',
945         'ajax'         => true,
946     ),
947     'core_competency_list_competencies_in_template' => array(
948         'classname'    => 'core_competency\external',
949         'methodname'   => 'list_competencies_in_template',
950         'classpath'    => '',
951         'description'  => 'Load a list of a competencies for a given template.',
952         'type'         => 'read',
953         'capabilities' => 'moodle/competency:competencyview',
954         'ajax'         => true,
955     ),
956     'core_competency_count_competencies' => array(
957         'classname'    => 'core_competency\external',
958         'methodname'   => 'count_competencies',
959         'classpath'    => '',
960         'description'  => 'Count a list of a competencies.',
961         'type'         => 'read',
962         'capabilities' => 'moodle/competency:competencyview',
963         'ajax'         => true,
964     ),
965     'core_competency_count_competencies_in_template' => array(
966         'classname'    => 'core_competency\external',
967         'methodname'   => 'count_competencies_in_template',
968         'classpath'    => '',
969         'description'  => 'Count a list of a competencies for a given template.',
970         'type'         => 'read',
971         'capabilities' => 'moodle/competency:competencyview',
972         'ajax'         => true,
973     ),
974     'core_competency_search_competencies' => array(
975         'classname'    => 'core_competency\external',
976         'methodname'   => 'search_competencies',
977         'classpath'    => '',
978         'description'  => 'Search a list of a competencies.',
979         'type'         => 'read',
980         'capabilities' => 'moodle/competency:competencyview',
981         'ajax'         => true,
982     ),
983     'core_competency_set_parent_competency' => array(
984         'classname'    => 'core_competency\external',
985         'methodname'   => 'set_parent_competency',
986         'classpath'    => '',
987         'description'  => 'Set a new parent for a competency.',
988         'type'         => 'write',
989         'capabilities' => 'moodle/competency:competencymanage',
990         'ajax'         => true,
991     ),
992     'core_competency_move_up_competency' => array(
993         'classname'    => 'core_competency\external',
994         'methodname'   => 'move_up_competency',
995         'classpath'    => '',
996         'description'  => 'Re-order a competency.',
997         'type'         => 'write',
998         'capabilities' => 'moodle/competency:competencymanage',
999         'ajax'         => true,
1000     ),
1001     'core_competency_move_down_competency' => array(
1002         'classname'    => 'core_competency\external',
1003         'methodname'   => 'move_down_competency',
1004         'classpath'    => '',
1005         'description'  => 'Re-order a competency.',
1006         'type'         => 'write',
1007         'capabilities' => 'moodle/competency:competencymanage',
1008         'ajax'         => true,
1009     ),
1010     'core_competency_list_course_competencies' => array(
1011         'classname'    => 'core_competency\external',
1012         'methodname'   => 'list_course_competencies',
1013         'classpath'    => '',
1014         'description'  => 'List the competencies in a course',
1015         'type'         => 'read',
1016         'capabilities' => 'moodle/competency:coursecompetencyview',
1017         'ajax'         => true,
1018     ),
1019     'core_competency_count_competencies_in_course' => array(
1020         'classname'    => 'core_competency\external',
1021         'methodname'   => 'count_competencies_in_course',
1022         'classpath'    => '',
1023         'description'  => 'List the competencies in a course',
1024         'type'         => 'read',
1025         'capabilities' => 'moodle/competency:coursecompetencyview',
1026         'ajax'         => true,
1027     ),
1028     'core_competency_count_courses_using_competency' => array(
1029         'classname'    => 'core_competency\external',
1030         'methodname'   => 'count_courses_using_competency',
1031         'classpath'    => '',
1032         'description'  => 'List the courses using a competency',
1033         'type'         => 'read',
1034         'capabilities' => 'moodle/competency:coursecompetencyview',
1035         'ajax'         => true,
1036     ),
1037     'core_competency_add_competency_to_course' => array(
1038         'classname'    => 'core_competency\external',
1039         'methodname'   => 'add_competency_to_course',
1040         'classpath'    => '',
1041         'description'  => 'Add the competency to a course',
1042         'type'         => 'write',
1043         'capabilities' => 'moodle/competency:coursecompetencymanage',
1044         'ajax'         => true,
1045     ),
1046     'core_competency_add_competency_to_template' => array(
1047         'classname'    => 'core_competency\external',
1048         'methodname'   => 'add_competency_to_template',
1049         'classpath'    => '',
1050         'description'  => 'Add the competency to a template',
1051         'type'         => 'write',
1052         'capabilities' => 'moodle/competency:templatemanage',
1053         'ajax'         => true,
1054     ),
1055     'core_competency_remove_competency_from_course' => array(
1056         'classname'    => 'core_competency\external',
1057         'methodname'   => 'remove_competency_from_course',
1058         'classpath'    => '',
1059         'description'  => 'Remove a competency from a course',
1060         'type'         => 'write',
1061         'capabilities' => 'moodle/competency:coursecompetencymanage',
1062         'ajax'         => true,
1063     ),
1064     'core_competency_set_course_competency_ruleoutcome' => array(
1065         'classname'    => 'core_competency\external',
1066         'methodname'   => 'set_course_competency_ruleoutcome',
1067         'classpath'    => '',
1068         'description'  => 'Modify the ruleoutcome value for course competency',
1069         'type'         => 'write',
1070         'capabilities' => 'moodle/competency:coursecompetencymanage',
1071         'ajax'         => true,
1072     ),
1073     'core_competency_remove_competency_from_template' => array(
1074         'classname'    => 'core_competency\external',
1075         'methodname'   => 'remove_competency_from_template',
1076         'classpath'    => '',
1077         'description'  => 'Remove a competency from a template',
1078         'type'         => 'write',
1079         'capabilities' => 'moodle/competency:templatemanage',
1080         'ajax'         => true,
1081     ),
1082     'core_competency_reorder_course_competency' => array(
1083         'classname'    => 'core_competency\external',
1084         'methodname'   => 'reorder_course_competency',
1085         'classpath'    => '',
1086         'description'  => 'Move a course competency to a new relative sort order.',
1087         'type'         => 'write',
1088         'capabilities' => 'moodle/competency:coursecompetencymanage',
1089         'ajax'         => true,
1090     ),
1091     'core_competency_reorder_template_competency' => array(
1092         'classname'    => 'core_competency\external',
1093         'methodname'   => 'reorder_template_competency',
1094         'classpath'    => '',
1095         'description'  => 'Move a template competency to a new relative sort order.',
1096         'type'         => 'write',
1097         'capabilities' => 'moodle/competency:templatemanage',
1098         'ajax'         => true,
1099     ),
1100     'core_competency_create_template' => array(
1101         'classname'    => 'core_competency\external',
1102         'methodname'   => 'create_template',
1103         'classpath'    => '',
1104         'description'  => 'Creates new learning plan templates.',
1105         'type'         => 'write',
1106         'capabilities' => 'moodle/competency:templatemanage',
1107         'ajax'         => true,
1108     ),
1109     'core_competency_duplicate_template' => array(
1110         'classname'    => 'core_competency\external',
1111         'methodname'   => 'duplicate_template',
1112         'classpath'    => '',
1113         'description'  => 'Duplicate learning plan template.',
1114         'type'         => 'write',
1115         'capabilities' => 'moodle/competency:templatemanage',
1116         'ajax'         => true,
1117     ),
1118     'core_competency_read_template' => array(
1119         'classname'    => 'core_competency\external',
1120         'methodname'   => 'read_template',
1121         'classpath'    => '',
1122         'description'  => 'Load a summary of a learning plan template.',
1123         'type'         => 'read',
1124         'capabilities' => 'moodle/competency:templateview',
1125         'ajax'         => true,
1126     ),
1127     'core_competency_delete_template' => array(
1128         'classname'    => 'core_competency\external',
1129         'methodname'   => 'delete_template',
1130         'classpath'    => '',
1131         'description'  => 'Delete a learning plan template.',
1132         'type'         => 'write',
1133         'capabilities' => 'moodle/competency:templatemanage',
1134         'ajax'         => true,
1135     ),
1136     'core_competency_update_template' => array(
1137         'classname'    => 'core_competency\external',
1138         'methodname'   => 'update_template',
1139         'classpath'    => '',
1140         'description'  => 'Update a learning plan template.',
1141         'type'         => 'write',
1142         'capabilities' => 'moodle/competency:templatemanage',
1143         'ajax'         => true,
1144     ),
1145     'core_competency_list_templates' => array(
1146         'classname'    => 'core_competency\external',
1147         'methodname'   => 'list_templates',
1148         'classpath'    => '',
1149         'description'  => 'Load a list of a learning plan templates.',
1150         'type'         => 'read',
1151         'capabilities' => 'moodle/competency:templateview',
1152         'ajax'         => true,
1153     ),
1154     'core_competency_list_templates_using_competency' => array(
1155         'classname'    => 'core_competency\external',
1156         'methodname'   => 'list_templates_using_competency',
1157         'classpath'    => '',
1158         'description'  => 'Load a list of a learning plan templates for a given competency.',
1159         'type'         => 'read',
1160         'capabilities' => 'moodle/competency:templateview',
1161         'ajax'         => true,
1162     ),
1163     'core_competency_count_templates' => array(
1164         'classname'    => 'core_competency\external',
1165         'methodname'   => 'count_templates',
1166         'classpath'    => '',
1167         'description'  => 'Count a list of a learning plan templates.',
1168         'type'         => 'read',
1169         'capabilities' => 'moodle/competency:templateview',
1170         'ajax'         => true,
1171     ),
1172     'core_competency_count_templates_using_competency' => array(
1173         'classname'    => 'core_competency\external',
1174         'methodname'   => 'count_templates_using_competency',
1175         'classpath'    => '',
1176         'description'  => 'Count a list of a learning plan templates for a given competency.',
1177         'type'         => 'read',
1178         'capabilities' => 'moodle/competency:templateview',
1179         'ajax'         => true,
1180     ),
1181     'core_competency_create_plan' => array(
1182         'classname'    => 'core_competency\external',
1183         'methodname'   => 'create_plan',
1184         'classpath'    => '',
1185         'description'  => 'Creates a learning plan.',
1186         'type'         => 'write',
1187         'capabilities' => 'moodle/competency:planmanage',
1188         'ajax'         => true,
1189     ),
1190     'core_competency_update_plan' => array(
1191         'classname'    => 'core_competency\external',
1192         'methodname'   => 'update_plan',
1193         'classpath'    => '',
1194         'description'  => 'Updates a learning plan.',
1195         'type'         => 'write',
1196         'capabilities' => 'moodle/competency:planmanage',
1197         'ajax'         => true,
1198     ),
1199     'core_competency_complete_plan' => array(
1200         'classname'    => 'core_competency\external',
1201         'methodname'   => 'complete_plan',
1202         'classpath'    => '',
1203         'description'  => 'Complete learning plan.',
1204         'type'         => 'write',
1205         'capabilities' => 'moodle/competency:planmanage',
1206         'ajax'         => true,
1207     ),
1208     'core_competency_reopen_plan' => array(
1209         'classname'    => 'core_competency\external',
1210         'methodname'   => 'reopen_plan',
1211         'classpath'    => '',
1212         'description'  => 'Reopen learning plan.',
1213         'type'         => 'write',
1214         'capabilities' => 'moodle/competency:planmanage',
1215         'ajax'         => true,
1216     ),
1217     'core_competency_read_plan' => array(
1218         'classname'    => 'core_competency\external',
1219         'methodname'   => 'read_plan',
1220         'classpath'    => '',
1221         'description'  => 'Load a learning plan.',
1222         'type'         => 'read',
1223         'capabilities' => 'moodle/competency:planviewown',
1224         'ajax'         => true,
1225     ),
1226     'core_competency_delete_plan' => array(
1227         'classname'    => 'core_competency\external',
1228         'methodname'   => 'delete_plan',
1229         'classpath'    => '',
1230         'description'  => 'Delete a learning plan.',
1231         'type'         => 'write',
1232         'capabilities' => 'moodle/competency:planmanage',
1233         'ajax'         => true,
1234     ),
1235     'core_competency_list_user_plans' => array(
1236         'classname'    => 'core_competency\external',
1237         'methodname'   => 'list_user_plans',
1238         'classpath'    => '',
1239         'description'  => 'List a user\'s learning plans.',
1240         'type'         => 'read',
1241         'capabilities' => 'moodle/competency:planviewown',
1242         'ajax'         => true,
1243     ),
1244     'core_competency_list_plan_competencies' => array(
1245         'classname'    => 'core_competency\external',
1246         'methodname'   => 'list_plan_competencies',
1247         'classpath'    => '',
1248         'description'  => 'List the competencies in a plan',
1249         'type'         => 'read',
1250         'capabilities' => 'moodle/competency:planviewown',
1251         'ajax'         => true,
1252     ),
1253     'core_competency_add_competency_to_plan' => array(
1254         'classname'    => 'core_competency\external',
1255         'methodname'   => 'add_competency_to_plan',
1256         'classpath'    => '',
1257         'description'  => 'Add the competency to a learning plan',
1258         'type'         => 'write',
1259         'capabilities' => 'moodle/competency:planmanage',
1260         'ajax'         => true,
1261     ),
1262     'core_competency_remove_competency_from_plan' => array(
1263         'classname'    => 'core_competency\external',
1264         'methodname'   => 'remove_competency_from_plan',
1265         'classpath'    => '',
1266         'description'  => 'Remove the competency from a learning plan',
1267         'type'         => 'write',
1268         'capabilities' => 'moodle/competency:planmanage',
1269         'ajax'         => true,
1270     ),
1271     'core_competency_reorder_plan_competency' => array(
1272         'classname'    => 'core_competency\external',
1273         'methodname'   => 'reorder_plan_competency',
1274         'classpath'    => '',
1275         'description'  => 'Move a plan competency to a new relative sort order.',
1276         'type'         => 'write',
1277         'capabilities' => 'moodle/competency:planmanage',
1278         'ajax'         => true,
1279     ),
1280     'core_competency_plan_request_review' => array(
1281         'classname'    => 'core_competency\external',
1282         'methodname'   => 'plan_request_review',
1283         'classpath'    => '',
1284         'description'  => 'Request for a plan to be reviewed.',
1285         'type'         => 'write',
1286         'capabilities' => 'moodle/competency:planmanagedraft',
1287         'ajax'         => true,
1288     ),
1289     'core_competency_plan_start_review' => array(
1290         'classname'    => 'core_competency\external',
1291         'methodname'   => 'plan_start_review',
1292         'classpath'    => '',
1293         'description'  => 'Start the review of a plan.',
1294         'type'         => 'write',
1295         'capabilities' => 'moodle/competency:planmanage',
1296         'ajax'         => true,
1297     ),
1298     'core_competency_plan_stop_review' => array(
1299         'classname'    => 'core_competency\external',
1300         'methodname'   => 'plan_stop_review',
1301         'classpath'    => '',
1302         'description'  => 'Stop the review of a plan.',
1303         'type'         => 'write',
1304         'capabilities' => 'moodle/competency:planmanage',
1305         'ajax'         => true,
1306     ),
1307     'core_competency_plan_cancel_review_request' => array(
1308         'classname'    => 'core_competency\external',
1309         'methodname'   => 'plan_cancel_review_request',
1310         'classpath'    => '',
1311         'description'  => 'Cancel the review of a plan.',
1312         'type'         => 'write',
1313         'capabilities' => 'moodle/competency:planmanagedraft',
1314         'ajax'         => true,
1315     ),
1316     'core_competency_approve_plan' => array(
1317         'classname'    => 'core_competency\external',
1318         'methodname'   => 'approve_plan',
1319         'classpath'    => '',
1320         'description'  => 'Approve a plan.',
1321         'type'         => 'write',
1322         'capabilities' => 'moodle/competency:planmanage',
1323         'ajax'         => true,
1324     ),
1325     'core_competency_unapprove_plan' => array(
1326         'classname'    => 'core_competency\external',
1327         'methodname'   => 'unapprove_plan',
1328         'classpath'    => '',
1329         'description'  => 'Unapprove a plan.',
1330         'type'         => 'write',
1331         'capabilities' => 'moodle/competency:planmanage',
1332         'ajax'         => true,
1333     ),
1334      'core_competency_template_has_related_data' => array(
1335         'classname'    => 'core_competency\external',
1336         'methodname'   => 'template_has_related_data',
1337         'classpath'    => '',
1338         'description'  => 'Check if a template has related data',
1339         'type'         => 'read',
1340         'capabilities' => 'moodle/competency:templateview',
1341         'ajax'         => true,
1342     ),
1343     'core_competency_get_scale_values' => array(
1344         'classname'    => 'core_competency\external',
1345         'methodname'   => 'get_scale_values',
1346         'classpath'    => '',
1347         'description'  => 'Fetch the values for a specific scale',
1348         'type'         => 'read',
1349         'capabilities' => 'moodle/competency:competencymanage',
1350         'ajax'         => true,
1351     ),
1352     'core_competency_add_related_competency' => array(
1353         'classname'    => 'core_competency\external',
1354         'methodname'   => 'add_related_competency',
1355         'classpath'    => '',
1356         'description'  => 'Adds a related competency',
1357         'type'         => 'write',
1358         'capabilities' => 'moodle/competency:competencymanage',
1359         'ajax'         => true,
1360     ),
1361     'core_competency_remove_related_competency' => array(
1362         'classname'    => 'core_competency\external',
1363         'methodname'   => 'remove_related_competency',
1364         'classpath'    => '',
1365         'description'  => 'Remove a related competency',
1366         'type'         => 'write',
1367         'capabilities' => 'moodle/competency:competencymanage',
1368         'ajax'         => true,
1369     ),
1370     'core_competency_read_user_evidence' => array(
1371         'classname'    => 'core_competency\external',
1372         'methodname'   => 'read_user_evidence',
1373         'classpath'    => '',
1374         'description'  => 'Read an evidence of prior learning.',
1375         'type'         => 'read',
1376         'capabilities' => 'moodle/competency:userevidenceview',
1377         'ajax'         => true,
1378     ),
1379     'core_competency_delete_user_evidence' => array(
1380         'classname'    => 'core_competency\external',
1381         'methodname'   => 'delete_user_evidence',
1382         'classpath'    => '',
1383         'description'  => 'Delete an evidence of prior learning.',
1384         'type'         => 'write',
1385         'capabilities' => 'moodle/competency:userevidencemanageown',
1386         'ajax'         => true,
1387     ),
1388     'core_competency_create_user_evidence_competency' => array(
1389         'classname'    => 'core_competency\external',
1390         'methodname'   => 'create_user_evidence_competency',
1391         'classpath'    => '',
1392         'description'  => 'Create an evidence of prior learning relationship with a competency.',
1393         'type'         => 'read',
1394         'capabilities' => 'moodle/competency:userevidencemanageown, moodle/competency:competencyview',
1395         'ajax'         => true,
1396     ),
1397     'core_competency_delete_user_evidence_competency' => array(
1398         'classname'    => 'core_competency\external',
1399         'methodname'   => 'delete_user_evidence_competency',
1400         'classpath'    => '',
1401         'description'  => 'Delete an evidence of prior learning relationship with a competency.',
1402         'type'         => 'write',
1403         'capabilities' => 'moodle/competency:userevidencemanageown',
1404         'ajax'         => true,
1405     ),
1406     'core_competency_user_competency_cancel_review_request' => array(
1407         'classname'    => 'core_competency\external',
1408         'methodname'   => 'user_competency_cancel_review_request',
1409         'classpath'    => '',
1410         'description'  => 'Cancel a review request.',
1411         'type'         => 'write',
1412         'capabilities' => 'moodle/competency:userevidencemanageown',
1413         'ajax'         => true,
1414     ),
1415     'core_competency_user_competency_request_review' => array(
1416         'classname'    => 'core_competency\external',
1417         'methodname'   => 'user_competency_request_review',
1418         'classpath'    => '',
1419         'description'  => 'Request a review.',
1420         'type'         => 'write',
1421         'capabilities' => 'moodle/competency:userevidencemanageown',
1422         'ajax'         => true,
1423     ),
1424     'core_competency_user_competency_start_review' => array(
1425         'classname'    => 'core_competency\external',
1426         'methodname'   => 'user_competency_start_review',
1427         'classpath'    => '',
1428         'description'  => 'Start a review.',
1429         'type'         => 'write',
1430         'capabilities' => 'moodle/competency:competencygrade',
1431         'ajax'         => true,
1432     ),
1433     'core_competency_user_competency_stop_review' => array(
1434         'classname'    => 'core_competency\external',
1435         'methodname'   => 'user_competency_stop_review',
1436         'classpath'    => '',
1437         'description'  => 'Stop a review.',
1438         'type'         => 'write',
1439         'capabilities' => 'moodle/competency:competencygrade',
1440         'ajax'         => true,
1441     ),
1442     'core_competency_user_competency_viewed' => array(
1443         'classname'    => 'core_competency\external',
1444         'methodname'   => 'user_competency_viewed',
1445         'classpath'    => '',
1446         'description'  => 'Log the user competency viewed event.',
1447         'type'         => 'read',
1448         'capabilities' => 'moodle/competency:usercompetencyview',
1449         'ajax'         => true,
1450     ),
1451     'core_competency_user_competency_viewed_in_plan' => array(
1452         'classname'    => 'core_competency\external',
1453         'methodname'   => 'user_competency_viewed_in_plan',
1454         'classpath'    => '',
1455         'description'  => 'Log the user competency viewed in plan event.',
1456         'type'         => 'read',
1457         'capabilities' => 'moodle/competency:usercompetencyview',
1458         'ajax'         => true,
1459     ),
1460     'core_competency_user_competency_viewed_in_course' => array(
1461         'classname'    => 'core_competency\external',
1462         'methodname'   => 'user_competency_viewed_in_course',
1463         'classpath'    => '',
1464         'description'  => 'Log the user competency viewed in course event',
1465         'type'         => 'read',
1466         'capabilities' => 'moodle/competency:usercompetencyview',
1467         'ajax'         => true,
1468     ),
1469     'core_competency_user_competency_plan_viewed' => array(
1470         'classname'    => 'core_competency\external',
1471         'methodname'   => 'user_competency_plan_viewed',
1472         'classpath'    => '',
1473         'description'  => 'Log the user competency plan viewed event.',
1474         'type'         => 'read',
1475         'capabilities' => 'moodle/competency:usercompetencyview',
1476         'ajax'         => true,
1477     ),
1478     'core_competency_grade_competency' => array(
1479         'classname'    => 'core_competency\external',
1480         'methodname'   => 'grade_competency',
1481         'classpath'    => '',
1482         'description'  => 'Grade a competency.',
1483         'type'         => 'write',
1484         'capabilities' => 'moodle/competency:competencygrade',
1485         'ajax'         => true,
1486     ),
1487     'core_competency_grade_competency_in_plan' => array(
1488         'classname'    => 'core_competency\external',
1489         'methodname'   => 'grade_competency_in_plan',
1490         'classpath'    => '',
1491         'description'  => 'Grade a competency from the user plan page.',
1492         'type'         => 'write',
1493         'capabilities' => 'moodle/competency:competencygrade',
1494         'ajax'         => true,
1495     ),
1496     'core_competency_grade_competency_in_course' => array(
1497         'classname'    => 'core_competency\external',
1498         'methodname'   => 'grade_competency_in_course',
1499         'classpath'    => '',
1500         'description'  => 'Grade a competency from the course page.',
1501         'type'         => 'write',
1502         'capabilities' => 'moodle/competency:competencygrade',
1503         'ajax'         => true,
1504     ),
1505     'core_competency_unlink_plan_from_template' => array(
1506         'classname'    => 'core_competency\external',
1507         'methodname'   => 'unlink_plan_from_template',
1508         'classpath'    => '',
1509         'description'  => 'Unlink a plan form it template.',
1510         'type'         => 'write',
1511         'capabilities' => 'moodle/competency:planmanage',
1512         'ajax'         => true,
1513     ),
1514     'core_competency_template_viewed' => array(
1515         'classname'     => 'core_competency\external',
1516         'methodname'    => 'template_viewed',
1517         'classpath'     => '',
1518         'description'   => 'Log event template viewed',
1519         'type'          => 'read',
1520         'capabilities'  => 'moodle/competency:templateview',
1521         'ajax'          => true,
1522     ),
1523     'core_competency_request_review_of_user_evidence_linked_competencies' => array(
1524         'classname'     => 'core_competency\external',
1525         'methodname'    => 'request_review_of_user_evidence_linked_competencies',
1526         'classpath'     => '',
1527         'description'   => 'Send user evidence competencies in review',
1528         'type'          => 'write',
1529         'capabilities'  => 'moodle/competency:userevidencemanageown',
1530         'ajax'          => true,
1531     ),
1532     'core_competency_update_course_competency_settings' => array(
1533         'classname'     => 'core_competency\external',
1534         'methodname'    => 'update_course_competency_settings',
1535         'classpath'     => '',
1536         'description'   => 'Update the course competency settings',
1537         'type'          => 'write',
1538         'capabilities'  => 'moodle/competency:coursecompetencyconfigure',
1539         'ajax'          => true,
1540     ),
1541     'core_competency_delete_evidence' => array(
1542         'classname'     => 'core_competency\external',
1543         'methodname'    => 'delete_evidence',
1544         'classpath'     => '',
1545         'description'   => 'Delete an evidence',
1546         'type'          => 'write',
1547         'capabilities'  => 'moodle/competency:evidencedelete',
1548         'ajax'          => true,
1549     ),
1551     'core_webservice_get_site_info' => array(
1552         'classname' => 'core_webservice_external',
1553         'methodname' => 'get_site_info',
1554         'classpath' => 'webservice/externallib.php',
1555         'description' => 'Return some site info / user info / list web service functions',
1556         'type' => 'read',
1557     )
1558 );
1560 $services = array(
1561    'Moodle mobile web service'  => array(
1562         'functions' => array (
1563             'core_badges_get_user_badges',
1564             'core_calendar_get_calendar_events',
1565             'core_comment_get_comments',
1566             'core_completion_get_activities_completion_status',
1567             'core_completion_get_course_completion_status',
1568             'core_completion_mark_course_self_completed',
1569             'core_completion_update_activity_completion_status_manually',
1570             'core_course_get_contents',
1571             'core_course_get_course_module',
1572             'core_course_get_course_module_by_instance',
1573             'core_course_get_courses',
1574             'core_course_search_courses',
1575             'core_course_view_course',
1576             'core_enrol_get_course_enrolment_methods',
1577             'core_enrol_get_enrolled_users',
1578             'core_enrol_get_users_courses',
1579             'core_files_get_files',
1580             'core_get_component_strings',
1581             'core_grades_update_grades',
1582             'core_group_get_activity_allowed_groups',
1583             'core_group_get_activity_groupmode',
1584             'core_group_get_course_user_groups',
1585             'core_message_block_contacts',
1586             'core_message_create_contacts',
1587             'core_message_delete_contacts',
1588             'core_message_delete_message',
1589             'core_message_get_blocked_users',
1590             'core_message_get_contacts',
1591             'core_message_get_messages',
1592             'core_message_mark_message_read',
1593             'core_message_search_contacts',
1594             'core_message_send_instant_messages',
1595             'core_message_unblock_contacts',
1596             'core_notes_create_notes',
1597             'core_notes_delete_notes',
1598             'core_notes_get_course_notes',
1599             'core_notes_view_notes',
1600             'core_question_update_flag',
1601             'core_rating_get_item_ratings',
1602             'core_user_add_user_device',
1603             'core_user_add_user_private_files',
1604             'core_user_get_course_user_profiles',
1605             'core_user_get_users_by_field',
1606             'core_user_remove_user_device',
1607             'core_user_view_user_list',
1608             'core_user_view_user_profile',
1609             'core_webservice_get_site_info',
1610             'enrol_guest_get_instance_info',
1611             'enrol_self_enrol_user',
1612             'enrol_self_get_instance_info',
1613             'gradereport_user_get_grades_table',
1614             'gradereport_user_view_grade_report',
1615             'message_airnotifier_are_notification_preferences_configured',
1616             'message_airnotifier_is_system_configured',
1617             ),
1618         'enabled' => 0,
1619         'restrictedusers' => 0,
1620         'shortname' => MOODLE_OFFICIAL_MOBILE_SERVICE,
1621         'downloadfiles' => 1,
1622         'uploadfiles' => 1
1623     ),
1624 );