| author | Sandro Knauß <knauss@netzguerilla.net> |
| Sun, 18 Dec 2011 18:03:45 +0100 | |
| branch | devel |
| changeset 81 | fea4c6760ca5 |
| parent 77 | 7dce6c0f06fb |
| child 271 | b218238e76b9 |
| permissions | -rw-r--r-- |
| 72 | 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
2 |
<html> |
|
3 |
||
4 |
||
5 |
<head> |
|
6 |
<title>Iro · API docs</title> |
|
7 |
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
|
8 |
<meta charset="utf-8"> |
|
9 |
<meta name="description" content=""> |
|
10 |
<meta name="keywords" content=""> |
|
11 |
<link rel="shortcut icon" type="image/x-icon" href="images/favicon.png"> |
|
12 |
<link rel="stylesheet" href="css/reset.css" type="text/css" media="screen"> |
|
13 |
<link rel="stylesheet" href="css/960.css" type="text/css" media="screen"> |
|
14 |
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen"> |
|
15 |
<!--[if IE]><link rel="stylesheet" href="css/style-ie.css" type="text/css" media="screen" /><![endif] --> |
|
16 |
</head> |
|
17 |
<body> |
|
18 |
<div id="head-container"> |
|
19 |
<div id="head"> |
|
20 |
<h1 id="logo"><a href="index.html" class="logo" title="Netzguerilla"><span>Netzguerilla</span></a></h1> |
|
21 |
<ul id="menu"> |
|
|
77
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
74
diff
changeset
|
22 |
<li><a href="index.html" class="menu">Iro</a></li><li><a href="current.html" class="menu active">API Documentation</a></li><li><a href="new.html" class="menu">geplante API Documentation</a></li><li><a href="database.html" class="menu">Datenbank Schema</a></li><li><a href="impressum.html" class="menu">Impressum</a></li> |
| 72 | 23 |
</ul> |
24 |
</div> |
|
25 |
</div> |
|
26 |
<div id="content-container"> |
|
27 |
<div id="content" class="container_12"> |
|
28 |
<div id="main" class="grid_9"> |
|
29 |
<h2>API Dokumentation</h2> |
|
30 |
<div class="item"> |
|
31 |
<p> |
|
32 |
</p> |
|
33 |
<ol> |
|
34 |
<li value="1">1. <a href="#api-intro">Einführung</a></li> |
|
35 |
<li value="2">2. |
|
36 |
<a href="#api-interfaces">Interfaces</a> |
|
37 |
<ol> |
|
38 |
<li value="2.1">2.1 <a href="#interface-xmlrpc">XML-RPC</a></li> |
|
39 |
</ol> |
|
40 |
</li> |
|
41 |
<li value="3">3. |
|
42 |
<a href="#api-methods">Methoden</a> |
|
43 |
<ol> |
|
44 |
<li value="3.1">3.1 <a href="#method-startSMS">StartSMS</a></li><li value="3.2">3.2 <a href="#method-startFAX">StartFAX</a></li><li value="3.3">3.3 <a href="#method-startMail">StartMail</a></li><li value="3.4">3.4 <a href="#method-status">Status</a></li><li value="3.5">3.5 <a href="#method-stop">Stop</a></li><li value="3.6">3.6 <a href="#method-getProvider">GetProvider</a></li><li value="3.7">3.7 <a href="#method-getDefaultProvider">GetDefaultProvider</a></li> |
|
45 |
</ol> |
|
46 |
</li> |
|
47 |
</ol> |
|
48 |
</div><div class="item" id="api-intro"> |
|
49 |
<h3>Einführung</h3> |
|
50 |
<p> |
|
51 |
Die Iro API enthält Funktion, die für den Massenversand nützlich sind. |
|
52 |
</p> |
|
53 |
</div><div class="item" id="api-interfaces"> |
|
54 |
<h3>Interfaces</h3> |
|
55 |
<p> |
|
56 |
Die Iro API stellt zur Zeit nur ein Interfaces bereit. |
|
57 |
</p> |
|
58 |
<div class="item" id="interface-xmlrpc"> |
|
59 |
<h4>XML-RPC</h4> |
|
60 |
<p> |
|
61 |
Interface-URI: <code>https://<em><benutzer></em>:<em><passwort></em>@localhost:8000</code> |
|
62 |
</p> |
|
63 |
<p> |
|
64 |
Die aufgerufene Methode wird dabei im <code><methodName /></code> übergeben. |
|
65 |
</p> |
|
66 |
</div> |
|
67 |
</div><div class="item" id="api-methods"> |
|
68 |
<h3>Methoden</h3> |
|
69 |
<div class="item" id="method-startSMS"> |
|
70 |
<h4>StartSMS</h4> |
|
|
74
c471fed3cab8
update document creation:
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
71 |
<p><code>startSMS(message, recipients, provider='default')</code></p> |
| 72 | 72 |
<p>Versendet eine SMS.</p> |
73 |
<h5>Parameter</h5> |
|
74 |
<table class="docs"> |
|
75 |
<thead> |
|
76 |
<tr> |
|
77 |
<td>Parameter</td> |
|
78 |
<td>Typ</td> |
|
79 |
<td>Beschreibung</td> |
|
80 |
</tr> |
|
81 |
</thead> |
|
82 |
<tbody> |
|
83 |
<tr> |
|
84 |
<td>message</td> |
|
85 |
<td>string</td> |
|
86 |
<td> Nachricht</td> |
|
87 |
</tr><tr> |
|
88 |
<td>recipients</td> |
|
89 |
<td>list</td> |
|
90 |
<td> eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)</td> |
|
91 |
</tr><tr> |
|
92 |
<td>provider</td> |
|
93 |
<td>string</td> |
|
| 73 | 94 |
<td> Provider über den geschickt werden soll</td> |
| 72 | 95 |
</tr> |
96 |
</tbody> |
|
97 |
</table> |
|
98 |
<h5>Ausgabe</h5> |
|
99 |
<table class="docs"> |
|
100 |
<thead> |
|
101 |
<tr> |
|
102 |
<td>Parameter</td> |
|
103 |
<td>Typ</td> |
|
104 |
<td>Beschreibung</td> |
|
105 |
</tr> |
|
106 |
</thead> |
|
107 |
<tbody> |
|
108 |
<tr> |
|
109 |
<td>id</td> |
|
110 |
<td>hash</td> |
|
111 |
<td> Die ID des Auftrages</td> |
|
112 |
</tr> |
|
113 |
</tbody> |
|
114 |
</table> |
|
115 |
</div><div class="item" id="method-startFAX"> |
|
116 |
<h4>StartFAX</h4> |
|
|
74
c471fed3cab8
update document creation:
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
117 |
<p><code>startFAX(subject, fax, recipients, provider='default')</code></p> |
| 72 | 118 |
<p>Versendet ein FAX.</p> |
119 |
<h5>Parameter</h5> |
|
120 |
<table class="docs"> |
|
121 |
<thead> |
|
122 |
<tr> |
|
123 |
<td>Parameter</td> |
|
124 |
<td>Typ</td> |
|
125 |
<td>Beschreibung</td> |
|
126 |
</tr> |
|
127 |
</thead> |
|
128 |
<tbody> |
|
129 |
<tr> |
|
130 |
<td>subject</td> |
|
131 |
<td>string</td> |
|
132 |
<td> der Betreff</td> |
|
133 |
</tr><tr> |
|
134 |
<td>fax</td> |
|
135 |
<td>string</td> |
|
136 |
<td> das pdf base64 kodiert</td> |
|
137 |
</tr><tr> |
|
138 |
<td>recipients</td> |
|
139 |
<td>list</td> |
|
140 |
<td> eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)</td> |
|
141 |
</tr><tr> |
|
142 |
<td>provider</td> |
|
143 |
<td>string</td> |
|
| 73 | 144 |
<td> Provider über den geschickt werden soll</td> |
| 72 | 145 |
</tr> |
146 |
</tbody> |
|
147 |
</table> |
|
148 |
<h5>Ausgabe</h5> |
|
149 |
<table class="docs"> |
|
150 |
<thead> |
|
151 |
<tr> |
|
152 |
<td>Parameter</td> |
|
153 |
<td>Typ</td> |
|
154 |
<td>Beschreibung</td> |
|
155 |
</tr> |
|
156 |
</thead> |
|
157 |
<tbody> |
|
158 |
<tr> |
|
159 |
<td>id</td> |
|
160 |
<td>hash</td> |
|
161 |
<td> Die ID des Auftrages</td> |
|
162 |
</tr> |
|
163 |
</tbody> |
|
164 |
</table> |
|
165 |
</div><div class="item" id="method-startMail"> |
|
166 |
<h4>StartMail</h4> |
|
|
74
c471fed3cab8
update document creation:
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
167 |
<p><code>startMail(subject, body, recipients, frm, provider='default')</code></p> |
| 72 | 168 |
<p>Versendet eine Email.</p> |
169 |
<h5>Parameter</h5> |
|
170 |
<table class="docs"> |
|
171 |
<thead> |
|
172 |
<tr> |
|
173 |
<td>Parameter</td> |
|
174 |
<td>Typ</td> |
|
175 |
<td>Beschreibung</td> |
|
176 |
</tr> |
|
177 |
</thead> |
|
178 |
<tbody> |
|
179 |
<tr> |
|
180 |
<td>subject</td> |
|
181 |
<td>string</td> |
|
182 |
<td> der Betreff</td> |
|
183 |
</tr><tr> |
|
184 |
<td>body</td> |
|
185 |
<td>string</td> |
|
186 |
<td> der Email Body</td> |
|
187 |
</tr><tr> |
|
188 |
<td>recipients</td> |
|
189 |
<td>list</td> |
|
190 |
<td> eine Liste von Emailadressen</td> |
|
191 |
</tr><tr> |
|
192 |
<td>frm</td> |
|
193 |
<td>string</td> |
|
194 |
<td> Die Absender Emailadresse</td> |
|
195 |
</tr><tr> |
|
196 |
<td>provider</td> |
|
197 |
<td>string</td> |
|
| 73 | 198 |
<td> Provider über den geschickt werden soll</td> |
| 72 | 199 |
</tr> |
200 |
</tbody> |
|
201 |
</table> |
|
202 |
<h5>Ausgabe</h5> |
|
203 |
<table class="docs"> |
|
204 |
<thead> |
|
205 |
<tr> |
|
206 |
<td>Parameter</td> |
|
207 |
<td>Typ</td> |
|
208 |
<td>Beschreibung</td> |
|
209 |
</tr> |
|
210 |
</thead> |
|
211 |
<tbody> |
|
212 |
<tr> |
|
213 |
<td>id</td> |
|
214 |
<td>hash</td> |
|
215 |
<td> Die ID des Auftrages</td> |
|
216 |
</tr> |
|
217 |
</tbody> |
|
218 |
</table> |
|
219 |
</div><div class="item" id="method-status"> |
|
220 |
<h4>Status</h4> |
|
|
74
c471fed3cab8
update document creation:
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
221 |
<p><code>status(id=None, detailed=False)</code></p> |
| 72 | 222 |
<p>Gibt den aktuellen Status eines Auftrages zurück.</p> |
223 |
<h5>Parameter</h5> |
|
224 |
<table class="docs"> |
|
225 |
<thead> |
|
226 |
<tr> |
|
227 |
<td>Parameter</td> |
|
228 |
<td>Typ</td> |
|
229 |
<td>Beschreibung</td> |
|
230 |
</tr> |
|
231 |
</thead> |
|
232 |
<tbody> |
|
233 |
<tr> |
|
234 |
<td>id</td> |
|
235 |
<td>hash</td> |
|
| 73 | 236 |
<td> Eine Auftragsnummer</td> |
| 72 | 237 |
</tr><tr> |
238 |
<td>detailed</td> |
|
239 |
<td>boolean</td> |
|
| 73 | 240 |
<td> Details ausgeben</td> |
| 72 | 241 |
</tr> |
242 |
</tbody> |
|
243 |
</table> |
|
244 |
<h5>Ausgabe</h5> |
|
245 |
<table class="docs"> |
|
246 |
<thead> |
|
247 |
<tr> |
|
248 |
<td>Parameter</td> |
|
249 |
<td>Typ</td> |
|
250 |
<td>Beschreibung</td> |
|
251 |
</tr> |
|
252 |
</thead> |
|
253 |
<tbody> |
|
254 |
<tr> |
|
255 |
<td>jobs</td> |
|
256 |
<td>list</td> |
|
257 |
<td> Eine Liste der Aufträge.</td> |
|
258 |
</tr><tr> |
|
259 |
<td>job.name</td> |
|
260 |
<td>string</td> |
|
261 |
<td> Angebener Name</td> |
|
262 |
</tr><tr> |
|
263 |
<td>job.status</td> |
|
264 |
<td>string</td> |
|
265 |
<td> Status des Auftrages</td> |
|
266 |
</tr> |
|
267 |
</tbody> |
|
268 |
</table> |
|
269 |
</div><div class="item" id="method-stop"> |
|
270 |
<h4>Stop</h4> |
|
|
74
c471fed3cab8
update document creation:
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
271 |
<p><code>stop(id)</code></p> |
| 72 | 272 |
<p>Stoppt den angegeben Auftrag.</p> |
273 |
<h5>Parameter</h5> |
|
274 |
<table class="docs"> |
|
275 |
<thead> |
|
276 |
<tr> |
|
277 |
<td>Parameter</td> |
|
278 |
<td>Typ</td> |
|
279 |
<td>Beschreibung</td> |
|
280 |
</tr> |
|
281 |
</thead> |
|
282 |
<tbody> |
|
283 |
<tr> |
|
284 |
<td>id</td> |
|
285 |
<td>hash</td> |
|
286 |
<td> Eine Auftragsnummer</td> |
|
287 |
</tr> |
|
288 |
</tbody> |
|
289 |
</table> |
|
290 |
</div><div class="item" id="method-getProvider"> |
|
291 |
<h4>GetProvider</h4> |
|
|
74
c471fed3cab8
update document creation:
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
292 |
<p><code>getProvider(typ)</code></p> |
| 72 | 293 |
<p>Gibt eine Liste aller verfügbaren Provider zurück.</p> |
294 |
<h5>Parameter</h5> |
|
295 |
<table class="docs"> |
|
296 |
<thead> |
|
297 |
<tr> |
|
298 |
<td>Parameter</td> |
|
299 |
<td>Typ</td> |
|
300 |
<td>Beschreibung</td> |
|
301 |
</tr> |
|
302 |
</thead> |
|
303 |
<tbody> |
|
304 |
<tr> |
|
305 |
<td>typ</td> |
|
306 |
<td>string</td> |
|
307 |
<td> Der Typ zu dem die Providerloste ausgeben werden soll |
|
308 |
Einer der Liste ["sms","fax","mail"]</td> |
|
309 |
</tr> |
|
310 |
</tbody> |
|
311 |
</table> |
|
312 |
<h5>Ausgabe</h5> |
|
313 |
<table class="docs"> |
|
314 |
<thead> |
|
315 |
<tr> |
|
316 |
<td>Parameter</td> |
|
317 |
<td>Typ</td> |
|
318 |
<td>Beschreibung</td> |
|
319 |
</tr> |
|
320 |
</thead> |
|
321 |
<tbody> |
|
322 |
<tr> |
|
323 |
<td>providerlist</td> |
|
324 |
<td>list</td> |
|
325 |
<td> Eine Liste aller möglichen Provider</td> |
|
326 |
</tr> |
|
327 |
</tbody> |
|
328 |
</table> |
|
329 |
</div><div class="item" id="method-getDefaultProvider"> |
|
330 |
<h4>GetDefaultProvider</h4> |
|
|
74
c471fed3cab8
update document creation:
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
331 |
<p><code>getDefaultProvider(typ)</code></p> |
| 72 | 332 |
<p>Gibt den Standardprovider zurück.</p> |
333 |
<h5>Parameter</h5> |
|
334 |
<table class="docs"> |
|
335 |
<thead> |
|
336 |
<tr> |
|
337 |
<td>Parameter</td> |
|
338 |
<td>Typ</td> |
|
339 |
<td>Beschreibung</td> |
|
340 |
</tr> |
|
341 |
</thead> |
|
342 |
<tbody> |
|
343 |
<tr> |
|
344 |
<td>typ</td> |
|
345 |
<td>string</td> |
|
346 |
<td> Der Typ zu dem die Providerloste ausgeben werden soll |
|
347 |
Einer der Liste ["sms","fax","mail"]</td> |
|
348 |
</tr> |
|
349 |
</tbody> |
|
350 |
</table> |
|
351 |
<h5>Ausgabe</h5> |
|
352 |
<table class="docs"> |
|
353 |
<thead> |
|
354 |
<tr> |
|
355 |
<td>Parameter</td> |
|
356 |
<td>Typ</td> |
|
357 |
<td>Beschreibung</td> |
|
358 |
</tr> |
|
359 |
</thead> |
|
360 |
<tbody> |
|
361 |
<tr> |
|
362 |
<td>provider</td> |
|
363 |
<td>string</td> |
|
364 |
<td> Der Standardprovider für den angeben Typ</td> |
|
365 |
</tr> |
|
366 |
</tbody> |
|
367 |
</table> |
|
368 |
</div> |
|
369 |
</div> |
|
370 |
</div> |
|
371 |
<div class="clear"></div> |
|
372 |
</div> |
|
373 |
</div> |
|
374 |
<div id="foot-container"> |
|
375 |
<div id="foot"> |
|
376 |
<p>© 2010-2011 <a href="impressum.html">Netzguerilla.net</a>.</p> |
|
377 |
</div> |
|
378 |
</div> |
|
379 |
</body> |
|
380 |
</html> |