Allgemein


Einstiegspunkt: http://api.podster.de/xmlrpc

Methoden


podster.test.echo


Argumente:
string apikey, string echostr

Funktionsweise:
echostr wird wieder zurückgegeben.

podster.tags.getAll


Argumente:
string apikey, int mincount

Funktionsweise:
Gibt eine struct mit allen verfügbaren Tags zurück, wobei der Feldname dem Tag entspricht, und der Wert der Anzahl der Elemente, die dem Tag zugewiesen sind.

Über den Parameter mincount lässt sich die Ausgabe filtern. Ein Tag wird dann nicht zurückgegeben, wenn die Anzahl der Zuordnungen kleiner als der Wert von mincount ist. Ist mincount gleich 0, dann erhält das Ergebnis-struct alle Tags.

podster.podcasts.getData


Argumente:
string apikey, string feedurl
string apikey, int podcastid
string apikey, array podcasts

Funktionsweise:
Erlaubt die Abfrage von Daten zu Podcast-Einträgen im Verzeichnis. Ein Podcast kann entweder über seine podster-ID (int), oder über die Feed-Adresse (string) identifziert werden. Als dritte Alternative kann ein Array angegeben werden, welches dann wiederum string oder int Werte enthält. Auf diese Weise können mehrere Podcasts gleichzeitig abgefragt werden.

Die Daten eines Podcasts werden in einem struct zurückgegeben, das zurzeit folgende Felder enthalten kann:
  • id: podster-ID des Podcast.
  • name: Der Name bzw. Titel des Podcasts im Verzeichnis.
  • lastupdated: Ein UNIX-Timestamp, der dem Zeitpunkt der letzten (podster bekannten) Aktualisierung entspricht.
  • subscriberCount: Die Anzahl der Abonnenten über podster.

Wurde ein einzelner Datensatz abgefragt, wird direkt dieser struct zurückgegeben. Andernfalls wird ein array der structs zurückgegeben, in der Reihenfolge der Anfrage.

podster.podcasts.getSubscribers


Argumente:
string apikey, int podcastid

Funktionsweise:
Gibt ein Array von Benutzer-IDs der Abonnenten des angeforderten Podcasts zurück.

podster.users.getData


Argumente:
string apikey, string username
string apikey, int userid
string apikey, array users

Funktionsweise:
Erlaubt die Abfrage von Daten zu angemeldeten Benutzern. Ein Benutzer kann entweder über seine podster-ID (int), oder über den Benutzernamen (string) identifziert werden. Zu beachten ist, dass der Benutzername sich ändern kann - die ID ist also zu bevorzugen. Als dritte Alternative kann ein Array angegeben werden, welches dann wiederum string oder int Werte enthält. Auf diese Weise können mehrere Benutzer gleichzeitig abgefragt werden.

Die Daten eines Benutzers werden in einem struct zurückgegeben, das zurzeit folgende Felder enthalten kann:
  • id: podster-ID des Users.
  • name: Benutzername.
  • hasImage: Boolean-Wert der angibt, ob ein Benutzerbild vorhanden ist.
  • imageExtension: Die Dateiendung des Benutzerbildes, falls vorhanden (z.B. "jpg""). Das kann verwendet werden um einen Link zum Benutzerfoto selbst zu bauen, allerdings ist es empfehlenswert die Funktion podster.users.getImages dafür zu verwenden.
  • location: Der vom Benutzer eingegebene Wohnort.
  • geo: Ein struct mit den Feldern lat und long, das die Geo-Position des Benutzers angibt, falls eingetragen.

Wurde ein einzelner Datensatz abgefragt, wird direkt dieser struct zurückgegeben. Andernfalls wird ein array der structs zurückgegeben, in der Reihenfolge der Anfrage.

podster.users.getImages


Argumente:
string apikey, string username
string apikey, int userid
string apikey, array users

Funktionsweise:
Erlaubt die Abfrage der URLs der Profilbilder von angemeldeten Benutzern. Ein Benutzer kann entweder über seine podster-ID (int), oder über den Benutzernamen (string) identifziert werden. Zu beachten ist, dass der Benutzername sich ändern kann - die ID ist also zu bevorzugen. Als dritte Alternative kann ein Array angegeben werden, welches dann wiederum string oder int Werte enthält. Auf diese Weise können mehrere Benutzer gleichzeitig abgefragt werden.

Jeder Datensatz enthält die folgenden Felder:
  • id: Die ID des Benutzers.
  • hasImage: Ist false, falls kein Bild zur Verfügung steht. Die folgenden Belder fehlen dann.
  • imageVerySmall, imageVerySmallSquare, imageSmall, imageSmallSquare, imageMedium, imageMediumSquare, imageBig, imageBigSquare: Die Links zu den Bildern in den entsprechenden Größen. Die Felder mit dem Zusatz Square meinen dabei immer Versionen der Bilder mit gleichen Seitenverhältnissen.

Wurde ein einzelner Datensatz abgefragt, wird direkt dieser struct zurückgegeben. Andernfalls wird ein array der structs zurückgegeben, in der Reihenfolge der Anfrage.