Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

Web services: Difference between revisions

From MoodleDocs
No edit summary
m (Protected "Web services": Developer Docs Migration ([Edit=Allow only administrators] (indefinite)))
 
(178 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==
 
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

Latest revision as of 06:13, 22 December 2022

Important:

This content of this page has been updated and migrated to the new Moodle Developer Resources. The information contained on the page should no longer be seen up-to-date.

Why not view this page on the new site and help us to migrate more content to the new site!