Friends/friends/requests

From KWICK! Developer Wiki

Jump to: navigation, search

Contents

Beschreibung

Aufzurufende Url: /friends/requests/?PAGE

Hinweis: In der Url mit einem ? (Fragezeichen) gekennzeichnete Pfade sind optionale Parameter, welche nicht bei jedem Aufruf erforderlich sind. Beachte bitte, dass die Reihenfolge der Parameter in jedem Fall eingehalten werden muss.

Soll beispielswiese der zweite optionale Parameter verwendet werden, so muss der Erste zwangsläufig mit angegeben werden, damit die Reihenfolge erhalten bleibt.

Liefert eine Liste der offenen Freundschaftsanträge. Der Platzhalter ?PAGE steht hierbei für die anzufragende Seite.

Parameter

Keine.

Rückgabe

Name Beschreibung
page Aktuell abgefragte Seite. 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.
requests Ein JSON-Objekt, welches für jeden offenen Freundschaftsantrag ein Attribut enthält, wobei jedes Attribut als Namen die eindeutige Mitglieds-ID des Antragstellers hat. Jedes dieser Attribute ist wiederum ein JSON-Objekt mit folgenden Werten.
Name Beschreibung
userid Eindeutige Mitglieds-ID.
date Datum und Uhrzeit der Antragstellung nach ISO 8601 im Format JJJJ-MM-TT hh:mm:ss.
reason Vom Antragsteller angegebener Grund für den Antrag.
vcard Visitenkarte (vcard) des Antragstellers. Siehe User/username.

Fehler-Rückgabe

Es ist darauf zu achten, dass bei der Angabe des Platzhalters ?PAGE stets im Rahmen der existierenden Seiten, also zwischen 0 und maxPage geblättert wird, da andernfalls ein leeres Ergebnis zurückgegeben wird.

Personal tools