MDL-54687 core_message: added userid parameter for altering contacts
[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_data_for_messagearea_conversations' => array(
640         'classname' => 'core_message_external',
641         'methodname' => 'data_for_messagearea_conversations',
642         'classpath' => 'message/externallib.php',
643         'description' => 'Retrieve the template data for the conversation list',
644         'type' => 'read',
645         'ajax' => true,
646     ),
647     'core_message_data_for_messagearea_contacts' => array(
648         'classname' => 'core_message_external',
649         'methodname' => 'data_for_messagearea_contacts',
650         'classpath' => 'message/externallib.php',
651         'description' => 'Retrieve the template data for the contact list',
652         'type' => 'read',
653         'ajax' => true,
654     ),
655     'core_message_data_for_messagearea_messages' => array(
656         'classname' => 'core_message_external',
657         'methodname' => 'data_for_messagearea_messages',
658         'classpath' => 'message/externallib.php',
659         'description' => 'Retrieve the template data for the messages',
660         'type' => 'read',
661         'ajax' => true,
662     ),
663     'core_message_data_for_messagearea_get_most_recent_message' => array(
664         'classname' => 'core_message_external',
665         'methodname' => 'data_for_messagearea_get_most_recent_message',
666         'classpath' => 'message/externallib.php',
667         'description' => 'Retrieve the template data for the most recent message',
668         'type' => 'read',
669         'ajax' => true,
670     ),
671     'core_message_get_contacts' => array(
672         'classname' => 'core_message_external',
673         'methodname' => 'get_contacts',
674         'classpath' => 'message/externallib.php',
675         'description' => 'Retrieve the contact list',
676         'type' => 'read',
677         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
678     ),
679     'core_message_get_messages' => array(
680         'classname' => 'core_message_external',
681         'methodname' => 'get_messages',
682         'classpath' => 'message/externallib.php',
683         'description' => 'Retrieve a list of messages sent and received by a user (conversations, notifications or both)',
684         'type' => 'read',
685         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
686     ),
687     'core_message_mark_message_read' => array(
688         'classname' => 'core_message_external',
689         'methodname' => 'mark_message_read',
690         'classpath' => 'message/externallib.php',
691         'description' => 'Mark a single message as read, trigger message_viewed event.',
692         'type' => 'write',
693         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
694     ),
695     'core_message_search_contacts' => array(
696         'classname' => 'core_message_external',
697         'methodname' => 'search_contacts',
698         'classpath' => 'message/externallib.php',
699         'description' => 'Search for contacts',
700         'type' => 'read',
701         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
702     ),
703     'core_message_send_instant_messages' => array(
704         'classname' => 'core_message_external',
705         'methodname' => 'send_instant_messages',
706         'classpath' => 'message/externallib.php',
707         'description' => 'Send instant messages',
708         'type' => 'write',
709         'capabilities' => 'moodle/site:sendmessage',
710         'ajax' => true,
711         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
712     ),
713     'core_message_unblock_contacts' => array(
714         'classname' => 'core_message_external',
715         'methodname' => 'unblock_contacts',
716         'classpath' => 'message/externallib.php',
717         'description' => 'Unblock contacts',
718         'type' => 'write',
719         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
720     ),
721     'core_notes_create_notes' => array(
722         'classname' => 'core_notes_external',
723         'methodname' => 'create_notes',
724         'classpath' => 'notes/externallib.php',
725         'description' => 'Create notes',
726         'type' => 'write',
727         'capabilities' => 'moodle/notes:manage',
728         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
729     ),
730     'core_notes_delete_notes' => array(
731         'classname' => 'core_notes_external',
732         'methodname' => 'delete_notes',
733         'classpath' => 'notes/externallib.php',
734         'description' => 'Delete notes',
735         'type' => 'write',
736         'capabilities' => 'moodle/notes:manage',
737         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
738     ),
739     'core_notes_get_course_notes' => array(
740         'classname' => 'core_notes_external',
741         'methodname' => 'get_course_notes',
742         'classpath' => 'notes/externallib.php',
743         'description' => 'Returns all notes in specified course (or site), for the specified user.',
744         'type' => 'read',
745         'capabilities' => 'moodle/notes:view',
746         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
747     ),
748     'core_notes_get_notes' => array(
749         'classname' => 'core_notes_external',
750         'methodname' => 'get_notes',
751         'classpath' => 'notes/externallib.php',
752         'description' => 'Get notes',
753         'type' => 'read',
754         'capabilities' => 'moodle/notes:view'
755     ),
756     'core_notes_update_notes' => array(
757         'classname' => 'core_notes_external',
758         'methodname' => 'update_notes',
759         'classpath' => 'notes/externallib.php',
760         'description' => 'Update notes',
761         'type' => 'write',
762         'capabilities' => 'moodle/notes:manage'
763     ),
764     'core_notes_view_notes' => array(
765         'classname' => 'core_notes_external',
766         'methodname' => 'view_notes',
767         'classpath' => 'notes/externallib.php',
768         'description' => 'Simulates the web interface view of notes/index.php: trigger events.',
769         'type' => 'write',
770         'capabilities' => 'moodle/notes:view',
771         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
772     ),
773     'core_output_load_template' => array(
774         'classname' => 'core\output\external',
775         'methodname' => 'load_template',
776         'description' => 'Load a template for a renderable',
777         'type' => 'read',
778         'loginrequired' => false,
779         'ajax' => true,
780     ),
781     // Question related functions.
782     'core_question_update_flag' => array(
783         'classname'     => 'core_question_external',
784         'methodname'    => 'update_flag',
785         'description'   => 'Update the flag state of a question attempt.',
786         'type'          => 'write',
787         'capabilities'  => 'moodle/question:flag',
788         'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
789     ),
790     'core_rating_get_item_ratings' => array(
791         'classname' => 'core_rating_external',
792         'methodname' => 'get_item_ratings',
793         'description' => 'Retrieve all the ratings for an item.',
794         'type' => 'read',
795         'capabilities' => 'moodle/rating:view',
796         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
797     ),
798     'core_rating_add_rating' => array(
799         'classname' => 'core_rating_external',
800         'methodname' => 'add_rating',
801         'description' => 'Rates an item.',
802         'type' => 'write',
803         'capabilities' => 'moodle/rating:rate',
804         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
805     ),
806     'core_role_assign_roles' => array(
807         'classname' => 'core_role_external',
808         'methodname' => 'assign_roles',
809         'classpath' => 'enrol/externallib.php',
810         'description' => 'Manual role assignments.',
811         'type' => 'write',
812         'capabilities' => 'moodle/role:assign'
813     ),
814     'core_role_unassign_roles' => array(
815         'classname' => 'core_role_external',
816         'methodname' => 'unassign_roles',
817         'classpath' => 'enrol/externallib.php',
818         'description' => 'Manual role unassignments.',
819         'type' => 'write',
820         'capabilities' => 'moodle/role:assign'
821     ),
822     'core_tag_get_tagindex' => array(
823         'classname' => 'core_tag_external',
824         'methodname' => 'get_tagindex',
825         'description' => 'Gets tag index page for one tag and one tag area',
826         'type' => 'read',
827         'ajax' => true,
828     ),
829     'core_tag_get_tags' => array(
830         'classname' => 'core_tag_external',
831         'methodname' => 'get_tags',
832         'description' => 'Gets tags by their ids',
833         'type' => 'read',
834         'ajax' => true,
835     ),
836     'core_tag_update_tags' => array(
837         'classname' => 'core_tag_external',
838         'methodname' => 'update_tags',
839         'description' => 'Updates tags',
840         'type' => 'write',
841         'ajax' => true,
842     ),
843     'core_update_inplace_editable' => array(
844         'classname' => 'core_external',
845         'methodname' => 'update_inplace_editable',
846         'classpath' => 'lib/external/externallib.php',
847         'description' => 'Generic service to update title',
848         'type' => 'write',
849         'loginrequired' => true,
850         'ajax' => true,
851     ),
852     'core_user_add_user_device' => array(
853         'classname' => 'core_user_external',
854         'methodname' => 'add_user_device',
855         'classpath' => 'user/externallib.php',
856         'description' => 'Store mobile user devices information for PUSH Notifications.',
857         'type' => 'write',
858         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
859     ),
860     'core_user_add_user_private_files' => array(
861         'classname' => 'core_user_external',
862         'methodname' => 'add_user_private_files',
863         'classpath' => 'user/externallib.php',
864         'description' => 'Copy files from a draft area to users private files area.',
865         'type' => 'write',
866         'capabilities' => 'moodle/user:manageownfiles',
867         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
868     ),
869     'core_user_create_users' => array(
870         'classname' => 'core_user_external',
871         'methodname' => 'create_users',
872         'classpath' => 'user/externallib.php',
873         'description' => 'Create users.',
874         'type' => 'write',
875         'capabilities' => 'moodle/user:create'
876     ),
877     'core_user_delete_users' => array(
878         'classname' => 'core_user_external',
879         'methodname' => 'delete_users',
880         'classpath' => 'user/externallib.php',
881         'description' => 'Delete users.',
882         'type' => 'write',
883         'capabilities' => 'moodle/user:delete'
884     ),
885     'core_user_get_course_user_profiles' => array(
886         'classname' => 'core_user_external',
887         'methodname' => 'get_course_user_profiles',
888         'classpath' => 'user/externallib.php',
889         'description' => 'Get course user profiles (each of the profils matching a course id and a user id),.',
890         'type' => 'read',
891         'capabilities' => 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update, '
892             . 'moodle/site:accessallgroups',
893         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
894     ),
895     'core_user_get_users' => array(
896         'classname' => 'core_user_external',
897         'methodname' => 'get_users',
898         'classpath' => 'user/externallib.php',
899         'description' => 'search for users matching the parameters',
900         'type' => 'read',
901         'capabilities' => 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update'
902     ),
903     'core_user_get_users_by_field' => array(
904         'classname' => 'core_user_external',
905         'methodname' => 'get_users_by_field',
906         'classpath' => 'user/externallib.php',
907         'description' => 'Retrieve users\' information for a specified unique field - If you want to do a user search, use '
908             . 'core_user_get_users()',
909         'type' => 'read',
910         'capabilities' => 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update',
911         'ajax' => true,
912         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
913     ),
914     'core_user_remove_user_device' => array(
915         'classname' => 'core_user_external',
916         'methodname' => 'remove_user_device',
917         'classpath' => 'user/externallib.php',
918         'description' => 'Remove a user device from the Moodle database.',
919         'type' => 'write',
920         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
921     ),
922     'core_user_update_users' => array(
923         'classname' => 'core_user_external',
924         'methodname' => 'update_users',
925         'classpath' => 'user/externallib.php',
926         'description' => 'Update users.',
927         'type' => 'write',
928         'capabilities' => 'moodle/user:update',
929     ),
930     'core_user_view_user_list' => array(
931         'classname' => 'core_user_external',
932         'methodname' => 'view_user_list',
933         'classpath' => 'user/externallib.php',
934         'description' => 'Simulates the web-interface view of user/index.php (triggering events),.',
935         'type' => 'write',
936         'capabilities' => 'moodle/course:viewparticipants',
937         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
938     ),
939     'core_user_view_user_profile' => array(
940         'classname' => 'core_user_external',
941         'methodname' => 'view_user_profile',
942         'classpath' => 'user/externallib.php',
943         'description' => 'Simulates the web-interface view of user/view.php and user/profile.php (triggering events),.',
944         'type' => 'write',
945         'capabilities' => 'moodle/user:viewdetails',
946         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
947     ),
948     'core_user_get_user_preferences' => array(
949         'classname' => 'core_user_external',
950         'methodname' => 'get_user_preferences',
951         'classpath' => 'user/externallib.php',
952         'description' => 'Return user preferences.',
953         'type' => 'read',
954         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
955     ),
956     'core_user_update_picture' => array(
957         'classname' => 'core_user_external',
958         'methodname' => 'update_picture',
959         'classpath' => 'user/externallib.php',
960         'description' => 'Update or delete the user picture in the site',
961         'type' => 'write',
962         'capabilities' => 'moodle/user:editownprofile, moodle/user:editprofile',
963         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
964     ),
965     'core_user_set_user_preferences' => array(
966         'classname' => 'core_user_external',
967         'methodname' => 'set_user_preferences',
968         'classpath' => 'user/externallib.php',
969         'description' => 'Set user preferences.',
970         'type' => 'write',
971         'capabilities' => 'moodle/site:config',
972     ),
973     'core_user_agree_site_policy' => array(
974         'classname' => 'core_user_external',
975         'methodname' => 'agree_site_policy',
976         'classpath' => 'user/externallib.php',
977         'description' => 'Agree the site policy for the current user.',
978         'type' => 'write',
979         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
980     ),
982     // Competencies functions.
983     'core_competency_create_competency_framework' => array(
984         'classname'    => 'core_competency\external',
985         'methodname'   => 'create_competency_framework',
986         'classpath'    => '',
987         'description'  => 'Creates new competency frameworks.',
988         'type'         => 'write',
989         'capabilities' => 'moodle/competency:competencymanage',
990         'ajax'         => true,
991     ),
992     'core_competency_read_competency_framework' => array(
993         'classname'    => 'core_competency\external',
994         'methodname'   => 'read_competency_framework',
995         'classpath'    => '',
996         'description'  => 'Load a summary of a competency framework.',
997         'type'         => 'read',
998         'capabilities' => 'moodle/competency:competencyview',
999         'ajax'         => true,
1000     ),
1001     'core_competency_duplicate_competency_framework' => array(
1002         'classname'    => 'core_competency\external',
1003         'methodname'   => 'duplicate_competency_framework',
1004         'classpath'    => '',
1005         'description'  => 'Duplicate a competency framework.',
1006         'type'         => 'write',
1007         'capabilities' => 'moodle/competency:competencymanage',
1008         'ajax'         => true,
1009     ),
1010     'core_competency_delete_competency_framework' => array(
1011         'classname'    => 'core_competency\external',
1012         'methodname'   => 'delete_competency_framework',
1013         'classpath'    => '',
1014         'description'  => 'Delete a competency framework.',
1015         'type'         => 'write',
1016         'capabilities' => 'moodle/competency:competencymanage',
1017         'ajax'         => true,
1018     ),
1019     'core_competency_update_competency_framework' => array(
1020         'classname'    => 'core_competency\external',
1021         'methodname'   => 'update_competency_framework',
1022         'classpath'    => '',
1023         'description'  => 'Update a competency framework.',
1024         'type'         => 'write',
1025         'capabilities' => 'moodle/competency:competencymanage',
1026         'ajax'         => true,
1027     ),
1028     'core_competency_list_competency_frameworks' => array(
1029         'classname'    => 'core_competency\external',
1030         'methodname'   => 'list_competency_frameworks',
1031         'classpath'    => '',
1032         'description'  => 'Load a list of a competency frameworks.',
1033         'type'         => 'read',
1034         'capabilities' => 'moodle/competency:competencyview',
1035         'ajax'         => true,
1036     ),
1037     'core_competency_count_competency_frameworks' => array(
1038         'classname'    => 'core_competency\external',
1039         'methodname'   => 'count_competency_frameworks',
1040         'classpath'    => '',
1041         'description'  => 'Count a list of a competency frameworks.',
1042         'type'         => 'read',
1043         'capabilities' => 'moodle/competency:competencyview',
1044         'ajax'         => true,
1045     ),
1046     'core_competency_competency_framework_viewed' => array(
1047         'classname'    => 'core_competency\external',
1048         'methodname'   => 'competency_framework_viewed',
1049         'classpath'    => '',
1050         'description'  => 'Log event competency framework viewed',
1051         'type'         => 'read',
1052         'capabilities' => 'moodle/competency:competencyview',
1053         'ajax'         => true,
1054     ),
1055     'core_competency_create_competency' => array(
1056         'classname'    => 'core_competency\external',
1057         'methodname'   => 'create_competency',
1058         'classpath'    => '',
1059         'description'  => 'Creates new competencies.',
1060         'type'         => 'write',
1061         'capabilities' => 'moodle/competency:competencymanage',
1062         'ajax'         => true,
1063     ),
1064     'core_competency_read_competency' => array(
1065         'classname'    => 'core_competency\external',
1066         'methodname'   => 'read_competency',
1067         'classpath'    => '',
1068         'description'  => 'Load a summary of a competency.',
1069         'type'         => 'read',
1070         'capabilities' => 'moodle/competency:competencyview',
1071         'ajax'         => true,
1072     ),
1073     'core_competency_competency_viewed' => array(
1074         'classname'    => 'core_competency\external',
1075         'methodname'   => 'competency_viewed',
1076         'classpath'    => '',
1077         'description'  => 'Log event competency viewed',
1078         'type'         => 'read',
1079         'capabilities' => 'moodle/competency:competencyview',
1080         'ajax'         => true,
1081         'services'     => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1082     ),
1083     'core_competency_delete_competency' => array(
1084         'classname'    => 'core_competency\external',
1085         'methodname'   => 'delete_competency',
1086         'classpath'    => '',
1087         'description'  => 'Delete a competency.',
1088         'type'         => 'write',
1089         'capabilities' => 'moodle/competency:competencymanage',
1090         'ajax'         => true,
1091     ),
1092     'core_competency_update_competency' => array(
1093         'classname'    => 'core_competency\external',
1094         'methodname'   => 'update_competency',
1095         'classpath'    => '',
1096         'description'  => 'Update a competency.',
1097         'type'         => 'write',
1098         'capabilities' => 'moodle/competency:competencymanage',
1099         'ajax'         => true,
1100     ),
1101     'core_competency_list_competencies' => array(
1102         'classname'    => 'core_competency\external',
1103         'methodname'   => 'list_competencies',
1104         'classpath'    => '',
1105         'description'  => 'Load a list of a competencies.',
1106         'type'         => 'read',
1107         'capabilities' => 'moodle/competency:competencyview',
1108         'ajax'         => true,
1109     ),
1110     'core_competency_list_competencies_in_template' => array(
1111         'classname'    => 'core_competency\external',
1112         'methodname'   => 'list_competencies_in_template',
1113         'classpath'    => '',
1114         'description'  => 'Load a list of a competencies for a given template.',
1115         'type'         => 'read',
1116         'capabilities' => 'moodle/competency:competencyview',
1117         'ajax'         => true,
1118     ),
1119     'core_competency_count_competencies' => array(
1120         'classname'    => 'core_competency\external',
1121         'methodname'   => 'count_competencies',
1122         'classpath'    => '',
1123         'description'  => 'Count a list of a competencies.',
1124         'type'         => 'read',
1125         'capabilities' => 'moodle/competency:competencyview',
1126         'ajax'         => true,
1127     ),
1128     'core_competency_count_competencies_in_template' => array(
1129         'classname'    => 'core_competency\external',
1130         'methodname'   => 'count_competencies_in_template',
1131         'classpath'    => '',
1132         'description'  => 'Count a list of a competencies for a given template.',
1133         'type'         => 'read',
1134         'capabilities' => 'moodle/competency:competencyview',
1135         'ajax'         => true,
1136     ),
1137     'core_competency_search_competencies' => array(
1138         'classname'    => 'core_competency\external',
1139         'methodname'   => 'search_competencies',
1140         'classpath'    => '',
1141         'description'  => 'Search a list of a competencies.',
1142         'type'         => 'read',
1143         'capabilities' => 'moodle/competency:competencyview',
1144         'ajax'         => true,
1145     ),
1146     'core_competency_set_parent_competency' => array(
1147         'classname'    => 'core_competency\external',
1148         'methodname'   => 'set_parent_competency',
1149         'classpath'    => '',
1150         'description'  => 'Set a new parent for a competency.',
1151         'type'         => 'write',
1152         'capabilities' => 'moodle/competency:competencymanage',
1153         'ajax'         => true,
1154     ),
1155     'core_competency_move_up_competency' => array(
1156         'classname'    => 'core_competency\external',
1157         'methodname'   => 'move_up_competency',
1158         'classpath'    => '',
1159         'description'  => 'Re-order a competency.',
1160         'type'         => 'write',
1161         'capabilities' => 'moodle/competency:competencymanage',
1162         'ajax'         => true,
1163     ),
1164     'core_competency_move_down_competency' => array(
1165         'classname'    => 'core_competency\external',
1166         'methodname'   => 'move_down_competency',
1167         'classpath'    => '',
1168         'description'  => 'Re-order a competency.',
1169         'type'         => 'write',
1170         'capabilities' => 'moodle/competency:competencymanage',
1171         'ajax'         => true,
1172     ),
1173     'core_competency_list_course_competencies' => array(
1174         'classname'    => 'core_competency\external',
1175         'methodname'   => 'list_course_competencies',
1176         'classpath'    => '',
1177         'description'  => 'List the competencies in a course',
1178         'type'         => 'read',
1179         'capabilities' => 'moodle/competency:coursecompetencyview',
1180         'ajax'         => true,
1181         'services'     => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1182     ),
1183     'core_competency_count_competencies_in_course' => array(
1184         'classname'    => 'core_competency\external',
1185         'methodname'   => 'count_competencies_in_course',
1186         'classpath'    => '',
1187         'description'  => 'List the competencies in a course',
1188         'type'         => 'read',
1189         'capabilities' => 'moodle/competency:coursecompetencyview',
1190         'ajax'         => true,
1191     ),
1192     'core_competency_count_courses_using_competency' => array(
1193         'classname'    => 'core_competency\external',
1194         'methodname'   => 'count_courses_using_competency',
1195         'classpath'    => '',
1196         'description'  => 'List the courses using a competency',
1197         'type'         => 'read',
1198         'capabilities' => 'moodle/competency:coursecompetencyview',
1199         'ajax'         => true,
1200     ),
1201     'core_competency_add_competency_to_course' => array(
1202         'classname'    => 'core_competency\external',
1203         'methodname'   => 'add_competency_to_course',
1204         'classpath'    => '',
1205         'description'  => 'Add the competency to a course',
1206         'type'         => 'write',
1207         'capabilities' => 'moodle/competency:coursecompetencymanage',
1208         'ajax'         => true,
1209     ),
1210     'core_competency_add_competency_to_template' => array(
1211         'classname'    => 'core_competency\external',
1212         'methodname'   => 'add_competency_to_template',
1213         'classpath'    => '',
1214         'description'  => 'Add the competency to a template',
1215         'type'         => 'write',
1216         'capabilities' => 'moodle/competency:templatemanage',
1217         'ajax'         => true,
1218     ),
1219     'core_competency_remove_competency_from_course' => array(
1220         'classname'    => 'core_competency\external',
1221         'methodname'   => 'remove_competency_from_course',
1222         'classpath'    => '',
1223         'description'  => 'Remove a competency from a course',
1224         'type'         => 'write',
1225         'capabilities' => 'moodle/competency:coursecompetencymanage',
1226         'ajax'         => true,
1227     ),
1228     'core_competency_set_course_competency_ruleoutcome' => array(
1229         'classname'    => 'core_competency\external',
1230         'methodname'   => 'set_course_competency_ruleoutcome',
1231         'classpath'    => '',
1232         'description'  => 'Modify the ruleoutcome value for course competency',
1233         'type'         => 'write',
1234         'capabilities' => 'moodle/competency:coursecompetencymanage',
1235         'ajax'         => true,
1236     ),
1237     'core_competency_remove_competency_from_template' => array(
1238         'classname'    => 'core_competency\external',
1239         'methodname'   => 'remove_competency_from_template',
1240         'classpath'    => '',
1241         'description'  => 'Remove a competency from a template',
1242         'type'         => 'write',
1243         'capabilities' => 'moodle/competency:templatemanage',
1244         'ajax'         => true,
1245     ),
1246     'core_competency_reorder_course_competency' => array(
1247         'classname'    => 'core_competency\external',
1248         'methodname'   => 'reorder_course_competency',
1249         'classpath'    => '',
1250         'description'  => 'Move a course competency to a new relative sort order.',
1251         'type'         => 'write',
1252         'capabilities' => 'moodle/competency:coursecompetencymanage',
1253         'ajax'         => true,
1254     ),
1255     'core_competency_reorder_template_competency' => array(
1256         'classname'    => 'core_competency\external',
1257         'methodname'   => 'reorder_template_competency',
1258         'classpath'    => '',
1259         'description'  => 'Move a template competency to a new relative sort order.',
1260         'type'         => 'write',
1261         'capabilities' => 'moodle/competency:templatemanage',
1262         'ajax'         => true,
1263     ),
1264     'core_competency_create_template' => array(
1265         'classname'    => 'core_competency\external',
1266         'methodname'   => 'create_template',
1267         'classpath'    => '',
1268         'description'  => 'Creates new learning plan templates.',
1269         'type'         => 'write',
1270         'capabilities' => 'moodle/competency:templatemanage',
1271         'ajax'         => true,
1272     ),
1273     'core_competency_duplicate_template' => array(
1274         'classname'    => 'core_competency\external',
1275         'methodname'   => 'duplicate_template',
1276         'classpath'    => '',
1277         'description'  => 'Duplicate learning plan template.',
1278         'type'         => 'write',
1279         'capabilities' => 'moodle/competency:templatemanage',
1280         'ajax'         => true,
1281     ),
1282     'core_competency_read_template' => array(
1283         'classname'    => 'core_competency\external',
1284         'methodname'   => 'read_template',
1285         'classpath'    => '',
1286         'description'  => 'Load a summary of a learning plan template.',
1287         'type'         => 'read',
1288         'capabilities' => 'moodle/competency:templateview',
1289         'ajax'         => true,
1290     ),
1291     'core_competency_delete_template' => array(
1292         'classname'    => 'core_competency\external',
1293         'methodname'   => 'delete_template',
1294         'classpath'    => '',
1295         'description'  => 'Delete a learning plan template.',
1296         'type'         => 'write',
1297         'capabilities' => 'moodle/competency:templatemanage',
1298         'ajax'         => true,
1299     ),
1300     'core_competency_update_template' => array(
1301         'classname'    => 'core_competency\external',
1302         'methodname'   => 'update_template',
1303         'classpath'    => '',
1304         'description'  => 'Update a learning plan template.',
1305         'type'         => 'write',
1306         'capabilities' => 'moodle/competency:templatemanage',
1307         'ajax'         => true,
1308     ),
1309     'core_competency_list_templates' => array(
1310         'classname'    => 'core_competency\external',
1311         'methodname'   => 'list_templates',
1312         'classpath'    => '',
1313         'description'  => 'Load a list of a learning plan templates.',
1314         'type'         => 'read',
1315         'capabilities' => 'moodle/competency:templateview',
1316         'ajax'         => true,
1317     ),
1318     'core_competency_list_templates_using_competency' => array(
1319         'classname'    => 'core_competency\external',
1320         'methodname'   => 'list_templates_using_competency',
1321         'classpath'    => '',
1322         'description'  => 'Load a list of a learning plan templates for a given competency.',
1323         'type'         => 'read',
1324         'capabilities' => 'moodle/competency:templateview',
1325         'ajax'         => true,
1326     ),
1327     'core_competency_count_templates' => array(
1328         'classname'    => 'core_competency\external',
1329         'methodname'   => 'count_templates',
1330         'classpath'    => '',
1331         'description'  => 'Count a list of a learning plan templates.',
1332         'type'         => 'read',
1333         'capabilities' => 'moodle/competency:templateview',
1334         'ajax'         => true,
1335     ),
1336     'core_competency_count_templates_using_competency' => array(
1337         'classname'    => 'core_competency\external',
1338         'methodname'   => 'count_templates_using_competency',
1339         'classpath'    => '',
1340         'description'  => 'Count a list of a learning plan templates for a given competency.',
1341         'type'         => 'read',
1342         'capabilities' => 'moodle/competency:templateview',
1343         'ajax'         => true,
1344     ),
1345     'core_competency_create_plan' => array(
1346         'classname'    => 'core_competency\external',
1347         'methodname'   => 'create_plan',
1348         'classpath'    => '',
1349         'description'  => 'Creates a learning plan.',
1350         'type'         => 'write',
1351         'capabilities' => 'moodle/competency:planmanage',
1352         'ajax'         => true,
1353     ),
1354     'core_competency_update_plan' => array(
1355         'classname'    => 'core_competency\external',
1356         'methodname'   => 'update_plan',
1357         'classpath'    => '',
1358         'description'  => 'Updates a learning plan.',
1359         'type'         => 'write',
1360         'capabilities' => 'moodle/competency:planmanage',
1361         'ajax'         => true,
1362     ),
1363     'core_competency_complete_plan' => array(
1364         'classname'    => 'core_competency\external',
1365         'methodname'   => 'complete_plan',
1366         'classpath'    => '',
1367         'description'  => 'Complete learning plan.',
1368         'type'         => 'write',
1369         'capabilities' => 'moodle/competency:planmanage',
1370         'ajax'         => true,
1371     ),
1372     'core_competency_reopen_plan' => array(
1373         'classname'    => 'core_competency\external',
1374         'methodname'   => 'reopen_plan',
1375         'classpath'    => '',
1376         'description'  => 'Reopen learning plan.',
1377         'type'         => 'write',
1378         'capabilities' => 'moodle/competency:planmanage',
1379         'ajax'         => true,
1380     ),
1381     'core_competency_read_plan' => array(
1382         'classname'    => 'core_competency\external',
1383         'methodname'   => 'read_plan',
1384         'classpath'    => '',
1385         'description'  => 'Load a learning plan.',
1386         'type'         => 'read',
1387         'capabilities' => 'moodle/competency:planviewown',
1388         'ajax'         => true,
1389     ),
1390     'core_competency_delete_plan' => array(
1391         'classname'    => 'core_competency\external',
1392         'methodname'   => 'delete_plan',
1393         'classpath'    => '',
1394         'description'  => 'Delete a learning plan.',
1395         'type'         => 'write',
1396         'capabilities' => 'moodle/competency:planmanage',
1397         'ajax'         => true,
1398     ),
1399     'core_competency_list_user_plans' => array(
1400         'classname'    => 'core_competency\external',
1401         'methodname'   => 'list_user_plans',
1402         'classpath'    => '',
1403         'description'  => 'List a user\'s learning plans.',
1404         'type'         => 'read',
1405         'capabilities' => 'moodle/competency:planviewown',
1406         'ajax'         => true,
1407     ),
1408     'core_competency_list_plan_competencies' => array(
1409         'classname'    => 'core_competency\external',
1410         'methodname'   => 'list_plan_competencies',
1411         'classpath'    => '',
1412         'description'  => 'List the competencies in a plan',
1413         'type'         => 'read',
1414         'capabilities' => 'moodle/competency:planviewown',
1415         'ajax'         => true,
1416     ),
1417     'core_competency_add_competency_to_plan' => array(
1418         'classname'    => 'core_competency\external',
1419         'methodname'   => 'add_competency_to_plan',
1420         'classpath'    => '',
1421         'description'  => 'Add the competency to a learning plan',
1422         'type'         => 'write',
1423         'capabilities' => 'moodle/competency:planmanage',
1424         'ajax'         => true,
1425     ),
1426     'core_competency_remove_competency_from_plan' => array(
1427         'classname'    => 'core_competency\external',
1428         'methodname'   => 'remove_competency_from_plan',
1429         'classpath'    => '',
1430         'description'  => 'Remove the competency from a learning plan',
1431         'type'         => 'write',
1432         'capabilities' => 'moodle/competency:planmanage',
1433         'ajax'         => true,
1434     ),
1435     'core_competency_reorder_plan_competency' => array(
1436         'classname'    => 'core_competency\external',
1437         'methodname'   => 'reorder_plan_competency',
1438         'classpath'    => '',
1439         'description'  => 'Move a plan competency to a new relative sort order.',
1440         'type'         => 'write',
1441         'capabilities' => 'moodle/competency:planmanage',
1442         'ajax'         => true,
1443     ),
1444     'core_competency_plan_request_review' => array(
1445         'classname'    => 'core_competency\external',
1446         'methodname'   => 'plan_request_review',
1447         'classpath'    => '',
1448         'description'  => 'Request for a plan to be reviewed.',
1449         'type'         => 'write',
1450         'capabilities' => 'moodle/competency:planmanagedraft',
1451         'ajax'         => true,
1452     ),
1453     'core_competency_plan_start_review' => array(
1454         'classname'    => 'core_competency\external',
1455         'methodname'   => 'plan_start_review',
1456         'classpath'    => '',
1457         'description'  => 'Start the review of a plan.',
1458         'type'         => 'write',
1459         'capabilities' => 'moodle/competency:planmanage',
1460         'ajax'         => true,
1461     ),
1462     'core_competency_plan_stop_review' => array(
1463         'classname'    => 'core_competency\external',
1464         'methodname'   => 'plan_stop_review',
1465         'classpath'    => '',
1466         'description'  => 'Stop the review of a plan.',
1467         'type'         => 'write',
1468         'capabilities' => 'moodle/competency:planmanage',
1469         'ajax'         => true,
1470     ),
1471     'core_competency_plan_cancel_review_request' => array(
1472         'classname'    => 'core_competency\external',
1473         'methodname'   => 'plan_cancel_review_request',
1474         'classpath'    => '',
1475         'description'  => 'Cancel the review of a plan.',
1476         'type'         => 'write',
1477         'capabilities' => 'moodle/competency:planmanagedraft',
1478         'ajax'         => true,
1479     ),
1480     'core_competency_approve_plan' => array(
1481         'classname'    => 'core_competency\external',
1482         'methodname'   => 'approve_plan',
1483         'classpath'    => '',
1484         'description'  => 'Approve a plan.',
1485         'type'         => 'write',
1486         'capabilities' => 'moodle/competency:planmanage',
1487         'ajax'         => true,
1488     ),
1489     'core_competency_unapprove_plan' => array(
1490         'classname'    => 'core_competency\external',
1491         'methodname'   => 'unapprove_plan',
1492         'classpath'    => '',
1493         'description'  => 'Unapprove a plan.',
1494         'type'         => 'write',
1495         'capabilities' => 'moodle/competency:planmanage',
1496         'ajax'         => true,
1497     ),
1498      'core_competency_template_has_related_data' => array(
1499         'classname'    => 'core_competency\external',
1500         'methodname'   => 'template_has_related_data',
1501         'classpath'    => '',
1502         'description'  => 'Check if a template has related data',
1503         'type'         => 'read',
1504         'capabilities' => 'moodle/competency:templateview',
1505         'ajax'         => true,
1506     ),
1507     'core_competency_get_scale_values' => array(
1508         'classname'    => 'core_competency\external',
1509         'methodname'   => 'get_scale_values',
1510         'classpath'    => '',
1511         'description'  => 'Fetch the values for a specific scale',
1512         'type'         => 'read',
1513         'capabilities' => 'moodle/competency:competencymanage',
1514         'ajax'         => true,
1515         'services'     => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1516     ),
1517     'core_competency_add_related_competency' => array(
1518         'classname'    => 'core_competency\external',
1519         'methodname'   => 'add_related_competency',
1520         'classpath'    => '',
1521         'description'  => 'Adds a related competency',
1522         'type'         => 'write',
1523         'capabilities' => 'moodle/competency:competencymanage',
1524         'ajax'         => true,
1525     ),
1526     'core_competency_remove_related_competency' => array(
1527         'classname'    => 'core_competency\external',
1528         'methodname'   => 'remove_related_competency',
1529         'classpath'    => '',
1530         'description'  => 'Remove a related competency',
1531         'type'         => 'write',
1532         'capabilities' => 'moodle/competency:competencymanage',
1533         'ajax'         => true,
1534     ),
1535     'core_competency_read_user_evidence' => array(
1536         'classname'    => 'core_competency\external',
1537         'methodname'   => 'read_user_evidence',
1538         'classpath'    => '',
1539         'description'  => 'Read an evidence of prior learning.',
1540         'type'         => 'read',
1541         'capabilities' => 'moodle/competency:userevidenceview',
1542         'ajax'         => true,
1543     ),
1544     'core_competency_delete_user_evidence' => array(
1545         'classname'    => 'core_competency\external',
1546         'methodname'   => 'delete_user_evidence',
1547         'classpath'    => '',
1548         'description'  => 'Delete an evidence of prior learning.',
1549         'type'         => 'write',
1550         'capabilities' => 'moodle/competency:userevidencemanageown',
1551         'ajax'         => true,
1552     ),
1553     'core_competency_create_user_evidence_competency' => array(
1554         'classname'    => 'core_competency\external',
1555         'methodname'   => 'create_user_evidence_competency',
1556         'classpath'    => '',
1557         'description'  => 'Create an evidence of prior learning relationship with a competency.',
1558         'type'         => 'read',
1559         'capabilities' => 'moodle/competency:userevidencemanageown, moodle/competency:competencyview',
1560         'ajax'         => true,
1561     ),
1562     'core_competency_delete_user_evidence_competency' => array(
1563         'classname'    => 'core_competency\external',
1564         'methodname'   => 'delete_user_evidence_competency',
1565         'classpath'    => '',
1566         'description'  => 'Delete an evidence of prior learning relationship with a competency.',
1567         'type'         => 'write',
1568         'capabilities' => 'moodle/competency:userevidencemanageown',
1569         'ajax'         => true,
1570     ),
1571     'core_competency_user_competency_cancel_review_request' => array(
1572         'classname'    => 'core_competency\external',
1573         'methodname'   => 'user_competency_cancel_review_request',
1574         'classpath'    => '',
1575         'description'  => 'Cancel a review request.',
1576         'type'         => 'write',
1577         'capabilities' => 'moodle/competency:userevidencemanageown',
1578         'ajax'         => true,
1579     ),
1580     'core_competency_user_competency_request_review' => array(
1581         'classname'    => 'core_competency\external',
1582         'methodname'   => 'user_competency_request_review',
1583         'classpath'    => '',
1584         'description'  => 'Request a review.',
1585         'type'         => 'write',
1586         'capabilities' => 'moodle/competency:userevidencemanageown',
1587         'ajax'         => true,
1588     ),
1589     'core_competency_user_competency_start_review' => array(
1590         'classname'    => 'core_competency\external',
1591         'methodname'   => 'user_competency_start_review',
1592         'classpath'    => '',
1593         'description'  => 'Start a review.',
1594         'type'         => 'write',
1595         'capabilities' => 'moodle/competency:competencygrade',
1596         'ajax'         => true,
1597     ),
1598     'core_competency_user_competency_stop_review' => array(
1599         'classname'    => 'core_competency\external',
1600         'methodname'   => 'user_competency_stop_review',
1601         'classpath'    => '',
1602         'description'  => 'Stop a review.',
1603         'type'         => 'write',
1604         'capabilities' => 'moodle/competency:competencygrade',
1605         'ajax'         => true,
1606     ),
1607     'core_competency_user_competency_viewed' => array(
1608         'classname'    => 'core_competency\external',
1609         'methodname'   => 'user_competency_viewed',
1610         'classpath'    => '',
1611         'description'  => 'Log the user competency viewed event.',
1612         'type'         => 'read',
1613         'capabilities' => 'moodle/competency:usercompetencyview',
1614         'ajax'         => true,
1615         'services'     => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1616     ),
1617     'core_competency_user_competency_viewed_in_plan' => array(
1618         'classname'    => 'core_competency\external',
1619         'methodname'   => 'user_competency_viewed_in_plan',
1620         'classpath'    => '',
1621         'description'  => 'Log the user competency viewed in plan event.',
1622         'type'         => 'read',
1623         'capabilities' => 'moodle/competency:usercompetencyview',
1624         'ajax'         => true,
1625         'services'     => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1626     ),
1627     'core_competency_user_competency_viewed_in_course' => array(
1628         'classname'    => 'core_competency\external',
1629         'methodname'   => 'user_competency_viewed_in_course',
1630         'classpath'    => '',
1631         'description'  => 'Log the user competency viewed in course event',
1632         'type'         => 'read',
1633         'capabilities' => 'moodle/competency:usercompetencyview',
1634         'ajax'         => true,
1635         'services'     => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1636     ),
1637     'core_competency_user_competency_plan_viewed' => array(
1638         'classname'    => 'core_competency\external',
1639         'methodname'   => 'user_competency_plan_viewed',
1640         'classpath'    => '',
1641         'description'  => 'Log the user competency plan viewed event.',
1642         'type'         => 'read',
1643         'capabilities' => 'moodle/competency:usercompetencyview',
1644         'ajax'         => true,
1645         'services'     => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1646     ),
1647     'core_competency_grade_competency' => array(
1648         'classname'    => 'core_competency\external',
1649         'methodname'   => 'grade_competency',
1650         'classpath'    => '',
1651         'description'  => 'Grade a competency.',
1652         'type'         => 'write',
1653         'capabilities' => 'moodle/competency:competencygrade',
1654         'ajax'         => true,
1655     ),
1656     'core_competency_grade_competency_in_plan' => array(
1657         'classname'    => 'core_competency\external',
1658         'methodname'   => 'grade_competency_in_plan',
1659         'classpath'    => '',
1660         'description'  => 'Grade a competency from the user plan page.',
1661         'type'         => 'write',
1662         'capabilities' => 'moodle/competency:competencygrade',
1663         'ajax'         => true,
1664     ),
1665     'core_competency_grade_competency_in_course' => array(
1666         'classname'    => 'core_competency\external',
1667         'methodname'   => 'grade_competency_in_course',
1668         'classpath'    => '',
1669         'description'  => 'Grade a competency from the course page.',
1670         'type'         => 'write',
1671         'capabilities' => 'moodle/competency:competencygrade',
1672         'ajax'         => true,
1673         'services'     => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1674     ),
1675     'core_competency_unlink_plan_from_template' => array(
1676         'classname'    => 'core_competency\external',
1677         'methodname'   => 'unlink_plan_from_template',
1678         'classpath'    => '',
1679         'description'  => 'Unlink a plan form it template.',
1680         'type'         => 'write',
1681         'capabilities' => 'moodle/competency:planmanage',
1682         'ajax'         => true,
1683     ),
1684     'core_competency_template_viewed' => array(
1685         'classname'     => 'core_competency\external',
1686         'methodname'    => 'template_viewed',
1687         'classpath'     => '',
1688         'description'   => 'Log event template viewed',
1689         'type'          => 'read',
1690         'capabilities'  => 'moodle/competency:templateview',
1691         'ajax'          => true,
1692     ),
1693     'core_competency_request_review_of_user_evidence_linked_competencies' => array(
1694         'classname'     => 'core_competency\external',
1695         'methodname'    => 'request_review_of_user_evidence_linked_competencies',
1696         'classpath'     => '',
1697         'description'   => 'Send user evidence competencies in review',
1698         'type'          => 'write',
1699         'capabilities'  => 'moodle/competency:userevidencemanageown',
1700         'ajax'          => true,
1701     ),
1702     'core_competency_update_course_competency_settings' => array(
1703         'classname'     => 'core_competency\external',
1704         'methodname'    => 'update_course_competency_settings',
1705         'classpath'     => '',
1706         'description'   => 'Update the course competency settings',
1707         'type'          => 'write',
1708         'capabilities'  => 'moodle/competency:coursecompetencyconfigure',
1709         'ajax'          => true,
1710     ),
1711     'core_competency_delete_evidence' => array(
1712         'classname'     => 'core_competency\external',
1713         'methodname'    => 'delete_evidence',
1714         'classpath'     => '',
1715         'description'   => 'Delete an evidence',
1716         'type'          => 'write',
1717         'capabilities'  => 'moodle/competency:evidencedelete',
1718         'ajax'          => true,
1719         'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1720     ),
1722     'core_webservice_get_site_info' => array(
1723         'classname' => 'core_webservice_external',
1724         'methodname' => 'get_site_info',
1725         'classpath' => 'webservice/externallib.php',
1726         'description' => 'Return some site info / user info / list web service functions',
1727         'type' => 'read',
1728         'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
1729     )
1730 );
1732 $services = array(
1733    'Moodle mobile web service'  => array(
1734         'functions' => array(), // Unused as we add the service in each function definition, third party services would use this.
1735         'enabled' => 0,
1736         'restrictedusers' => 0,
1737         'shortname' => MOODLE_OFFICIAL_MOBILE_SERVICE,
1738         'downloadfiles' => 1,
1739         'uploadfiles' => 1
1740     ),
1741 );