From 5409726f678904c8b48b63ccc959d738e041297b Mon Sep 17 00:00:00 2001 From: Levin Faber Date: Wed, 22 May 2019 10:53:54 +0000 Subject: [PATCH] Update _Dokumente/Ausgearbeitete Dokumente/Endpoints.md --- _Dokumente/Ausgearbeitete Dokumente/Endpoints.md | 135 +++++++++++++++++++++++ 1 file changed, 135 insertions(+) create mode 100644 _Dokumente/Ausgearbeitete Dokumente/Endpoints.md diff --git a/_Dokumente/Ausgearbeitete Dokumente/Endpoints.md b/_Dokumente/Ausgearbeitete Dokumente/Endpoints.md new file mode 100644 index 0000000..ef9d281 --- /dev/null +++ b/_Dokumente/Ausgearbeitete Dokumente/Endpoints.md @@ -0,0 +1,135 @@ +# Endpoints + +## Screens +### Login +- POST Login +- Parameter + - Username string + - Password string + + +### Übersichtsseite (Dozent und Verwaltung) +- GET screens +- Liefert alle erlaubten Ansichten für einen User zurück + +### Wochenübersicht (Dozent) +- GET weekly_overview +- Liefert alle Unterrichtseinheiten für die nächsten 7 Tage + +### Kursübericht [besser Kursdetails] (Dozent und Verwaltung) +- GET course_detail + - KursID string +- GET course_contents + - KursID string +- PUT new_course_content +- Inhalt der Letzten UE wird gesetzt + - KursID string + - content string + +### Welcher Lehrer Welcher Kurs (Verwaltung) +- GET course_teacher_match +- Liefert Array + - KursID string + - KursName string + - DozentID string + - DozentName string + +### Welche Schüler Welcher Kurs (Verwaltung) +- GET course_student_match +- Liefert Array + - KursID string + - KursName string + - DozentID string + - DozentName string + +### Lehrerübersicht (Verwaltung) +- GET all_teachers +- Liefert Array + - DozentID string + - DozentName string + +### Schüler von Lehrer (Dozent und Verwaltung) +- GET students_of_teacher +- Parameter DozentID +- Liefert Array + - StundentID string + - StudentName string + +### Raumübersicht (Verwaltung) +- GET rooms +- Liefert Array + - RaumID string + - RaumName string + - Instrumente Array + - InstrumentName string +- GET instruments +- Liefert Array + - InstrumentName string +- PUT create_rooms + - RaumName string + - Instrumente Array + + +### Raumdetails (Verwaltung) +- GET room_free +- Parameter RaumID +- Liefert Frei bool +- GET room_instruments +- Parameter RaumID +- Liefert Array + - InstrumentName string + - Vorhanden bool +- GET lessons +- Parameter + - RaumID string + - Sort // Maybe wenn benötigt +- Liefert Array + - StartZeit DT + + +### Kurs Erstellen [Person + Kurs] +- nutzt GET instruments +- GET create_ +- POST get_capable_teachers +- Parameter + - Typ string + - Instrumente Array +- Liefert Array + - DozentID string + - DozentName string +- POST get_cross_referenced_rooms +- Parameter + - Typ string + - Instrumente Array + - InstrumentName string + - DozentID string +- Liefert Array + - RaumID string + - Zeiten Array + - Zeitfenster number +- POST create_person +- Parameter + - Name string + - Vorname string + - istErmaesigt bool + - Geburtsdatum DT + - Geburtsort string + - PLZ string + - Ort string + - StrasseHNR string + - Bankname string + - BLZ string + - KontoNr string +- POST create_course +- Parameter + // Kursdaten + - Typ string + - Instrumente Array + - Instrument string + - DonzentID string + - Unterrichtseinheiten Array + - Zeit int +- POST enroll_student +- Parameter + - KursID string + - PersonID string