|
|
(177 intermediate revisions by 19 users not shown) |
Line 1: |
Line 1: |
| 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.
| | {{Template:Migrated|newDocId=/docs/apis/subsystems/external/}} |
| | |
| Please add new functions if there's functionality you want that isn't covered (we can refactor/whittle at the end).
| |
| | |
| ==add user==
| |
| 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. In particular password should be "required" if authentication method is "internal" . This may require extra inputs such as city, description ... (unsure of the full ist depending of Moodle version ?).
| |
| | |
| 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
| |