Friends/friends

From KWICK! Developer Wiki

Jump to: navigation, search

Contents

Beschreibung

Aufzurufende Url: /friends

Liefert eine Liste der Freunde optional anhand der Gruppen.

Parameter

Name Übergabe Beschreibung
page GET Nummer der Seite, die angezeigt werden soll. 0 bedeutet erste Seite, 1 zweite Seite und so weiter.
group (optional) GET Die Gruppen-ID kann hier optional übergeben werden. Wenn keine ID oder -1 übergeben wird, werden alle Kontakte zurückgegeben, die gerade online sind. Wird eine andere ID übergeben, so werden alle Kontakte der Gruppe mit dieser ID zurückgegeben, unabhängig davon, ob diese gerade online oder offline sind.
showOffline (optional) GET Wenn dieser Parameter auf 1 gesetzt ist, werden auch die Freunde angezeigt, die gerade offline sind.

Rückgabe

Hinweis: Standardmäßig werden bei allen Anfragen ohne den Parameter group nur Freunde zurückgegeben, die gerade online sind. Wenn auch die Freunde zurückgegeben werden sollen, die gerade offline sind, so ist der Parameter showOffline auf 1 zu setzen.

Name Beschreibung
page Aktuell abgefragte Seite, falls es mehrere Seiten gibt. Die erste Seite ist Seite 0, die zweite 1, und so weiter.
maxPage Die maximale Seitennummer, falls es mehrere Seiten gibt. Bei 5 Seiten beispielsweise 4.
friendRequestCount Gesamtzahl der offenen Freundschaftsanträge.
groups Ein JSON-Array, welches für jede Gruppe ein JSON-Objekt mit folgenden Werten enthält.
Name Beschreibung
id Eindeutige Gruppen-ID.
groupname Name der Gruppe.
buddies Anzahl der Freunde in dieser Gruppe.
buddiesSel Ein JSON-Array, welches für jeden Freund in der aktuellen Abfrage, ein JSON-Objekt mit folgenden Werten enthält.
Name Beschreibung
userid Eindeutige Mitglieds-ID des Freundes.
groupid Gruppen-ID der Gruppe, in der sich der Freund befindet.
vcard Visitenkarte (vcard) des Freundes. Siehe User/username.
selected Gruppen-ID der zurückgegebenen Gruppe.
totalSize Gesamtzahl der Freunde.

Fehler-Rückgabe

Im Fall einer Anfrage an eine Gruppe die nicht existiert, wird die Standardgruppe zurückgegeben. Des Weiteren ist darauf zu achten, dass die gewünschte Seitenzahl wirklich existiert, da andernfalls ein leeres Ergebnis zurückgegeben wird.

Personal tools