docs:xmlrpc

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
docs:xmlrpc [08-04-2015 09:53]
127.0.0.1 external edit
docs:xmlrpc [10-10-2019 23:30] (current)
cwacha
Line 14: Line 14:
  
 ===== Getting Started ===== ===== Getting Started =====
-  - Download an XML-RPC Client such as this one here: http://www.ditchnet.org/xmlrpc/+{{ :docs:xmlrpc_example.png?nolink&500|}} 
 + 
 +  - Download an XML-RPC Client such as this one here: http://www.ditchnet.org/xmlrpc/ or use the example python script provided here https://svn.code.sf.net/p/iaddressbook/code/trunk/docs/xmlrpc.py
   - Enable the XML-RPC in config.php (HINT: ''$conf['xmlrpc_enable'] = 1'')   - Enable the XML-RPC in config.php (HINT: ''$conf['xmlrpc_enable'] = 1'')
-  - Uncomment/setup an XML RPC user in auth.php+  - Setup an XML RPC user in auth.php (HINT: uncomment 'abcd' api_key for testing)
   - Set the Endpoint URI to your installation: http://yourdomain.com/your_address_book/xmlrpc.php   - Set the Endpoint URI to your installation: http://yourdomain.com/your_address_book/xmlrpc.php
   - Choose method: ''version''   - Choose method: ''version''
Line 59: Line 61:
  
 ^ Method Name     ^ Parameters ^ Return value ^ Description ^ ^ Method Name     ^ Parameters ^ Return value ^ Description ^
 +| system.listMethods     | | array of available methods | Returns all supported methods by iAddressBook XMLRPC |
 +| system.methodSignature | method | signature of method | Returns the method signature for the specified method |
 +| system.methodHelp      | method | help string of method | Returns the Parameters and return values for the given method |
 | version         | api_key    | version string | Returns the iAddressBook version (i.e. "1.0") | | version         | api_key    | version string | Returns the iAddressBook version (i.e. "1.0") |
 | get_contact     | api_key, contact id    | contact | Returns the contact with the given id | | get_contact     | api_key, contact id    | contact | Returns the contact with the given id |
Line 67: Line 72:
 | import_vcard    | api_key, vcard as string | success or error | Imports a vCard into the addressbook, returns success or error | | import_vcard    | api_key, vcard as string | success or error | Imports a vCard into the addressbook, returns success or error |
 | export_vcard    | api_key, contact id's | vcards as string | Exports all contacts matching the id's as one vCard string | | export_vcard    | api_key, contact id's | vcards as string | Exports all contacts matching the id's as one vCard string |
- 
  
  • docs/xmlrpc.1428479604.txt.gz
  • Last modified: 17-11-2016 12:33
  • (external edit)