Proxer API/v1/Ucp

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

Diese Klasse dient der Verwaltung sämtlicher Daten, die normalerweise über das UCP Abrufbar/Veränderbar sind. Logischerweise erfordern alle diese Funktionen, dass der User eingeloggt ist.


Get List

FunktionsnameGet List
BeschreibungDiese Funktion liefert die Liste aller Animes/Mangas, zu denen der User einen Eintrag im UCP hat.
Anfragelinkhttps://proxer.me/api/v1/ucp/list
ZugriffslevelLevel 0
EingabeparameterParameter (GET oder POST):
  • kat (optional): Dieser Parameter gibt an, welche Kategorie geladen werden soll. Default Wert "anime". Erlaubte Werte: "anime","manga"
  • p (optional): Dieser Parameter gibt an, welche Seite geladen werden soll. Default Wert 0. Start bei 0.
  • limit (optional): Dieser Parameter gibt an, wie viele Einträge eine Seite enthalten soll. Default Wert 100.
  • search (optional): Durch die Angabe dieses Parameters werden nur Entrys angezeigt, die den angegeben Wert als Substring ihres Namens haben. Dabei ist die Position im Namen egal.
  • search_start (optional): Durch die Angabe dieses Parameters werden nur Entrys angezeigt, die den angegeben Wert als Substring zu Beginn ihres Namens haben.
  • sort (optional): Dieser Parameter gibt an, wie die Liste sortiert werden soll, erlaubte Eingaben (Fehlerhafte Eingaben werden auf den Default-Wert gezwungen):
    • nameASC: Sortierung nach Entry-Name Aufsteigend
    • nameDESC: Sortierung nach Entry-Name Absteigend
    • stateNameASC: Sortierung nach Status des Entrys, dann Entry-Name Aufsteigend (default Wert)
    • stateNameDESC: Sortierung nach Status des Entrys, dann Entry-Name Absteigend
    • changeDateASC: Sortierung nach letzter Änderung Aufsteigend
    • changeDateDESC: Sortierung nach letzter Änderung Absteigend
    • stateChangeDateASC: Sortierung nach Status des Entrys, dann letzter Änderung Aufsteigend
    • stateChangeDateDESC: Sortierung nach Status des Entrys, dann letzter Änderung Absteigend
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 des Entrys
    • name: Der Name des Entrys
    • count: Anzahl der Folgen/Kapitel (müssen nicht hochgeladen sein!)
    • medium: Das Medium des Entrys (animeseries,movie,ova,hentai,mangaseries,oneshot,doujin,hmanga)
    • estate: Der Status des Entrys
    • cid: Die ID des zugehörigen Kommentars
    • comment: Der Text des zugehörigen Kommentars
    • state: Der Status des zugehörigen Kommentars
    • episode: Die Episodenzahl des zugehörigen Kommentars (bis wohin der Entry gesehen/gelesen wurde)
    • data: Die Daten des zugehörigen Kommentars
    • rating: Die Bewertung des Entrys durch den User (0 bis 10)
Codes
  • 3004: User nicht eingeloggt.
  • 3005: Kategorie existiert nicht.



Get Listsum

FunktionsnameGet Listsum
BeschreibungDiese Funktion liefert die Summe der Episoden/Kapitel, die der User bisher gesehen hat.
Anfragelinkhttps://proxer.me/api/v1/ucp/listsum
ZugriffslevelLevel 0
EingabeparameterParameter (GET oder POST):
  • kat (optional): Dieser Parameter gibt an, welche Kategorie geladen werden soll. Default Wert "anime". Erlaubte Werte: "anime","manga"
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.
Codes
  • 3004: User nicht eingeloggt.
  • 3005: Kategorie existiert nicht.



Get Topten

FunktionsnameGet Topten
BeschreibungDiese Funktion liefert die Top-Ten des Users. (Anime und Manga)
Anfragelinkhttps://proxer.me/api/v1/ucp/topten
ZugriffslevelLevel 0
EingabeparameterParameter (GET oder POST):
  • Keine
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.
Codes
  • 3004: User nicht eingeloggt.



Get History

FunktionsnameGet History
BeschreibungDiese Funktion liefert die Chronik des Users.
Anfragelinkhttps://proxer.me/api/v1/ucp/history
ZugriffslevelLevel 0
EingabeparameterParameter (GET oder POST):
  • limit (optional): Dieser Parameter gibt an, wie viele Einträge eine Seite der Chronik haben soll. Default Wert 50.
  • p (optional): Dieser Parameter gibt an, welche Seite der Chronik geladen werden soll. Start bei 0, Default Wert 0.
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)
    • eid: Die ID des Entrys
    • name: Der Name des Entrys
    • language: Die Sprache des Entrys
    • medium: Das Medium des Entrys (animeseries,movie,ova,hentai,mangaseries,oneshot,doujin,hmanga)
    • kat: Die Kategorie des Entrys (anime,manga)
    • episode: Die Episoden/Kapitelnummer
    • timestamp: Der Zeitpunkt des Aufrufs (Format: 'YYYY-MM-DD hh:mm:ss')
Codes
  • 3004: User nicht eingeloggt.



Get Votes

FunktionsnameGet Votes
BeschreibungDiese Funktion liefert die Kommentarvotes des Users.
Anfragelinkhttps://proxer.me/api/v1/ucp/votes
ZugriffslevelLevel 0
EingabeparameterParameter (GET oder POST):
  • Keine
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 des Kommentarvotes
    • name: Der Name des gevoteten Entrys
    • uid: Die User-ID des Erstellers des Kommentars
    • username: Der Username des Erstellers des Kommentars
    • kid: Die ID des Kommentars
    • comment: Der Inhalt des Kommentars
    • rating: Die Bewertung des Kommentars
    • type: Der Typ des Votes
Codes
  • 3004: User nicht eingeloggt.



Get Reminder

FunktionsnameGet Reminder
BeschreibungDiese Funktion liefert eine Liste aller Lesezeichen des Users.
Anfragelinkhttps://proxer.me/api/v1/ucp/reminder
ZugriffslevelLevel 0
EingabeparameterParameter (GET oder POST):
  • kat (optional): Dieser Parameter gibt an, welche Kategorie geladen werden soll. Wenn weggelassen werden beide Kategorien geladen. Erlaubte Werte: "anime","manga"
  • p (optional): Die zu ladende Seite, Start bei 0. Default 0
  • limit (optional): Die zu ladenden Einträge pro Seite. Default 100
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)
    • eid: Die ID des Entrys
    • kat: Die Kategorie des Entrys (anime,manga)
    • name: Der Name des Entrys
    • episode: Die Folgen/Kapitelnummer des Lesezeichens
    • language: Die Sprache des Lesezeichens
    • medium: Das Medium des Entrys (animeseries,movie,ova,hentai,mangaseries,oneshot,doujin,hmanga)
    • id: Die ID des Lesezeichens
    • state: Der Status des Entrys
    • available: Gibt an, ob ein Kapitel/Stream für das Lesezeichen existiert. "1" wenn ja, sonst "0"
Codes
  • 3004: User nicht eingeloggt.
  • 3005: Kategorie existiert nicht.



Delete Reminder

FunktionsnameDelete Reminder
BeschreibungDiese Funktion löscht ein Lesezeichen.
Anfragelinkhttps://proxer.me/api/v1/ucp/deletereminder
ZugriffslevelLevel 1
EingabeparameterParameter (POST):
  • id (pflicht): die ID des zu löschenden Lesezeichens (erhältlich über die "Reminder" Funktion)
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
  • 3004: User nicht eingeloggt.
  • 3006: Ungültige ID.



Delete Favorite

FunktionsnameDelete Favorite
BeschreibungDiese Funktion löscht einen Eintrag der Top-ten.
Anfragelinkhttps://proxer.me/api/v1/ucp/deletefavorite
ZugriffslevelLevel 1
EingabeparameterParameter (POST):
  • id (pflicht): die ID des zu löschenden Eintrags (erhältlich über die "Topten" Funktion)
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
  • 3004: User nicht eingeloggt.
  • 3006: Ungültige ID.



Delete Vote

FunktionsnameDelete Vote
BeschreibungDiese Funktion löscht einen Kommentarvote.
Anfragelinkhttps://proxer.me/api/v1/ucp/deletevote
ZugriffslevelLevel 1
EingabeparameterParameter (POST):
  • id (pflicht): die ID des zu löschenden Eintrags (erhältlich über die "Vote" Funktion)
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
  • 3004: User nicht eingeloggt.
  • 3006: Ungültige ID.



Set Comment State

FunktionsnameSet Comment State
BeschreibungDiese Funktion setzt die Zahl der bereits gesehenen/gelesenen Folgen/Kapitel für einen Anime/Manga aus der Liste des Users. Wird dieser Wert auf oder über die Zahl der vorhandenen Folgen/Kapitel gesetzt, so wird zudem der Status des Animes/Mangas auf "Abgeschlossen" gesetzt.
Anfragelinkhttps://proxer.me/api/v1/ucp/setcommentstate
ZugriffslevelLevel 1
EingabeparameterParameter (POST):
  • id (pflicht): die ID des zu bearbeitenden Eintrags (erhältlich über die "List" Funktion)
  • value (pflicht): der zu setzende Wert
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
  • 3004: User nicht eingeloggt.
  • 3006: Ungültige ID.



Set Reminder

FunktionsnameSet Reminder
BeschreibungDiese Funktion setzt eine Episode auf die Watch/Readlist eines eingeloggten Users.
Anfragelinkhttps://proxer.me/api/v1/ucp/setreminder
ZugriffslevelLevel 1
EingabeparameterParameter (GET oder POST):
  • id (pflicht): Die id des Entrys
  • episode (pflicht): Die Episodennummer, auf die das Lesezeichen gesetzt werden soll.
  • language (pflicht): Die zu ladende Sprache. (Für Animes: gersub,gerdub,engsub,engdub; Für Mangas: de,en)
  • kat (pflicht): Die Kategorie des Entrys (manga oder anime)
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
  • 3022: Episode existiert nicht
  • 3004: User ist nicht eingeloggt
  • 3005: Kategorie existiert nicht