Web services: Difference between revisions
From MoodleDocs
No edit summary |
No edit summary |
||
| Line 10: | Line 10: | ||
email | email | ||
idnumber | idnumber | ||
login | |||
authentication method (optional , default= manual ?) | |||
OPERATION: | OPERATION: | ||
| Line 15: | Line 19: | ||
OUTPUT: | OUTPUT: | ||
id or false | id or false | ||
==delete user== | ==delete user== | ||
Revision as of 10:00, 13 November 2007
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) as an API for those writing code to work against Moodle.
Please add new functions if there's functionality you want that isn't covered (we can refactor/whittle at the end).
add user
INPUT:
firstname lastname email idnumber login authentication method (optional , default= manual ?)
OPERATION:
Adds a new user to the user database
OUTPUT:
id or false
delete user
INPUT:
idnumber or email or id
OPERATION:
User is marked as deleted
OUTPUT:
true/false
add course
INPUT:
name shortname format (default topics) idnumber
OPERATION:
Adds a new course to the course table
OUTPUT:
id or false
delete course
INPUT:
name OR shortname OR idnumber
OPERATION:
Deletes a course from the course table
OUTPUT:
true or false
