Externe Lehrgangsanmeldung

Wichtiger Hinweis:

Die Nutzung der REST-API kann an einen Vertrag oder eine einmalige oder fortlaufende Lizenzgebühr gebunden sein.

Hinweis:

Ihren persönlichen API-Token können Sie beim Dräger Service beantragen.

Geben Sie niemals Ihren API-Token an Dritte weiter.

Ablauf für externe Teilnehmende (REST API)

In der Regel erfolgt die Anmeldung externer Teilnehmender über Anwender von Drägerware.ZMS auf Landkreisebene. Diese Anwender sind anschließend für den gesamten Workflow in der Lehrgangsverwaltung mit der Landesebene zuständig. Damit Teilnehmende auf Landesebene sichtbar werden, muss der Status auf Angemeldet (Land) gesetzt werden.

Über die REST API kann dieser Workflow jedoch nicht beibehalten werden. Daher erhalten alle Teilnehmenden, die über die REST API erstellt werden, automatisch den Status Angemeldet (Land). In diesem Zustand lassen sie sich auf Landkreisebene nicht mehr löschen.

Ab diesem Zeitpunkt werden externe Teilnehmende auf Landesebene behandelt wie alle anderen Lehrgangsteilnehmenden. Über die Schnittstelle können Sie jederzeit die Daten und den Status dieser externen Teilnehmenden abrufen.

REST Endpunkte

Lehrgänge

Methode	Pfad	Beschreibung
GET	/lehrgaenge/	Liste aller Lehrgänge für die Organisation/Token
GET	/lehrgaenge/{id}/	Details zu einem Lehrgang

Teilnehmer

Methode	Pfad	Beschreibung
GET	/lehrgaenge/{id}/teilnehmer-extern/	Liste aller externen Teilnehmer eines Lehrgangs
POST	/lehrgaenge/{id}/teilnehmer-extern/	Externen Teilnehmer hinzufügen
GET	/lehrgaenge/{id}/teilnehmer-extern/{teilnehmerId}/	Einzelnen externen Teilnehmer abrufen
PATCH	/lehrgaenge/{id}/teilnehmer-extern/{teilnehmerId}/	Externen Teilnehmer aktualisieren
DELETE	/lehrgaenge/{id}/teilnehmer-extern/{teilnehmerId}/	Externen Teilnehmer löschen

Stammdaten

Methode	Pfad	Beschreibung
GET	/anreden	Alle verfügbaren Anreden
GET	/titel	Alle verfügbaren Titel
GET	/dienststellungen	Alle verfügbaren Dienststellungen
GET	/dienstgrade	Alle verfügbaren Dienstgrade
GET	/bundeslaender	Alle verfügbaren Bundesländer
GET	/landkreise	Alle verfügbaren Landkreise

API-Schnittstelle auslösen

Nachfolgend wird Ihnen erklärt, wie Sie die Lehrgangs-API-Schnittstelle ansprechen.

Hinweis:

Bei Verwendung der Drägerware.ZMS Anwendung mit einem SSL-Client-Zertifikat wird dieses eventuell für die Nutzung der Schnittstelle benötigt.

Schritt-für-Schritt Anleitung

Die REST-API kann über verschiedene Software-Tools angesprochen werden. Im folgenden Beispiel wird das kostenlose Tool Postman verwendet:

1. Laden und installieren Sie Postman: Download Postman
2. Erstellen Sie in Postman einen neue Collection
3. Erstellen Sie eine Anfrage Ihrer Wahl:
   • GET
   • PATCH
   • POST
4. Geben Sie die folgende REST-API-URL ein:

<Ihre ZMS-Instanz URL> + <Pfad aus den Endpunkten>

5. Öffnen Sie im Request den Bereich Body, stellen Sie das Format auf RAW und wählen Sie JSON aus
6. Fügen Sie den folgenden Beispielcode ein.
7. Tragen Sie unter Auth Ihren Authentifizierungs-Token ein.

Lehrgang-JSON

{
  "id": "string",
  "typ": "KREIS | LAND | WFV | OTHER",
  "bezeichnung": "string (max 80)",
  "kurzbezeichnung": "string (max 25)",
  "startzeit": "HH:mm",
  "ort": "string",
  "startTag": "YYYY-MM-DD",
  "endTag": "YYYY-MM-DD",
  "hinweis": "string",
  "anmeldeschluss": "YYYY-MM-DD",
  "maxAnzahlTeilnehmer": 12,
  "isLehrgangLocked": true,
  "lehrgangstage": [LehrgangTag]
}

LehrgangTeilnehmerExtern-JSON

{
  "id": "string (readonly)",
  "organisation": "string (max 80)",
  "artOrganisation": "string (max 100)",
  "gemeinde": "string (max 80)",
  "ortsteil": "string (max 80)",
  "geschlecht": "MALE | FEMALE | OTHER",
  "nachname": "string (max 50)",
  "vorname": "string (max 50)",
  "geburtsdatum": "YYYY-MM-DD",
  "anrede": "string/null",
  "titel": "string/null",
  "dienststellung": "string/null",
  "dienstgrad": "string/null",
  "landkreis": "string/null",
  "bundesland": "string/null",
  "isPlausibilitaetErfuellt": true,
  "isUebernachtungRequired": false,
  "geburtsort": "string",
  "geburtsname": "string",
  "beruf": "string",
  "emails": {
    "privateEmail": "string",
    "businessEmail": "string"
  },
  "phoneNumbers": {
    "privatePhone": "string",
    "businessPhone": "string",
    "privateMobile": "string",
    "businessMobile": "string"
  },
  "adresse": {
    "strasse": "string",
    "hausnummer": "string",
    "plz": "string",
    "ort": "string",
    "ortsteil": "string"
  },
  "rechnungsAdresse": {
    "recipient": "string",
    "strasse": "string",
    "hausnummer": "string",
    "plz": "string",
    "ort": "string",
    "ortsteil": "string"
  },
  "bankverbindung": {
    "iban": "string",
    "bic": "string"
  },
  "status": "string (readonly, z.B. 'Angemeldet (Land)')"
}

Lehrgangstag-JSON

{
  "datum": "YYYY-MM-DD",
  "isAktiv": true
}

Fehlerbehandlung

Fehlerantworten werden als RFC 7807 Problem JSON geliefert.

Status	Bedeutung
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
423	Locked
500	Internal Server Error
503	Service Unavailable