IF_045 – Leistungsdaten erfassen

Über diese, vom Suchdienst bereitgestellte Schnittstelle kann der Datenbestand des Suchdiensts durch andere Komponenten des Online-Gateways aktualisiert werden.

Endpunkte

Die Datenänderungen werden über eine REST API übertragen.

HTTP Methode	URL	Beschreibung
POST	/push/xzufi-22/enqueue	Reiht die übergebenen XZuFi-Rohdaten in die Import-Queue ein.

Authentifizierung

Der Zugriff auf diese Schnittstelle ist nur für berechtigte Nutzer möglich. Aktuell ist nur der Sammlerdienst berechtigt. Die Berechtigungsprüfung durch den Suchdienst erfolgt auf Basis eines OpenID Connect Access Tokens, das Sammlerdienst beim Aufruf der Schnittstelle mitliefern muss. Detaillierte Informationen bzgl. des Anmeldeverfahrens können dem Dokument „PVOGBerechtigungsmanagementkonzept“ (öffnet in neuem Tab, Download) entnommen werden.

Nutzungsfrequenz

Diese Schnittstelle wird regelmäßig genutzt. Aktuell ist eine tägliche Aktualisierung des Datenbestands geplant. Werden Notfall-Updates für die Änderung von falschen Online-Dienst-URLs durchgeführt, dann werden diese Änderungen ebenfalls über diese Schnittstelle übertragen. Notfall-Updates werden eher selten erwartet und sind bei der Betrachtung der Nutzungsfrequenz zu vernachlässigen.

Verschlüsselung der Übertragungswege

Der Zugriff auf die Schnittstelle muss über eine verschlüsselte Verbindung erfolgen, um ausschließen zu können, dass die Daten während der Übertragung manipuliert werden können. Die Verschlüsselung der Übertragungswege erfolgt auf Basis von TLS (mindestens Version 1.2).

Nachrichtenformat Abfrage

Die Übertragung der Datenänderungen am Gesamtdatenbestand erfolgt durch direkte Weitergabe vom Sammlerdienst an Bereitstelldienst und Suchdienst. Die Daten werden als XZuFi 2.2 Transfernachricht im Body der HTTP-Anfrage übergeben werden.

Als Transfernachricht wird ein XZuFi transfer.operation.040502 Objekt verwendet, welches wiederum Leistungen, Leistungsspezialisierungen, Organisationseinheiten, Onlinedienste sowie Zuständigkeiten von Organisationseinheiten und Onlinediensten enthält. Eine Transfernachricht kann eine variable Anzahl dieser Verwaltungsobjekte enthalten, aber eine Nachricht kann nur Verwaltungsobjekte enthalten, die keine Referenz auf andere Verwaltungsobjekte enthalten oder Verwaltungsobjekte referenzieren, die in der gleichen Nachricht enthalten sind oder in einer vorherigen Nachricht übertragen wurden. Im XZuFi wird für jedes Verwaltungsobjekt spezifiziert, ob es sich um eine CREATEUPDATE oder DELETE Operation handelt.

Rückgabecodes

Der REST-Endpunkt für das Erfassen von Leistungen antwortet mit den folgenden HTTPStatuscodes auf eingehende Anfragen:

HTTP Statuscode	Bedeutung
200	Daten erfolgreich empfangen.
400	Fehler in der Anfrage.
401	Autorisierung gegenüber Keycloak fehlt.
403	Berechtigung für den Zugriff auf den Endpunkt fehlt.
500	Interner Fehler bei der Verarbeitung der Anfrage.