[ Index ]
 

Code source de eGroupWare 1.2.106-2
Accédez au Source d'autres logiciels libres • Soutenez Angelica Josefina !

title

Body

[fermer]

/phpgwapi/doc/xmlrpc/ -> phpgw_server-1.html (source)

[Sommaire] [Imprimer] 

   1  <HTML
   2  ><HEAD
   3  ><TITLE
   4  >   Business layer requests
   5    </TITLE
   6  ><META
   7  NAME="GENERATOR"
   8  CONTENT="Modular DocBook HTML Stylesheet Version 1.64
   9  "><LINK
  10  REL="HOME"
  11  TITLE="   eGroupWare XML-RPC/SOAP Methodology
  12    "
  13  HREF="phpgw_server.html"><LINK
  14  REL="PREVIOUS"
  15  TITLE="   eGroupWare XML-RPC/SOAP Methodology
  16    "
  17  HREF="phpgw_server.html"><LINK
  18  REL="NEXT"
  19  TITLE="   More to come...
  20    "
  21  HREF="phpgw_server-2.html"></HEAD
  22  ><BODY
  23  CLASS="SECT1"
  24  ><DIV
  25  CLASS="NAVHEADER"
  26  ><TABLE
  27  WIDTH="100%"
  28  BORDER="0"
  29  CELLPADDING="0"
  30  CELLSPACING="0"
  31  ><TR
  32  ><TH
  33  COLSPAN="3"
  34  ALIGN="center"
  35  >eGroupWare XML-RPC/SOAP Methodology</TH
  36  ></TR
  37  ><TR
  38  ><TD
  39  WIDTH="10%"
  40  ALIGN="left"
  41  VALIGN="bottom"
  42  ><A
  43  HREF="phpgw_server.html"
  44  >Prev</A
  45  ></TD
  46  ><TD
  47  WIDTH="80%"
  48  ALIGN="center"
  49  VALIGN="bottom"
  50  ></TD
  51  ><TD
  52  WIDTH="10%"
  53  ALIGN="right"
  54  VALIGN="bottom"
  55  ><A
  56  HREF="phpgw_server-2.html"
  57  >Next</A
  58  ></TD
  59  ></TR
  60  ></TABLE
  61  ><HR
  62  ALIGN="LEFT"
  63  WIDTH="100%"></DIV
  64  ><DIV
  65  CLASS="SECT1"
  66  ><H1
  67  CLASS="SECT1"
  68  ><A
  69  NAME="AEN33"
  70  >Business layer requests</A
  71  ></H1
  72  ><P
  73  >   Once a successful login return packet has been received and sessionid/kp3 have been extracted, every subsequent packet sent to the egroupware server must be preceded by an Authorization header. Here is a sample header:
  74    </P
  75  ><TABLE
  76  BORDER="0"
  77  BGCOLOR="#E0E0E0"
  78  WIDTH="100%"
  79  ><TR
  80  ><TD
  81  ><PRE
  82  CLASS="PROGRAMLISTING"
  83  >POST /egroupware/xmlrpc.php HTTP/1.0
  84  User-Agent: PHP XMLRPC 1.0
  85  Host: my.local.host
  86  Authorization: Basic ZDgxNDIyZDRkYjg5NDEyNGNiMzZlMDhhZTdlYzAxZmY6NTU3YzkyYjBmNGE4ZDVlOTUzMzI2YmU2OTQyNjM3YjQ=
  87  Content-Type: text/xml
  88  Content-Length: 875
  89    </PRE
  90  ></TD
  91  ></TR
  92  ></TABLE
  93  ><P
  94  >   The longish string is a base64 encoding of the $sessionid . ':' . $kp3. For now this is our only supported authentication method. Additional methods would probably also affect the methodCalls. This is certainly open to discussion. Following is a typical request for some contact data:
  95    </P
  96  ><TABLE
  97  BORDER="0"
  98  BGCOLOR="#E0E0E0"
  99  WIDTH="100%"
 100  ><TR
 101  ><TD
 102  ><PRE
 103  CLASS="PROGRAMLISTING"
 104  >&#60;?xml version="1.0"?&#62;
 105  &#60;methodCall&#62;
 106  &#60;methodName&#62;addressbook.boaddressbook.read_entries&#60;/methodName&#62;
 107  &#60;params&#62;
 108  &#60;param&#62;
 109  &#60;value&#62;&#60;struct&#62;
 110  &#60;member&#62;&#60;name&#62;start&#60;/name&#62;
 111  &#60;value&#62;&#60;string&#62;1&#60;/string&#62;&#60;/value&#62;
 112  &#60;/member&#62;
 113  &#60;member&#62;&#60;name&#62;limit&#60;/name&#62;
 114  &#60;value&#62;&#60;string&#62;5&#60;/string&#62;&#60;/value&#62;
 115  &#60;/member&#62;
 116  &#60;member&#62;&#60;name&#62;fields&#60;/name&#62;
 117  &#60;value&#62;&#60;struct&#62;
 118  &#60;member&#62;&#60;name&#62;n_given&#60;/name&#62;
 119  &#60;value&#62;&#60;string&#62;n_given&#60;/string&#62;&#60;/value&#62;
 120  &#60;/member&#62;
 121  &#60;member&#62;&#60;name&#62;n_family&#60;/name&#62;
 122  &#60;value&#62;&#60;string&#62;n_family&#60;/string&#62;&#60;/value&#62;
 123  &#60;/member&#62;
 124  &#60;/struct&#62;&#60;/value&#62;
 125  &#60;/member&#62;
 126  &#60;member&#62;&#60;name&#62;query&#60;/name&#62;
 127  &#60;value&#62;&#60;string&#62;&#60;/string&#62;&#60;/value&#62;
 128  &#60;/member&#62;
 129  &#60;member&#62;&#60;name&#62;filter&#60;/name&#62;
 130  &#60;value&#62;&#60;string&#62;&#60;/string&#62;&#60;/value&#62;
 131  &#60;/member&#62;
 132  &#60;member&#62;&#60;name&#62;sort&#60;/name&#62;
 133  &#60;value&#62;&#60;string&#62;&#60;/string&#62;&#60;/value&#62;
 134  &#60;/member&#62;
 135  &#60;member&#62;&#60;name&#62;order&#60;/name&#62;
 136  &#60;value&#62;&#60;string&#62;&#60;/string&#62;&#60;/value&#62;
 137  &#60;/member&#62;
 138  &#60;/struct&#62;&#60;/value&#62;
 139  &#60;/param&#62;
 140  &#60;/params&#62;
 141  &#60;/methodCall&#62;
 142    </PRE
 143  ></TD
 144  ></TR
 145  ></TABLE
 146  ><P
 147  >   Successful response:
 148    </P
 149  ><TABLE
 150  BORDER="0"
 151  BGCOLOR="#E0E0E0"
 152  WIDTH="100%"
 153  ><TR
 154  ><TD
 155  ><PRE
 156  CLASS="PROGRAMLISTING"
 157  >&#60;?xml version="1.0"?&#62;
 158  &#60;methodResponse&#62;
 159  &#60;params&#62; 
 160  &#60;param&#62;
 161  &#60;value&#62;&#60;struct&#62;
 162  &#60;member&#62;&#60;name&#62;0&#60;/name&#62;
 163  &#60;value&#62;&#60;struct&#62; 
 164  &#60;member&#62;&#60;name&#62;id&#60;/name&#62;
 165  &#60;value&#62;&#60;string&#62;1&#60;/string&#62;&#60;/value&#62;
 166  &#60;/member&#62;
 167  &#60;member&#62;&#60;name&#62;lid&#60;/name&#62;
 168  &#60;value&#62;&#60;string&#62;&#60;/string&#62;&#60;/value&#62;
 169  &#60;/member&#62;
 170  &#60;member&#62;&#60;name&#62;tid&#60;/name&#62; 
 171  &#60;value&#62;&#60;string&#62;n&#60;/string&#62;&#60;/value&#62; 
 172  &#60;/member&#62;
 173  &#60;member&#62;&#60;name&#62;owner&#60;/name&#62; 
 174  &#60;value&#62;&#60;string&#62;500&#60;/string&#62;&#60;/value&#62; 
 175  &#60;/member&#62;
 176  &#60;member&#62;&#60;name&#62;access&#60;/name&#62;
 177  &#60;value&#62;&#60;string&#62;private&#60;/string&#62;&#60;/value&#62; 
 178  &#60;/member&#62;
 179  &#60;member&#62;&#60;name&#62;cat_id&#60;/name&#62; 
 180  &#60;value&#62;&#60;string&#62;1&#60;/string&#62;&#60;/value&#62; 
 181  &#60;/member&#62; 
 182  &#60;member&#62;&#60;name&#62;n_given&#60;/name&#62; 
 183  &#60;value&#62;&#60;string&#62;Alan&#60;/string&#62;&#60;/value&#62; 
 184  &#60;/member&#62; 
 185  &#60;/struct&#62;&#60;/value&#62; 
 186  &#60;/member&#62; 
 187  &#60;member&#62;&#60;name&#62;1&#60;/name&#62;
 188  &#60;value&#62;&#60;struct&#62;
 189  &#60;member&#62;&#60;name&#62;id&#60;/name&#62;
 190  &#60;value&#62;&#60;string&#62;2&#60;/string&#62;&#60;/value&#62;
 191  &#60;/member&#62;
 192  &#60;member&#62;&#60;name&#62;lid&#60;/name&#62;
 193  &#60;value&#62;&#60;string&#62;&#60;/string&#62;&#60;/value&#62;
 194  &#60;/member&#62;
 195  &#60;member&#62;&#60;name&#62;tid&#60;/name&#62;
 196  &#60;value&#62;&#60;string&#62;n&#60;/string&#62;&#60;/value&#62;
 197  &#60;/member&#62;
 198  &#60;member&#62;&#60;name&#62;owner&#60;/name&#62;
 199  &#60;value&#62;&#60;string&#62;500&#60;/string&#62;&#60;/value&#62;
 200  &#60;/member&#62;
 201  &#60;member&#62;&#60;name&#62;access&#60;/name&#62;
 202  &#60;value&#62;&#60;string&#62;private&#60;/string&#62;&#60;/value&#62;
 203  &#60;/member&#62;
 204  &#60;member&#62;&#60;name&#62;cat_id&#60;/name&#62;
 205  &#60;value&#62;&#60;string&#62;1&#60;/string&#62;&#60;/value&#62;
 206  &#60;/member&#62;
 207  &#60;member&#62;&#60;name&#62;n_given&#60;/name&#62;
 208  &#60;value&#62;&#60;string&#62;Andy&#60;/string&#62;&#60;/value&#62;
 209  &#60;/member&#62;
 210  &#60;/struct&#62;&#60;/value&#62;
 211  &#60;/member&#62;
 212  ...
 213    </PRE
 214  ></TD
 215  ></TR
 216  ></TABLE
 217  ><P
 218  >   Unauthorized access attempt returns:
 219    </P
 220  ><TABLE
 221  BORDER="0"
 222  BGCOLOR="#E0E0E0"
 223  WIDTH="100%"
 224  ><TR
 225  ><TD
 226  ><PRE
 227  CLASS="PROGRAMLISTING"
 228  >&#60;methodResponse&#62;
 229  &#60;params&#62;
 230  &#60;param&#62;
 231  &#60;value&#62;&#60;string&#62;UNAUTHORIZED&#60;/string&#62;&#60;/value&#62;
 232  &#60;/param&#62;
 233  &#60;/params&#62;
 234  &#60;/methodResponse&#62;
 235    </PRE
 236  ></TD
 237  ></TR
 238  ></TABLE
 239  ></DIV
 240  ><DIV
 241  CLASS="NAVFOOTER"
 242  ><HR
 243  ALIGN="LEFT"
 244  WIDTH="100%"><TABLE
 245  WIDTH="100%"
 246  BORDER="0"
 247  CELLPADDING="0"
 248  CELLSPACING="0"
 249  ><TR
 250  ><TD
 251  WIDTH="33%"
 252  ALIGN="left"
 253  VALIGN="top"
 254  ><A
 255  HREF="phpgw_server.html"
 256  >Prev</A
 257  ></TD
 258  ><TD
 259  WIDTH="34%"
 260  ALIGN="center"
 261  VALIGN="top"
 262  ><A
 263  HREF="phpgw_server.html"
 264  >Home</A
 265  ></TD
 266  ><TD
 267  WIDTH="33%"
 268  ALIGN="right"
 269  VALIGN="top"
 270  ><A
 271  HREF="phpgw_server-2.html"
 272  >Next</A
 273  ></TD
 274  ></TR
 275  ><TR
 276  ><TD
 277  WIDTH="33%"
 278  ALIGN="left"
 279  VALIGN="top"
 280  >eGroupWare XML-RPC/SOAP Methodology</TD
 281  ><TD
 282  WIDTH="34%"
 283  ALIGN="center"
 284  VALIGN="top"
 285  >&nbsp;</TD
 286  ><TD
 287  WIDTH="33%"
 288  ALIGN="right"
 289  VALIGN="top"
 290  >More to come...</TD
 291  ></TR
 292  ></TABLE
 293  ></DIV
 294  ></BODY
 295  ></HTML
 296  >

Corps

Corps

Corps

Corps


Généré le : Sun Feb 25 17:20:01 2007 par Balluche grâce à PHPXref 0.7