MAPI Guestbook-Service

From KWICK! Developer Wiki

Jump to: navigation, search

Contents

Paket-Fehlercodes

-keine-

Index

Gibt eine Liste von Gästebucheinträgen zurück.

URL

Aufzurufende Url: /:username/guestbook/:page

Name Typ Optional Beschreibung
username String nein Name des Mitglieds
page Integer nein Seite (0 für die erste Seite)

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.
privacyWrite True, wenn unter Beachtung der Privatsphäre auf das Gästebuch zugegriffen werden kann, andernfalls false.
isOwn True, wenn das angefragte Gästebuch das des eingeloggten Benutzers ist, andernfalls false.
pr_vcard Visitenkarte (vcard) des Mitgliedes, dem das Gästebuch gehört. Siehe User/username;
entrys data Ein JSON-Array, welches für jeden Gästebucheintrag ein JSON-Objekt mit folgenden Werten enthält.
Name Beschreibung
id Eindeutige ID des Gästebucheintrages.
pinned 1 wenn der Eintrag vom Gästebuchbesitzer gepinnt wurde, andernfalls 0.
fromuser Eindeutige Mitglieds-ID des Mitglieds, von dem der Eintrag geschrieben wurde.
text Inhalt des Eintrages im HTML-Format.
date Datum und Uhrzeit des Eintrages nach ISO 8601 im Format JJJJ-MM-TT hh:mm:ss.
date_modified Datum und Uhrzeit, wann der Eintrag das letzte mal Editiert wurde im gleichen Format wie date. Wenn der Eintrag nie editiert wurde 0000-00-00 00:00:00.
touser Eindeutige Mitglieds-ID des Empfängers des Eintrages.
replyid Falls der Eintrag eine Antwort auf einen anderen Gästebucheintrag ist, die eindeutige ID des Gästebucheintrages auf den geantwortet wurde, andernfalls 0.
comment Kommentar des Gästebuchbesitzers, oder null wenn kein Kommentar vorhanden.
cid Eindeutige Kommentar-ID des Kommentars, oder null wenn kein Kommentar vorhanden.
comment_date Datum und Uhrzeit des Kommentars im gleichen Format wie date, oder null wenn kein Kommentar vorhanden.
vcard Visitenkarte (vcard) des Mitglieds das den Gästebucheintrag geschrieben hat. Siehe User/username;
socialObject Daten des Social Objects
Name Typ Beschreibung
type String Social Object Type
id String Unique ID des Social Objects

Fehlercodes

-keine-

Rückgabe im Fehlerfall

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.

Name Beschreibung
errorMsg Fehlermeldung, falls das Gästebuch nicht zurückgegeben werden konnte.

Show

Gibt einen bestimmten Gästebucheintrag zurück.

URL

Aufzurufende Url: /:username/guestbook/show/:id

Name Typ Optional Beschreibung
username String nein Name des Mitglieds
id Integer nein Id des Eintrags

Rückgabe

Ein Gästebucheintrag.

Name Beschreibung
id Eindeutige ID des Eintrags.
vcard Visitenkarte (vcard) des Gästebuchbesitzers. Siehe User/username.
canEdit True, wenn der Eintrag vom Benutzer bearbeitet werden kann, andernfalls false.
entry id Eindeutige ID des Gästebucheintrages.
fromuser Eindeutige Mitglieds-ID des Mitglieds, von dem der Eintrag geschrieben wurde.
text Inhalt des Eintrages im HTML-Format.
date Datum und Uhrzeit des Eintrages nach ISO 8601 im Format JJJJ-MM-TT hh:mm:ss.
date_modified Datum und Uhrzeit, wann der Eintrag das letzte mal Editiert wurde im gleichen Format wie date. Wenn der Eintrag nie editiert wurde 0000-00-00 00:00:00.
touser Mitgliedsname des Empfängers des Eintrages.
replyid Falls der Eintrag eine Antwort auf einen anderen Gästebucheintrag ist, die eindeutige ID des Gästebucheintrages auf den geantwortet wurde, andernfalls 0.
username Mitgliedsname des Autors des Eintrages.
has_pic Wenn kein Bild vorhanden ist 0, wenn das Bild gesperrt ist -1, andernfalls der UNIX-Zeitstempel des aktuellen Mitgliedsbildes.
pic Absolute URL zum Profilbild des Autors im Format 100 x 100 Pixel.
age Alter des Autors in Jahren.
birthday Geburtsdatum des Autors nach ISO 8601 im Format JJJJ-MM-TT.
userid Eindeutige Mitglieds-ID des Autors.
sex Geschlecht des Autors. 1 für weiblich oder 2 für männlich.
city Ort dies Autors.
comment Kommentar des Gästebuchbesitzers, oder null wenn kein Kommentar vorhanden.
comment_date Datum und Uhrzeit des Kommentars im gleichen Format wie date, oder null wenn kein Kommentar vorhanden.
status Online-Status des Autors. Folgende Werte sind möglich.
Wert Beschreibung
0 Offline
1 Online
2 Abwesend
3 Bitte nicht stören!
4 Unsichtbar
6 Will chatten
ulink Link zum Profil des Autors inklusive Alter und Geschlecht im HTML-Format.
vcard Visitenkarte (vcard) des Autors. Siehe User/username.
socialObject Daten des Social Objects
Name Typ Beschreibung
type String Social Object Type
id String Unique ID des Social Objects

Fehlercodes

-keine-

Rückgabe im Fehlerfall

Wird eine Ganzzahl als ID übergeben, zu der kein Eintrag existiert, so wird das entry-Attribut des Rückgabeobjektes teilweise leer zurückgegeben.

Name Beschreibung
errorMsg Fehlermeldung, falls der Eintrag nicht gefunden werden konnte.

Write

Erstellt einen neuen Gästebucheintrag.

URL

Aufzurufende Url: /:username/guestbook/write

Name Typ Optional Beschreibung
username String nein Name des Mitglieds

-Keine Dokumentation-

Delete

Löscht einen Gästebucheintrag

URL

Aufzurufende Url: /:username/guestbook/delete/:id

Name Typ Optional Beschreibung
username String nein Name des Mitglieds
id Integer nein Id des Eintrags

-Keine Dokumentation-

Personal tools