Server-API

Moderatoren: Raffenberg, A. Schüller, Pfotenhauer

Antworten
Benutzeravatar
wschrewe
Fachberater*in
Beiträge: 1698
Registriert: Dienstag 25. September 2018, 17:36
Schulform: BK (Pensionär)
Kontaktdaten:

Server-API

Beitrag von wschrewe »

In der Dokumentation des SVWS-Servers heißt es "...Ebenso können weitere GUIs auf die API des SVWS-Servers zugreifen.". Das möchte ich gerne nutzen (bzw. nutze es schon, so weit es geht). Was im Moment (aus meiner Sicht) fehlt, ist
  • eine Funktion, die zu einem Anmeldenamen die zugehörigen Berechtigungen liefert.
  • /db/{schema}/klassen/abschnitt/{abschnitt} erwartet als Parameter eine Abschnitts-ID. Leider gibt es keine Funktionalität, um eine Liste der Schuljahresabschnitte zu erhalten, wenigstens habe ich in der Swagger-UI nichts gefunden. Zudem wäre es IMHO einfacher, wenn statt einer ID der gewünschte Abschnitt in geeigneter Form (z.B. 20202,20231...) übergeben werden könnte. Gleiches gilt auch für /db/{schema}/kurse/abschnitt/{abschnitt}
Falls es die angesprochenen Features bereits gibt, bitte ich um einen Hinweis, wo ich sie finden kann.

Sollte hier nicht der richtige Ort für derartige Wünsche bzw. Vorschläge sein, bitte ich um Nachsicht und einen Hinweis, wo so etwas hinterlegt werden soll bzw. kann.
Mit freundlichen Grüßen
Walter Schrewe
"If all else fails, read the instructions" (Donald E. Knuth, letzter TeX - Hilfehinweis)
Benutzeravatar
Raffenberg
Beiträge: 2230
Registriert: Dienstag 25. September 2018, 15:22
Schulform: Gymnasium
Kontaktdaten:

Re: Server-API

Beitrag von Raffenberg »

Hallo Herr Schrewe,
das ist genau der richtige Ort für Wünsche und Vorschläge.

zu Punkt 1: Ich meine, dass Herr Richter das aber schon nutzt. Insofern sollte es da eine Schnittstelle geben. Zumindest finden sich in der SwaggerUI einige Schnittstellen zum Thema Benutzer und Benutzergruppen.
Mit freundlichen Grüßen
Jens Raffenberg
Benutzeravatar
Pfotenhauer
Beiträge: 3081
Registriert: Dienstag 25. September 2018, 12:53
Wohnort: Wuppertal
Schulform: Realschule
Motto: Wer schnell hilft, hilft doppelt!
Kontaktdaten:

Re: Server-API

Beitrag von Pfotenhauer »

Hallo Walter.

/db/{schema}/schule/stammdaten
liefert alle Daten zur Schule mit bestehenden Abschnitten und deren IDs.

/db/{schema}/benutzer/{id}
Liefert zu der ID des Benutzers die zugehörigen Daten.

Das Rechtekonzept ist in der API noch nicht vollständig umgesetzt.
Es wird aber später so sein, dass User über die API gar keine Daten bekommen, die sie nicht sehen dürfen.
Bei funktionsbezogenen Rechten ist das noch nicht überall der Fall.
Mit freundlichen Grüßen
Frank Pfotenhauer
---
Fachberater für die Schulverwaltungssoftware des MSB
Referat 135

E-Mail: frank.pfotenhauer@msb.nrw.de
Benutzeravatar
wschrewe
Fachberater*in
Beiträge: 1698
Registriert: Dienstag 25. September 2018, 17:36
Schulform: BK (Pensionär)
Kontaktdaten:

Re: Server-API

Beitrag von wschrewe »

Danke für die Hinweise. Das hilft mir weiter.

Die Abschnitts-ID und die Kompetenzen (und ein paar andere Dinge) habe ich bisher durch SQL-Abfragen direkt aus der DB bezogen, aber das ist ja offenbar demnächst nicht mehr erwünscht.

Darauf, dass die Schuljahresabschnitte ein Teil der Stammdaten der Schule sind, muss man auch erstmal kommen ;)
Es wird aber später so sein, dass User über die API gar keine Daten bekommen, die sie nicht sehen dürfen.
Wie weist dann ein externes Programm nach, dass es über die notwendigen Berechtigungen verfügt?
Mit freundlichen Grüßen
Walter Schrewe
"If all else fails, read the instructions" (Donald E. Knuth, letzter TeX - Hilfehinweis)
Benutzeravatar
Pfotenhauer
Beiträge: 3081
Registriert: Dienstag 25. September 2018, 12:53
Wohnort: Wuppertal
Schulform: Realschule
Motto: Wer schnell hilft, hilft doppelt!
Kontaktdaten:

Re: Server-API

Beitrag von Pfotenhauer »

Die API-Calls werden ja mit Benutzername und Passwort abgerufen.
Zum Benutzer sind die Berechtigungen in der Datenbank hinterlegt.
Mit freundlichen Grüßen
Frank Pfotenhauer
---
Fachberater für die Schulverwaltungssoftware des MSB
Referat 135

E-Mail: frank.pfotenhauer@msb.nrw.de
Benutzeravatar
wschrewe
Fachberater*in
Beiträge: 1698
Registriert: Dienstag 25. September 2018, 17:36
Schulform: BK (Pensionär)
Kontaktdaten:

Re: Server-API

Beitrag von wschrewe »

Mit '/db/{schema}/schule/logo' kann das Schullogo ausgelesen werden. Als REST-Content wird ein String zurückgegeben. (z.B. "/9j/4AAQSkZJRgABAQEASABIAAD/2wBD...) Um was für ein Grafikformat handelt es sich hier, bzw. wie kann dieser String in ein übliches Grafikformat umgewandelt werden?

Edit: Ich habe es schon gefunden.
Mit freundlichen Grüßen
Walter Schrewe
"If all else fails, read the instructions" (Donald E. Knuth, letzter TeX - Hilfehinweis)
Antworten

Zurück zu „SVWS-Server (BETA)“