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 | ><?xml version="1.0"?> |
---|
105 | <methodCall> |
---|
106 | <methodName>addressbook.boaddressbook.read_entries</methodName> |
---|
107 | <params> |
---|
108 | <param> |
---|
109 | <value><struct> |
---|
110 | <member><name>start</name> |
---|
111 | <value><string>1</string></value> |
---|
112 | </member> |
---|
113 | <member><name>limit</name> |
---|
114 | <value><string>5</string></value> |
---|
115 | </member> |
---|
116 | <member><name>fields</name> |
---|
117 | <value><struct> |
---|
118 | <member><name>n_given</name> |
---|
119 | <value><string>n_given</string></value> |
---|
120 | </member> |
---|
121 | <member><name>n_family</name> |
---|
122 | <value><string>n_family</string></value> |
---|
123 | </member> |
---|
124 | </struct></value> |
---|
125 | </member> |
---|
126 | <member><name>query</name> |
---|
127 | <value><string></string></value> |
---|
128 | </member> |
---|
129 | <member><name>filter</name> |
---|
130 | <value><string></string></value> |
---|
131 | </member> |
---|
132 | <member><name>sort</name> |
---|
133 | <value><string></string></value> |
---|
134 | </member> |
---|
135 | <member><name>order</name> |
---|
136 | <value><string></string></value> |
---|
137 | </member> |
---|
138 | </struct></value> |
---|
139 | </param> |
---|
140 | </params> |
---|
141 | </methodCall> |
---|
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 | ><?xml version="1.0"?> |
---|
158 | <methodResponse> |
---|
159 | <params> |
---|
160 | <param> |
---|
161 | <value><struct> |
---|
162 | <member><name>0</name> |
---|
163 | <value><struct> |
---|
164 | <member><name>id</name> |
---|
165 | <value><string>1</string></value> |
---|
166 | </member> |
---|
167 | <member><name>lid</name> |
---|
168 | <value><string></string></value> |
---|
169 | </member> |
---|
170 | <member><name>tid</name> |
---|
171 | <value><string>n</string></value> |
---|
172 | </member> |
---|
173 | <member><name>owner</name> |
---|
174 | <value><string>500</string></value> |
---|
175 | </member> |
---|
176 | <member><name>access</name> |
---|
177 | <value><string>private</string></value> |
---|
178 | </member> |
---|
179 | <member><name>cat_id</name> |
---|
180 | <value><string>1</string></value> |
---|
181 | </member> |
---|
182 | <member><name>n_given</name> |
---|
183 | <value><string>Alan</string></value> |
---|
184 | </member> |
---|
185 | </struct></value> |
---|
186 | </member> |
---|
187 | <member><name>1</name> |
---|
188 | <value><struct> |
---|
189 | <member><name>id</name> |
---|
190 | <value><string>2</string></value> |
---|
191 | </member> |
---|
192 | <member><name>lid</name> |
---|
193 | <value><string></string></value> |
---|
194 | </member> |
---|
195 | <member><name>tid</name> |
---|
196 | <value><string>n</string></value> |
---|
197 | </member> |
---|
198 | <member><name>owner</name> |
---|
199 | <value><string>500</string></value> |
---|
200 | </member> |
---|
201 | <member><name>access</name> |
---|
202 | <value><string>private</string></value> |
---|
203 | </member> |
---|
204 | <member><name>cat_id</name> |
---|
205 | <value><string>1</string></value> |
---|
206 | </member> |
---|
207 | <member><name>n_given</name> |
---|
208 | <value><string>Andy</string></value> |
---|
209 | </member> |
---|
210 | </struct></value> |
---|
211 | </member> |
---|
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 | ><methodResponse> |
---|
229 | <params> |
---|
230 | <param> |
---|
231 | <value><string>UNAUTHORIZED</string></value> |
---|
232 | </param> |
---|
233 | </params> |
---|
234 | </methodResponse> |
---|
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 | >phpGroupWare XML-RPC/SOAP Methodology</TD |
---|
281 | ><TD |
---|
282 | WIDTH="34%" |
---|
283 | ALIGN="center" |
---|
284 | VALIGN="top" |
---|
285 | > </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 | > |
---|