| author | Sandro Knauß <knauss@netzguerilla.net> |
| Wed, 25 Apr 2012 00:04:47 +0200 | |
| branch | devel |
| changeset 274 | 1653470ccaff |
| parent 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> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
6 |
<title>Iro · api docs current</title> |
| 72 | 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"> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
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="database.html" class="menu">Datenbase Schema</a></li><li><a href="about.html" class="menu">About us</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"> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
29 |
<h2>API Documentation</h2> |
| 72 | 30 |
<div class="item"> |
31 |
<p> |
|
32 |
</p> |
|
33 |
<ol> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
34 |
<li value="1">1. <a href="#api-intro">Intro</a></li> |
| 72 | 35 |
<li value="2">2. |
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
36 |
<a href="#api-interfaces">Interfaces</a> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
37 |
<ol> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
38 |
<li value="2.1">2.1 <a href="#interface-xmlrpc">XML-RPC</a></li> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
39 |
<li value="2.1">2.2 <a href="#interface-soap">SOAP</a></li> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
40 |
<li value="2.3">2.3 <a href="#interface-json">JSON</a></li> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
41 |
<li value="2.4">2.4 <a href="#interface-jsonp">JSONP</a></li> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
42 |
</ol> |
| 72 | 43 |
</li> |
44 |
<li value="3">3. |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
45 |
<a href="#api-methods">Methods</a> |
| 72 | 46 |
<ol> |
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
47 |
<li value="3.1">3.1 <a href="#method-status">Status</a></li><li value="3.2">3.2 <a href="#method-sms">Sms</a></li><li value="3.3">3.3 <a href="#method-fax">Fax</a></li><li value="3.4">3.4 <a href="#method-mail">Mail</a></li><li value="3.5">3.5 <a href="#method-routes">Routes</a></li><li value="3.6">3.6 <a href="#method-defaultRoute">DefaultRoute</a></li><li value="3.7">3.7 <a href="#method-bill">Bill</a></li><li value="3.8">3.8 <a href="#method-telnumber">Telnumber</a></li><li value="3.9">3.9 <a href="#method-email">Email</a></li> |
| 72 | 48 |
</ol> |
49 |
</li> |
|
50 |
</ol> |
|
51 |
</div><div class="item" id="api-intro"> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
52 |
<h3>Intro</h3> |
| 72 | 53 |
<p> |
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
54 |
Iro API has many methods, that are usefull if you want to send a bunch of messages. This Site describes the API for Iro 1.0. |
| 72 | 55 |
</p> |
56 |
</div><div class="item" id="api-interfaces"> |
|
57 |
<h3>Interfaces</h3> |
|
58 |
<p> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
59 |
You can use diffrent interfaces to get to same result. |
| 72 | 60 |
</p> |
61 |
<div class="item" id="interface-xmlrpc"> |
|
62 |
<h4>XML-RPC</h4> |
|
63 |
<p> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
64 |
Interface-URI: <code>http://localhost:8000/xmlrpc</code> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
65 |
</p> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
66 |
</div> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
67 |
<div class="item" id="interface-soap"> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
68 |
<h4>SOAP</h4> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
69 |
<p> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
70 |
Interface-URI: <code>http://localhost:8000/soap</code> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
71 |
</p> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
72 |
</div> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
73 |
<div class="item" id="interface-json"> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
74 |
<h4>JSON</h4> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
75 |
<p> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
76 |
Interface-URI: <code>http://localhost:8000/json/<em><methode></em></code> |
| 72 | 77 |
</p> |
78 |
<p> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
79 |
Not yet implementet |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
80 |
</p> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
81 |
</div> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
82 |
<div class="item" id="interface-jsonp"> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
83 |
<h4>JSONP</h4> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
84 |
<p> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
85 |
Interface-URI: <code>http://localhost:8000/jsonp/<em><methode></em>?callback=<callback></code> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
86 |
</p> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
87 |
<p> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
88 |
Not yet implementet |
| 72 | 89 |
</p> |
90 |
</div> |
|
91 |
</div><div class="item" id="api-methods"> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
92 |
<h3>Methods</h3> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
93 |
<div class="item" id="method-status"> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
94 |
<h4>Status</h4> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
95 |
<p><code>status(user=None, id=False, detailed=None)</code></p> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
96 |
<p>Returns the status of one or more jobs.</p> |
| 72 | 97 |
<h5>Parameter</h5> |
98 |
<table class="docs"> |
|
99 |
<thead> |
|
100 |
<tr> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
101 |
<td>parameter</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
102 |
<td>type</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
103 |
<td>description</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
104 |
</tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
105 |
</thead> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
106 |
<tbody> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
107 |
<tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
108 |
<td>user</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
109 |
<td>string</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
110 |
<td>apikey of a user</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
111 |
</tr><tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
112 |
<td>id</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
113 |
<td>integer</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
114 |
<td>one job id</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
115 |
</tr><tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
116 |
<td>detailed</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
117 |
<td>boolean</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
118 |
<td>return more details about the status</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
119 |
</tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
120 |
</tbody> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
121 |
</table> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
122 |
<h5>Return</h5> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
123 |
<table class="docs"> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
124 |
<thead> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
125 |
<tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
126 |
<td>parameter</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
127 |
<td>type</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
128 |
<td>description</td> |
| 72 | 129 |
</tr> |
130 |
</thead> |
|
131 |
<tbody> |
|
132 |
<tr> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
133 |
<td>return</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
134 |
<td>dict</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
135 |
<td><ul class="simple"> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
136 |
<li><cite>key</cite> -- is the job id</li> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
137 |
<li>[<cite>key</cite>][<strong>'status'</strong>] -- status of the job</li> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
138 |
</ul></td> |
| 72 | 139 |
</tr> |
140 |
</tbody> |
|
141 |
</table> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
142 |
</div><div class="item" id="method-sms"> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
143 |
<h4>Sms</h4> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
144 |
<p><code>sms(user, message, recipients, route='default', info='')</code></p> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
145 |
<p>Send a sms.</p> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
146 |
<h5>Parameter</h5> |
| 72 | 147 |
<table class="docs"> |
148 |
<thead> |
|
149 |
<tr> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
150 |
<td>parameter</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
151 |
<td>type</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
152 |
<td>description</td> |
| 72 | 153 |
</tr> |
154 |
</thead> |
|
155 |
<tbody> |
|
156 |
<tr> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
157 |
<td>user</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
158 |
<td>string</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
159 |
<td>apikey of a user</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
160 |
</tr><tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
161 |
<td>message</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
162 |
<td>string</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
163 |
<td>message</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
164 |
</tr><tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
165 |
<td>recipients</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
166 |
<td>list</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
167 |
<td>a list of telefon numbers (use ITU-T E.123)</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
168 |
</tr><tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
169 |
<td>route</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
170 |
<td>string|list</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
171 |
<td>route to use to send, or a list of routes as fallback</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
172 |
</tr><tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
173 |
<td>info</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
174 |
<td>string</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
175 |
<td>a name, to combine different jobs to one billing group</td> |
| 72 | 176 |
</tr> |
177 |
</tbody> |
|
178 |
</table> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
179 |
<h5>Return</h5> |
| 72 | 180 |
<table class="docs"> |
181 |
<thead> |
|
182 |
<tr> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
183 |
<td>parameter</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
184 |
<td>type</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
185 |
<td>description</td> |
| 72 | 186 |
</tr> |
187 |
</thead> |
|
188 |
<tbody> |
|
189 |
<tr> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
190 |
<td>return</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
191 |
<td>integer</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
192 |
<td>the job id</td> |
| 72 | 193 |
</tr> |
194 |
</tbody> |
|
195 |
</table> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
196 |
</div><div class="item" id="method-fax"> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
197 |
<h4>Fax</h4> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
198 |
<p><code>fax(user, subject, fax, recipients, route='default', info='')</code></p> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
199 |
<p>Send a fax.</p> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
200 |
<h5>Parameter</h5> |
| 72 | 201 |
<table class="docs"> |
202 |
<thead> |
|
203 |
<tr> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
204 |
<td>parameter</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
205 |
<td>type</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
206 |
<td>description</td> |
| 72 | 207 |
</tr> |
208 |
</thead> |
|
209 |
<tbody> |
|
210 |
<tr> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
211 |
<td>user</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
212 |
<td>string</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
213 |
<td>apikey of a user</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
214 |
</tr><tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
215 |
<td>subject</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
216 |
<td>string</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
217 |
<td>subject</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
218 |
</tr><tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
219 |
<td>fax</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
220 |
<td>string</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
221 |
<td>content (base64 encoded)</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
222 |
</tr><tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
223 |
<td>recipients</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
224 |
<td>list</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
225 |
<td>a list of telefon numbers (use ITU-T E.123)</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
226 |
</tr><tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
227 |
<td>route</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
228 |
<td>string|list</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
229 |
<td>route to use to send, or a list of routes as fallback</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
230 |
</tr><tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
231 |
<td>info</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
232 |
<td>string</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
233 |
<td>a name, to combine different jobs to one billing group</td> |
| 72 | 234 |
</tr> |
235 |
</tbody> |
|
236 |
</table> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
237 |
<h5>Return</h5> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
238 |
<table class="docs"> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
239 |
<thead> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
240 |
<tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
241 |
<td>parameter</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
242 |
<td>type</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
243 |
<td>description</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
244 |
</tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
245 |
</thead> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
246 |
<tbody> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
247 |
<tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
248 |
<td>return</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
249 |
<td>integer</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
250 |
<td>the job id</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
251 |
</tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
252 |
</tbody> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
253 |
</table> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
254 |
</div><div class="item" id="method-mail"> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
255 |
<h4>Mail</h4> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
256 |
<p><code>mail(user, subject, body, recipients, frm=None, route='default', info='')</code></p> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
257 |
<p>Send a mail.</p> |
| 72 | 258 |
<h5>Parameter</h5> |
259 |
<table class="docs"> |
|
260 |
<thead> |
|
261 |
<tr> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
262 |
<td>parameter</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
263 |
<td>type</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
264 |
<td>description</td> |
| 72 | 265 |
</tr> |
266 |
</thead> |
|
267 |
<tbody> |
|
268 |
<tr> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
269 |
<td>user</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
270 |
<td>string</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
271 |
<td>apikey of a user</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
272 |
</tr><tr> |
| 72 | 273 |
<td>subject</td> |
274 |
<td>string</td> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
275 |
<td>subject</td> |
| 72 | 276 |
</tr><tr> |
277 |
<td>body</td> |
|
278 |
<td>string</td> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
279 |
<td>mail body</td> |
| 72 | 280 |
</tr><tr> |
281 |
<td>recipients</td> |
|
282 |
<td>list</td> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
283 |
<td>a list of email addresses</td> |
| 72 | 284 |
</tr><tr> |
285 |
<td>frm</td> |
|
286 |
<td>string</td> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
287 |
<td>sender mail address</td> |
| 72 | 288 |
</tr><tr> |
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
289 |
<td>route</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
290 |
<td>string|list</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
291 |
<td>route to use to send, or a list of routes as fallback</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
292 |
</tr><tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
293 |
<td>info</td> |
| 72 | 294 |
<td>string</td> |
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
295 |
<td>a name, to combine different jobs to one billing group</td> |
| 72 | 296 |
</tr> |
297 |
</tbody> |
|
298 |
</table> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
299 |
<h5>Return</h5> |
| 72 | 300 |
<table class="docs"> |
301 |
<thead> |
|
302 |
<tr> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
303 |
<td>parameter</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
304 |
<td>type</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
305 |
<td>description</td> |
| 72 | 306 |
</tr> |
307 |
</thead> |
|
308 |
<tbody> |
|
309 |
<tr> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
310 |
<td>return</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
311 |
<td>integer</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
312 |
<td>the job id</td> |
| 72 | 313 |
</tr> |
314 |
</tbody> |
|
315 |
</table> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
316 |
</div><div class="item" id="method-routes"> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
317 |
<h4>Routes</h4> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
318 |
<p><code>routes(user, typ=None)</code></p> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
319 |
<p>Returns a list of all possible offernames.</p> |
| 72 | 320 |
<h5>Parameter</h5> |
321 |
<table class="docs"> |
|
322 |
<thead> |
|
323 |
<tr> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
324 |
<td>parameter</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
325 |
<td>type</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
326 |
<td>description</td> |
| 72 | 327 |
</tr> |
328 |
</thead> |
|
329 |
<tbody> |
|
330 |
<tr> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
331 |
<td>user</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
332 |
<td>string</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
333 |
<td>apikey of a user</td> |
| 72 | 334 |
</tr><tr> |
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
335 |
<td>typ</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
336 |
<td>string</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
337 |
<td>a typ of message -- one of in this list ["sms","fax","mail"]</td> |
| 72 | 338 |
</tr> |
339 |
</tbody> |
|
340 |
</table> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
341 |
<h5>Return</h5> |
| 72 | 342 |
<table class="docs"> |
343 |
<thead> |
|
344 |
<tr> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
345 |
<td>parameter</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
346 |
<td>type</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
347 |
<td>description</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
348 |
</tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
349 |
</thead> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
350 |
<tbody> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
351 |
<tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
352 |
<td>return</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
353 |
<td>list</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
354 |
<td>a list of all possible offer names for a typ</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
355 |
</tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
356 |
</tbody> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
357 |
</table> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
358 |
</div><div class="item" id="method-defaultRoute"> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
359 |
<h4>DefaultRoute</h4> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
360 |
<p><code>defaultRoute(user, typ=None)</code></p> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
361 |
<p>Returns all default offernames.</p> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
362 |
<h5>Parameter</h5> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
363 |
<table class="docs"> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
364 |
<thead> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
365 |
<tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
366 |
<td>parameter</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
367 |
<td>type</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
368 |
<td>description</td> |
| 72 | 369 |
</tr> |
370 |
</thead> |
|
371 |
<tbody> |
|
372 |
<tr> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
373 |
<td>user</td> |
| 72 | 374 |
<td>string</td> |
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
375 |
<td>apikey of a user</td> |
| 72 | 376 |
</tr><tr> |
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
377 |
<td>typ</td> |
| 72 | 378 |
<td>string</td> |
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
379 |
<td>a typ of message -- one of in this list ["sms","fax","mail"]</td> |
| 72 | 380 |
</tr> |
381 |
</tbody> |
|
382 |
</table> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
383 |
<h5>Return</h5> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
384 |
<table class="docs"> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
385 |
<thead> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
386 |
<tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
387 |
<td>parameter</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
388 |
<td>type</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
389 |
<td>description</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
390 |
</tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
391 |
</thead> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
392 |
<tbody> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
393 |
<tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
394 |
<td>return</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
395 |
<td>list</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
396 |
<td>a list of all possible offer names for a typ</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
397 |
</tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
398 |
</tbody> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
399 |
</table> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
400 |
</div><div class="item" id="method-bill"> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
401 |
<h4>Bill</h4> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
402 |
<p><code>bill(user=None)</code></p> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
403 |
<p>Returns the bill, of not paid messages.</p> |
| 72 | 404 |
<h5>Parameter</h5> |
405 |
<table class="docs"> |
|
406 |
<thead> |
|
407 |
<tr> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
408 |
<td>parameter</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
409 |
<td>type</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
410 |
<td>description</td> |
| 72 | 411 |
</tr> |
412 |
</thead> |
|
413 |
<tbody> |
|
414 |
<tr> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
415 |
<td>user</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
416 |
<td>string</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
417 |
<td>apikey of a user</td> |
| 72 | 418 |
</tr> |
419 |
</tbody> |
|
420 |
</table> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
421 |
<h5>Return</h5> |
| 72 | 422 |
<table class="docs"> |
423 |
<thead> |
|
424 |
<tr> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
425 |
<td>parameter</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
426 |
<td>type</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
427 |
<td>description</td> |
| 72 | 428 |
</tr> |
429 |
</thead> |
|
430 |
<tbody> |
|
431 |
<tr> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
432 |
<td>return</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
433 |
<td>dict</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
434 |
<td><ul class="simple"> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
435 |
<li><cite>route</cite> -- one offer name ; <strong>"total"</strong> complete sum</li> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
436 |
<li>[<cite>route</cite>][<cite>info</cite>][<strong>anz</strong>] -- Number of sended messages in one billing group</li> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
437 |
<li>[<cite>route</cite>][<cite>info</cite>][<strong>price</strong>] -- Price for one billing group</li> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
438 |
<li>[<cite>route</cite> | <strong>total</strong>][<strong>anz</strong>] -- Number of sended messages for one offer</li> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
439 |
<li>[<cite>route</cite> | <strong>total</strong>][<strong>price</strong>] -- Price for one offer</li> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
440 |
</ul></td> |
| 72 | 441 |
</tr> |
442 |
</tbody> |
|
443 |
</table> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
444 |
</div><div class="item" id="method-telnumber"> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
445 |
<h4>Telnumber</h4> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
446 |
<p><code>telnumber(recipients)</code></p> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
447 |
<p>Return True, if all telnumbers a vaild.</p> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
448 |
<h5>Parameter</h5> |
| 72 | 449 |
<table class="docs"> |
450 |
<thead> |
|
451 |
<tr> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
452 |
<td>parameter</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
453 |
<td>type</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
454 |
<td>description</td> |
| 72 | 455 |
</tr> |
456 |
</thead> |
|
457 |
<tbody> |
|
458 |
<tr> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
459 |
<td>recipients</td> |
| 72 | 460 |
<td>list</td> |
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
461 |
<td>a list of telnumbers (use ITU-T E.123)</td> |
| 72 | 462 |
</tr> |
463 |
</tbody> |
|
464 |
</table> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
465 |
<h5>Return</h5> |
| 72 | 466 |
<table class="docs"> |
467 |
<thead> |
|
468 |
<tr> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
469 |
<td>parameter</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
470 |
<td>type</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
471 |
<td>description</td> |
| 72 | 472 |
</tr> |
473 |
</thead> |
|
474 |
<tbody> |
|
475 |
<tr> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
476 |
<td>return</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
477 |
<td>boolean</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
478 |
<td>True -- all numbers are valid</td> |
| 72 | 479 |
</tr> |
480 |
</tbody> |
|
481 |
</table> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
482 |
</div><div class="item" id="method-email"> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
483 |
<h4>Email</h4> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
484 |
<p><code>email(recipients)</code></p> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
485 |
<p>Return True, if all mailadresses a valid.</p> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
486 |
<h5>Parameter</h5> |
| 72 | 487 |
<table class="docs"> |
488 |
<thead> |
|
489 |
<tr> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
490 |
<td>parameter</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
491 |
<td>type</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
492 |
<td>description</td> |
| 72 | 493 |
</tr> |
494 |
</thead> |
|
495 |
<tbody> |
|
496 |
<tr> |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
497 |
<td>recipients</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
498 |
<td>list</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
499 |
<td>a list of mailadresses</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
500 |
</tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
501 |
</tbody> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
502 |
</table> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
503 |
<h5>Return</h5> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
504 |
<table class="docs"> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
505 |
<thead> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
506 |
<tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
507 |
<td>parameter</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
508 |
<td>type</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
509 |
<td>description</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
510 |
</tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
511 |
</thead> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
512 |
<tbody> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
513 |
<tr> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
514 |
<td>return</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
515 |
<td>boolean</td> |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
77
diff
changeset
|
516 |
<td>True -- all addresses are valid</td> |
| 72 | 517 |
</tr> |
518 |
</tbody> |
|
519 |
</table> |
|
520 |
</div> |
|
521 |
</div> |
|
522 |
</div> |
|
523 |
<div class="clear"></div> |
|
524 |
</div> |
|
525 |
</div> |
|
526 |
<div id="foot-container"> |
|
527 |
<div id="foot"> |
|
528 |
<p>© 2010-2011 <a href="impressum.html">Netzguerilla.net</a>.</p> |
|
529 |
</div> |
|
530 |
</div> |
|
531 |
</body> |
|
532 |
</html> |