Errors handling in web services

This article is a stub. Please help improve Moodle Docs by editing it and adding some content.

I'm looking at how we return errors in the current Moodle web services. Here is the status:

- exceptions are raised: 16 functions

- string error messages: 2 functions (create notes / send messages)

- download/upload script return string error message (JSON) + error code

- When exception are raised, a unique error message is returned. It is format by the protocol server.

REST: <?xml version="1.0" encoding="UTF-8"?> <EXCEPTION class="invalid_parameter_exception">

   <MESSAGE>Invalid parameter value detected</MESSAGE>
   <DEBUGINFO></DEBUGINFO>

</EXCEPTION>

XMLRPC/SOAP: respective error format

Documentation