1cb0188dca80d7ed1639738377687c37233024e8
[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(
38     // Cohort related functions.
40     'core_cohort_create_cohorts' => array(
41         'classname'   => 'core_cohort_external',
42         'methodname'  => 'create_cohorts',
43         'classpath'   => 'cohort/externallib.php',
44         'description' => 'Creates new cohorts.',
45         'type'        => 'write',
46         'capabilities'=> 'moodle/cohort:manage',
47     ),
49     'core_cohort_delete_cohorts' => array(
50         'classname'   => 'core_cohort_external',
51         'methodname'  => 'delete_cohorts',
52         'classpath'   => 'cohort/externallib.php',
53         'description' => 'Deletes all specified cohorts.',
54         'type'        => 'delete',
55         'capabilities'=> 'moodle/cohort:manage',
56     ),
58     'core_cohort_get_cohorts' => array(
59         'classname'   => 'core_cohort_external',
60         'methodname'  => 'get_cohorts',
61         'classpath'   => 'cohort/externallib.php',
62         'description' => 'Returns cohort details.',
63         'type'        => 'read',
64         'capabilities'=> 'moodle/cohort:view',
65     ),
67     'core_cohort_update_cohorts' => array(
68         'classname'   => 'core_cohort_external',
69         'methodname'  => 'update_cohorts',
70         'classpath'   => 'cohort/externallib.php',
71         'description' => 'Updates existing cohorts.',
72         'type'        => 'write',
73         'capabilities'=> 'moodle/cohort:manage',
74     ),
76     'core_cohort_add_cohort_members' => array(
77         'classname'   => 'core_cohort_external',
78         'methodname'  => 'add_cohort_members',
79         'classpath'   => 'cohort/externallib.php',
80         'description' => 'Adds cohort members.',
81         'type'        => 'write',
82         'capabilities'=> 'moodle/cohort:assign',
83     ),
85     'core_cohort_delete_cohort_members' => array(
86         'classname'   => 'core_cohort_external',
87         'methodname'  => 'delete_cohort_members',
88         'classpath'   => 'cohort/externallib.php',
89         'description' => 'Deletes cohort members.',
90         'type'        => 'delete',
91         'capabilities'=> 'moodle/cohort:assign',
92     ),
94     'core_cohort_get_cohort_members' => array(
95         'classname'   => 'core_cohort_external',
96         'methodname'  => 'get_cohort_members',
97         'classpath'   => 'cohort/externallib.php',
98         'description' => 'Returns cohort members.',
99         'type'        => 'read',
100         'capabilities'=> 'moodle/cohort:view',
101     ),
103     // === group related functions ===
105     'moodle_group_create_groups' => array(
106         'classname'   => 'core_group_external',
107         'methodname'  => 'create_groups',
108         'classpath'   => 'group/externallib.php',
109         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_group_create_groups(). ',
110         'type'        => 'write',
111         'capabilities'=> 'moodle/course:managegroups',
112     ),
114     'core_group_create_groups' => array(
115         'classname'   => 'core_group_external',
116         'methodname'  => 'create_groups',
117         'classpath'   => 'group/externallib.php',
118         'description' => 'Creates new groups.',
119         'type'        => 'write',
120         'capabilities'=> 'moodle/course:managegroups',
121     ),
123     'moodle_group_get_groups' => array(
124         'classname'   => 'core_group_external',
125         'methodname'  => 'get_groups',
126         'classpath'   => 'group/externallib.php',
127         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_group_get_groups()',
128         'type'        => 'read',
129         'capabilities'=> 'moodle/course:managegroups',
130     ),
132     'core_group_get_groups' => array(
133         'classname'   => 'core_group_external',
134         'methodname'  => 'get_groups',
135         'classpath'   => 'group/externallib.php',
136         'description' => 'Returns group details.',
137         'type'        => 'read',
138         'capabilities'=> 'moodle/course:managegroups',
139     ),
141     'moodle_group_get_course_groups' => array(
142         'classname'   => 'core_group_external',
143         'methodname'  => 'get_course_groups',
144         'classpath'   => 'group/externallib.php',
145         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_group_get_course_groups()',
146         'type'        => 'read',
147         'capabilities'=> 'moodle/course:managegroups',
148     ),
150     'core_group_get_course_groups' => array(
151         'classname'   => 'core_group_external',
152         'methodname'  => 'get_course_groups',
153         'classpath'   => 'group/externallib.php',
154         'description' => 'Returns all groups in specified course.',
155         'type'        => 'read',
156         'capabilities'=> 'moodle/course:managegroups',
157     ),
159     'moodle_group_delete_groups' => array(
160         'classname'   => 'core_group_external',
161         'methodname'  => 'delete_groups',
162         'classpath'   => 'group/externallib.php',
163         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_group_delete_groups()',
164         'type'        => 'delete',
165         'capabilities'=> 'moodle/course:managegroups',
166     ),
168     'core_group_delete_groups' => array(
169         'classname'   => 'core_group_external',
170         'methodname'  => 'delete_groups',
171         'classpath'   => 'group/externallib.php',
172         'description' => 'Deletes all specified groups.',
173         'type'        => 'delete',
174         'capabilities'=> 'moodle/course:managegroups',
175     ),
177     'moodle_group_get_groupmembers' => array(
178         'classname'   => 'core_group_external',
179         'methodname'  => 'get_group_members',
180         'classpath'   => 'group/externallib.php',
181         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_group_get_group_members()',
182         'type'        => 'read',
183         'capabilities'=> 'moodle/course:managegroups',
184     ),
186     'core_group_get_group_members' => array(
187         'classname'   => 'core_group_external',
188         'methodname'  => 'get_group_members',
189         'classpath'   => 'group/externallib.php',
190         'description' => 'Returns group members.',
191         'type'        => 'read',
192         'capabilities'=> 'moodle/course:managegroups',
193     ),
195     'moodle_group_add_groupmembers' => array(
196         'classname'   => 'core_group_external',
197         'methodname'  => 'add_group_members',
198         'classpath'   => 'group/externallib.php',
199         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_group_add_group_members()',
200         'type'        => 'write',
201         'capabilities'=> 'moodle/course:managegroups',
202     ),
204     'core_group_add_group_members' => array(
205         'classname'   => 'core_group_external',
206         'methodname'  => 'add_group_members',
207         'classpath'   => 'group/externallib.php',
208         'description' => 'Adds group members.',
209         'type'        => 'write',
210         'capabilities'=> 'moodle/course:managegroups',
211     ),
213     'moodle_group_delete_groupmembers' => array(
214         'classname'   => 'core_group_external',
215         'methodname'  => 'delete_group_members',
216         'classpath'   => 'group/externallib.php',
217         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_group_delete_group_members()',
218         'type'        => 'delete',
219         'capabilities'=> 'moodle/course:managegroups',
220     ),
222     'core_group_delete_group_members' => array(
223         'classname'   => 'core_group_external',
224         'methodname'  => 'delete_group_members',
225         'classpath'   => 'group/externallib.php',
226         'description' => 'Deletes group members.',
227         'type'        => 'delete',
228         'capabilities'=> 'moodle/course:managegroups',
229     ),
231     'core_group_create_groupings' => array(
232         'classname'   => 'core_group_external',
233         'methodname'  => 'create_groupings',
234         'classpath'   => 'group/externallib.php',
235         'description' => 'Creates new groupings',
236         'type'        => 'write',
237     ),
239     'core_group_update_groupings' => array(
240         'classname'   => 'core_group_external',
241         'methodname'  => 'update_groupings',
242         'classpath'   => 'group/externallib.php',
243         'description' => 'Updates existing groupings',
244         'type'        => 'write',
245     ),
247     'core_group_get_groupings' => array(
248         'classname'   => 'core_group_external',
249         'methodname'  => 'get_groupings',
250         'classpath'   => 'group/externallib.php',
251         'description' => 'Returns groupings details.',
252         'type'        => 'read',
253     ),
255     'core_group_get_course_groupings' => array(
256         'classname'   => 'core_group_external',
257         'methodname'  => 'get_course_groupings',
258         'classpath'   => 'group/externallib.php',
259         'description' => 'Returns all groupings in specified course.',
260         'type'        => 'read',
261     ),
263     'core_group_delete_groupings' => array(
264         'classname'   => 'core_group_external',
265         'methodname'  => 'delete_groupings',
266         'classpath'   => 'group/externallib.php',
267         'description' => 'Deletes all specified groupings.',
268         'type'        => 'write',
269     ),
271     'core_group_assign_grouping' => array(
272         'classname'   => 'core_group_external',
273         'methodname'  => 'assign_grouping',
274         'classpath'   => 'group/externallib.php',
275         'description' => 'Assing groups from groupings',
276         'type'        => 'write',
277     ),
279     'core_group_unassign_grouping' => array(
280         'classname'   => 'core_group_external',
281         'methodname'  => 'unassign_grouping',
282         'classpath'   => 'group/externallib.php',
283         'description' => 'Unassing groups from groupings',
284         'type'        => 'write',
285     ),
287     // === file related functions ===
289     'moodle_file_get_files' => array(
290         'classname'   => 'core_files_external',
291         'methodname'  => 'get_files',
292         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_files_get_files()',
293         'type'        => 'read',
294         'classpath'   => 'files/externallib.php',
295     ),
297     'core_files_get_files' => array(
298         'classname'   => 'core_files_external',
299         'methodname'  => 'get_files',
300         'description' => 'browse moodle files',
301         'type'        => 'read',
302         'classpath'   => 'files/externallib.php',
303     ),
305     'moodle_file_upload' => array(
306         'classname'   => 'core_files_external',
307         'methodname'  => 'upload',
308         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_files_upload()',
309         'type'        => 'write',
310         'classpath'   => 'files/externallib.php',
311     ),
313     'core_files_upload' => array(
314         'classname'   => 'core_files_external',
315         'methodname'  => 'upload',
316         'description' => 'upload a file to moodle',
317         'type'        => 'write',
318         'classpath'   => 'files/externallib.php',
319     ),
321     // === user related functions ===
323     'moodle_user_create_users' => array(
324         'classname'   => 'core_user_external',
325         'methodname'  => 'create_users',
326         'classpath'   => 'user/externallib.php',
327         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_user_create_users()',
328         'type'        => 'write',
329         'capabilities'=> 'moodle/user:create',
330     ),
332     'core_user_create_users' => array(
333         'classname'   => 'core_user_external',
334         'methodname'  => 'create_users',
335         'classpath'   => 'user/externallib.php',
336         'description' => 'Create users.',
337         'type'        => 'write',
338         'capabilities'=> 'moodle/user:create',
339     ),
341     'core_user_get_users' => array(
342         'classname'   => 'core_user_external',
343         'methodname'  => 'get_users',
344         'classpath'   => 'user/externallib.php',
345         'description' => 'search for users matching the parameters',
346         'type'        => 'read',
347         'capabilities'=> 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update',
348     ),
350     'moodle_user_get_users_by_id' => array(
351         'classname'   => 'core_user_external',
352         'methodname'  => 'get_users_by_id',
353         'classpath'   => 'user/externallib.php',
354         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_user_get_users_by_id()',
355         'type'        => 'read',
356         'capabilities'=> 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update',
357     ),
359     'core_user_get_users_by_field' => array(
360         'classname'   => 'core_user_external',
361         'methodname'  => 'get_users_by_field',
362         'classpath'   => 'user/externallib.php',
363         'description' => 'Retrieve users information for a specified unique field - If you want to do a user search, use core_user_get_users()',
364         'type'        => 'read',
365         'capabilities'=> 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update',
366     ),
368     'core_user_get_users_by_id' => array(
369         'classname'   => 'core_user_external',
370         'methodname'  => 'get_users_by_id',
371         'classpath'   => 'user/externallib.php',
372         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has been replaced by core_user_get_users_by_field()',
373         'type'        => 'read',
374         'capabilities'=> 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update',
375     ),
377     'moodle_user_get_users_by_courseid' => array(
378         'classname'   => 'core_enrol_external',
379         'methodname'  => 'get_enrolled_users',
380         'classpath'   => 'enrol/externallib.php',
381         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_enrol_get_enrolled_users()',
382         'type'        => 'read',
383         'capabilities'=> 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update, moodle/site:accessallgroups',
384     ),
386     'moodle_user_get_course_participants_by_id' => array(
387         'classname'   => 'core_user_external',
388         'methodname'  => 'get_course_user_profiles',
389         'classpath'   => 'user/externallib.php',
390         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_user_get_course_user_profiles()',
391         'type'        => 'read',
392         'capabilities'=> 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update, moodle/site:accessallgroups',
393     ),
395     'core_user_get_course_user_profiles' => array(
396         'classname'   => 'core_user_external',
397         'methodname'  => 'get_course_user_profiles',
398         'classpath'   => 'user/externallib.php',
399         'description' => 'Get course user profiles (each of the profils matching a course id and a user id).',
400         'type'        => 'read',
401         'capabilities'=> 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update, moodle/site:accessallgroups',
402     ),
404     'moodle_user_delete_users' => array(
405         'classname'   => 'core_user_external',
406         'methodname'  => 'delete_users',
407         'classpath'   => 'user/externallib.php',
408         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_user_delete_users()',
409         'type'        => 'write',
410         'capabilities'=> 'moodle/user:delete',
411     ),
413     'core_user_delete_users' => array(
414         'classname'   => 'core_user_external',
415         'methodname'  => 'delete_users',
416         'classpath'   => 'user/externallib.php',
417         'description' => 'Delete users.',
418         'type'        => 'write',
419         'capabilities'=> 'moodle/user:delete',
420     ),
422     'moodle_user_update_users' => array(
423         'classname'   => 'core_user_external',
424         'methodname'  => 'update_users',
425         'classpath'   => 'user/externallib.php',
426         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_user_update_users()',
427         'type'        => 'write',
428         'capabilities'=> 'moodle/user:update',
429     ),
431     'core_user_update_users' => array(
432         'classname'   => 'core_user_external',
433         'methodname'  => 'update_users',
434         'classpath'   => 'user/externallib.php',
435         'description' => 'Update users.',
436         'type'        => 'write',
437         'capabilities'=> 'moodle/user:update',
438     ),
440     'core_user_add_user_device' => array(
441         'classname'   => 'core_user_external',
442         'methodname'  => 'add_user_device',
443         'classpath'   => 'user/externallib.php',
444         'description' => 'Store mobile user devices information for PUSH Notifications.',
445         'type'        => 'write',
446         'capabilities'=> '',
447     ),
449     // === enrol related functions ===
451     'core_enrol_get_enrolled_users_with_capability' => array(
452         'classname'   => 'core_enrol_external',
453         'methodname'  => 'get_enrolled_users_with_capability',
454         'classpath'   => 'enrol/externallib.php',
455         'description' => 'For each course and capability specified, return a list of the users that are enrolled in the course
456                           and have that capability',
457         'type'        => 'read',
458     ),
460     'moodle_enrol_get_enrolled_users' => array(
461         'classname'   => 'moodle_enrol_external',
462         'methodname'  => 'get_enrolled_users',
463         'classpath'   => 'enrol/externallib.php',
464         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. Please use core_enrol_get_enrolled_users() (previously known as moodle_user_get_users_by_courseid).',
465         'type'        => 'read',
466         'capabilities'=> 'moodle/site:viewparticipants, moodle/course:viewparticipants,
467             moodle/role:review, moodle/site:accessallgroups, moodle/course:enrolreview',
468     ),
470     'core_enrol_get_enrolled_users' => array(
471         'classname'   => 'core_enrol_external',
472         'methodname'  => 'get_enrolled_users',
473         'classpath'   => 'enrol/externallib.php',
474         'description' => 'Get enrolled users by course id.',
475         'type'        => 'read',
476         'capabilities'=> 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update, moodle/site:accessallgroups',
477     ),
479     'moodle_enrol_get_users_courses' => array(
480         'classname'   => 'core_enrol_external',
481         'methodname'  => 'get_users_courses',
482         'classpath'   => 'enrol/externallib.php',
483         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_enrol_get_users_courses()',
484         'type'        => 'read',
485         'capabilities'=> 'moodle/course:viewparticipants',
486     ),
488     'core_enrol_get_users_courses' => array(
489         'classname'   => 'core_enrol_external',
490         'methodname'  => 'get_users_courses',
491         'classpath'   => 'enrol/externallib.php',
492         'description' => 'Get the list of courses where a user is enrolled in',
493         'type'        => 'read',
494         'capabilities'=> 'moodle/course:viewparticipants',
495     ),
497     'core_enrol_get_course_enrolment_methods' => array(
498         'classname'   => 'core_enrol_external',
499         'methodname'  => 'get_course_enrolment_methods',
500         'classpath'   => 'enrol/externallib.php',
501         'description' => 'Get the list of course enrolment methods',
502         'type'        => 'read',
503     ),
505     // === Role related functions ===
507     'moodle_role_assign' => array(
508         'classname'   => 'core_role_external',
509         'methodname'  => 'assign_roles',
510         'classpath'   => 'enrol/externallib.php',
511         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_role_assign_role()',
512         'type'        => 'write',
513         'capabilities'=> 'moodle/role:assign',
514     ),
516     'core_role_assign_roles' => array(
517         'classname'   => 'core_role_external',
518         'methodname'  => 'assign_roles',
519         'classpath'   => 'enrol/externallib.php',
520         'description' => 'Manual role assignments.',
521         'type'        => 'write',
522         'capabilities'=> 'moodle/role:assign',
523     ),
525     'moodle_role_unassign' => array(
526         'classname'   => 'core_role_external',
527         'methodname'  => 'unassign_roles',
528         'classpath'   => 'enrol/externallib.php',
529         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_role_unassign_role()',
530         'type'        => 'write',
531         'capabilities'=> 'moodle/role:assign',
532     ),
534     'core_role_unassign_roles' => array(
535         'classname'   => 'core_role_external',
536         'methodname'  => 'unassign_roles',
537         'classpath'   => 'enrol/externallib.php',
538         'description' => 'Manual role unassignments.',
539         'type'        => 'write',
540         'capabilities'=> 'moodle/role:assign',
541     ),
543     // === course related functions ===
545     'core_course_get_contents' => array(
546         'classname'   => 'core_course_external',
547         'methodname'  => 'get_course_contents',
548         'classpath'   => 'course/externallib.php',
549         'description' => 'Get course contents',
550         'type'        => 'read',
551         'capabilities'=> 'moodle/course:update,moodle/course:viewhiddencourses',
552     ),
554     'moodle_course_get_courses' => array(
555         'classname'   => 'core_course_external',
556         'methodname'  => 'get_courses',
557         'classpath'   => 'course/externallib.php',
558         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_course_get_courses()',
559         'type'        => 'read',
560         'capabilities'=> 'moodle/course:view,moodle/course:update,moodle/course:viewhiddencourses',
561     ),
563     'core_course_get_courses' => array(
564         'classname'   => 'core_course_external',
565         'methodname'  => 'get_courses',
566         'classpath'   => 'course/externallib.php',
567         'description' => 'Return course details',
568         'type'        => 'read',
569         'capabilities'=> 'moodle/course:view,moodle/course:update,moodle/course:viewhiddencourses',
570     ),
572     'moodle_course_create_courses' => array(
573         'classname'   => 'core_course_external',
574         'methodname'  => 'create_courses',
575         'classpath'   => 'course/externallib.php',
576         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_course_create_courses()',
577         'type'        => 'write',
578         'capabilities'=> 'moodle/course:create,moodle/course:visibility',
579     ),
581     'core_course_create_courses' => array(
582         'classname'   => 'core_course_external',
583         'methodname'  => 'create_courses',
584         'classpath'   => 'course/externallib.php',
585         'description' => 'Create new courses',
586         'type'        => 'write',
587         'capabilities'=> 'moodle/course:create,moodle/course:visibility',
588     ),
590     'core_course_delete_courses' => array(
591         'classname'   => 'core_course_external',
592         'methodname'  => 'delete_courses',
593         'classpath'   => 'course/externallib.php',
594         'description' => 'Deletes all specified courses',
595         'type'        => 'write',
596         'capabilities'=> 'moodle/course:delete',
597     ),
599     'core_course_delete_modules' => array(
600         'classname' => 'core_course_external',
601         'methodname' => 'delete_modules',
602         'classpath' => 'course/externallib.php',
603         'description' => 'Deletes all specified module instances',
604         'type' => 'write',
605         'capabilities' => 'moodle/course:manageactivities'
606     ),
608     'core_course_duplicate_course' => array(
609         'classname'   => 'core_course_external',
610         'methodname'  => 'duplicate_course',
611         'classpath'   => 'course/externallib.php',
612         'description' => 'Duplicate an existing course (creating a new one) without user data',
613         'type'        => 'write',
614         'capabilities'=> 'moodle/backup:backupcourse,moodle/restore:restorecourse,moodle/course:create',
615     ),
617     'core_course_update_courses' => array(
618         'classname'   => 'core_course_external',
619         'methodname'  => 'update_courses',
620         'classpath'   => 'course/externallib.php',
621         'description' => 'Update courses',
622         'type'        => 'write',
623         'capabilities'=> 'moodle/course:update,moodle/course:changecategory,moodle/course:changefullname,moodle/course:changeshortname,moodle/course:changeidnumber,moodle/course:changesummary,moodle/course:visibility',
624     ),
626     // === course category related functions ===
628     'core_course_get_categories' => array(
629         'classname'   => 'core_course_external',
630         'methodname'  => 'get_categories',
631         'classpath'   => 'course/externallib.php',
632         'description' => 'Return category details',
633         'type'        => 'read',
634         'capabilities'=> 'moodle/category:viewhiddencategories',
635     ),
637     'core_course_create_categories' => array(
638         'classname'   => 'core_course_external',
639         'methodname'  => 'create_categories',
640         'classpath'   => 'course/externallib.php',
641         'description' => 'Create course categories',
642         'type'        => 'write',
643         'capabilities'=> 'moodle/category:manage',
644     ),
646     'core_course_update_categories' => array(
647         'classname'   => 'core_course_external',
648         'methodname'  => 'update_categories',
649         'classpath'   => 'course/externallib.php',
650         'description' => 'Update categories',
651         'type'        => 'write',
652         'capabilities'=> 'moodle/category:manage',
653     ),
655     'core_course_delete_categories' => array(
656         'classname'   => 'core_course_external',
657         'methodname'  => 'delete_categories',
658         'classpath'   => 'course/externallib.php',
659         'description' => 'Delete course categories',
660         'type'        => 'write',
661         'capabilities'=> 'moodle/category:manage',
662     ),
664     'core_course_import_course' => array(
665         'classname'   => 'core_course_external',
666         'methodname'  => 'import_course',
667         'classpath'   => 'course/externallib.php',
668         'description' => 'Import course data from a course into another course. Does not include any user data.',
669         'type'        => 'write',
670         'capabilities'=> 'moodle/backup:backuptargetimport, moodle/restore:restoretargetimport',
671     ),
673     // === message related functions ===
675     'moodle_message_send_instantmessages' => array(
676         'classname'   => 'core_message_external',
677         'methodname'  => 'send_instant_messages',
678         'classpath'   => 'message/externallib.php',
679         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_message_send_instant_messages()',
680         'type'        => 'write',
681         'capabilities'=> 'moodle/site:sendmessage',
682     ),
684     'core_message_send_instant_messages' => array(
685         'classname'   => 'core_message_external',
686         'methodname'  => 'send_instant_messages',
687         'classpath'   => 'message/externallib.php',
688         'description' => 'Send instant messages',
689         'type'        => 'write',
690         'capabilities'=> 'moodle/site:sendmessage',
691     ),
693     'core_message_create_contacts' => array(
694         'classname'   => 'core_message_external',
695         'methodname'  => 'create_contacts',
696         'classpath'   => 'message/externallib.php',
697         'description' => 'Add contacts to the contact list',
698         'type'        => 'write',
699         'capabilities'=> '',
700     ),
702     'core_message_delete_contacts' => array(
703         'classname'   => 'core_message_external',
704         'methodname'  => 'delete_contacts',
705         'classpath'   => 'message/externallib.php',
706         'description' => 'Remove contacts from the contact list',
707         'type'        => 'write',
708         'capabilities'=> '',
709     ),
711     'core_message_block_contacts' => array(
712         'classname'   => 'core_message_external',
713         'methodname'  => 'block_contacts',
714         'classpath'   => 'message/externallib.php',
715         'description' => 'Block contacts',
716         'type'        => 'write',
717         'capabilities'=> '',
718     ),
720     'core_message_unblock_contacts' => array(
721         'classname'   => 'core_message_external',
722         'methodname'  => 'unblock_contacts',
723         'classpath'   => 'message/externallib.php',
724         'description' => 'Unblock contacts',
725         'type'        => 'write',
726         'capabilities'=> '',
727     ),
729     'core_message_get_contacts' => array(
730         'classname'   => 'core_message_external',
731         'methodname'  => 'get_contacts',
732         'classpath'   => 'message/externallib.php',
733         'description' => 'Retrieve the contact list',
734         'type'        => 'read',
735         'capabilities'=> '',
736     ),
738     'core_message_search_contacts' => array(
739         'classname'   => 'core_message_external',
740         'methodname'  => 'search_contacts',
741         'classpath'   => 'message/externallib.php',
742         'description' => 'Search for contacts',
743         'type'        => 'read',
744         'capabilities'=> '',
745     ),
747     // === notes related functions ===
749     'moodle_notes_create_notes' => array(
750         'classname'   => 'core_notes_external',
751         'methodname'  => 'create_notes',
752         'classpath'   => 'notes/externallib.php',
753         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_notes_create_notes()',
754         'type'        => 'write',
755         'capabilities'=> 'moodle/notes:manage',
756     ),
758     'core_notes_create_notes' => array(
759         'classname'   => 'core_notes_external',
760         'methodname'  => 'create_notes',
761         'classpath'   => 'notes/externallib.php',
762         'description' => 'Create notes',
763         'type'        => 'write',
764         'capabilities'=> 'moodle/notes:manage',
765     ),
767     'core_notes_delete_notes' => array(
768         'classname'   => 'core_notes_external',
769         'methodname'  => 'delete_notes',
770         'classpath'   => 'notes/externallib.php',
771         'description' => 'Delete notes',
772         'type'        => 'write',
773         'capabilities'=> 'moodle/notes:manage',
774     ),
776     'core_notes_get_notes' => array(
777         'classname'   => 'core_notes_external',
778         'methodname'  => 'get_notes',
779         'classpath'   => 'notes/externallib.php',
780         'description' => 'Get notes',
781         'type'        => 'read',
782         'capabilities'=> 'moodle/notes:view',
783     ),
785     'core_notes_update_notes' => array(
786         'classname'   => 'core_notes_external',
787         'methodname'  => 'update_notes',
788         'classpath'   => 'notes/externallib.php',
789         'description' => 'Update notes',
790         'type'        => 'write',
791         'capabilities'=> 'moodle/notes:manage',
792     ),
794     // === grading related functions ===
796     'core_grading_get_definitions' => array(
797         'classname'   => 'core_grading_external',
798         'methodname'  => 'get_definitions',
799         'classpath'   => 'grade/externallib.php',
800         'description' => 'Get grading definitions',
801         'type'        => 'read'
802     ),
804     'core_grade_get_definitions' => array(
805         'classname'   => 'core_grade_external',
806         'methodname'  => 'get_definitions',
807         'classpath'   => 'grade/externallib.php',
808         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has been renamed as core_grading_get_definitions()',
809         'type'        => 'read'
810     ),
812     'core_grading_get_gradingform_instances' => array(
813         'classname'   => 'core_grading_external',
814         'methodname'  => 'get_gradingform_instances',
815         'classpath'   => 'grade/externallib.php',
816         'description' => 'Get grading form instances',
817         'type'        => 'read'
818     ),
820     // === webservice related functions ===
822     'moodle_webservice_get_siteinfo' => array(
823         'classname'   => 'core_webservice_external',
824         'methodname'  => 'get_site_info',
825         'classpath'   => 'webservice/externallib.php',
826         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_webservice_get_site_info()',
827         'type'        => 'read',
828     ),
830     'core_webservice_get_site_info' => array(
831         'classname'   => 'core_webservice_external',
832         'methodname'  => 'get_site_info',
833         'classpath'   => 'webservice/externallib.php',
834         'description' => 'Return some site info / user info / list web service functions',
835         'type'        => 'read',
836     ),
838     'core_get_string' => array(
839         'classname'   => 'core_external',
840         'methodname'  => 'get_string',
841         'classpath'   => 'lib/external/externallib.php',
842         'description' => 'Return a translated string - similar to core get_string() call',
843         'type'        => 'read',
844     ),
846     'core_get_strings' => array(
847         'classname'   => 'core_external',
848         'methodname'  => 'get_strings',
849         'classpath'   => 'lib/external/externallib.php',
850         'description' => 'Return some translated strings - like several core get_string() calls',
851         'type'        => 'read',
852     ),
854     'core_get_component_strings' => array(
855         'classname'   => 'core_external',
856         'methodname'  => 'get_component_strings',
857         'classpath'   => 'lib/external/externallib.php',
858         'description' => 'Return all raw strings (with {$a->xxx}) for a specific component
859             - similar to core get_component_strings() call',
860         'type'        => 'read',
861     ),
864     // === Calendar related functions ===
866     'core_calendar_delete_calendar_events' => array(
867         'classname'   => 'core_calendar_external',
868         'methodname'  => 'delete_calendar_events',
869         'description' => 'Delete calendar events',
870         'classpath'   => 'calendar/externallib.php',
871         'type'        => 'write',
872         'capabilities'=> 'moodle/calendar:manageentries', 'moodle/calendar:manageownentries', 'moodle/calendar:managegroupentries'
873     ),
876     'core_calendar_get_calendar_events' => array(
877         'classname'   => 'core_calendar_external',
878         'methodname'  => 'get_calendar_events',
879         'description' => 'Get calendar events',
880         'classpath'   => 'calendar/externallib.php',
881         'type'        => 'read',
882         'capabilities'=> 'moodle/calendar:manageentries', 'moodle/calendar:manageownentries', 'moodle/calendar:managegroupentries'
883     ),
885     'core_calendar_create_calendar_events' => array(
886         'classname'   => 'core_calendar_external',
887         'methodname'  => 'create_calendar_events',
888         'description' => 'Create calendar events',
889         'classpath'   => 'calendar/externallib.php',
890         'type'        => 'write',
891         'capabilities'=> 'moodle/calendar:manageentries', 'moodle/calendar:manageownentries', 'moodle/calendar:managegroupentries'
892     ),
893 );
895 $services = array(
896    'Moodle mobile web service'  => array(
897         'functions' => array (
898             'moodle_enrol_get_users_courses',
899             'moodle_enrol_get_enrolled_users',
900             'moodle_user_get_users_by_id',
901             'moodle_webservice_get_siteinfo',
902             'moodle_notes_create_notes',
903             'moodle_user_get_course_participants_by_id',
904             'moodle_user_get_users_by_courseid',
905             'moodle_message_send_instantmessages',
906             'core_course_get_contents',
907             'core_get_component_strings',
908             'core_user_add_user_device',
909             'core_calendar_get_calendar_events'),
910         'enabled' => 0,
911         'restrictedusers' => 0,
912         'shortname' => MOODLE_OFFICIAL_MOBILE_SERVICE,
913         'downloadfiles' => 1,
914         'uploadfiles' => 1
915     ),
916 );