Dokumentation der Schnittstelle

Submitted by Marco on Fri, 05/27/2011 - 15:27

Request
Die Funktionen des Webservice werden über eine URI (Unique Resource Identifier) aufgerufen. Jedem Aufruf muss mindestens der Query-Parameter "key" und muss der Query-Parameter "secret" übergeben werden, falls eine Authentifizierung notwendig ist. Der Flag "info=verbose" liefert alle Details zur Anfrage. Der Flag "info" liefert Details zur Begrenzung der Abfragegeschwindigkeit.

Response
Der Server antwortet im XML oder JSON-Format. Alle Formate sind über XML-Schemas definiert und erlauben lokal eine automatische Generierung der Daten-Klassen. Alle Antwort-Schemas des Servers setzten sich aus Request-Schema, Info-Schema und Response-Schema zusammen. Beinhaltet die aufgerufene Funktion keine Daten, so wird das leere Standard-Element der Funktion zurückgegeben. Liefert die Funktion zumindest einen Fehler, so wird anstatt dem leeren Standard-Element die Liste der Fehlermeldungen angezeigt.