Web services
Note: This page is a work-in-progress. Feedback and suggested improvements are welcome. Please join the discussion on moodle.org or use the page comments.
Moodle 2.0
Introduction
This page described the Web Services module implemented for Moodle 2.0
Implementation
Web Services module has been conceived in a purpose to be ported on different Moodle version, and also on different project. It has also for purpose to support multiple web services protocol, adding a new protocol should be relatively easy.
Client Point of view
Till the protocol is supported by Moodle web services, the client will be able to use the web service as it would do for any web services for the selected protocol.
Security
How does the web services are secured ?
Security layer implemented by every protocol?
List of functions
All callable functions are declared into Moodle API, please read Moodle API documentation.
FOLLOWING DOCUMENTATION WILL NEED TO BE DELETED
This page is to decide on a STANDARD list of CORE web service functions that we should support in Moodle (by XMLRPC, REST and SOAP with the option to plug in AMFPHP for Flash/Flex interfaces) as an API for those writing code to work against Moodle.
The tracker bug for all this is here: MDL-12886
add_users
I think we should require all data needed for a successful "first login" to Moodle without popping him out the profile page to fill in all missing required data. This may require extra inputs such as city, description ... (unsure of the full list depending of Moodle version ?). Also password should be "required" if authentication method is "internal" .
INPUT: one or more of these in an array
firstname lastname email idnumber login authentication method (optional , default= manual ?)
OPERATION:
Adds one or more new users to the user database
OUTPUT:
array of ids or false
delete_users
INPUT:
String: field name ('id' or 'idnumber' or 'email' or 'login') Array: values
OPERATION:
User is marked as deleted All it's role assignments are destroyed
OUTPUT:
true/false
To Be Defined:
- Security: avoid devastating calls such as delete_users ('confirmed',array(1)) or delete_users('firstname',array('patrick')). Where to implement it?
- Wildcards: such as delete_users (array('idnumber','CS%'). Permit or not?
get_users
INPUT: one or more of these
idnumber or email or id or login
OPERATION:
user record with optional fields set (Moodle 1.8 and later) and maybe some fields filtered out (password, email if user said not to disclose it ...) depending of the identity of the "caller" (admin or the user himself)
OUTPUT:
false or user record
add_courses
INPUT: one or more of these in an array
name shortname format (default topics) idnumber
OPERATION:
Adds a new course to the course table
OUTPUT:
id or false
delete_courses
INPUT: one or more of these in an array
name OR shortname OR idnumber OR id
OPERATION:
Deletes courses from the course table What about associated ressources, roles ...
OUTPUT:
true or false
get_courses
INPUT: one or more of these in an array
id or idnumber or shortname
OPERATION:
fetch course record with some fields filtered out depending of the "caller" identity (admin, teacher, student ...)
OUTPUT:
false or course records in an array
Doubts: so id , idenumber or shortname stands for... user, category, the very course you want to get itself?
add_enrolments
INPUT:
course unique Id (Moodle's ID or idnumber or shortname) (could be one or an array) user unique id (Moodle's ID or idnumber or login or email) (could be one or an array) role id (id or shortname or legacy capability name) (could be one or an array)
OPERATION:
assign given user a given role to given course
OUTPUT:
true or false
delete_enrolments
INPUT:
course unique Id (Moodle's ID or idnumber or shortname) (could be one or an array) user unique id (Moodle's ID or idnumber or login or email) (could be one or an array) role id (teacher, non editing teacher, student (?) ...) (could be one or an array)
OPERATION:
remove given user's "standard" role from given course
OUTPUT:
true or false
get_enrolments
INPUT:
user unique id (Moodle's ID or idnumber or login or email) context course or site
OPERATION:
return a "list" of course's id in which given user move given user has some role assigned return all the roles for a given courseid
OUTPUT:
"array" of (course id, course shortname, course fullname, role id, role name, course url) or false in case of error (bad user id)
get_recent_activity
INPUT:
user unique id (Moodle's ID or idnumber or login or email) course unique Id (Moodle's ID ,idnumber or shortname) - optional (default = all my courses) timestamp - optional (default = time of last connexion in every course)
OPERATION:
return a "list" of changes (resource added/modified, new activities, etc.) for courses in which given user has some role assigned - since timestamp or last connexion in given course
OUTPUT:
"array" of (course id, course shortname, course fullname, role id, role name, url of the resource/activity, time of change) or false in case of error (bad user/course id)
get_grades
(see grade_get_course_grade in grade/querylib.php)
INPUT:
user unique id (Moodle's ID or idnumber or login or email) course unique Id (Moodle's ID ,idnumber or shortname) - optional (default = all my courses)
OPERATION:
return a "list" of grades and statistics for the given student in the given course
OUTPUT:
"array" of grades records (name,maxgrade,grade,percent,weight,weighted,sortOrder) and "array" of stats (gradeItems,allgrades, points,totalpoints, percent, weight, weighted;) or false in case of error (bad user/course id or user not in course)
get_groups
OPERATION:
return a "list" of group records in a given course (or site ?)
add_groups
delete_groups
get_group_members
OPERATION:
return a "list" of ids for members of a group (within a course or global)
add_group_members
OPERATION:
add new members to a group
delete_group_members
OPERATION:
remove membership from a group
add_calendar_events
OPERATION:
add/modify an event in Moodle database (site, course, private ...)
delete_calendar_events
OPERATION:
delete given events
get_calendar_events
OPERATION:
return in an "exportable" format (iCal, vCal ...)an event recorded in Moodle database (site, course, private ...)