EDM Anlagen-Abfrageschnittstelle für Behörden v0.91

Schnittstellenbeschreibung

BMK_Logo_srgb

Bundesministerium für Klimaschutz, Umwelt, Energie, Mobilität, Innovation und Technologie (BMK)

Stubenbastei 5, 1010 Wien

edm-logo


Inhaltsverzeichnis

Einleitung

Zielgruppe

EDM

Once-Only-Prinzip

Register- und Systemverbund (RSV)

EDM Anlagen-Abfrageschnittstelle für Behörden

Kontakt

Relevante EDM-Registrierungseinträge

Personen mit GLN der öffentlichen Verwaltung bzw. EDM-Personen-GLN

Anlagen mit Anlagen-GLN und Anlagengenehmigungs-ID

Technische Grundlagen

Webservice-Technologie

Zugriff per RSV

Portalverbund

Codelisten

Einleitung

Codelisten-Veröffentlichung

In der Schnittstelle genutzte EDM-Codelisten

Webservice-Operationen

Abfrage von Details zu mobilen Anlagen (searchMobileInstallations)

Technische Details

Umgebungen und Endpoints

Beschreibung der Webservice-Operationen mit JSON-Inputs und Outputs

Relevante PVP2-HTTP-Header

Spezifikations-Änderungsverzeichnis

Änderungsverzeichnis

Einleitung

Disclaimer

	REGISTRATION v0.91

	Copyright (C) 2024 Environment Agency Austria
	Contact: edm-helpdesk@umweltbundesamt.at

	Commissioned by the Austrian Federal Ministry of Environment (BMK)

	Licensed under the EUPL, Version 1.2 or – as soon they will be approved
	by the European Commission – subsequent versions of the EUPL (the "Licence");

	You may not use this work except in compliance with the Licence.

	You may obtain a copy of the Licence at: http://joinup.ec.europa.eu/software/page/eupl

	Unless required by applicable law or agreed to in writing, work distributed under the licence is distributed
	on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

	See the Licence for the specific language governing permissions and limitations under the Licence.

Zielgruppe

Zielgruppe dieser Schnittstellenbeschreibung sind Personen, die - indirekt über den Register- und Systemverbund RSV - an der Umsetzung an einer Schnittstellenanbindung arbeiten (IT-Personal), sowie Personen, die sich zur Schnittstelle informieren wollen, z.B. weil Sie eine Nutzung der Schnittstelle in Erwägung ziehen (Fach- und IT-Personal).

EDM

Funktionalität

Das EDM, edm.gv.at, ist eine vom BMK betriebene e-Goverment-Lösung für Business-to-Administration-Prozesse in der Umwelt- und Abfallwirtschaft.

Zu den EDM-Funktionalitäten zählt, Unternehmen die elektronische Abwicklung von Berichtspflichten und Genehmigungsprozessen zu ermöglichen.

Das EDM setzt sich aus mehreren Teilanwendungen zusammen. Eine dieser Teilanwendungen ist ZAReg. Dabei handelt es sich um ein Stammdatenregister, das die rechtsraumübergreifende Erfassung von Anlagen- und Personenstammdaten ermöglicht, inklusive Verwaltung von Berechtigungen und Genehmigungen.

Rechtsgrundlagen

Das EDM unterstützt die elektronische Abwicklung von auf unterschiedlichsten Rechtsgrundlagen basierenden Prozessen. Zu diesen Rechtsgrundlagen zählen das Emissionsschutzgesetz für Kesselanlagen, das Emissionszertifikategesetz 2011, das Erneuerbaren-Ausbau-Gesetz, das Mineralrohstoffgesetz und das Strahlenschutzgesetz 2020.

Die wichtigste Rechtsgrundlage für den Betrieb des EDM ist das Abfallwirtschaftsgesetz 2002.

Die wichtigsten Rechtsgrundlagen für die Registrierung von Personen (Unternehmen und andere juristische und natürliche Personen), Standorten und Anlagen im EDM sind das Abfallwirtschaftsgesetz 2002 und die Gewerbeordnung 1994.

Once-Only-Prinzip

Das Once-Only-Prinzip ist ein Konzept zur Erzielung einer effizienten Verwaltung dadurch, dass Bürger und Unternehmen den Behörden Daten nur einmal mitteilen müssen, auch bei Verwendung in mehreren Verwaltungsangelegenheiten und ggf. bei verschiedenen Behörden.

Register- und Systemverbund (RSV)

Der Register- und Systemverbund (RSV), auch Digital Austria Data Exchange (dadeX) genannt, ist eine vom Bundesrechenzentrum (BRZ) im Auftrag des Bundesministeriums für Finanzen (BMF) betriebene Datendrehscheibe der östterreichischen öffentlichen Verwaltung.

Diese Datendrehscheibe unterstützt maßgeblich dabei, in der österreichischen öffentlichen Verwaltung das Once-Only-Prinzip umzusetzen.

Behörden können über diese Datendrehscheibe direkt auf Daten aus angebundenen Anwendungen und Registern zugreifen. Der RSV gewährt Datenzugriff ausschließlich bei Vorliegen entsprechender gesetzlicher Voraussetzungen.

EDM Anlagen-Abfrageschnittstelle für Behörden

Mit der vorliegenden EDM Anlagen-Abfrageschnittstelle stellt das BMK als Betreiber des EDM der österreichischen Verwaltung eine Zugriffsmöglichkeit auf Inhalte des EDM ZAReg Stammdatenregisters für die Verwendung außerhalb des EDM zur Verfügung.

Diese Zugriffsmöglichkeit richtet das BMK per Register- und Systemverbund (RSV) ein. Sämtliche Anfragen an die vorliegende EDM-Anlagen-Abfrageschnittstelle für Behörden müssen per RSV erfolgen.

Aktuell unterstützt die Schnittstelle die Abfrage von im EDM zu einem Unternehmen - oder anderen rechtlichen bzw. natürlichen Personen - registrierten mobilen Anlagen. Das BMK wird diesen Schnittstellen-Funktionsumfang nach Bedarf in künftigen Schnittstellen-Versionen erweitern.

Kontakt

Anfragen zur Schnittstelle bitte per Mail an edm-helpdesk@umweltbundesamt.at zu richten.

Relevante EDM-Registrierungseinträge

Personen mit GLN der öffentlichen Verwaltung bzw. EDM-Personen-GLN

"Person" bezeichnet im EDM juristische Personen, z.B. Unternehmen oder natürliche Personen, die beispielsweise als Antragsteller, Meldeverpflichtete, Registrierungsverpflichtete oder Bevollmächtigte auftreten.

Die EDM-Anwendungen nutzen Global Location Numbers (GLNs) zur eindeutigen Identifikation im EDM registrierter Personen. Bei GLNs handelt es sich um ein von der Standardisierungsorganisation GS1 spezifiziertes Identifikationsschema.

Die EDM-Anwendungen nutzen zwei verschiedene Arten von GLNs zur Personen-Identifikation:

  1. Aus dem Unternehmensregister für Zwecke der öffentlichen Verwaltung (URV) stammende GLNs, bezeichnet als "UR-GLN" bzw. "GLN der öffentlichen Verwaltung"
  2. Im EDM selbst der Person zugeordnete GLN, bezeichnet als EDM-Personen-GLN

Das BMK hat EDM darauf ausgelegt, zur Personen-Identifikation nach Möglichkeit ausschließlich bzw. vorrangig GLNs der öffentlichen Verwaltung zu verwenden.

Es gibt jedoch auch einige EDM-Personen-Registrierungen, auf die eines vom Folgenden zutrifft:

Anlagen mit Anlagen-GLN und Anlagengenehmigungs-ID

Im EDM erfolgt die Registrierung einer Anlage zu einem Registrierten als Anlageninhaber, bei stationären Anlagen darüber hinaus zu einem Standort.

Eine im EDM vergebene EDM-Anlagen-GLN identifiziert einen solchen Anlagenregistrierungs-Eintrag.

Eine EDM-Anlagen-GLN identifiziert also nicht nur eine einzelne Anlage, sondern auch einen einzelnen Inhaber. Im Falle einer Anlagenübertragung von einem Inhaber auf einen anderen besitzt der zum neuen Inhaber gehörende EDM-Anlagen-Registrierungseintrag also auch eine neue EDM-Anlagen-GLN.

Um Anlagen auch über Inhaber und Inhaberwechsel hinweg eindeutig identifizieren zu können, nutzt das EDM für Anlagen eine weitere ID, die sogenannte Anlagengenehmigungs-ID. Dabei handelt es sich ebenfalls um eine GLN. Die zwei wesentlichsten Eigenschaften der Anlagengenehmigungs-ID:

  1. Wenn sich meherere EDM-Anlagenregistrierungs-Einträgen auf dieselbe, aber zu mehreren unterschiedlichen Inhabern gehörende Anlage beziehen, dann besitzen diese EDM-Anlagen-Einträge eine übereinstimmende Anlagengenehmigungs-ID
  2. Bei Inhaberwechseln bleiben Anlagengenehmigungs-IDs unverändert bestehen

Technische Grundlagen

Webservice-Technologie

Das BMK hat die Anlagenabfrage-Schnittstelle als OpenAPI REST/JSON-Schnittstelle umgesetzt.

Zugriff per RSV

Das BMK ermöglicht ausschließlich dem Register- und Systemverbund (RSV) den Direktzugriff auf die EDM-Anlagenabfrage-Schnittstelle.

Behörden und Verwaltungseinrichtungen, die EDM-Anlagendaten nutzen möchten, müssen den Zugriff per RSV als Data Consumer beantragen und einrichten.

Portalverbund

Das BMK ermöglicht dem RSV den Zugriff auf das Webservice per Portalverbundprotokoll Version 2 (PVP 2) und Umweltbundesamt-Stammportal https://stp.umweltbundesamt.at/.

Anfragen von außen erreichen zunächst den Stammportal Reverse Proxy, der sie nach den Portalverbundprotokoll-Regeln an ein internes Webservice weiterleitet. Entsprechende Prüfung des Webservice-Client-SSL-Zertifikats stellt sicher, dass es sich beim Webservice-Client um den RSV handelt.

Codelisten

Einleitung

Codifizierte Information spielt eine wichtige Rolle in der Informationstechnologie und der automatisierten Informationsverarbeitung.

Ein Beispiel für eine Codeliste ist die ISO 3166-1 Liste der Länder, mit Einträgen wie »AT« für Österreich und »DE« für Deutschland.

Software nutzt Codelisten unter anderem dafür, um die in Datenbanken und EDI-Dateninstanzen enthaltene codifizierte Information für Benutzeroberflächen, Ausdrucke, usw. in „lesbare“ Information zu „übersetzen“, also beispielsweise um anstelle eines eines Länder-Codes »AT« die Landesbezeichnung »Österreich« darzustellen.

Das BMK verwaltet in edm.gv.at die für EDM-Anwendungen und Schnittstellen relevanten Codelisten, und stellt diese öffentlich zur Verfügung. Darunter auch die im vorliegenden Webservice genutzten Codelisten.

Codelisten-Veröffentlichung

Das BMK veröffentlicht die in edm.gv.at genutzten Codelisten auf zwei Wegen:

  1. Am Portal edm.gv.at im öffentlich zugänglichen Bereich unter dem Menüpunkt Zuordnungstabellen
  2. Über ein Codelisten-Webservice für den maschinellen Abruf und die maschinelle Synchronisation von Codelisten. Das BMK veröffentlicht am Portal edm.gv.at im öffentlich zugänglichen Bereich unter dem Menüpunkt Technische und organisatorische Spezifikationen das Codelisten-Webservice-Spezifikationspaket inklusive Schnittstellenbeschreibung

Alle der in dieser Spezifikation genutzten Codelisten stehen auf beiden Wegen - Portal und Webservice - öffentlich abrufbar zur Verfügung.

In der Schnittstelle genutzte EDM-Codelisten

Webservice-Operationen

Abfrage von Details zu mobilen Anlagen (searchMobileInstallations)

Funktionalität

Die Operation ist auf zwei Arten nutzbar:

  1. Abfrage von Details zu einer konkreten im EDM registrierten mobilen Anlage
  2. Abfrage von Details für alle mobilen Anlagen, die im EDM registriert sind und gemäß EDM-Registrierung zu einem konkreten Inhaber gehören

Input

Für Schnittstellennutzer als Abfrageparameter relevante Daten:

  1. Identifikation einer im EDM registrierten Person: GLN der öffentlichen Verwaltung (UR-GLN) bzw. EDM-Personen-GLN - siehe Personen mit GLN der öffentlichenVerwaltung bzw. EDM-Personen-GLN
  2. Identifikation einer im EDM registrierten Anlage: EDM-Anlagen-GLN bzw EDM-Anlagengenehmigungs-ID - siehe Anlagen mit Anlagen-GLN und Anlagengenehmigungs-ID

Die Abfrage erfordert die folgenden Parameter:

  1. Für die Abfrage von Details zu einer Anlage: Personen-ID und Anlagen-ID
    1. Personen-ID: GLN der öffentlichen Verwaltung oder EDM-Personen-GLN
    2. Anlagen-ID: EDM-Anlagen-GLN oder EDM-Anlagengenehmigungs-ID
  2. Für die Abfrage von Details zu allen mobilen Anlagen eines Inhabers: Personen-ID
    1. Personen-IDGLN der öffentlichen Verwaltung oder EDM-Personen-GLN

Output

Der Output enthält für jede im EDM registrierte Anlage, die auf Abfrageparameter passt, einen Eintrag mit im EDM zur Anlage verwalteten Anlagendetails. Dazu zählen:

Fehler

Im Fehlerfall retourniert die Operation eine JSON-Struktur mit HTTP-Statuscode und Fehlerbeschreibung.

Technische Details

Umgebungen und Endpoints

Produktivumgebungs-Endpoint: https://stp.umweltbundesamt.at/at.umweltbundesamt.edm-p/zaregSearch-ws

Zugang und Informationen zu Testinstanzen des Webservice stellt das BMK auf Anfrage zur Verfügung. Siehe Kontakt.

Beschreibung der Webservice-Operationen mit JSON-Inputs und Outputs

Die technischen Details, z.B. die JSON-Strukturen der Inputs und Ouputs sowie Beispielwerte, stellt das BMK per OpenAPI-Webservice-Spezifikation zur Verfügung:

Produktivumgebung: https://edm.gv.at/zaregServices-ws/swagger-ui/index.html

Testumgebung: https://test.umweltbundesamt.at/zaregServices-ws/swagger-ui/index.html

Bitte bei diesen Links auf die OpenAPI-Spezifikation zu beachten, dass das BMK diese zu Dokumentationszwecken bereitstellt. Das Ausprobieren von Webservice-Interaktionen per try it out und execute liefert für gewöhnlich - so der Zugriff nicht vom RSV aus erfolgt - einen Authentifizierungsfehler!

Relevante PVP2-HTTP-Header

HeaderBeispielwertBeschreibung
XPVPVERSION2.1

Verwendete PVP-Version. Das Webservice unterstützt Version 2 und damit kompatible Versionen.

Anmerkung: Das interne Webservice nutzt diesen Header nicht.

XPVPSECCLASS3

Sicherheitsklasse des Principals. Das Webservice unterstützt nur Sicherheitsklasse 3, mit Client-Zertifikat aus dem LDAP des Anwendungsportals.

Anmerkung: Das interne Webservice nutzt diesen Header nicht.

XPVPPARTICIPANTID

AT:B:115RSV

Muss den Wert AT:B:115RSV für den Register- und Systemverbund (RSV) enthalten.

Anmerkung: Das interne Webservice nutzt diesen Header nicht.

XPVPGID

AT:B:0:LxXnvpcYZesiqVXsZG0bB==

Siehe Portalverbundprotokoll Version 2 (PVP 2).

Anmerkung: Das interne Webservice nutzt diesen Header nicht.

XPVPUSERID

max.mustermann@ooe.gv.at

Siehe Portalverbundprotokoll Version 2 (PVP 2).

Anmerkung: Diesen PVP-Header nutzt auch das interne Webservice. Insbesondere loggt das interne Webservice den betreffenden Wert.

XPVPPRINCIPALNAME

Mustermann

Siehe Portalverbundprotokoll Version 2 (PVP 2).

Anmerkung: Das interne Webservice nutzt diesen Header nicht.

XPVPOUGVOUID

AT:GGA-60420:0815

Siehe Portalverbundprotokoll Version 2 (PVP 2).

Anmerkung: Das interne Webservice nutzt diesen Header nicht.

XPVPOU

Bundesrechenzentrum Gesellschaft mit beschr&#xe4nkter Haftung

Siehe Portalverbundprotokoll Version 2 (PVP 2).

Anmerkung: Das interne Webservice nutzt diesen Header nicht.

XPVPROLES

edm

Siehe Portalverbundprotokoll Version 2 (PVP 2).

Anmerkung: Diesen PVP-Header nutzt auch das interne Webservice. Insbesondere loggt das interne Webservice den betreffenden Wert.

Spezifikations-Änderungsverzeichnis

Änderungsverzeichnis

VersionDatumBeschreibung / Änderungen
0.912024-04-09

Aktualisierungen und Ergänzungen, insbesondere zu Webservice-URLs, OpenAPI-Dokumentation, Portalverbund-Protokoll und PVP-Headern.

0.9020240202

Öffentlicher Schnittstellenentwurf zum Review