diff --git a/phpgwapi/doc/xmlrpc/phpgw_server.txt b/phpgwapi/doc/xmlrpc/phpgw_server.txt index cf01bac4bf..640b535057 100644 --- a/phpgwapi/doc/xmlrpc/phpgw_server.txt +++ b/phpgwapi/doc/xmlrpc/phpgw_server.txt @@ -1,5 +1,3 @@ - - eGroupWare XML-RPC/SOAP Methodology (C) 2001-2004 Miles Lott @@ -28,7 +26,7 @@ will be undertaken. A client or server sends the appropriate XML-RPC or SOAP packet containing host, user, and password information to -the phpgw server. The server then assigns a sessionid and +the egroupware server. The server then assigns a sessionid and key, which is returned to the client in the appropriate format. @@ -50,181 +48,105 @@ The first request a client will make is the system.login method. Here is a sample of a server login packet in XML-RPC: - - system.login - - - - server_name - my.host.name - - username - bubba - - password - gump - - - - And the same in SOAP: - - - my.host.name - bubba - gump - - - The same style of packet would be required for a user/client login. A successful login should yield the following reply: - - - - sessionid - cf5c5534307562fc57915608377db007 - - kp3 - 2fe54daa11c8d52116788aa3f93cb70e - - - - - And a failed login: - - - - GOAWAY - XOXO - - - - - -eqweqw - 1.1.2 system.logout Logout: - - system.logout - - - sessionid - ea35cac53d2c12bd05caecd97304478a - - kp3 - 4f2b256e0da4e7cbbebaac9f1fc8ca4a - - - - - Logout worked: - - - - GOODBYE - XOXO - - - - - 2 Business layer requests @@ -235,15 +157,10 @@ sent to the egroupware server must be preceded by an Authorization header. Here is a sample header: POST /egroupware/xmlrpc.php HTTP/1.0 - User-Agent: PHP XMLRPC 1.0 - Host: my.local.host - Authorization: Basic ZDgxNDIyZDRkYjg5NDEyNGNiMzZlMDhhZTdlYzAxZmY6NTU3YzkyYjBmNGE4ZDVlOTUzMzI2YmU2OTQyNjM3YjQ= - Content-Type: text/xml - Content-Length: 875 The longish string is a base64 encoding of the $sessionid @@ -253,191 +170,100 @@ methodCalls. This is certainly open to discussion. Following is a typical request for some contact data: - - addressbook.boaddressbook.read_entries - - - - start - 1 - - limit - 5 - - fields - - n_given - n_given - - n_family - n_family - - - - query - - - filter - - - sort - - - order - - - - - - Successful response: - - - - - 0 - - id - 1 - - lid - - - tid - n - - owner - 500 - - access - private - - cat_id - 1 - - n_given - Alan - - - - 1 - - id - 2 - - lid - - - tid - n - - owner - 500 - - access - private - - cat_id - 1 - - n_given - Andy - - - ... @@ -445,17 +271,11 @@ Successful response: Unauthorized access attempt returns: - - - UNAUTHORIZED - - - 3 More to come...