Skip to content

Was ist JSON RPC?

Dev Kev edited this page Jan 14, 2022 · 1 revision

Eine offizielle und ausführliche Dokumentation zu JSON RPC 2.0 befindet sich hier

Basics

Ich schreibe hier trotzdem nochmal kurz die wichtigsten Punkte für eine Abfrage auf:

Format einer Server Anfrage

  • JSON Format -> Erklärung
  • es MUSS die Variable jsonrpc": 2.0 gesendet werden
  • Das Feld "method" beschreibt den Methodennamen der Daten die vom Server geliefert werden sollen z.B. "timetable"
  • "params" beschreibt die Parameter die zusätzlich zur Methode gesendet werden sollen
  • Es MUSS das Feld "id" existieren. Das kann z.B. der Name der App sein.

Beispiel einer einfachen Anfrage:

{
  "jsonrpc": "2.0", 
  "method": "login", 
  "params": {
    "username": "Benutzername",
    "passwort": "Passwort"
  }, 
  "id": "tolleApp!"
}

So könnte eine Login Methode aussehen. Was der Server zurückliefern könnte ist in "Format einer Server Antwort" beschrieben.

Format einer Server Antwort

Eine Antwort kommt auch im JSON Format. Dabei sind standartmäßig folgende Werte enthalten:

  • Das Feld jsonrpc": 2.0
  • Die id die in der Anfrage mitgeschickt wurde. Im Beispiel "id": "tolleApp!"
  • Die eigentlichen Daten die man auslesen möchte besitzten keinen standartisierten namen. Die Feldnamen und das Datenformat können sich je nach methodennamen ändern.

Beispiel einer Serverantwort:

{
  "jsonrpc": "2.0", 
  "errorMessage": "Benutzername oder Passwort falsch!", 
  "id": 1
}

Wie JSONRPC konkret in der App benutzt wird und welche Methoden es gibt, erfährst du hier

Handbuch

  • Installation
  • Login
  • Stundenplan
  • Phasierung Laden
  • Fehlercodes
  • Für Lehrer
    • Phasierung bereitstellen

API

Backend

Mitwirken

  • Fehler melden
Clone this wiki locally