{"openapi":"3.1.0","info":{"title":"Portalverbund - Bereitstelldienst REST-API","description":"Das Portalverbund-Onlinegateway (PVOG) stellt zentral die Verwaltungsleistungen von Bund und Ländern bereit. Die Aufgabe des Bereitstelldienstes ist es, den gesamten, im PVOG gesammelten Datenbestand für Verwaltungsportale und weitere Plattformen bereitzustellen. Die vom Bereitstelldienst bereitgestellte REST-API ermöglicht einen kontinuierlichen Abruf des Gesamtdatenbestands an Verwaltungsleistungen und dessen Aktualisierung.<br/><br/>Weitere Informationen zur Versionierung der Schnittstellen finden Sie in unserem <a target=\"_blank\" href=\"https://anbindung.pvog.cloud-bdc.dataport.de/docs/bereitstelldienst/doku#versionierung-der-schnittstelle\">Produktportal</a>.","contact":{"name":"FITKO","url":"https://www.fitko.de/"},"license":{"name":"Creative Commons Attribution Share Alike 4.0 (CC BY-SA 4.0)","url":"https://creativecommons.org/licenses/by-sa/4.0/"},"version":"6.17.5"},"servers":[{"url":"https://stage.pvog.fitko.net/bereitstelldienst/api","description":"Generated server url"}],"security":[{"OAUTH2":[]}],"paths":{"/v2/verwaltungsobjekte":{"get":{"tags":["konsumentenschnittstelle-controller"],"summary":"Abruf des Gesamtdatenbestandes an Verwaltungsobjekten.","description":"Ü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. Erlaubte Werte sind (Stand 2025) '2.2.0' und '2.3.1'. Falls dieser Parameter im Accept-Header nicht angegeben wird, wird '2.2.0' angenommen. Wenn die Auslieferungsversion der Daten von der Version abweicht, in der die Daten an das PVOG geliefert wurden, werden die ausgelieferten Daten entsprechend konvertiert.","operationId":"getDatenAlsXZuFiV2","parameters":[{"name":"index","in":"query","description":"Ein Update-Index über alle Verwaltungsobjekte. Bei einer initialen Abfrage muss dieser auf `0` gesetzt sein. Als Teil der Antwort bekommt man den nächsten Wert mitgeteilt, um die nächsten Daten abzurufen.","required":true,"schema":{"type":"integer","format":"int64","minimum":0},"example":0},{"name":"ars","in":"query","description":"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.","required":true,"schema":{"type":"string","pattern":"((\\d{0,11}%)|(\\d{12}))(,((\\d{0,11}%)|(\\d{12})))*+"},"example":"02%"}],"responses":{"200":{"description":"Die Anfrage wurde erfolgreich verarbeitet.","content":{"application/json;xzufi-version=2.2.0":{"schema":{"$ref":"#/components/schemas/AntwortTransfernachricht"}},"application/json;xzufi-version=2.3.1":{"schema":{"$ref":"#/components/schemas/AntwortTransfernachricht"}}}},"400":{"description":"Die Anfrage ist nicht korrekt formuliert."},"401":{"description":"Die Anfrage ist nicht autorisiert."},"403":{"description":"Die Anfrage hat nicht die notwendige Berechtigung."},"500":{"description":"Ein interner Server-Fehler ist aufgetreten."}}}}},"components":{"schemas":{"AntwortTransfernachricht":{"type":"object","properties":{"anzahlObjekte":{"type":"integer","format":"int32","description":"Anzahl der Objekte innerhalb der Antwort. Diese Anzahl wird vom Server berechnet für eine performante Auslieferung. Um alle Objekte zu erhalten, müssen gegebenenfalls mehrere Anfragen gestellt werden. Die nächste Anfrage muss dann den Update-Index der letzten Antwort verwenden.","example":10},"naechsterIndex":{"type":"integer","format":"int64","description":"Der für die nächste Anfrage benötigte Update-Index, um weitere Antwortobjekte zu erhalten.","example":12345},"naechsteAnfrageUrl":{"type":"string","format":"url","description":"Vorgefertigte URL der nächsten Anfrage.","example":"https://.../bereitstelldienst/api/v1/verwaltungsobjekte?ars=02%25&index=12345"},"vollstaendig":{"type":"boolean","description":"Boolean der anzeigt, ob alle Daten für den aktuellen Datenabruf übermittelt wurden (true) oder ob noch Updates vorhanden sind (false).","example":true},"xzufiObjekte":{"type":"string","description":"Die angeforderten Objekte im XZuFi-Format.","example":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><xzufi:transfer.operation.040502 produktbezeichnung=\"PVOG\" produkthersteller=\"Dataport AöR\" xmlns:xzufi=\"http://xoev.de/schemata/xzufi/2_2_0\" xzufiVersion=\"2.2.0\">...</xzufi:transfer.operation.040502>"}}}},"parameters":{"Version":{"name":"Version","in":"header","required":false,"schema":{"type":"string"}}},"securitySchemes":{"OAUTH2":{"type":"oauth2","description":"Oauth2 flow","flows":{"authorizationCode":{"authorizationUrl":"https://stage.pvog.fitko.net/auth/realms/pvog/protocol/openid-connect/auth","tokenUrl":"https://stage.pvog.fitko.net/auth/realms/pvog/protocol/openid-connect/token","scopes":{}}}}}}}