<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:py="http://genshi.edgewall.org/">
<xi:include href="layout.tmpl" />
<head>
<title>api docs new</title>
</head>
<body>
<title>geplante API Dokumentation</title>
<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>
<li value="2.1">2.1 <a href="#interface-soap">SOAP</a></li>
<li value="2.2">2.2 <a href="#interface-xml">XML</a></li>
<li value="2.3">2.3 <a href="#interface-json">JSON</a></li>
<li value="2.4">2.4 <a href="#interface-jsonp">JSONP</a></li>
<li value="2.5">2.5 <a href="#interface-php">PHP</a></li>
</ol>
</li>
<li value="3">3.
<a href="#api-methods">Methoden</a>
<ol>
<li py:for="(key,method) in enumerate(new)" value="3.${key+1}">3.${key+1} <a href="#method-${method.name}">${method.title}</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 wird über verschiedene Interfaces bereit gestellt, die unterschiedlich angesprochen werden, aber das selbe tun.
</p>
<div class="item" id="interface-xmlrpc">
<h4>XML-RPC</h4>
<p>
Interface-URI: <code>http://localhost:8000/xmlrpc</code>
</p>
<p>
Die aufgerufene Methode wird dabei im <code><methodName /></code> übergeben.
</p>
</div>
<div class="item" id="interface-soap">
<h4>SOAP</h4>
<p>
Interface-URI: <code>http://localhost:8000/soap</code>
</p>
<p>
Die aufgerufene Methode wird dabei im <code><methodName /></code> übergeben.
</p>
</div>
<div class="item" id="interface-xml">
<h4>XML</h4>
<p>
Interface-URI: <code>http://localhost:8000/xml/<em><methode></em></code>
</p>
<p>
Die aufgerufene Methode wird im Pfad der Interface-URI übergeben.
</p>
<p>
Parameter können via HTTP per GET oder POST im Format <em>application/x-www-form-urlencoded</em> übergeben werden.
</p>
<p>
Die Ausgabe erfolgt als XML Markup.
</p>
</div>
<div class="item" id="interface-json">
<h4>JSON</h4>
<p>
Interface-URI: <code>http://localhost:8000/json/<em><methode></em></code>
</p>
<p>
Die aufgerufene Methode wird im Pfad der Interface-URI übergeben.
</p>
<p>
Parameter können via HTTP per GET oder POST im Format <em>application/x-www-form-urlencoded</em> oder JSON-Objekt übergeben werden.
</p>
<p>
Die Ausgabe erfolgt als JSON-Objekt.
</p>
</div>
<div class="item" id="interface-jsonp">
<h4>JSONP</h4>
<p>
Interface-URI: <code>http://localhost:8000/jsonp/<em><methode></em>?callback=<callback></code>
</p>
<p>
Die aufgerufene Methode wird im Pfad der Interface-URI übergeben.
</p>
<p>
Der Name für die Callback-Methode wird als Parameter Callback übergeben.
</p>
<p>
Parameter können via HTTP per GET im Format <em>application/x-www-form-urlencoded</em> übergeben werden.
</p>
<p>
Die Ausgabe erfolgt als Javascript-Funktionsaufruf mit einem JSON-Objekt als Parameter.
</p>
</div>
</div>
<div class="item" id="api-methods">
<h3>Methoden</h3>
<div py:for="method in new" class="item" id="method-${method.name}">
<h4>${method.title}</h4>
<p><code>${method.name}${method.func_line}</code></p>
<p py:content="method.description">
Diese Methode at bis jetzt noch keine Beschreibung.
</p>
<h5>Parameter</h5>
<table class="docs">
<thead>
<tr>
<td>Parameter</td>
<td>Typ</td>
<td>Beschreibung</td>
</tr>
</thead>
<tbody>
<tr py:for="arg in method.args">
<td>${arg.name}</td>
<td>${arg.typ}</td>
<td>${arg.description}</td>
</tr>
</tbody>
</table>
<py:if test="method.rets">
<h5>Ausgabe</h5>
<table class="docs">
<thead>
<tr>
<td>Parameter</td>
<td>Typ</td>
<td>Beschreibung</td>
</tr>
</thead>
<tbody>
<tr py:for="arg in method.rets">
<td>${arg.name}</td>
<td>${arg.typ}</td>
<td>${arg.description}</td>
</tr>
</tbody>
</table>
</py:if>
</div>
</div>
</body>
</html>