Proxer API/v1/Notifications

Aus Proxer.Me - Wiki
Wechseln zu: Navigation, Suche

Diese Klasse beinhaltet alle Schnittstellen, die mit Daten zu tun haben, die normalerweise auf Proxer oben rechts bei den Notifications zu sehen sind, insbesondere News und Benachrichtigungen.


Get Count

FunktionsnameGet Count
BeschreibungDiese Funktion gibt die Anzahl an verschiedenen Notification-Kategorien zurück (kleine rote Zahlen auf Proxer). Die Ausgabedaten befinden sich in einem Array, wobei folgende Indices folgende Anzahlen enthalten:
  • 0 = Error (entspricht error-Wert des jsons)
  • 1 = Altes PN-System (deprecated)
  • 2 = Neues PN-System
  • 3 = Freundschaftsanfragen
  • 4 = News
  • 5 = Benachrichtigungen
Anfragelinkhttps://proxer.me/api/v1/notifications/count
ZugriffslevelLevel 0
Eingabeparameter
  • Keine
Ausgabeparameter
  • error: 0 oder 1. 0 wenn das Abrufen erfolgreich war. Ansonsten 1.
  • message : Eine Statusbeschreibung im Klartext.
  • code (optional): Zur besseren maschinellen Verarbeitung gibt es bei einem Fehler ein Fehler-Code.
  • data (optional): Im Falle einer Erfolgreichen Abfrage sind hier die Ausgabedaten enthalten
Codes
  • 3002: User nicht eingeloggt



Get News

FunktionsnameGet News
BeschreibungGibt die neuesten News aus.

Der Bildlink einer News setzt sich zusammen aus: cdn.proxer.me/news/[News-ID]_[Image-ID].png

Für Tumbnail: cdn.proxer.me/news/th/[News-ID]_[Image-ID].png

Link zum Forumspost der News: proxer.me/forum/[catid]/[mid]
Anfragelinkhttps://proxer.me/api/v1/notifications/news
ZugriffslevelLevel 0
EingabeparameterParameter (GET oder POST):
  • p (optional): Die zu ladende Seite, beginnend ab 0 (Auf Seite 0 befinden sich die neuesten News, nach hinten werden die News älter). Wenn nicht gegeben, so wird die erste Seite geladen.
  • limit (optional): Die Anzahl der zu ladenden News pro Seite. Default 15.
Ausgabeparameter
  • error: 0 oder 1. 0 wenn die Abfrage erfolgreich war, ansonsten 1.
  • message: Eine Statusbeschreibung im Klartext.
  • code (optional): Zur besseren maschinellen Verarbeitung gibt es bei einem Fehler ein Fehler-Code.
  • data (optional): Ein Array aus Objekten mit den Daten der News. Dabei enthält jedes Objekt folgende Daten:
    • nid: Die ID der News
    • time: Der Zeitpunkt der publizierung (Unix-Timestamp als Sekunden gespeichert)
    • mid: Die ID des entsprechenden Forumsbeitrags
    • description: Die Beschreibung der News
    • image_id: ID zum Bild.
    • image_style: CSS-Konforme Style-Elemente um die Positionierung des Bildes zu bestimmen.
    • subject: Der Titel des entsprechenden Forumsbeitrags
    • hits: Anzahl der Zugriffe auf den entsprechenden Forumsbeitrag
    • thread: mid
    • uid: User-ID des Erstellers des Forumsposts
    • uname: Benutzername des Autors
    • posts: Anzahl der Antworten/Kommentare auf die News
    • catid: Die ID der Kategorie, in der sich eine News befindet.
    • catname: Der Name der Kategorie.
Codes
  • 2001: Serverfehler bei der Abfrage.



Get Notifications

FunktionsnameGet Notifications
BeschreibungGibt die Benachrichtigungen des momentan eingeloggten Users aus.
Anfragelinkhttps://proxer.me/api/v1/notifications/notifications
ZugriffslevelLevel 0
EingabeparameterParameter (GET oder POST):
  • p (optional): Die zu ladende Seite, beginnend bei 0. Default 0.
  • limit (optional): Die Größe einer Seite. Default 15.
  • set_read (optional): Ein boolscher String, ob die geholten Benachrichtigungen als "gelesen" markiert werden sollen. Erlaubte Werte: "true", "false" (default, jeder weitere String wird zu false)
Ausgabeparameter
  • error: 0 oder 1. 0 wenn die Abfrage erfolgreich war, ansonsten 1.
  • message: Eine Statusbeschreibung im Klartext.
  • code (optional): Zur besseren maschinellen Verarbeitung gibt es bei einem Fehler ein Fehler-Code.
  • data (optional): Hier werden die geholten Daten abgelegt, wenn die Abfrage erfolgreich war. (Array aus Objekten)
    • id: Die ID der Benachrichtigung (wird benötigt zum Löschen)
    • type: Der Typ der Benachrichtigungen (nur einer von Bedeutung: "media_reminder" -> kann per API weiterverarbeitet werden. Alle anderen Typen nicht)
      • vorhandene Typen: (user_boardmessage, user_boardreply, user_friendaccept, subs_projectstate, media_reminder, ticket, ticket_comment, ticket_mention, forum_post, forum_topic, gallery2_album, apps_release, apps_state, podcast)
    • tid: Die ID des Inhaltes der Benachrichtigung (abhängig vom Typ, bei "media_reminder": ID des Lesezeichens)
    • link: Ein Link zur korrespondierenden Seite Proxers - bei jedem Typen vorhanden
    • linktext: Der eigentliche Text der Benachrichtigung
    • time: Der Zeitpunkt, zu dem die Benachrichtigung erstellt wurde. Als Integer.
    • description: Zusäztliche Informationen in Form eines Strings. Kann auch leer sein.
Codes
  • 3002: User nicht eingeloggt



Delete

FunktionsnameDelete
BeschreibungLöscht eine gegebene Notification
Anfragelinkhttps://proxer.me/api/v1/notifications/delete
ZugriffslevelLevel 1
EingabeparameterParameter (POST):
  • nid (optional): Die ID der zu löschenden Notification. Wenn weggelassen oder 0, so werden alle als gelesen markierten Benachrichtigungen gelöscht.
Ausgabeparameter
  • error: 0 oder 1. 0 wenn die Abfrage erfolgreich war, ansonsten 1.
  • message: Eine Statusbeschreibung im Klartext.
  • code (optional): Zur besseren maschinellen Verarbeitung gibt es bei einem Fehler ein Fehler-Code.
Codes
  • 3002: User nicht eingeloggt.