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