{"openapi":"3.1.0","info":{"title":"Data Hub API","version":"1.0"},"servers":[{"url":"https://api.ozg-umsetzung.de/api"}],"paths":{"/public/v1/dash/open-pvog":{"get":{"tags":["Dashboard"],"summary":"Informationen zu OZG-Leistungen und deren zugehörigen Onlinediensten","description":"Liefert Informationen zu OZG-Leistungen und deren zugehörigen Onlinediensten.","operationId":"findAll","parameters":[{"name":"order","in":"query","description":"Gibt an, wie die Ergebnismenge sortiert werden soll.","required":false,"schema":{"type":"string","default":"asc","description":"Gibt an, wie die Ergebnismenge sortiert werden soll.","enum":["asc","desc"],"example":"asc"},"example":"asc"},{"name":"page","in":"query","description":"Gibt an, welche Seite der Ergebnismenge zurückgegeben werden soll. Die erste Seite entspricht dem Wert 0.","required":false,"schema":{"type":"integer","format":"int32","default":0,"description":"Gibt an, welche Seite der Ergebnismenge zurückgegeben werden soll. Die erste Seite entspricht dem Wert 0.","example":0},"example":0},{"name":"size","in":"query","description":"Gibt an, wie groß die Ergebnismenge für die abgefragte Seite maximal sein darf.","required":false,"schema":{"type":"integer","format":"int32","default":100,"description":"Gibt an, wie groß die Ergebnismenge für die abgefragte Seite maximal sein darf.","example":100},"example":100}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelOpenPvogDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelOpenPvogDto"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelOpenPvogDto"}}}}}}},"/public/v1/dash/open-pvog/{ars}":{"get":{"tags":["Dashboard"],"summary":"Informationen zu OZG-Leistungen und deren zugehörigen Onlinediensten eingeschränkt auf Gebietskörperschaften","description":"Liefert Informationen zu OZG-Leistungen und deren zugehörigen Onlinediensten eingeschränkt auf Gebietskörperschaften.","operationId":"findByFilter","parameters":[{"name":"ars","in":"path","description":"Gibt den 12-stelligen amtlichen Regionalschlüssel einer Gebietskörperschaft an.","required":true,"schema":{"type":"string","description":"Gibt den 12-stelligen amtlichen Regionalschlüssel einer Gebietskörperschaft an.","example":"010510000000","pattern":"^\\d{12}$"},"example":"010510000000"},{"name":"order","in":"query","description":"Gibt an, wie die Ergebnismenge sortiert werden soll.","required":false,"schema":{"type":"string","default":"asc","description":"Gibt an, wie die Ergebnismenge sortiert werden soll.","enum":["asc","desc"],"example":"asc"},"example":"asc"},{"name":"page","in":"query","description":"Gibt an, welche Seite der Ergebnismenge zurückgegeben werden soll. Die erste Seite entspricht dem Wert 0.","required":false,"schema":{"type":"integer","format":"int32","default":0,"description":"Gibt an, welche Seite der Ergebnismenge zurückgegeben werden soll. Die erste Seite entspricht dem Wert 0.","example":0},"example":0},{"name":"size","in":"query","description":"Gibt an, wie groß die Ergebnismenge für die abgefragte Seite maximal sein darf.","required":false,"schema":{"type":"integer","format":"int32","default":100,"description":"Gibt an, wie groß die Ergebnismenge für die abgefragte Seite maximal sein darf.","example":100},"example":100},{"name":"includeAbove","in":"query","description":"Gibt an, ob OZG-Leistungen auf darüberliegenden Gebietskörperschaften mit in der Ergebnismenge enthalten sein sollen.","required":false,"schema":{"type":"boolean","default":true,"description":"Gibt an, ob OZG-Leistungen auf darüberliegenden Gebietskörperschaften mit in der Ergebnismenge enthalten sein sollen.","enum":[true,false],"example":true},"example":true},{"name":"includeBelow","in":"query","description":"Gibt an, ob OZG-Leistungen auf darunterliegenden Gebietskörperschaften mit in der Ergebnismenge enthalten sein sollen.","required":false,"schema":{"type":"boolean","default":true,"description":"Gibt an, ob OZG-Leistungen auf darunterliegenden Gebietskörperschaften mit in der Ergebnismenge enthalten sein sollen.","enum":[true,false],"example":true},"example":true}],"responses":{"200":{"description":"Ok","content":{"application/json":{}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelOpenPvogDto"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelOpenPvogDto"}}}}}}},"/public/v1/dash/open-pvog/{ars}/export":{"get":{"tags":["Dashboard"],"summary":"Export von OZG-Leistungen und deren zugehörigen Onlinediensten eingeschränkt auf Gebietskörperschaften","description":"Liefert den vollständigen Export als CSV oder XLSX. Der Export wird serverseitig gestreamt.","operationId":"exportByFilter","parameters":[{"name":"ars","in":"path","description":"Gibt den 12-stelligen amtlichen Regionalschlüssel einer Gebietskörperschaft an.","required":true,"schema":{"type":"string","description":"Gibt den 12-stelligen amtlichen Regionalschlüssel einer Gebietskörperschaft an.","example":"010510000000","pattern":"^\\d{12}$"},"example":"010510000000"},{"name":"filetype","in":"query","description":"Gibt an, in welchem Dateiformat (CSV, XLSX) die Ergebnismenge zurückgegeben werden soll.","required":false,"schema":{"type":"string","default":"csv","description":"Gibt an, in welchem Dateiformat (CSV, XLSX) die Ergebnismenge zurückgegeben werden soll.","enum":["csv","xlsx"],"example":"csv","pattern":"csv|xlsx"},"example":"csv"},{"name":"includeAbove","in":"query","description":"Gibt an, ob OZG-Leistungen auf darüberliegenden Gebietskörperschaften mit in der Ergebnismenge enthalten sein sollen.","required":false,"schema":{"type":"boolean","default":true,"description":"Gibt an, ob OZG-Leistungen auf darüberliegenden Gebietskörperschaften mit in der Ergebnismenge enthalten sein sollen.","enum":[true,false],"example":true},"example":true},{"name":"includeBelow","in":"query","description":"Gibt an, ob OZG-Leistungen auf darunterliegenden Gebietskörperschaften mit in der Ergebnismenge enthalten sein sollen.","required":false,"schema":{"type":"boolean","default":true,"description":"Gibt an, ob OZG-Leistungen auf darunterliegenden Gebietskörperschaften mit in der Ergebnismenge enthalten sein sollen.","enum":[true,false],"example":true},"example":true}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{}}},"400":{"description":"Bad Request","content":{"application/json":{}}},"413":{"description":"Payload Too Large","content":{"application/json":{}}},"500":{"description":"Internal Server Error","content":{"application/json":{}}}}}},"/public/v1/dash/open-ars":{"get":{"tags":["Dashboard"],"summary":"Informationen zu Gebietskörperschaften in Deutschland","description":"Liefert amtliche Regionalschlüssel und Bezeichnungen zu allen Gebietskörperschaften innerhalb Deutschlands.","operationId":"findAll_1","parameters":[{"name":"order","in":"query","description":"Gibt an, wie die Ergebnismenge sortiert werden soll.","required":false,"schema":{"type":"string","default":"asc","description":"Gibt an, wie die Ergebnismenge sortiert werden soll.","enum":["asc","desc"],"example":"asc"},"example":"asc"},{"name":"page","in":"query","description":"Gibt an, welche Seite der Ergebnismenge zurückgegeben werden soll. Die erste Seite entspricht dem Wert 0.","required":false,"schema":{"type":"integer","format":"int32","default":0,"description":"Gibt an, welche Seite der Ergebnismenge zurückgegeben werden soll. Die erste Seite entspricht dem Wert 0.","example":0},"example":0},{"name":"size","in":"query","description":"Gibt an, wie groß die Ergebnismenge für die abgefragte Seite maximal sein darf.","required":false,"schema":{"type":"integer","format":"int32","default":100,"description":"Gibt an, wie groß die Ergebnismenge für die abgefragte Seite maximal sein darf.","example":100},"example":100}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelOpenArsDto"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelOpenArsDto"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelOpenArsDto"}}}}}}}},"components":{"schemas":{"OpenPvogDto":{"type":"object","properties":{"leika_key":{"type":"string","description":"LeiKa Schlüssel","example":"99041006017000"},"leika_name":{"type":"string","description":"LeiKa-Name","example":"Hundehaltung anmelden"},"ars":{"type":"string","description":"12-stelliger amtlicher Regionalschlüssel einer Gebietskörperschaft","example":"010510000000"},"ars_name":{"type":["string","null"],"description":"Bezeichnung der Gebietskörperschaft","example":"Dithmarschen"},"ars_federal_state":{"type":["string","null"],"description":"2-stelliger Bundeslandcode","example":"01"},"bundesland":{"type":["string","null"],"description":"Bundesland","example":"Schleswig-Holstein"},"leika_bezeichnung":{"type":["string","null"],"description":"LeiKa-Bezeichnung","example":"Hundesteuer Anmeldung"},"ozgid":{"type":["integer","null"],"format":"int32","description":"ID der OZG-Leistung","example":10000},"ozg_bezeichnung":{"type":["string","null"],"description":"Bezeichnung der OZG-Leistung","example":"Elterngeld"},"url":{"type":"string","description":"URL des Onlinedienstes","example":"https://www.elterngeld-digital.de/ams/Elterngeld/wizardng/FFE7CD?v=1631864309988"},"online_status":{"type":"string","description":"Gibt Aufschluss über die Funktionsfähigkeit des Onlinedienstes","enum":["ok","nicht ok"],"example":"ok"},"aktiv":{"type":["string","null"],"description":"Gibt an, ob die OZG-Leistung aktiv ist","enum":["ja","nein"],"example":"ja"},"art_flaechendeckung":{"type":"string","description":"Gibt an, welches Flächendeckungsergebnis die OZG-Leistung für die Gebietskörperschaft erzielt","enum":["bundesweit flächendeckend","in mind. einer Kommune verfügbar","landesweit flächendeckend","kreisweit flächendeckend","nicht in Auswertung berücksichtigt"],"example":"landesweit flächendeckend"},"begruendung_nicht_beruecksichtigt":{"type":["string","null"],"description":"Berücksichtigung der Leistung bei Onlinediensten im Detail","example":"Leistungsschlüssel nicht im Leistungskatalog"},"export_datum":{"type":["string","null"],"format":"date","deprecated":true,"description":"Entfällt zukünftig, da die Angabe für Nutzende nicht genau genug ist. Bitte zukünftig datenstand_pvog_import verwenden.","example":"2025-10-03"},"datenstand_pvog_import":{"type":["string","null"],"format":"date","description":"Zeitpunkt des Imports aus der Datenquelle (PVOG)","example":"2025-10-03"}}},"PageMetadata":{"type":"object","properties":{"size":{"type":"integer","format":"int64"},"number":{"type":"integer","format":"int64"},"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int64"}}},"PagedModelOpenPvogDto":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/OpenPvogDto"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"OpenArsDto":{"type":"object","properties":{"ars":{"type":"string","description":"12-stelliger amtlicher Regionalschlüssel einer Gebietskörperschaft","example":"010510000000"},"arsName":{"type":"string","description":"Bezeichnung der Gebietskörperschaft","example":"Dithmarschen"}}},"PagedModelOpenArsDto":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/OpenArsDto"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}}}}}