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