PVOG – ein Produkt der Fitko
EntwicklungsressourcenFöderale IT-StandardsQuellcode
Zum Hauptinhalt springen

Abruf des Gesamtdatenbestandes an Verwaltungsobjekten.

GET 
/v2/verwaltungsobjekte
deprecated

Dieser Endpunkt ist veraltet und wird möglicherweise in zukünftigen Versionen der API ersetzt oder entfernt.

Überträgt Leistungen, Leistungsspezialisierungen, Organisationseinheiten, Onlinedienste, Formulare und Zuständigkeiten als XZuFi Transfernachrichten. Mehrere Anfragen unter Verwendung des Update-Index können nötig sein, um alle Daten abzurufen. Der Umfang der abzufragenden Leistungsdaten kann durch Angabe von Amtlichen Regionalschlüsseln auf bestimmte Regionen eingeschränkt werden. Mit der Einführung des XZuFi-Standards in Version 2.3.1 erwartet der Bereitstelldienst im Accept-Header den zusätzlichen Parameter 'xzufi-version', der die XZuFi-Version festlegt, in der die Daten ausgeliefert werden. Im Mai 2026 (Release PVOG 9.17) wurde die Unterstützung von XZuFi '2.2.0' gestrichen, womit der einzige erlaubte Wert jetzt '2.3.1' ist. Entfallen ist damit auch die Möglichkeit, diesen Parameter im Accept-Header nicht anzugeben, wodurch vorher die Auslieferungsversion auf Version '2.2.0' gesetzt wurde. Wenn die Auslieferungsversion der Daten von der Version abweicht, in der die Daten an das PVOG geliefert wurden, werden die ausgelieferten Daten entsprechend konvertiert.swagger.v2.verwaltungsobjekte.param.ars=Eine komma-separierte Liste an amtlichen Regionalschlüssel (ARS) oder ARS-Mustern. Ein amtlicher Regionalschlüssel ist eine 12-stellige Ziffernfolge. Ein ARS-Muster ist ein ARS-Schlüssel, bei dem ein Teil des Schlüssels von rechts an durch % ersetzt wurde. Mithilfe dieses Parameters kann die Abfrage auf bestimmte geografische Bereiche eingeschränkt werden. Für einen Abruf des Gesamtdatenbestandes muss dieser Parameter den Wert % haben. Wichtig: Beim Abruf eines Datenbestandes und späterer Aktualisierungen muss der ars-Parameter bei jeder Anfrage den gleichen Wert haben, damit die gelieferten Daten referenzkonsistent sind.

Request​

Responses​

Die Anfrage wurde erfolgreich verarbeitet.