Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
docs:xmlrpc [26-05-2008 00:00] cwacha created |
docs:xmlrpc [10-10-2019 23:30] (current) cwacha |
||
---|---|---|---|
Line 13: | Line 13: | ||
(in case anything should change substantially). | (in case anything should change substantially). | ||
+ | ===== Getting Started ===== | ||
+ | {{ : | ||
+ | |||
+ | - Download an XML-RPC Client such as this one here: http:// | ||
+ | - Enable the XML-RPC in config.php (HINT: '' | ||
+ | - Setup an XML RPC user in auth.php (HINT: uncomment ' | ||
+ | - Set the Endpoint URI to your installation: | ||
+ | - Choose method: '' | ||
+ | - As parameters type in your API key (don't forget quotation marks if necessary) | ||
+ | - Hit Execute | ||
+ | - If everything worked you should see an object response similar to the one below | ||
+ | |||
+ | < | ||
+ | { | ||
+ | result = " | ||
+ | status = success; | ||
+ | } | ||
+ | </ | ||
===== Authentication and Security ===== | ===== Authentication and Security ===== | ||
Line 35: | Line 53: | ||
^ Key ^ Type ^ Values | ^ Key ^ Type ^ Values | ||
- | | status | string | success, error | Status contains " | + | | status | string | success, error | Status contains " |
- | | result | mixed | + | | result | mixed | - | This is the actual result of the function. In case of error this field remains empty | |
- | | errmsg | string | - | Contains a human readable error message in case of error. This key is not set in case of success | + | | errmsg | string | - | Contains a human readable error message in case of error. This key is not set in case of success | |
- | + | ||
- | + | ||
- | ===== Methods in Version 1.0 ===== | + | |
- | + | ||
- | ^ Method Name ^ Parameters ^ Return value ^ Description ^ | + | |
- | | version | + | |
- | | get_contact | + | |
+ | ===== Available Methods ===== | ||
+ | ^ Method Name ^ Parameters ^ Return value ^ Description ^ | ||
+ | | system.listMethods | ||
+ | | system.methodSignature | method | signature of method | Returns the method signature for the specified method | | ||
+ | | system.methodHelp | ||
+ | | version | ||
+ | | get_contact | ||
+ | | get_contacts | ||
+ | | set_contact | ||
+ | | count_contacts | ||
+ | | delete_contact | ||
+ | | import_vcard | ||
+ | | export_vcard | ||