|
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 new</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"> |
|
|
22 |
<li><a href="index.html" class="menu">Iro</a></li><li><a href="current.html" class="menu">API Documentation</a></li><li><a href="new.html" class="menu active">geplante API Documentation</a></li><li><a href="impressum.html" class="menu">Impressum</a></li> |
|
|
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>geplante 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 |
<li value="2.2">2.2 <a href="#interface-xml">XML</a></li> |
|
|
40 |
<li value="2.3">2.3 <a href="#interface-json">JSON</a></li> |
|
|
41 |
<li value="2.4">2.4 <a href="#interface-jsonp">JSONP</a></li> |
|
|
42 |
<li value="2.5">2.5 <a href="#interface-php">PHP</a></li> |
|
|
43 |
</ol> |
|
|
44 |
</li> |
|
|
45 |
<li value="3">3. |
|
|
46 |
<a href="#api-methods">Methoden</a> |
|
|
47 |
<ol> |
|
|
48 |
<li value="3.1">3.1 <a href="#method-route">Route</a></li> |
|
|
49 |
<li value="3.2">3.2 <a href="#method-dist">Dist</a></li> |
|
|
50 |
<li value="3.3">3.3 <a href="#method-geocode">Geocode</a></li> |
|
|
51 |
<li value="3.4">3.4 <a href="#method-sms">SMS</a></li> |
|
|
52 |
<li value="3.5">3.5 <a href="#method-bank">Bank</a></li> |
|
|
53 |
<li value="3.6">3.6 <a href="#method-bank">Boxcar</a></li> |
|
|
54 |
<li value="3.7">3.7 <a href="#method-postcode-match">Postcode-Match</a></li> |
|
|
55 |
<li value="3.8">3.8 <a href="#method-postcode-shape">Postcode-Shape</a></li> |
|
|
56 |
</ol> |
|
|
57 |
</li> |
|
|
58 |
<li value="4">4. <a href="#api-errors">Fehlermeldungen</a></li> |
|
|
59 |
</ol> |
|
|
60 |
</div><div class="item" id="api-intro"> |
|
|
61 |
<h3>Einführung</h3> |
|
|
62 |
<p> |
|
|
63 |
Die Mesngr API enthält viele Funktionen, die von Fahrradkurierdiensten benötigt werden. |
|
|
64 |
</p> |
|
|
65 |
</div><div class="item" id="api-interfaces"> |
|
|
66 |
<h3>Interfaces</h3> |
|
|
67 |
<p> |
|
|
68 |
Die Mesngr API stellt verschiedene Interfaces bereit, die unterschiedlich angesprochen werden, aber das selbe tun. |
|
|
69 |
</p> |
|
|
70 |
<div class="item" id="interface-xmlrpc"> |
|
|
71 |
<h4>XML-RPC</h4> |
|
|
72 |
<p> |
|
|
73 |
Interface-URI: <code>http://api.mesngr.de/xmlrpc</code> |
|
|
74 |
</p> |
|
|
75 |
<p> |
|
|
76 |
Die aufgerufene Methode wird dabei im <code><methodName /></code> übergeben. |
|
|
77 |
</p> |
|
|
78 |
<p> |
|
|
79 |
Das XML-RPC Interface nimmt die Parameter der aufgerufenen Methode als <code><struct /></code> inerhalb des ersten <code><param /></code> entgegen, alle weiteren <code><param /></code>s werden ignoriert. |
|
|
80 |
</p> |
|
|
81 |
<p> |
|
|
82 |
Zeichen außerhalb des ASCII-Sets sind als HTML Entities zu übergeben. |
|
|
83 |
</p> |
|
|
84 |
</div> |
|
|
85 |
<div class="item" id="interface-xml"> |
|
|
86 |
<h4>XML</h4> |
|
|
87 |
<p> |
|
|
88 |
Interface-URI: <code>http://api.mesngr.de/xml/<em><methode></em></code> |
|
|
89 |
</p> |
|
|
90 |
<p> |
|
|
91 |
Die aufgerufene Methode wird im Pfad der Interface-URI übergeben. |
|
|
92 |
</p> |
|
|
93 |
<p> |
|
|
94 |
Parameter können via HTTP per GET oder POST im Format <em>application/x-www-form-urlencoded</em> übergeben werden. |
|
|
95 |
</p> |
|
|
96 |
<p> |
|
|
97 |
Die Ausgabe erfolgt als XML Markup. |
|
|
98 |
</p> |
|
|
99 |
</div> |
|
|
100 |
<div class="item" id="interface-json"> |
|
|
101 |
<h4>JSON</h4> |
|
|
102 |
<p> |
|
|
103 |
Interface-URI: <code>http://api.mesngr.de/json/<em><methode></em></code> |
|
|
104 |
</p> |
|
|
105 |
<p> |
|
|
106 |
Die aufgerufene Methode wird im Pfad der Interface-URI übergeben. |
|
|
107 |
</p> |
|
|
108 |
<p> |
|
|
109 |
Parameter können via HTTP per GET oder POST im Format <em>application/x-www-form-urlencoded</em> oder JSON-Objekt übergeben werden. |
|
|
110 |
</p> |
|
|
111 |
<p> |
|
|
112 |
Die Ausgabe erfolgt als JSON-Objekt. |
|
|
113 |
</p> |
|
|
114 |
</div> |
|
|
115 |
<div class="item" id="interface-json"> |
|
|
116 |
<h4>JSONP</h4> |
|
|
117 |
<p> |
|
|
118 |
Interface-URI: <code>http://api.mesngr.de/jsonp/<em><methode></em>?callback=<callback></code> |
|
|
119 |
</p> |
|
|
120 |
<p> |
|
|
121 |
Die aufgerufene Methode wird im Pfad der Interface-URI übergeben. |
|
|
122 |
</p> |
|
|
123 |
<p> |
|
|
124 |
Der Name für die Callback-Methode wird als Parameter Callback übergeben. |
|
|
125 |
</p> |
|
|
126 |
<p> |
|
|
127 |
Parameter können via HTTP per GET im Format <em>application/x-www-form-urlencoded</em> übergeben werden. |
|
|
128 |
</p> |
|
|
129 |
<p> |
|
|
130 |
Die Ausgabe erfolgt als Javascript-Funktionsaufruf mit einem JSON-Objekt als Parameter. |
|
|
131 |
</p> |
|
|
132 |
</div> |
|
|
133 |
<div class="item" id="interface-php"> |
|
|
134 |
<h4>PHP</h4> |
|
|
135 |
<p> |
|
|
136 |
Interface-URI: <code>http://api.mesngr.de/php/<em><methode></em></code> |
|
|
137 |
</p> |
|
|
138 |
<p> |
|
|
139 |
Die aufgerufene Methode wird im Pfad der Interface-URI übergeben. |
|
|
140 |
</p> |
|
|
141 |
<p> |
|
|
142 |
Parameter können via HTTP per GET oder POST im Format <em>application/x-www-form-urlencoded</em> übergeben werden. |
|
|
143 |
</p> |
|
|
144 |
<p> |
|
|
145 |
Die Ausgabe erfolgt als serialisiertes PHP-Objekt. |
|
|
146 |
</p> |
|
|
147 |
</div> |
|
|
148 |
</div><div class="item" id="api-methods"> |
|
|
149 |
<h3>Methoden</h3> |
|
|
150 |
<div class="item" id="method-route"> |
|
|
151 |
<h4>Route</h4> |
|
|
152 |
<p><code>route</code></p> |
|
|
153 |
<p> |
|
|
154 |
Diese Methode ermittelt die Routing-Entfernung zwischen zwei Koordinaten. |
|
|
155 |
</p> |
|
|
156 |
<h5>Parameter</h5> |
|
|
157 |
<table class="docs"> |
|
|
158 |
<thead> |
|
|
159 |
<tr> |
|
|
160 |
<td>Parameter</td> |
|
|
161 |
<td>Typ</td> |
|
|
162 |
<td>Beschreibung</td> |
|
|
163 |
</tr> |
|
|
164 |
</thead> |
|
|
165 |
<tbody> |
|
|
166 |
<tr> |
|
|
167 |
<td>apikey</td> |
|
|
168 |
<td>str[20]</td> |
|
|
169 |
<td>Der API Key</td> |
|
|
170 |
</tr> |
|
|
171 |
<tr> |
|
|
172 |
<td>type</td> |
|
|
173 |
<td>enum[car,bicycle,foot]</td> |
|
|
174 |
<td>Die gewünschte Routing-Methode</td> |
|
|
175 |
</tr> |
|
|
176 |
<tr> |
|
|
177 |
<td>flon</td> |
|
|
178 |
<td>float</td> |
|
|
179 |
<td>Der Längengrad des Startpunktes</td> |
|
|
180 |
</tr> |
|
|
181 |
<tr> |
|
|
182 |
<td>flat</td> |
|
|
183 |
<td>float</td> |
|
|
184 |
<td>Der Breitengrad des Startpunktes</td> |
|
|
185 |
</tr> |
|
|
186 |
<tr> |
|
|
187 |
<td>tlon</td> |
|
|
188 |
<td>float</td> |
|
|
189 |
<td>Der Längengrad des Zielpunktes</td> |
|
|
190 |
</tr> |
|
|
191 |
<tr> |
|
|
192 |
<td>tlat</td> |
|
|
193 |
<td>float</td> |
|
|
194 |
<td>Der Breitengrad des Zielpunktes</td> |
|
|
195 |
</tr> |
|
|
196 |
</tbody> |
|
|
197 |
</table> |
|
|
198 |
<h5>Ausgabe</h5> |
|
|
199 |
<table class="docs"> |
|
|
200 |
<thead> |
|
|
201 |
<tr> |
|
|
202 |
<td>Parameter</td> |
|
|
203 |
<td>Typ</td> |
|
|
204 |
<td>Beschreibung</td> |
|
|
205 |
</tr> |
|
|
206 |
</thead> |
|
|
207 |
<tbody> |
|
|
208 |
<tr> |
|
|
209 |
<td>status</td> |
|
|
210 |
<td>bool</td> |
|
|
211 |
<td>Fehlerindikator</td> |
|
|
212 |
</tr> |
|
|
213 |
<tr> |
|
|
214 |
<td>distance</td> |
|
|
215 |
<td>float</td> |
|
|
216 |
<td>Die ermittelte Routing-Distanz in km</td> |
|
|
217 |
</tr> |
|
|
218 |
</tbody> |
|
|
219 |
</table> |
|
|
220 |
</div> |
|
|
221 |
<div class="item" id="method-dist"> |
|
|
222 |
<h4>Dist</h4> |
|
|
223 |
<p><code>dist</code></p> |
|
|
224 |
<p> |
|
|
225 |
Diese Methode ermittelt die direkte Entfernung zwischen zwei Koordinaten. |
|
|
226 |
</p> |
|
|
227 |
<h5>Parameter</h5> |
|
|
228 |
<table class="docs"> |
|
|
229 |
<thead> |
|
|
230 |
<tr> |
|
|
231 |
<td>Parameter</td> |
|
|
232 |
<td>Typ</td> |
|
|
233 |
<td>Beschreibung</td> |
|
|
234 |
</tr> |
|
|
235 |
</thead> |
|
|
236 |
<tbody> |
|
|
237 |
<tr> |
|
|
238 |
<td>apikey</td> |
|
|
239 |
<td>str[20]</td> |
|
|
240 |
<td>Der API Key</td> |
|
|
241 |
</tr> |
|
|
242 |
<tr> |
|
|
243 |
<td>flon</td> |
|
|
244 |
<td>float</td> |
|
|
245 |
<td>Der Längengrad des Startpunktes</td> |
|
|
246 |
</tr> |
|
|
247 |
<tr> |
|
|
248 |
<td>flat</td> |
|
|
249 |
<td>float</td> |
|
|
250 |
<td>Der Breitengrad des Startpunktes</td> |
|
|
251 |
</tr> |
|
|
252 |
<tr> |
|
|
253 |
<td>tlon</td> |
|
|
254 |
<td>float</td> |
|
|
255 |
<td>Der Längengrad des Zielpunktes</td> |
|
|
256 |
</tr> |
|
|
257 |
<tr> |
|
|
258 |
<td>tlat</td> |
|
|
259 |
<td>float</td> |
|
|
260 |
<td>Der Breitengrad des Zielpunktes</td> |
|
|
261 |
</tr> |
|
|
262 |
</tbody> |
|
|
263 |
</table> |
|
|
264 |
<h5>Ausgabe</h5> |
|
|
265 |
<table class="docs"> |
|
|
266 |
<thead> |
|
|
267 |
<tr> |
|
|
268 |
<td>Parameter</td> |
|
|
269 |
<td>Typ</td> |
|
|
270 |
<td>Beschreibung</td> |
|
|
271 |
</tr> |
|
|
272 |
</thead> |
|
|
273 |
<tbody> |
|
|
274 |
<tr> |
|
|
275 |
<td>status</td> |
|
|
276 |
<td>bool</td> |
|
|
277 |
<td>Fehlerindikator</td> |
|
|
278 |
</tr> |
|
|
279 |
<tr> |
|
|
280 |
<td>distance</td> |
|
|
281 |
<td>float</td> |
|
|
282 |
<td>Die ermittelte Routing-Distanz in km</td> |
|
|
283 |
</tr> |
|
|
284 |
</tbody> |
|
|
285 |
</table> |
|
|
286 |
</div> |
|
|
287 |
<div class="item" id="method-geocode"> |
|
|
288 |
<h4>Geocode</h4> |
|
|
289 |
<p><code>geocode</code></p> |
|
|
290 |
<p> |
|
|
291 |
Ermittelt die Koordinaten zu einer Adresse. Diese Methode ist Kostenpflichtig. |
|
|
292 |
</p> |
|
|
293 |
<h5>Parameter</h5> |
|
|
294 |
<table class="docs"> |
|
|
295 |
<thead> |
|
|
296 |
<tr> |
|
|
297 |
<td>Parameter</td> |
|
|
298 |
<td>Typ</td> |
|
|
299 |
<td>Beschreibung</td> |
|
|
300 |
</tr> |
|
|
301 |
</thead> |
|
|
302 |
<tbody> |
|
|
303 |
<tr> |
|
|
304 |
<td>apikey</td> |
|
|
305 |
<td>str[20]</td> |
|
|
306 |
<td>Der API Key</td> |
|
|
307 |
</tr> |
|
|
308 |
<tr> |
|
|
309 |
<td>type</td> |
|
|
310 |
<td>enum[fast, complete]</td> |
|
|
311 |
<td>Die Eingabemethode. Im Modus <em>fast</em> wird der Parameter <code>number</code> an den Parameter <code>street</code> angehängt sowie der Parameter <code>postcode</code> vor den Parameter <code>city</code>; Die Parameter <code>postcode</code> und <code>number</code> werden dann ignoriert.</td> |
|
|
312 |
</tr> |
|
|
313 |
<tr> |
|
|
314 |
<td>street</td> |
|
|
315 |
<td>str</td> |
|
|
316 |
<td>Der Straßenname der Adresse</td> |
|
|
317 |
</tr> |
|
|
318 |
<tr> |
|
|
319 |
<td>number</td> |
|
|
320 |
<td>str</td> |
|
|
321 |
<td>Die Hausnummer der Adresse</td> |
|
|
322 |
</tr> |
|
|
323 |
<tr> |
|
|
324 |
<td>postcode</td> |
|
|
325 |
<td>str</td> |
|
|
326 |
<td>Die Postleitzahl der Adresse</td> |
|
|
327 |
</tr> |
|
|
328 |
<tr> |
|
|
329 |
<td>city</td> |
|
|
330 |
<td>str</td> |
|
|
331 |
<td>Die Stadt der Adresse</td> |
|
|
332 |
</tr> |
|
|
333 |
<tr> |
|
|
334 |
<td>country</td> |
|
|
335 |
<td>str</td> |
|
|
336 |
<td>Das Land der Adresse, ISO 3166</td> |
|
|
337 |
</tr> |
|
|
338 |
</tbody> |
|
|
339 |
</table> |
|
|
340 |
<h5>Ausgabe</h5> |
|
|
341 |
<table class="docs"> |
|
|
342 |
<thead> |
|
|
343 |
<tr> |
|
|
344 |
<td>Parameter</td> |
|
|
345 |
<td>Typ</td> |
|
|
346 |
<td>Beschreibung</td> |
|
|
347 |
</tr> |
|
|
348 |
</thead> |
|
|
349 |
<tbody> |
|
|
350 |
<tr> |
|
|
351 |
<td>status</td> |
|
|
352 |
<td>bool</td> |
|
|
353 |
<td>Fehlerindikator</td> |
|
|
354 |
</tr> |
|
|
355 |
<tr> |
|
|
356 |
<td>stage</td> |
|
|
357 |
<td>enum[1,2,3]</td> |
|
|
358 |
<td> |
|
|
359 |
Grad des Erfolges des Geocodings:<br> |
|
|
360 |
1 → Es stehen mehrere mögliche Adressen zur Auswahl.<br> |
|
|
361 |
2 → Eine mögliche Adresse als Korrekturvorschlag.<br> |
|
|
362 |
3 → Die Adresse konnte verifiziert und zugehörige Geokoordinaten ermittelt werden. |
|
|
363 |
</td> |
|
|
364 |
</tr> |
|
|
365 |
<tr> |
|
|
366 |
<td>data</td> |
|
|
367 |
<td>array</td> |
|
|
368 |
<td> |
|
|
369 |
Die ermittelten Adressdaten |
|
|
370 |
</td> |
|
|
371 |
</tr> |
|
|
372 |
<tr> |
|
|
373 |
<td>data[i]</td> |
|
|
374 |
<td>array</td> |
|
|
375 |
<td> |
|
|
376 |
Ein ermittelter Adressdatensatz |
|
|
377 |
</td> |
|
|
378 |
</tr> |
|
|
379 |
<tr> |
|
|
380 |
<td>data[i][street]</td> |
|
|
381 |
<td>str</td> |
|
|
382 |
<td>Name der Straße</td> |
|
|
383 |
</tr> |
|
|
384 |
<tr> |
|
|
385 |
<td>data[i][nr]</td> |
|
|
386 |
<td>str</td> |
|
|
387 |
<td>Hausnummer</td> |
|
|
388 |
</tr> |
|
|
389 |
<tr> |
|
|
390 |
<td>data[i][fragment]</td> |
|
|
391 |
<td>str</td> |
|
|
392 |
<td>Hausnummernzusatz (z.B. <em>a</em> bei <em>12a</em>)</td> |
|
|
393 |
</tr> |
|
|
394 |
<tr> |
|
|
395 |
<td>data[i][postcode]</td> |
|
|
396 |
<td>str</td> |
|
|
397 |
<td>Postleitzahl</td> |
|
|
398 |
</tr> |
|
|
399 |
<tr> |
|
|
400 |
<td>data[i][city]</td> |
|
|
401 |
<td>str</td> |
|
|
402 |
<td>Ort</td> |
|
|
403 |
</tr> |
|
|
404 |
<tr> |
|
|
405 |
<td>data[i][country]</td> |
|
|
406 |
<td>str[2]</td> |
|
|
407 |
<td>Land (gemäß ISO 3166)</td> |
|
|
408 |
</tr> |
|
|
409 |
<tr> |
|
|
410 |
<td>data[i][accuracy]</td> |
|
|
411 |
<td>int</td> |
|
|
412 |
<td>Genauigkeit (Genau > Ungenau)</td> |
|
|
413 |
</tr> |
|
|
414 |
<tr> |
|
|
415 |
<td>data[i][lat]</td> |
|
|
416 |
<td>float</td> |
|
|
417 |
<td>Breitengrad</td> |
|
|
418 |
</tr> |
|
|
419 |
<tr> |
|
|
420 |
<td>data[i][lon]</td> |
|
|
421 |
<td>float</td> |
|
|
422 |
<td>Längengrad</td> |
|
|
423 |
</tr> |
|
|
424 |
</tbody> |
|
|
425 |
</table> |
|
|
426 |
</div> |
|
|
427 |
<div class="item" id="method-sms"> |
|
|
428 |
<h4>SMS</h4> |
|
|
429 |
<p><code>sms</code></p> |
|
|
430 |
<p> |
|
|
431 |
Versendet eine SMS-Nachricht. Diese Methode ist kostenpflichtig. |
|
|
432 |
</p> |
|
|
433 |
<h5>Parameter</h5> |
|
|
434 |
<table class="docs"> |
|
|
435 |
<thead> |
|
|
436 |
<tr> |
|
|
437 |
<td>Parameter</td> |
|
|
438 |
<td>Typ</td> |
|
|
439 |
<td>Beschreibung</td> |
|
|
440 |
</tr> |
|
|
441 |
</thead> |
|
|
442 |
<tbody> |
|
|
443 |
<tr> |
|
|
444 |
<td>apikey</td> |
|
|
445 |
<td>str[20]</td> |
|
|
446 |
<td>Der API Key</td> |
|
|
447 |
</tr> |
|
|
448 |
<tr> |
|
|
449 |
<td>from</td> |
|
|
450 |
<td>str[11]|tel[16]</td> |
|
|
451 |
<td>Der gewünschte Absender (optional)</td> |
|
|
452 |
</tr> |
|
|
453 |
<tr> |
|
|
454 |
<td>to</td> |
|
|
455 |
<td>tel[15]</td> |
|
|
456 |
<td>Emfänger-Nummer (gemäß ITU-T E.123)</td> |
|
|
457 |
</tr> |
|
|
458 |
<tr> |
|
|
459 |
<td>ref</td> |
|
|
460 |
<td>str</td> |
|
|
461 |
<td>Referenz für Antworten</td> |
|
|
462 |
</tr> |
|
|
463 |
<tr> |
|
|
464 |
<td>callback</td> |
|
|
465 |
<td>str</td> |
|
|
466 |
<td>Callback-URL für SMS-Antworten. Noch nicht implementiert.</td> |
|
|
467 |
</tr> |
|
|
468 |
</tbody> |
|
|
469 |
</table> |
|
|
470 |
<h5>Ausgabe</h5> |
|
|
471 |
<table class="docs"> |
|
|
472 |
<thead> |
|
|
473 |
<tr> |
|
|
474 |
<td>Parameter</td> |
|
|
475 |
<td>Typ</td> |
|
|
476 |
<td>Beschreibung</td> |
|
|
477 |
</tr> |
|
|
478 |
</thead> |
|
|
479 |
<tbody> |
|
|
480 |
<tr> |
|
|
481 |
<td>status</td> |
|
|
482 |
<td>bool</td> |
|
|
483 |
<td>Fehlerindikator</td> |
|
|
484 |
</tr> |
|
|
485 |
</tbody> |
|
|
486 |
</table> |
|
|
487 |
</div> |
|
|
488 |
<div class="item" id="method-bank"> |
|
|
489 |
<h4>Bank</h4> |
|
|
490 |
<p><code>bank</code></p> |
|
|
491 |
<p> |
|
|
492 |
Prüft Bankdaten auf Plausibilität. |
|
|
493 |
</p> |
|
|
494 |
<h5>Parameter</h5> |
|
|
495 |
<table class="docs"> |
|
|
496 |
<thead> |
|
|
497 |
<tr> |
|
|
498 |
<td>Parameter</td> |
|
|
499 |
<td>Typ</td> |
|
|
500 |
<td>Beschreibung</td> |
|
|
501 |
</tr> |
|
|
502 |
</thead> |
|
|
503 |
<tbody> |
|
|
504 |
<tr> |
|
|
505 |
<td>apikey</td> |
|
|
506 |
<td>str[20]</td> |
|
|
507 |
<td>Der API Key</td> |
|
|
508 |
</tr> |
|
|
509 |
<tr> |
|
|
510 |
<td>country</td> |
|
|
511 |
<td>[de]</td> |
|
|
512 |
<td>Das Land des Bankdatenformates</td> |
|
|
513 |
</tr> |
|
|
514 |
<tr> |
|
|
515 |
<td>bank</td> |
|
|
516 |
<td>int[8]</td> |
|
|
517 |
<td>Die Bankleitzahl</td> |
|
|
518 |
</tr> |
|
|
519 |
<tr> |
|
|
520 |
<td>account</td> |
|
|
521 |
<td>int[10]</td> |
|
|
522 |
<td>Die Kontonummer (optional)</td> |
|
|
523 |
</tr> |
|
|
524 |
</tbody> |
|
|
525 |
</table> |
|
|
526 |
<h5>Ausgabe</h5> |
|
|
527 |
<table class="docs"> |
|
|
528 |
<thead> |
|
|
529 |
<tr> |
|
|
530 |
<td>Parameter</td> |
|
|
531 |
<td>Typ</td> |
|
|
532 |
<td>Beschreibung</td> |
|
|
533 |
</tr> |
|
|
534 |
</thead> |
|
|
535 |
<tbody> |
|
|
536 |
<tr> |
|
|
537 |
<td>status</td> |
|
|
538 |
<td>bool</td> |
|
|
539 |
<td>Fehlerindikator</td> |
|
|
540 |
</tr> |
|
|
541 |
<tr> |
|
|
542 |
<td>bank</td> |
|
|
543 |
<td>array</td> |
|
|
544 |
<td>Der Bankdatensatz</td> |
|
|
545 |
</tr> |
|
|
546 |
<tr> |
|
|
547 |
<td>bank[id]</td> |
|
|
548 |
<td>int[8]</td> |
|
|
549 |
<td>Die Bankleitzahl</td> |
|
|
550 |
</tr> |
|
|
551 |
<tr> |
|
|
552 |
<td>bank[name]</td> |
|
|
553 |
<td>str</td> |
|
|
554 |
<td>Name der Bank</td> |
|
|
555 |
</tr> |
|
|
556 |
<tr> |
|
|
557 |
<td>bank[city]</td> |
|
|
558 |
<td>str</td> |
|
|
559 |
<td>Stadt</td> |
|
|
560 |
</tr> |
|
|
561 |
<tr> |
|
|
562 |
<td>bank[bic]</td> |
|
|
563 |
<td>str</td> |
|
|
564 |
<td>Der BIC der Bank</td> |
|
|
565 |
</tr> |
|
|
566 |
<tr> |
|
|
567 |
<td>account</td> |
|
|
568 |
<td>array</td> |
|
|
569 |
<td>Der Kontodatensatz</td> |
|
|
570 |
</tr> |
|
|
571 |
<tr> |
|
|
572 |
<td>account[id]</td> |
|
|
573 |
<td>int[10]</td> |
|
|
574 |
<td>Die Kontonummer</td> |
|
|
575 |
</tr> |
|
|
576 |
</tbody> |
|
|
577 |
</table> |
|
|
578 |
</div> |
|
|
579 |
<div class="item" id="method-bank"> |
|
|
580 |
<h4>Boxcar</h4> |
|
|
581 |
<p><code>boxcar</code></p> |
|
|
582 |
<p> |
|
|
583 |
Sendet eine Push-Notification via Boxcar. Ist der Boxcar-user nicht subskribiert, wird statt der Nachricht eine Subskriptions-Anfrage gesendet. |
|
|
584 |
</p> |
|
|
585 |
<h5>Parameter</h5> |
|
|
586 |
<table class="docs"> |
|
|
587 |
<thead> |
|
|
588 |
<tr> |
|
|
589 |
<td>Parameter</td> |
|
|
590 |
<td>Typ</td> |
|
|
591 |
<td>Beschreibung</td> |
|
|
592 |
</tr> |
|
|
593 |
</thead> |
|
|
594 |
<tbody> |
|
|
595 |
<tr> |
|
|
596 |
<td>apikey</td> |
|
|
597 |
<td>str[20]</td> |
|
|
598 |
<td>Der API Key</td> |
|
|
599 |
</tr> |
|
|
600 |
<tr> |
|
|
601 |
<td>to</td> |
|
|
602 |
<td>str</td> |
|
|
603 |
<td>E-Mail-Adresse des Boxcar-Accounts</td> |
|
|
604 |
</tr> |
|
|
605 |
<tr> |
|
|
606 |
<td>from</td> |
|
|
607 |
<td>str</td> |
|
|
608 |
<td>Absender</td> |
|
|
609 |
</tr> |
|
|
610 |
<tr> |
|
|
611 |
<td>message</td> |
|
|
612 |
<td>str</td> |
|
|
613 |
<td>Die Nachricht</td> |
|
|
614 |
</tr> |
|
|
615 |
<tr> |
|
|
616 |
<td>url</td> |
|
|
617 |
<td>str</td> |
|
|
618 |
<td>Die URL die aufgerufen werden soll</td> |
|
|
619 |
</tr> |
|
|
620 |
</tbody> |
|
|
621 |
</table> |
|
|
622 |
<h5>Ausgabe</h5> |
|
|
623 |
<table class="docs"> |
|
|
624 |
<thead> |
|
|
625 |
<tr> |
|
|
626 |
<td>Parameter</td> |
|
|
627 |
<td>Typ</td> |
|
|
628 |
<td>Beschreibung</td> |
|
|
629 |
</tr> |
|
|
630 |
</thead> |
|
|
631 |
<tbody> |
|
|
632 |
<tr> |
|
|
633 |
<td>status</td> |
|
|
634 |
<td>bool</td> |
|
|
635 |
<td>Fehlerindikator</td> |
|
|
636 |
</tr> |
|
|
637 |
</tbody> |
|
|
638 |
</table> |
|
|
639 |
</div> |
|
|
640 |
<div class="item" id="method-postcode-match"> |
|
|
641 |
<h4>Postcode-Match</h4> |
|
|
642 |
<p><code>postcodematch</code></p> |
|
|
643 |
<p> |
|
|
644 |
Liefert die Schwerpunkt-Koordinaten aller Postleizahlengebiete innerhalb eines Bereiches. |
|
|
645 |
</p> |
|
|
646 |
<h5>Parameter</h5> |
|
|
647 |
<table class="docs"> |
|
|
648 |
<thead> |
|
|
649 |
<tr> |
|
|
650 |
<td>Parameter</td> |
|
|
651 |
<td>Typ</td> |
|
|
652 |
<td>Beschreibung</td> |
|
|
653 |
</tr> |
|
|
654 |
</thead> |
|
|
655 |
<tbody> |
|
|
656 |
<tr> |
|
|
657 |
<td>apikey</td> |
|
|
658 |
<td>str[20]</td> |
|
|
659 |
<td>Der API Key</td> |
|
|
660 |
</tr> |
|
|
661 |
<tr> |
|
|
662 |
<td>bbox_n</td> |
|
|
663 |
<td>float</td> |
|
|
664 |
<td>Maximale Latitude</td> |
|
|
665 |
</tr> |
|
|
666 |
<tr> |
|
|
667 |
<td>bbox_s</td> |
|
|
668 |
<td>float</td> |
|
|
669 |
<td>Minimale Latitude</td> |
|
|
670 |
</tr> |
|
|
671 |
<tr> |
|
|
672 |
<td>bbox_e</td> |
|
|
673 |
<td>float</td> |
|
|
674 |
<td>Maximale Longitude</td> |
|
|
675 |
</tr> |
|
|
676 |
<tr> |
|
|
677 |
<td>bbox_w</td> |
|
|
678 |
<td>float</td> |
|
|
679 |
<td>Minimale Longitude</td> |
|
|
680 |
</tr> |
|
|
681 |
</tbody> |
|
|
682 |
</table> |
|
|
683 |
<h5>Ausgabe</h5> |
|
|
684 |
<table class="docs"> |
|
|
685 |
<thead> |
|
|
686 |
<tr> |
|
|
687 |
<td>Parameter</td> |
|
|
688 |
<td>Typ</td> |
|
|
689 |
<td>Beschreibung</td> |
|
|
690 |
</tr> |
|
|
691 |
</thead> |
|
|
692 |
<tbody> |
|
|
693 |
<tr> |
|
|
694 |
<td>status</td> |
|
|
695 |
<td>bool</td> |
|
|
696 |
<td>Fehlerindikator</td> |
|
|
697 |
</tr> |
|
|
698 |
<tr> |
|
|
699 |
<td>postcodes</td> |
|
|
700 |
<td>array</td> |
|
|
701 |
<td>Ergebnisse</td> |
|
|
702 |
</tr> |
|
|
703 |
<tr> |
|
|
704 |
<td>postcodes[i]</td> |
|
|
705 |
<td>array</td> |
|
|
706 |
<td>Ergebnis</td> |
|
|
707 |
</tr> |
|
|
708 |
<tr> |
|
|
709 |
<td>postcodes[i][postcode]</td> |
|
|
710 |
<td>str</td> |
|
|
711 |
<td>Postleitzahl</td> |
|
|
712 |
</tr> |
|
|
713 |
<tr> |
|
|
714 |
<td>postcodes[i][lat]</td> |
|
|
715 |
<td>float</td> |
|
|
716 |
<td>Latitude des Schwerpunktes</td> |
|
|
717 |
</tr> |
|
|
718 |
<tr> |
|
|
719 |
<td>postcodes[i][lon]</td> |
|
|
720 |
<td>float</td> |
|
|
721 |
<td>Longitude des Schwerpunktes</td> |
|
|
722 |
</tr> |
|
|
723 |
</tbody> |
|
|
724 |
</table> |
|
|
725 |
</div> |
|
|
726 |
<div class="item" id="method-postcode-shape"> |
|
|
727 |
<h4>Postcode-Shape</h4> |
|
|
728 |
<p><code>postcodeshape</code></p> |
|
|
729 |
<p> |
|
|
730 |
Gibt eine Näherung an die geografische Definition eines Postleitzahlengebietes aus. |
|
|
731 |
</p> |
|
|
732 |
<h5>Parameter</h5> |
|
|
733 |
<table class="docs"> |
|
|
734 |
<thead> |
|
|
735 |
<tr> |
|
|
736 |
<td>Parameter</td> |
|
|
737 |
<td>Typ</td> |
|
|
738 |
<td>Beschreibung</td> |
|
|
739 |
</tr> |
|
|
740 |
</thead> |
|
|
741 |
<tbody> |
|
|
742 |
<tr> |
|
|
743 |
<td>apikey</td> |
|
|
744 |
<td>str[20]</td> |
|
|
745 |
<td>Der API Key</td> |
|
|
746 |
</tr> |
|
|
747 |
<tr> |
|
|
748 |
<td>postcode</td> |
|
|
749 |
<td>str</td> |
|
|
750 |
<td>Die Postleitzahl des Gebietes</td> |
|
|
751 |
</tr> |
|
|
752 |
</tbody> |
|
|
753 |
</table> |
|
|
754 |
<h5>Ausgabe</h5> |
|
|
755 |
<table class="docs"> |
|
|
756 |
<thead> |
|
|
757 |
<tr> |
|
|
758 |
<td>Parameter</td> |
|
|
759 |
<td>Typ</td> |
|
|
760 |
<td>Beschreibung</td> |
|
|
761 |
</tr> |
|
|
762 |
</thead> |
|
|
763 |
<tbody> |
|
|
764 |
<tr> |
|
|
765 |
<td>status</td> |
|
|
766 |
<td>bool</td> |
|
|
767 |
<td>Fehlerindikator</td> |
|
|
768 |
</tr> |
|
|
769 |
<tr> |
|
|
770 |
<td>postcode</td> |
|
|
771 |
<td>str</td> |
|
|
772 |
<td></td> |
|
|
773 |
</tr> |
|
|
774 |
<tr> |
|
|
775 |
<td>center</td> |
|
|
776 |
<td>array</td> |
|
|
777 |
<td></td> |
|
|
778 |
</tr> |
|
|
779 |
<tr> |
|
|
780 |
<td>center[lat]</td> |
|
|
781 |
<td>flaot</td> |
|
|
782 |
<td></td> |
|
|
783 |
</tr> |
|
|
784 |
<tr> |
|
|
785 |
<td>center[lon]</td> |
|
|
786 |
<td>flaot</td> |
|
|
787 |
<td></td> |
|
|
788 |
</tr> |
|
|
789 |
<tr> |
|
|
790 |
<td>bbox</td> |
|
|
791 |
<td>array</td> |
|
|
792 |
<td></td> |
|
|
793 |
</tr> |
|
|
794 |
<tr> |
|
|
795 |
<td>bbox[n]</td> |
|
|
796 |
<td>float</td> |
|
|
797 |
<td></td> |
|
|
798 |
</tr> |
|
|
799 |
<tr> |
|
|
800 |
<td>bbox[s]</td> |
|
|
801 |
<td>float</td> |
|
|
802 |
<td></td> |
|
|
803 |
</tr> |
|
|
804 |
<tr> |
|
|
805 |
<td>bbox[w]</td> |
|
|
806 |
<td>float</td> |
|
|
807 |
<td></td> |
|
|
808 |
</tr> |
|
|
809 |
<tr> |
|
|
810 |
<td>bbox[e]</td> |
|
|
811 |
<td>float</td> |
|
|
812 |
<td></td> |
|
|
813 |
</tr> |
|
|
814 |
<tr> |
|
|
815 |
<td>shape</td> |
|
|
816 |
<td>array</td> |
|
|
817 |
<td>Alle Shapes dieses Postleitzahlengebietes</td> |
|
|
818 |
</tr> |
|
|
819 |
<tr> |
|
|
820 |
<td>shape[i]</td> |
|
|
821 |
<td>array</td> |
|
|
822 |
<td>Ein Shape des Postleitzahlengebietes</td> |
|
|
823 |
</tr> |
|
|
824 |
<tr> |
|
|
825 |
<td>shape[i][j]</td> |
|
|
826 |
<td>array</td> |
|
|
827 |
<td>Ein Punkt des Shapes</td> |
|
|
828 |
</tr> |
|
|
829 |
<tr> |
|
|
830 |
<td>shape[i][j][lat]</td> |
|
|
831 |
<td>array</td> |
|
|
832 |
<td>Die Latitude des Punktes</td> |
|
|
833 |
</tr> |
|
|
834 |
<tr> |
|
|
835 |
<td>shape[i][j][lon]</td> |
|
|
836 |
<td>array</td> |
|
|
837 |
<td>Die Longitude des Punktes</td> |
|
|
838 |
</tr> |
|
|
839 |
</tbody> |
|
|
840 |
</table> |
|
|
841 |
</div> |
|
|
842 |
</div><div class="item" id="api-errors"> |
|
|
843 |
<h3>Fehlercode</h3> |
|
|
844 |
<p> |
|
|
845 |
Wenn der Ausgabeparameter <code>status</code> einen Fehler indiziert, werden alle weiteren Ausgabeparameter ersetzt durch die Parameter <code>code</code> und <code>msg</code>. |
|
|
846 |
</p> |
|
|
847 |
<table class="docs"> |
|
|
848 |
<thead> |
|
|
849 |
<tr> |
|
|
850 |
<td>Parameter</td> |
|
|
851 |
<td>Typ</td> |
|
|
852 |
<td>Beschreibung</td> |
|
|
853 |
</tr> |
|
|
854 |
</thead> |
|
|
855 |
<tbody> |
|
|
856 |
<tr> |
|
|
857 |
<td>status</td> |
|
|
858 |
<td>bool</td> |
|
|
859 |
<td>Fehlerindikator</td> |
|
|
860 |
</tr> |
|
|
861 |
<tr> |
|
|
862 |
<td>code</td> |
|
|
863 |
<td>int[3]</td> |
|
|
864 |
<td>Fehlercode</td> |
|
|
865 |
</tr> |
|
|
866 |
<tr> |
|
|
867 |
<td>msg</td> |
|
|
868 |
<td>str</td> |
|
|
869 |
<td>Fehlermeldung</td> |
|
|
870 |
</tr> |
|
|
871 |
<tr> |
|
|
872 |
<td>result</td> |
|
|
873 |
<td></td> |
|
|
874 |
<td>Optionale weitere Daten</td> |
|
|
875 |
</tr> |
|
|
876 |
</tbody> |
|
|
877 |
</table> |
|
|
878 |
<h4>Fehlercodes</h4> |
|
|
879 |
<table class="docs"> |
|
|
880 |
<thead> |
|
|
881 |
<tr> |
|
|
882 |
<td>Code</td> |
|
|
883 |
<td>Bedeutung</td> |
|
|
884 |
</tr> |
|
|
885 |
</thead> |
|
|
886 |
<tbody> |
|
|
887 |
<tr> |
|
|
888 |
<td>900</td> |
|
|
889 |
<td>Die aufgerufene Methode existiert nicht</td> |
|
|
890 |
</tr> |
|
|
891 |
<tr> |
|
|
892 |
<td>901</td> |
|
|
893 |
<td>Der API-Key ist ungültig</td> |
|
|
894 |
</tr> |
|
|
895 |
<tr> |
|
|
896 |
<td>902</td> |
|
|
897 |
<td>Fehler in externer API</td> |
|
|
898 |
</tr> |
|
|
899 |
<tr> |
|
|
900 |
<td>903</td> |
|
|
901 |
<td>Encoding-Problem: Ein Nicht-UTF-8-Zeichen hat den Parser gestoppt</td> |
|
|
902 |
</tr> |
|
|
903 |
<tr> |
|
|
904 |
<td>904</td> |
|
|
905 |
<td>Es wurden keine gültigen JSON-Daten im POST-Request gefunden</td> |
|
|
906 |
</tr> |
|
|
907 |
<tr> |
|
|
908 |
<td>910</td> |
|
|
909 |
<td>Ungültige Eingabemethode</td> |
|
|
910 |
</tr> |
|
|
911 |
<tr> |
|
|
912 |
<td>911</td> |
|
|
913 |
<td>Die eingegebenen Daten reichen nicht aus, um die Adresse zu bestimmen</td> |
|
|
914 |
</tr> |
|
|
915 |
<tr> |
|
|
916 |
<td>912</td> |
|
|
917 |
<td>Die Adresse wurde nicht gefunden</td> |
|
|
918 |
</tr> |
|
|
919 |
<tr> |
|
|
920 |
<td>913</td> |
|
|
921 |
<td>Für diese Adresse wurden keine Koordinaten gefunden</td> |
|
|
922 |
</tr> |
|
|
923 |
<tr> |
|
|
924 |
<td>914</td> |
|
|
925 |
<td>Die Koordinaten für diese Adresse sind nicht eindeutig</td> |
|
|
926 |
</tr> |
|
|
927 |
<tr> |
|
|
928 |
<td>921</td> |
|
|
929 |
<td>Ungültige Koordinaten</td> |
|
|
930 |
</tr> |
|
|
931 |
<tr> |
|
|
932 |
<td>922</td> |
|
|
933 |
<td>Keine Route gefunden</td> |
|
|
934 |
</tr> |
|
|
935 |
<tr> |
|
|
936 |
<td>930</td> |
|
|
937 |
<td>Keine Verbindung zum Gateway</td> |
|
|
938 |
</tr> |
|
|
939 |
<tr> |
|
|
940 |
<td>931</td> |
|
|
941 |
<td>Empfänger fehlerhaft</td> |
|
|
942 |
</tr> |
|
|
943 |
<tr> |
|
|
944 |
<td>932</td> |
|
|
945 |
<td>Absenderkennung zu lang</td> |
|
|
946 |
</tr> |
|
|
947 |
<tr> |
|
|
948 |
<td>933</td> |
|
|
949 |
<td>Nachrichtentext zu lang</td> |
|
|
950 |
</tr> |
|
|
951 |
<tr> |
|
|
952 |
<td>934</td> |
|
|
953 |
<td>Messagetyp nicht korrekt</td> |
|
|
954 |
</tr> |
|
|
955 |
<tr> |
|
|
956 |
<td>935</td> |
|
|
957 |
<td>Falscher SMS-Typ</td> |
|
|
958 |
</tr> |
|
|
959 |
<tr> |
|
|
960 |
<td>936</td> |
|
|
961 |
<td>Fehler bei Login</td> |
|
|
962 |
</tr> |
|
|
963 |
<tr> |
|
|
964 |
<td>937</td> |
|
|
965 |
<td>Guthaben zu gering</td> |
|
|
966 |
</tr> |
|
|
967 |
<tr> |
|
|
968 |
<td>938</td> |
|
|
969 |
<td>Netz wird von Route nicht unterstützt</td> |
|
|
970 |
</tr> |
|
|
971 |
<tr> |
|
|
972 |
<td>939</td> |
|
|
973 |
<td>Feature nicht über diese Route möglich</td> |
|
|
974 |
</tr> |
|
|
975 |
<tr> |
|
|
976 |
<td>940</td> |
|
|
977 |
<td>Ungültige BLZ</td> |
|
|
978 |
</tr> |
|
|
979 |
<tr> |
|
|
980 |
<td>941</td> |
|
|
981 |
<td>Ungültige Kontonummer</td> |
|
|
982 |
</tr> |
|
|
983 |
<tr> |
|
|
984 |
<td>942</td> |
|
|
985 |
<td>Ungültiges Land</td> |
|
|
986 |
</tr> |
|
|
987 |
<tr> |
|
|
988 |
<td>945</td> |
|
|
989 |
<td>Ungültiger Empfänger</td> |
|
|
990 |
</tr> |
|
|
991 |
<tr> |
|
|
992 |
<td>946</td> |
|
|
993 |
<td>Keine Nachricht angegeben</td> |
|
|
994 |
</tr> |
|
|
995 |
<tr> |
|
|
996 |
<td>947</td> |
|
|
997 |
<td>Der Empfänger ist nicht subskribiert</td> |
|
|
998 |
</tr> |
|
|
999 |
<tr> |
|
|
1000 |
<td>948</td> |
|
|
1001 |
<td>Der Empfänger hat den Dienst abgeschaltet</td> |
|
|
1002 |
</tr> |
|
|
1003 |
<tr> |
|
|
1004 |
<td>950</td> |
|
|
1005 |
<td>Die Postleitzahl ist ungültig.</td> |
|
|
1006 |
</tr> |
|
|
1007 |
<tr> |
|
|
1008 |
<td>951</td> |
|
|
1009 |
<td>Für diese Postleitzahl gibt es keine Shapes.</td> |
|
|
1010 |
</tr> |
|
|
1011 |
<tr> |
|
|
1012 |
<td>952</td> |
|
|
1013 |
<td>In diesem Bereich wurden keine Postleitzahlen gefunden.</td> |
|
|
1014 |
</tr> |
|
|
1015 |
<tr> |
|
|
1016 |
<td>953</td> |
|
|
1017 |
<td>Dieser Bereich enthält zu viele Postleitzahlen.</td> |
|
|
1018 |
</tr> |
|
|
1019 |
<tr> |
|
|
1020 |
<td>999</td> |
|
|
1021 |
<td>Unbekannter Fehler</td> |
|
|
1022 |
</tr> |
|
|
1023 |
</tbody> |
|
|
1024 |
</table> |
|
|
1025 |
</div> |
|
|
1026 |
</div> |
|
|
1027 |
<div class="clear"></div> |
|
|
1028 |
</div> |
|
|
1029 |
</div> |
|
|
1030 |
<div id="foot-container"> |
|
|
1031 |
<div id="foot"> |
|
|
1032 |
<p>© 2010-2011 <a href="impressum.html">Netzguerilla.net</a>.</p> |
|
|
1033 |
</div> |
|
|
1034 |
</div> |
|
|
1035 |
</body> |
|
|
1036 |
</html> |