<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>Iro · API docs</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta charset="utf-8">
<meta name="description" content="">
<meta name="keywords" content="">
<link rel="shortcut icon" type="image/x-icon" href="images/favicon.png">
<link rel="stylesheet" href="css/reset.css" type="text/css" media="screen">
<link rel="stylesheet" href="css/960.css" type="text/css" media="screen">
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen">
<!--[if IE]><link rel="stylesheet" href="css/style-ie.css" type="text/css" media="screen" /><![endif] -->
</head>
<body>
<div id="head-container">
<div id="head">
<h1 id="logo"><a href="index.html" class="logo" title="Netzguerilla"><span>Netzguerilla</span></a></h1>
<ul id="menu">
<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>
</ul>
</div>
</div>
<div id="content-container">
<div id="content" class="container_12">
<div id="main" class="grid_9">
<h2>API Dokumentation</h2>
<div class="item">
<p>
</p>
<ol>
<li value="1">1. <a href="#api-intro">Einführung</a></li>
<li value="2">2.
<a href="#api-interfaces">Interfaces</a>
<ol>
<li value="2.1">2.1 <a href="#interface-xmlrpc">XML-RPC</a></li>
</ol>
</li>
<li value="3">3.
<a href="#api-methods">Methoden</a>
<ol>
<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>
</ol>
</li>
</ol>
</div><div class="item" id="api-intro">
<h3>Einführung</h3>
<p>
Die Iro API enthält Funktion, die für den Massenversand nützlich sind.
</p>
</div><div class="item" id="api-interfaces">
<h3>Interfaces</h3>
<p>
Die Iro API stellt zur Zeit nur ein Interfaces bereit.
</p>
<div class="item" id="interface-xmlrpc">
<h4>XML-RPC</h4>
<p>
Interface-URI: <code>https://<em><benutzer></em>:<em><passwort></em>@localhost:8000</code>
</p>
<p>
Die aufgerufene Methode wird dabei im <code><methodName /></code> übergeben.
</p>
</div>
</div><div class="item" id="api-methods">
<h3>Methoden</h3>
<div class="item" id="method-startSMS">
<h4>StartSMS</h4>
<p><code>startSMS(message, recipients, provider='default')</code></p>
<p>Versendet eine SMS.</p>
<h5>Parameter</h5>
<table class="docs">
<thead>
<tr>
<td>Parameter</td>
<td>Typ</td>
<td>Beschreibung</td>
</tr>
</thead>
<tbody>
<tr>
<td>message</td>
<td>string</td>
<td> Nachricht</td>
</tr><tr>
<td>recipients</td>
<td>list</td>
<td> eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)</td>
</tr><tr>
<td>provider</td>
<td>string</td>
<td> Provider über den geschickt werden soll</td>
</tr>
</tbody>
</table>
<h5>Ausgabe</h5>
<table class="docs">
<thead>
<tr>
<td>Parameter</td>
<td>Typ</td>
<td>Beschreibung</td>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>hash</td>
<td> Die ID des Auftrages</td>
</tr>
</tbody>
</table>
</div><div class="item" id="method-startFAX">
<h4>StartFAX</h4>
<p><code>startFAX(subject, fax, recipients, provider='default')</code></p>
<p>Versendet ein FAX.</p>
<h5>Parameter</h5>
<table class="docs">
<thead>
<tr>
<td>Parameter</td>
<td>Typ</td>
<td>Beschreibung</td>
</tr>
</thead>
<tbody>
<tr>
<td>subject</td>
<td>string</td>
<td> der Betreff</td>
</tr><tr>
<td>fax</td>
<td>string</td>
<td> das pdf base64 kodiert</td>
</tr><tr>
<td>recipients</td>
<td>list</td>
<td> eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)</td>
</tr><tr>
<td>provider</td>
<td>string</td>
<td> Provider über den geschickt werden soll</td>
</tr>
</tbody>
</table>
<h5>Ausgabe</h5>
<table class="docs">
<thead>
<tr>
<td>Parameter</td>
<td>Typ</td>
<td>Beschreibung</td>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>hash</td>
<td> Die ID des Auftrages</td>
</tr>
</tbody>
</table>
</div><div class="item" id="method-startMail">
<h4>StartMail</h4>
<p><code>startMail(subject, body, recipients, frm, provider='default')</code></p>
<p>Versendet eine Email.</p>
<h5>Parameter</h5>
<table class="docs">
<thead>
<tr>
<td>Parameter</td>
<td>Typ</td>
<td>Beschreibung</td>
</tr>
</thead>
<tbody>
<tr>
<td>subject</td>
<td>string</td>
<td> der Betreff</td>
</tr><tr>
<td>body</td>
<td>string</td>
<td> der Email Body</td>
</tr><tr>
<td>recipients</td>
<td>list</td>
<td> eine Liste von Emailadressen</td>
</tr><tr>
<td>frm</td>
<td>string</td>
<td> Die Absender Emailadresse</td>
</tr><tr>
<td>provider</td>
<td>string</td>
<td> Provider über den geschickt werden soll</td>
</tr>
</tbody>
</table>
<h5>Ausgabe</h5>
<table class="docs">
<thead>
<tr>
<td>Parameter</td>
<td>Typ</td>
<td>Beschreibung</td>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>hash</td>
<td> Die ID des Auftrages</td>
</tr>
</tbody>
</table>
</div><div class="item" id="method-status">
<h4>Status</h4>
<p><code>status(id=None, detailed=False)</code></p>
<p>Gibt den aktuellen Status eines Auftrages zurück.</p>
<h5>Parameter</h5>
<table class="docs">
<thead>
<tr>
<td>Parameter</td>
<td>Typ</td>
<td>Beschreibung</td>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>hash</td>
<td> Eine Auftragsnummer</td>
</tr><tr>
<td>detailed</td>
<td>boolean</td>
<td> Details ausgeben</td>
</tr>
</tbody>
</table>
<h5>Ausgabe</h5>
<table class="docs">
<thead>
<tr>
<td>Parameter</td>
<td>Typ</td>
<td>Beschreibung</td>
</tr>
</thead>
<tbody>
<tr>
<td>jobs</td>
<td>list</td>
<td> Eine Liste der Aufträge.</td>
</tr><tr>
<td>job.name</td>
<td>string</td>
<td> Angebener Name</td>
</tr><tr>
<td>job.status</td>
<td>string</td>
<td> Status des Auftrages</td>
</tr>
</tbody>
</table>
</div><div class="item" id="method-stop">
<h4>Stop</h4>
<p><code>stop(id)</code></p>
<p>Stoppt den angegeben Auftrag.</p>
<h5>Parameter</h5>
<table class="docs">
<thead>
<tr>
<td>Parameter</td>
<td>Typ</td>
<td>Beschreibung</td>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>hash</td>
<td> Eine Auftragsnummer</td>
</tr>
</tbody>
</table>
</div><div class="item" id="method-getProvider">
<h4>GetProvider</h4>
<p><code>getProvider(typ)</code></p>
<p>Gibt eine Liste aller verfügbaren Provider zurück.</p>
<h5>Parameter</h5>
<table class="docs">
<thead>
<tr>
<td>Parameter</td>
<td>Typ</td>
<td>Beschreibung</td>
</tr>
</thead>
<tbody>
<tr>
<td>typ</td>
<td>string</td>
<td> Der Typ zu dem die Providerloste ausgeben werden soll
Einer der Liste ["sms","fax","mail"]</td>
</tr>
</tbody>
</table>
<h5>Ausgabe</h5>
<table class="docs">
<thead>
<tr>
<td>Parameter</td>
<td>Typ</td>
<td>Beschreibung</td>
</tr>
</thead>
<tbody>
<tr>
<td>providerlist</td>
<td>list</td>
<td> Eine Liste aller möglichen Provider</td>
</tr>
</tbody>
</table>
</div><div class="item" id="method-getDefaultProvider">
<h4>GetDefaultProvider</h4>
<p><code>getDefaultProvider(typ)</code></p>
<p>Gibt den Standardprovider zurück.</p>
<h5>Parameter</h5>
<table class="docs">
<thead>
<tr>
<td>Parameter</td>
<td>Typ</td>
<td>Beschreibung</td>
</tr>
</thead>
<tbody>
<tr>
<td>typ</td>
<td>string</td>
<td> Der Typ zu dem die Providerloste ausgeben werden soll
Einer der Liste ["sms","fax","mail"]</td>
</tr>
</tbody>
</table>
<h5>Ausgabe</h5>
<table class="docs">
<thead>
<tr>
<td>Parameter</td>
<td>Typ</td>
<td>Beschreibung</td>
</tr>
</thead>
<tbody>
<tr>
<td>provider</td>
<td>string</td>
<td> Der Standardprovider für den angeben Typ</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="clear"></div>
</div>
</div>
<div id="foot-container">
<div id="foot">
<p>© 2010-2011 <a href="impressum.html">Netzguerilla.net</a>.</p>
</div>
</div>
</body>
</html>