Grundlagen und Definitionen zur Schnittstelle finden Sie hier.
Schnittstelle im Web-Frontend einrichten
Im linken Auswahlmenü auf „Stammdaten“ klicken.
Im Tab „Schnittstellen“ können neue Schnittstellen angelegt und vorhandene bearbeitet werden. Um eine vorhandene Schnittstelle zu bearbeiten, klicken Sie in der entsprechenden Zeile auf das Bleistiftsymbol, eine neue Schnittstelle definieren Sie über den Button „Schnittstelle erstellen“.
In dem Popup vergeben Sie nun eine eindeutige alphanumerische ID, die Sie ebenfalls in allen Kursen als externes System eintragen, die über diese Schnittstelle verwaltet werden sollen.
Als letzten Eintrag wird der https-Endpunkt angezeigt, den Sie verwenden können um die Webservice Endpunkte zu erreichen. Die Struktur sowie die vorhandenen Endpunkte finden Sie in unserem OpenApi 3.0 Exchange-JSON.
API-Requests
Abruf (GET)
Anwesenheiten abrufen:
/api/exchange/{traegerId}/{systemId}/kurse/{kursId}/anwesenheiten/{tag}
Daten aller Kurse abrufen:
/api/exchange/{traegerId}/{systemId}/kurse/
Teilnehmerdaten je Kurs abrufen:
/api/exchange/{traegerId}/{systemId}/kurse/{kursId}/teilnehmer
Einspielen (PUT)
Daten aller Kurse einspielen:
/api/exchange/{traegerId}/{systemId}/kurse/
Teilnehmerdaten je Kurs einspielen:
/api/exchange/{traegerId}/{systemId}/kurse/{kursId}/teilnehmer
Beispiele
JSON-FLAT Kursdaten
[ { „kursnummer“: „BF1“, „externesSystem“: „TEST1“, „bezeichnung“: „Deutsch für Erzieher/innen“, „kursStatus“: „RUNNING“, „kursBeginn“: „2022-10-05“, „kursEnde“: „2023-04-23“, „schulungsstaette“: { „bezeichnung“: „Ausbildungszentrum Süd“, „strasse“: „Hauptstraße“, „hausnummer“: „12“, „adresszusatz“: „Geb. 22c, Raum 7“, „land“: „DE“, „plz“: „12345“, „ort“: „Musterstadt“, „externeId“: „AS1“}, „lehrkraefte“: [], „praesenzUnterricht“: [], „onlineUnterricht“: []}, { „kursnummer“: „BF2“, „externesSystem“: „TEST1“, „bezeichnung“: „Erfolgreich im Einzelhandel, Deutsch B2“, „kursStatus“: „DONE“, „kursBeginn“: „2022-11-25“, „kursEnde“: „2023-05-23“, „schulungsstaette“: { „bezeichnung“: „Ausbildungszentrum Süd“, „strasse“: „Hauptstraße“, „hausnummer“: „12“, „adresszusatz“: „Geb. 22c, Raum 7“, „land“: „DE“, „plz“: „12345“, „ort“: „Musterstadt“, „externeId“: „AS1}, „lehrkraefte“: [], „praesenzUnterricht“: [], „onlineUnterricht“: []}, { „kursnummer“: „BF3“, „externesSystem“: „TEST1“, „bezeichnung“: „Deutsch für Pflegekräfte“, „kursStatus“: „RUNNING“, „zusatz“:“Fortgeschrittenenkurs“, „kursBeginn“: „2023-02-05“, „kursEnde“: „2023-04-23“, „schulungsstaette“: { „bezeichnung“: „Ausbildungszentrum Süd“, „strasse“: „Hauptstraße“, „hausnummer“: „12“, „adresszusatz“: „Geb. 22c, Raum 7“, „land“: „DE“, „plz“: „12345“, „ort“: „Musterstadt“, „externeId“: „AS1“, „externesSystem“: null }, „lehrkraefte“: [], „praesenzUnterricht“: [], „onlineUnterricht“: []} ]
CSV_EASY Teilnehmerliste
Externe ID;Name;Email;Status;Anmeldedatum;Public Key PK3322;Teilnehmer Eins;;REGISTERED;2022-10-23; B112233;Hermann Lern;; REGISTERED;2022-10-24; M334455;Sophia Fleiss;; REGISTERED;2022-10-26; M334466;-;;NONE;2022-10-25; M334477;-;;NONE;2022-10-25; M334488;-;;CANCELED;2022-10-25;