MDL-50132 mod_choice: New WS mod_choice_get_choices_by_courses
[moodle.git] / mod / choice / db / services.php
CommitLineData
b87f31db
JL
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/>.
16
17/**
18 * Choice external functions and service definitions.
19 *
20 * @package mod_choice
21 * @category external
22 * @copyright 2015 Juan Leyva <juan@moodle.com>
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24 * @since Moodle 3.0
25 */
26
27defined('MOODLE_INTERNAL') || die;
28
29$functions = array(
30
31 'mod_choice_get_choice_results' => array(
32 'classname' => 'mod_choice_external',
33 'methodname' => 'get_choice_results',
34 'description' => 'Retrieve users results for a given choice.',
35 'type' => 'read',
36 'capabilities' => ''
37 ),
38
565528ce
JL
39 'mod_choice_get_choice_options' => array(
40 'classname' => 'mod_choice_external',
41 'methodname' => 'get_choice_options',
42 'description' => 'Retrieve options for a specific choice.',
43 'type' => 'read',
44 'capabilities' => 'mod/choice:choose'
45 ),
10064594
JL
46
47 'mod_choice_submit_choice_response' => array(
48 'classname' => 'mod_choice_external',
49 'methodname' => 'submit_choice_response',
50 'description' => 'Submit responses to a specific choice item.',
51 'type' => 'write',
52 'capabilities' => 'mod/choice:choose'
53 ),
4c4d3b73
JL
54
55 'mod_choice_view_choice' => array(
56 'classname' => 'mod_choice_external',
57 'methodname' => 'view_choice',
58 'description' => 'Trigger the course module viewed event and update the module completion status.',
59 'type' => 'write',
60 'capabilities' => ''
61 ),
f07a2bb0
JL
62
63 'mod_choice_get_choices_by_courses' => array(
64 'classname' => 'mod_choice_external',
65 'methodname' => 'get_choices_by_courses',
66 'description' => 'Returns a list of choice instances in a provided set of courses,
67 if no courses are provided then all the choice instances the user has access to will be returned.',
68 'type' => 'read',
69 'capabilities' => ''
70 ),
b87f31db 71);