User/index

From KWICK! Developer Wiki

Jump to: navigation, search

Contents

Beschreibung

Aufzurufende Url: /index/PAGE

Liefert die Startseite des eingeloggten Benutzers. Hierbei ist insbesondere der Neuigkeiten-Feed interessant, welcher zur weiteren Verarbeitung mit dem Feed-Service unabdingbar ist. Über PAGE wird die gewünschte Seitenzahl angegeben.

Parameter

Name Übergabe Beschreibung
page (optional) GET / POST Gibt die Seite an, welche Seite abgefragt werden soll. Die erste Seite ist Seite 0, die zweite 1, und so weiter.

Rückgabe

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.
status status Aktuelle Status-Nachricht des eingeloggten Benutzers.
time Datum und Uhrzeit der Status-Nachricht im HTML-Format.
infobox Die unter der Rückgabe infobox aufgeführten Rückgaben der Infobox.
ticker_count Anzahl der Ereignisse.
feed Ein JSON-Objekt, welches als Attribute für jeden Feed-Eintrag ein JSON-Objekt enthält, wobei der Attributname die ID des Feed-Eintrages ist. Das JSON-Objekt für den Feed-Eintrag enthält folgende Werte.
Name Beschreibung
body Inhalt des Feed-Eintrages im HTML-Format.
timestamp Datum und Uhrzeit des Eintrages als UNIX-Zeitstempel.
from_id Eindeutige Mitglieds-ID des Feed-Autors.
from_name Mitglidsname des Autors.
from_type Typ des Autors, beispielsweise user für Benutzer.
has_pic 1 wenn der Benutzer ein Profilbild hat.
type Typ-ID des Feed-Eintrages, beispielsweise 1 für Profilbesuch oder 38 für Statusnachricht.
comments Ein JSON-Objekt, welches als Attribute für jeden Kommentar ein JSON-Objekt enthält, wobei der Attributname die ID des Kommentars ist. Das JSON-Objekt für den Kommentar enthält folgende Werte.
Name Beschreibung
text Kommentartext.
timestamp Datum und Uhrzeit des Kommentars als UNIX-Zeitstempel.
userid Eindeutige Mitglieds-ID des Kommentators.
username Mitgliedsname des Kommentators.
age Alter des Kommentators in Jahren.
gender Geschlecht des Kommentators. 1 für weiblich oder 2 für männlich.
has_pic Wenn kein Bild vorhanden ist 0, wenn das Bild gesperrt ist -1, andernfalls der UNIX-Zeitstempel des aktuellen Mitgliedsbildes.
vcard Visitenkarte (vcard) des Kommentators. Siehe User/username.
has_comments Anzahl der Kommentare die zum Feed-Eintrag vorhanden sind.
vcard Visitenkarte (vcard) des Autors des Feed-Eintrages. Siehe User/username.

Fehler-Rückgabe

Es ist darauf zu achten, dass bei der Angabe des Parameters 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