MAPI Blog-Service

From KWICK! Developer Wiki

Jump to: navigation, search

Contents

Paket-Fehlercodes

Die folgenden Fehlercodes werden nur vom Blog-Service zurückgegeben. Dieser Service gibt auch globale Fehlercodes zurück.

Name Beschreibung
10101 Der Titel ist zu kurz.
10102 Der Titel ist zu lang.
10103 Der Text ist zu kurz.
10104 Der Text ist zu lang.

Index

Gibt eine Liste von Blogeinträgen zurück.

URL

Aufzurufende Url: /:username/blog/:?limit/:?offset

Name Typ Optional Beschreibung
username String nein Name des Mitglieds
limit Integer ja Anzahl der Einträge
offset Integer ja Position des ersten Eintrags

Rückgabe

Name Typ Beschreibung
overallCount Integer Gesamtzahl der Blogeinträge des Mitglieds
entries Array Liste der Blogeinträge im aktuellen limit/offset-Bereich
Name Typ Beschreibung
id Integer Id des Eintrags
userId Integer User Id des Autors
title String Titel
text String Text
created String Erstellungsdatum
modified String Datum der letzten Änderung
isPinned Boolean Gibt an, ob der Eintrag gepinnt ist
likes Integer Anzahl der Bewertungen
comments Integer Anzahl der Kommentare
socialObject Object Daten des Social Objects
Name Typ Beschreibung
type String Typ
id String Id

Fehlercodes

Name Beschreibung
403 Der Benutzer darf diese Aktion nicht durchführen.
500 Ein interner Fehler ist aufgetreten.
503 Diese Aktion kann im Moment nicht durchgeführt werden. Eine Wiederholung ist in Kürze vermutlich erfolgreich.

Get

Gibt einen bestimmten Blogeintrag zurück.

URL

Aufzurufende Url: /:username/blog/get/:id

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

Rückgabe

Ein Blogeintrag.

Name Typ Beschreibung
id Integer Id des Eintrags
userId Integer User Id des Autors
title String Titel
text String Text
created String Erstellungsdatum
modified String Datum der letzten Änderung
isPinned Boolean Gibt an, ob der Eintrag gepinnt ist
likes Integer Anzahl der Bewertungen
comments Integer Anzahl der Kommentare
socialObject Object Daten des Social Objects
Name Typ Beschreibung
type String Typ
id String Id

Fehlercodes

Name Beschreibung
403 Der Benutzer darf diese Aktion nicht durchführen.
404 Blogeintrag wurde nicht gefunden.
500 Ein interner Fehler ist aufgetreten.
503 Diese Aktion kann im Moment nicht durchgeführt werden. Eine Wiederholung ist in Kürze vermutlich erfolgreich.

Create

Erstellt einen neuen Blogeintrag.

URL

Aufzurufende Url: /:username/blog/create

Name Typ Optional Beschreibung
username String nein Name des Mitglieds

POST-Parameter

Name Typ Optional Beschreibung
title String nein Titel
text String nein Text
isPinned Integer (0/1) nein Gibt an, ob ein Eintrag gepinnt ist.
shareExternal Integer (0/1) nein Gibt an, ob der Eintrag an verbundene Netzwerke geschickt werden soll.

Rückgabe

Der neu erstellte Blogeintrag.

Name Typ Beschreibung
id Integer Id des Eintrags
userId Integer User Id des Autors
title String Titel
text String Text
created String Erstellungsdatum
modified String Datum der letzten Änderung
isPinned Boolean Gibt an, ob der Eintrag gepinnt ist
likes Integer Anzahl der Bewertungen
comments Integer Anzahl der Kommentare
socialObject Object Daten des Social Objects
Name Typ Beschreibung
type String Typ
id String Id

Fehlercodes

Name Beschreibung
401 Der Benutzer ist nicht eingeloggt.
403 Der Benutzer darf diese Aktion nicht durchführen.
500 Ein interner Fehler ist aufgetreten.
503 Diese Aktion kann im Moment nicht durchgeführt werden. Eine Wiederholung ist in Kürze vermutlich erfolgreich.
10101 Der Titel ist zu kurz.
10102 Der Titel ist zu lang.
10103 Der Text ist zu kurz.
10104 Der Text ist zu lang.

Update

Aktualisiert einen Blogeintrag.

URL

Aufzurufende Url: /:username/blog/update/:id

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

POST-Parameter

Name Typ Optional Beschreibung
title String nein Titel
text String nein Text
isPinned Integer (0/1) nein Gibt an, ob ein Eintrag gepinnt ist.

Rückgabe

Der aktualisierte Blogeintrag.

Name Typ Beschreibung
id Integer Id des Eintrags
userId Integer User Id des Autors
title String Titel
text String Text
created String Erstellungsdatum
modified String Datum der letzten Änderung
isPinned Boolean Gibt an, ob der Eintrag gepinnt ist
likes Integer Anzahl der Bewertungen
comments Integer Anzahl der Kommentare
socialObject Object Daten des Social Objects
Name Typ Beschreibung
type String Typ
id String Id

Fehlercodes

Name Beschreibung
401 Der Benutzer ist nicht eingeloggt.
403 Der Benutzer darf diese Aktion nicht durchführen.
404 Blogeintrag wurde nicht gefunden.
500 Ein interner Fehler ist aufgetreten.
503 Diese Aktion kann im Moment nicht durchgeführt werden. Eine Wiederholung ist in Kürze vermutlich erfolgreich.
10101 Der Titel ist zu kurz.
10102 Der Titel ist zu lang.
10103 Der Text ist zu kurz.
10104 Der Text ist zu lang.

Delete

Löscht einen Blogeintrag

URL

Aufzurufende Url: /:username/blog/delete/:id

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

Rückgabe

Der neu erstellte Blogeintrag.

Name Typ Beschreibung
success Boolean Immer true

Fehlercodes

Name Beschreibung
401 Der Benutzer ist nicht eingeloggt.
403 Der Benutzer darf diese Aktion nicht durchführen.
500 Ein interner Fehler ist aufgetreten.
503 Diese Aktion kann im Moment nicht durchgeführt werden. Eine Wiederholung ist in Kürze vermutlich erfolgreich.
Personal tools