Schnittstellenbeschreibung

(1)

s

Schnittstellenbeschreibung

Personenbezogene Abfrage Webservice

Projekt: Transparenzdatenbank

Thema: Personenbezogene Abfrage in der TDB Version: 2.00

Verfasser: Abteilung II/12 Transparenzdatenbank

Beschreibung: Beschreibung der Schnittstelle für die Abfrage von

personenbezogenen Leistungsdaten

(2)

Änderungshistorie

Version Datum Änderung

0.1 16.03.2015 Ersterstellung

0.9 24.09.2015 Aktualisierung PDF Auszug 1.0 10.02.2016 GZAntragsId in PDF, PV Rolle

1.1 12.08.2016 PVPChainedToken

1.2 03.10.2018 Gemeinsame Abfrage mehrerer Personen

2.00 13.05.2020 Aufnahme von Förderungsfällen, Auszahlungen und Excel

2.00 22.09.2021 Korrektur der Häufigkeit des Elements AuszugAbschnitt

(3)

Inhalt

Abbildungsverzeichnis ... 4

Begriffsdefinitionen ... 5

SOAP Header ... 5

2.1 PVP-Token im Portalverbund ... 5

2.2 SOAP Header für das Unternehmensserviceportal ... 6

Request zur personenbezogenen Abfrage ... 7

3.1 Behördenabfrage Request ... 8

3.2 BehoerdenabfrageRequestType ... 9

3.3 Request ab Version 2.00 ... 10

3.4 Leistungsempfänger ... 11

3.4.1 Nicht natürliche Person ... 12

3.4.2 Natürliche Person ... 12

3.4.3 Identifizierung ... 13

3.5 Zustimmungserklärung ... 14

3.6 Fehlercodes ... 15

Response der personenbezogenen Abfrage ... 17

4.1 Response ab Version 2.00 ... 18

4.2 Verhalten der Schnittstelle bei fehlender Zustimmung zur Einsicht ... 20

4.3 Leistungsdatenauszug ... 21

4.3.1 Auszugdetails ... 22

4.3.2 Leistungsempfänger ... 23

4.3.3 Auszugabschnitt ... 26

4.3.4 Bereich ... 27

4.3.5 Leistungen ... 28

4.3.6 Hinweise ... 31

4.4 Leistungsdatenauszug als PDF oder Excel ... 32

Anhang ... 33

(4)

Abbildungsverzeichnis

Abbildung 1: Behördenabfrage Request 8

Abbildung 2: BehoerdenabfrageRequestType 9

Abbildung 3: RequestAbV2_00Type 10

Abbildung 4: LeistungsempfaengerType 11

Abbildung 5: NichtNatuerlichePersonType 12

Abbildung 6: NatuerlichePersonType 12

Abbildung 7: IdentificationType 13

Abbildung 8: LeistungsangebotIDsZustimmungType 14

Abbildung 9: Webservice Response 17

Abbildung 10: BehoerdenabfrageResponse 18

Abbildung 11: ResponseV2_00 19

Abbildung 12: TDBAuszug 21

Abbildung 13: Auszugdetails 22

Abbildung 14: Leistungsempfänger 23

Abbildung 15: Natürliche Person 24

Abbildung 16: Nicht natürliche Person 25

Abbildung 17: Auszug Abschnitt 26

Abbildung 18: Bereich 27

Abbildung 19: Leistung 28

Abbildung 20: Hinweis 31

Abbildung 21: Beispiel Betrag bei Hinweis 31

Abbildung 22: Dokumente 32

(5)

Begriffsdefinitionen

Die Begriffe des personenbezogene Abfrage WebService unterscheiden sich zu den verwendeten Begriffen in der Webapplikation. In der folgenden Tabelle finden Sie gleichbedeutende Begriffe.

Webapplikation WebService

Förderung Leistungsangebot

Leistungen Förderungsfälle, Auszahlungen und Leistungsmitteilungen LeistungsangebotID ID der Förderung

Leistungsempfänger Förderungsempfänger Personenbezogene Abfrage Behördenabfrage

SOAP Header

Die Transparenzdatenbank bietet zwei Möglichkeiten der personenbezogenen Abfrage mittels Webservice an. Der Zugang und die Authentifizierung kann mittels Portalverbundprotokoll erfolgen oder mittels Unternehmensserviceportal (USP) erfolgen. Für den Zugang über das USP muss sich die Abwicklungsstelle mit der Abteilung Transparenzdatenbank (transparenzdatenbank@bmf.gv.at) für das benötigte Whitelisting in Verbindung setzen. Weitere Informationen zum Anlegen eines WebService Accounts im USP sind dem Leitfaden „TDB Berechtigungen am USP“ zu entnehmen.

2.1 PVP-Token im Portalverbund

Die Schnittstelle der personenbezogenen Abfrage entspricht den E-Government Standards Portalverbundprotokoll zur Authentifizierung von Anfrage. Das Webservice ist ein SOAP Webservice, die Portalverbundinformationen werden gemäß PVP-Spezifikation im SOAP-Header abgebildet.

Gemäß PVP 1.9 müssen die Authentifizierungsinformationen des auf die Schnittstelle zugreifenden Systems, im Element systemPrincipal enthalten sein. Die Informationen des zugreifenden Endbenutzers müssen im Element pvpChainedToken enthalten sein.

Für Abfragen wird die Rolle „TDB_Personenabfrage_WS“ mit einem oder mehreren Parametern, welche das/die Organisationskennzeichen (OKZ) der abfrageberechtigten Stellen enthält, benötigt:

(6)

<sec:Security>

<pvp1:pvpToken version="1.9">

<pvp1:authenticate>

<pvp1:participantId>AT:VKZ:BMF-S5-1234</pvp1:participantId>

<pvp1:gvOuDomain>AT:VKZ:BMF-S5-1234</pvp1:gvOuDomain>

<pvp1:systemPrincipal>

<pvp1:userId>tdb.test@bmf.gv.at</pvp1:userId>

<pvp1:cn/>

<pvp1:gvOuId>AT:VKZ:BMF-S5-1234</pvp1:gvOuId>

<pvp1:ou>Bundesministerium für Finanzen</pvp1:ou>

<pvp1:gvSecClass>3</pvp1:gvSecClass>

</pvp1:systemPrincipal>

</pvp1:authenticate>

<pvp1:pvpChainedToken version="1.9">

<pvp1:authenticate>

<pvp1:userPrincipal>

<pvp1:cn/>

<pvp1:gvGid>tdb.test@bmf.gv.at</pvp1:gvGid>

</pvp1:userPrincipal>

<pvp1:authorize>

<pvp1:role value="TDB_Personenabfrage_WS">

<pvp1:param>

<pvp1:key>OKZ</pvp1:key>

<pvp1:value>BMF-II-12</pvp1:value>

</pvp1:param>

</pvp1:role>

</pvp1:authorize>

</pvp1:pvpChainedToken>

</pvp1:pvpToken>

</sec:Security>

</soapenv:Header>

2.2 SOAP Header für das Unternehmensserviceportal

Die Abfrage über USP erfordert eine Authentifizierung gegenüber dem USP mittels Benutzername und Passwort eines im USP angelegten Webservicekontos. Die Zugangsdaten werden anstelle des PVP Token im SOAP Header der Nachricht übermittelt. Die Informationen zur Rolle und zum Organisationskennzeichen (OKZ) werden automatisiert über das USP zugewiesen:

<soapenv:Header>

<wsse:Security>

<wsse:UsernameToken>

<wsse:Username>s000b000g025</wsse:Username>

<wsse:Password>123xyz</wsse:Password>

</wsse:UsernameToken>

</wsse:Security>

</soapenv:Header>

(7)

Request zur personenbezogenen Abfrage

Die Version 2.00 der Webservice Schnittstelle wird durch Verwendung des Namensraums http://transparenzportal.gv.at/behoerdenabfrageV2 aufgerufen.

Endpoint URL

Portalverbund Produktion https://pamgate2.portal.at/at.gv.bmf.tdb-p/ws/behoerdenabfrage Portalverbund Test https://pamgate2.portal.at/at.gv.bmf.tdb-t/ws/behoerdenabfrage USP Produktion https://txm.portal.at/at.gv.bmf/tdb/behoerdenabfrage

USP Test https://txm.portal.at/at.gv.bmf/tdb-t/behoerdenabfrage

Hinweis zur Testumgebung:

Die Produktiv- und Testumgebung verwenden verschiedene Nummernkreise für Förderungen (unterschiedliche LeistungsangebotsIDs). Daher ist es nicht möglich Förderungen aus der Produktivumgebung in der

Testumgebung zu verwenden. Sollten sie Förderungen in der Testumgebung benötigen wenden Sie sich an die Abteilung Transparenzdatenbank (transparenzdatenbank@bmf.gv.at). Diese wird Ihnen die Testaten zur Verfügung stellen.

(8)

3.1 Behördenabfrage Request

Abbildung 1: Behördenabfrage Request

Im SOAP Body des Webservice Request wird ein XML mit dem Element BehoerdenabfrageRequest mitgegeben, welches im Folgenden beschrieben ist und das Wurzelelement darstellt. Die Webservice Schnittstelle erfordert (wie auch die Benutzerschnittstelle) den Transport über HTTPS. Das Zertifikat muss von einem Portalverbund-Zertifizierungsdienstanbieter oder vom Zertifizierungsdienstanbieter A-trust ausgestellt sein. Des Weiteren erfordert das TDB-Anwendungsportal das Vorhandensein der im Portalverbundprotokoll definierten HTTP-Header einschließlich der Authentifizierungs- und Autorisierungsinformationen (siehe 5).

(9)

3.2 BehoerdenabfrageRequestType

Abbildung 2: BehoerdenabfrageRequestType

Dem Request muss die verwendete Webservice Version und zur eindeutigen Kennung eine AbfrageId mitgegeben werden. Die AbfrageId dient dafür eine Verbindung mit dem Suchergebnis herstellen zu können und kann frei gewählt werden. Im Element RequestAbV2_00 werden die fachlichen Daten für die personenbezogene Abfrage mitgegeben.

<soapenv:Body>

<RequestAbV2_00>[..]</RequestAbV2_00>

</BehoerdenabfrageRequest>

</soapenv:Body>

Name / Type ^min/max Definition

Version String

1..1 Verwendete Versionsnummer der Behördenabfrage.

Aktuell: v2.00 AbfrageId

String

1..1 Eindeutige ID um den Response zuordnen zu können.

1-36 Zeichen RequestAbV2_00

FoerderfallType

1..1 Container für Abfragekriterien (Siehe 10)

(10)

3.3 Request ab Version 2.00

Im RequestAbV2_00Type sind alle Informationen mitzugeben die benötigt werden um für eine bestimmte natürliche oder nicht natürliche Person eine personenbezogene Abfrage aus der Transparenzdatenbank durchzuführen.

Abbildung 3: RequestAbV2_00Type

<RequestAbV2_00>

<PdfAuszug>false</PdfAuszug>

</RequestAbV2_00>

GZAntragsId String

0..1 Mit dem optionalen Element GZAntragsId kann der auf den Geschäftsfall referenziert werden, aufgrund dessen die Abfrage durchgeführt wird.

Max 40 Zeichen Leistungsempfaenger

LeistungsempfaengerType

1..1 Person (natürlich oder nicht natürlich) für welche die Abfrage erfolgen soll.

AbfrageJahrVon String

1..1 Zeitspannen Beginn, als Jahreszahl, in welcher das Auszahlungsdatum der Leistungen bzw. das Datum des Förderfalles liegen muss. Wird nur ein Jahr abgefragt ist AbfrageJahrVon gleich AbfrageJahrBis. Z.B. 2020 4 Zeichen

AbfrageJahrBis String

1..1 Zeitspannen Ende, als Jahreszahl, in welcher das Auszahlungsdatum der Leistungen bzw. das Datum des Förderfalles liegen muss. Wird nur ein Jahr abgefragt ist AbfrageJahrVon gleich AbfrageJahrBis. Z.B. 2020 4 Zeichen

LeistungsangebotIDAbfrage 1..1 Leistungsangebot welches abgefragt werden soll, angegeben als LeistungsangebotID laut Leistungsangebotsdatenbank.

Max 9 Zeichen

(11)

Name / Type ^min/max Definition LeistungsangebotIDsZustimmung

LeistungsangebotIDsZustimmung Type

0..* Erklärung der Zustimmung zur Einsichtnahme auf sensible und der Geheimhaltung unterliegende Leistungsangebote (siehe 3.5)

PdfAuszug Boolean

1..1 Das Element PdfAuszug gibt an, ob das Ergebnis der Abfrage zusätzlich als Dokument im PDF Format mitgeliefert werden soll.

Werte: true/false ExcelAuszug

Boolean

1..1 Das Element PdfAuszug gibt an, ob das Ergebnis der Abfrage zusätzlich als Dokument im Excel Format mitgeliefert werden soll.

Werte: true/false

3.4 Leistungsempfänger

Abbildung 4: LeistungsempfaengerType

Die personenbezogene Abfrage kann für natürliche (siehe 3.4.2) oder nicht natürliche Personen (siehe 3.4.1) erfolgen. Es ist nicht möglich diese Empfängertypen zu mischen. Werden mehrere Leistungsempfänger desselben Typs angegeben, so erfolgt eine gemeinsame Abfrage dieser Personen.

Hinweis zur gemeinsamen Abfrage mehrerer Leistungsempfänger:

Die gemeinsame Abfrage ist keine Möglichkeit Massenabfragen durchzuführen. Bei einer gemeinsamen Abfrage werden mehrere Personen in einer Abfrage gemeinsam dargestellt. Dies kann zum Beispiel bei einer Personengemeinschaft oder einem gemeinsamen Haushalt erforderlich sein.

NichtNatuerlichePerson NichtNatuerlichePersonType

1..* Container mit Informationen über die abzufragende nicht natürliche Person.

NatuerlichePerson NatuerlichePersonType

1..* Container mit Informationen über die abzufragende natürliche Person.

(12)

3.4.1 Nicht natürliche Person

Nicht natürliche Personen benötigen zur Identifizierung eine gültige Stammzahl.

Abbildung 5: NichtNatuerlichePersonType

</Identification>

</NichtNatuerlichePerson>

Identification IdentificationType

1..1 Container für Identifikationsdaten

3.4.2 Natürliche Person

Neben der im Container angegeben vbPK-ZP-TD wird für natürliche Personen auch Vorname, Nachname und das Geburtsdatum benötigt.

Abbildung 6: NatuerlichePersonType

<Zuname>Mustermann</Zuname>

<Value>iO9A77oeaIEhk5VdszkXsSa[..]hSDlCebOD8kYLAlBUGE=</Value>

<Type>urn:publicid:gv.at:ecdid+BMF+ZP-TD</Type>

</Identification>

</NatuerlichePerson>

(13)

Name / Type ^min/max Definition Vorname

String

1..1 Vorname der abzufragenden Person.

max 200 Zeichen Nachname

String

1..1 Nachname der abzufragenden Person.

max 200 Zeichen Geburtsdatum

Date

1..1 Geburtsdatum der abzufragenden Person Format: JJJJ-MM-DD

Identification IdentificationType

1..1 Container für Identifikationsdaten

3.4.3 Identifizierung

In diesem Element wird im Type angegeben um welche Art von Stammzahl es sich handelt. In Value wird die Stammzahl selbst übermittelt. Für natürliche Personen ist die vbPK-ZP-TD zu übermitteln. Bei nicht natürlichen Personen können verschiedene Stammzahl Typen übermittelt werden (Z.B.: KUR oder Firmenbuchnummer).

Abbildung 7: IdentificationType

Value String

1..1 Identifikationswert

NatuerlichePersonType: vbPK-ZP-TD

NichtNatuerlichePersonType: Stammzahl oder KUR

(14)

Name / Type ^min/max Definition Type

String

1..1 NatuerlichePersonType: urn:publicid:gv.at:ecdid+BMF+ZP- TD

NichtNatuerlichePersonType:

Syntax: urn:publicid:gv.at:baseid+SOURCE

Im URN bezeichnet SOURCE ein Kürzel für die Herkunft der Stammzahl und MUSS einer der folgenden Werte entsprechen

 Firmenbuchnummer: XFN

 Vereinsregisternummer: XZVR

 Ergänzungsregister: XERSB

 Global Location Number: XGLN

 Gemeindekennziffer: XGKZ

Für die Kennziffer des Unternehmens wird nicht die URI-Syntax sondern lediglich das Kürzel KUR verwendet.

3.5 Zustimmungserklärung

Für die Einsicht auf einzelne Leistungen kann es erforderlich sein, sich die Zustimmung der Förderungsempfänger einzuholen. Sollte im Zuge einer Behördenabfrage auf solche Leistungen Einsicht genommen werden, so ist es erforderlich, die Zustimmung des abgefragten Leistungsempfängers einzuholen und dies zu dokumentieren. Bei der manuellen Abfrage im Verfahren der Transparenzdatenbank wird diese Zustimmung durch den Benutzer unmittelbar über entsprechende Checkboxen in der Anwendung abgefragt und geprüft. Bei der Abfrage durch Webservice kommt die Information, dass der Nutzer zuvor seine Zustimmung für die Einsicht auf alle notwendigen Leitungsangebote erteilt hat, nicht aus der direkten Benutzerinteraktion, sondern nur mittelbar.

Hinweis zur Zustimmungserklärung:

Die Abfrage von Leistungen, welche die Zustimmung des Leistungsempfängers erfordern, darf auch wirklich nur mit vorliegender Zustimmung des Leistungsempfängers erfolgen.

Ist die Einsicht auf das Einkommen des Leistungsempfängers nur mit Zustimmung möglich, so muss auch dafür eine Zustimmung erfolgen. Da das Einkommen selbst keine LeistungsangebotID hat muss das Feld LeistungsangebotID der Wert „Einkommen“ eingetragen werden.

Abbildung 8: LeistungsangebotIDsZustimmungType

(15)

Name / Type ^min/max Definition LeistungsangebotID

String

1..1 Identifikationsnummer des Leistungsangebots dem zugestimmt wird oder „Einkommen“ für die Abfrage des Einkommens

Zustimmung String

1..1 Information, ob der Leistungsempfänger zugestimmt hat. Format: „J“

oder „N“

3.6 Fehlercodes

Im Fehlerfall liefert das Element Message einen CustomFaultType mit einer Fehlernummer und einer Fehlerbeschreibung zurück. Der CustomFaultType gliedert sich in die Elemente Code, Reason und die optionalen Felder Help und Detail.

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

<SOAP-ENV:Header/>

<SOAP-ENV:Body>

<SOAP-ENV:Fault>

<faultcode>SOAP-ENV:Client</faultcode>

<FaultHint>Das AbfrageJahr ist ungültig. (gültige Werte: 2013 - aktuelles Jahr) </FaultHint>

<FaultIdType>AbfrageId</FaultIdType>

</TDBFaultDetails>

</detail>

</SOAP-ENV:Fault>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>

Fehlercode Fehlertext

1600 Das Webservice für personenbezogen Abfrage steht aktuell nicht zur Verfügung. Unbekannter Fehler.

Bitte versuchen Sie es später erneut.

2601 Die AbfrageId enthält ungültige Zeichen.

2602 Die GZAntragsId enthält ungültige Zeichen.

2604 Der Vorname muss eingegeben werden.

2605 Der Vorname enthält ungültige Zeichen.

2606 Der Zuname muss eingegeben werden.

2607 Der Zuname enthält ungültige Zeichen.

2608 Ungültiger IdentificationTyp für natürliche Person.

(16)

2611 Die angegebene KUR ist ungültig.

2612 Die angegebene Firmenbuchnummer ist ungültig.

2613 Die angegebene Vereinsregisternummer ist ungültig.

2614 Die angegebene Ergänzungsregisternummer ist ungültig.

2615 Das AbfrageJahr ist ungültig. (gültige Werte: 2013 - aktuelles Jahr) 2616 Die LeistungsangebotsIDAbfrage ist ungültig.

2617 Die LeistungsangebotsID der Zustimmung ist ungültig. (LeistungsangebotID: <LAID>) 2618 Das AbfrageJahrVon muss kleiner gleich dem AbfrageJahrBis sein.

2619 Die angegebene Gemeindekennziffer ist ungültig.

2620 Die angegebene Globale Location Number ist ungültig.

2621 Versionsnummer und übermittelter Request stimmen nicht überein.

3601 Jede LeistungsangebotsID der Zustimmung darf nur einmal vorhanden sein.

4602 Die LeistungsangebotsIDAbfrage kann nicht abgefragt werden, da diese nicht in der aktuell gültigen Verordnung vorhanden ist.

4603 Ein Unfallversicherungsauszug kann nur für eine natürliche Person erstellt werden.

4604 Nicht für die Abfrage dieser LeistungsangebotsIDAbfrage berechtigt, da das OKZ der Rolle nicht im Leistungsangebot berechtigt wurde.

4605 Für die Abfrage dieser LeistungsangebotsIDAbfrage sind keine Zustimmungen notwendig.

4606 Die vbPK des Empfängers konnte nicht entschlüsselt werden.

4607 Die nicht natürliche Person konnte mit der angegebenen Stammzahl nicht im Unternehmensregister ermittelt werden.

4608 Die nicht natürliche Person konnte mit der angegebenen Stammzahl nicht im Unternehmensregister ermittelt werden.

4609 Es konnte keine Person im ZMR und/oder ERnP gefunden werden.

4610 Ein Unfallversicherungsauszug kann nur für ein Auszahlungsjahr erstellt werden. (AbfrageJahrVon und AbfrageJahrBis müssen gleich sein)

5601 Der Zugriff auf die Daten des Hauptverbandes der österreichischen Sozialversicherungsträger ist derzeit aus technischen Gründen nicht verfügbar, daher kann kein Unfallversicherungsauszug erstellt werden. Versuchen Sie es bitte zu einem späteren Zeitpunkt noch einmal.

5602 Das Service zum Entschlüsseln der vbPk-Zp-TD steht zur Zeit nicht zur Verfügung.

5603 Das ZMR-Service steht aktuell nicht zur Verfügung.

5604 Das Unternehmensregister steht aktuell nicht zur Verfügung.

5605 Die Transparenzportalabfrage konnte aus technischen Gründen nicht durchgeführt werden.

(17)

5608 Die SearchRequestId für die Abfrage der Schnittstellen konnte nicht erzeugt werden.

Response der personenbezogenen Abfrage

Das Webservice liefert im Erfolgsfall alle Informationen welche auch bei der Abfrage in der Applikation Transparenzdatenbank zurückgeliefert werden.

Abbildung 9: Webservice Response

Um den Response dem ursprünglichen Request zuordnen zu können und richtig verarbeiten zu können wird die AbfrageId und die Version gemeinsam mit dem Ergebnis zurück geliefert.

(18)

Abbildung 10: BehoerdenabfrageResponse

<ResponseV2_00>[..]</ResponseV2_00>

Version VersionType

1..1 Version des Response

AbfrageId AbfrageIdType

1..1 Identifikationsnummer die dem Request mitgegeben wurde.

ResponseV2_00 ResponseV2_00Type

1..1 Container für das Abfrageergebnis

4.1 Response ab Version 2.00

Die Antwort des Webservice enthält im Container ResponseV2_00 entweder einen Auszug der Leistungsdaten des Leistungsempfängers oder eine Liste jener Leistungsangebote, für welche die Zustimmung des Empfängers erforderlich ist (siehe 2.4). Die Antwort kann auf Anforderung das Ergebnis zusätzlich im PDF und/oder im Excel Format mitliefern (z.B. zur Beilage für einen Akt). Die AbfrageID entspricht der Request AbfrageID.

(19)

Abbildung 11: ResponseV2_00

<ResponseV2_00>

<ns3:TDBAuszug>[..]</ns3:TDBAuszug>

</ResponseV2_00>

ZustimmungErforderlich ZustimmungErforderlichType

1..* Container für fehlende Zustimmung (siehe 0)

ta2_00:TDBAuszug 1..1 Leistungsdatenauszug (siehe 00) PdfAuszug

DokumentType

0..1 Leistungsdaten als PDF-Auszug (siehe 0)

ExcelAuszug DokumentType

0..1 Leistungsdaten als Excel (siehe 0)

(20)

4.2 Verhalten der Schnittstelle bei fehlender Zustimmung zur Einsicht

Die Zustimmung wird in Form der jeweiligen LeistungsangebotIDs der betroffenen Leistungsangebote sowie eines Ja/Nein-Wertes (J/N) dokumentiert. Fehlen eine oder mehrere LeistungsangebotsIDs (für welche eine Zustimmung erforderlich ist) gibt die Schnittstelle eine Fehlermeldung zurück. Diese Fehlermeldung enthält eine Liste aller Leistungsangebote für die eine Zustimmung erforderlich ist.

Beispiel: Leistungsangebot 1027473 Pflegekarenzgeld hat Einsicht auf Leistungsangebote 1004647, 1004662 sowie auf das Einkommen. Die Einsicht auf alle diese Leistungen erfordern die Zustimmung des Leistungsempfängers.

In diesen Fällen wird das Element ZustimmungErforderlich zurück geliefert. Es enthält eine Liste jener erforderlichen LeistungsangebotIDs für die der Leistungsempfänger seine Zustimmung erklären muss, damit Leistungsdaten abgefragt werden können. Die Liste ist in der Rückantwort enthalten, wenn im Such-Request nicht alle erforderlichen LeistungsangebotIDs enthalten waren (siehe 3.5).

<ResponseV2_00>

<LeistungsangebotID>Einkommen</LeistungsangebotID>

<Leistungsbezeichnung>Einkommen</Leistungsbezeichnung>

</ZustimmungErforderlich>

<Leistungsbezeichnung>Audit Pflegeundfamilie</Leistungsbezeichnung>

<Leistungsbezeichnung>Familienbeihilfe</Leistungsbezeichnung>

</ResponseV2_00>

</BehoerdenabfrageResponse>

(21)

4.3 Leistungsdatenauszug

Die Leistungsdaten werden der abfragenden Stelle in der Struktur des Leistungsdatenauszugs des Leistungsempfängers übermittelt. Der Auszug besteht aus Details zum Auszug, Daten des Leistungsempfängers und mehreren Abschnitten mit ausbezahlten Leistungen.

Abbildung 12: TDBAuszug

</TDBAuszug>

AuszugDetails AuszugDetailsType

1..1 Allgemeine Details

Leistungsempfaenger LeistungsempfaengerType

1..1 Daten der Leistungsempfänger

AuszugAbschnitt AuszugAbschnittType

0..* Abschnitte über ausbezahlte Leistungen

HinweisGesamt Hinweis_Type

0..* Hinweise, welche das gesamte Ergebnis betreffen

(22)

4.3.1 Auszugdetails

In den Auszugdetails sind die Metainformationen zur Abfrage enthalten: Das Jahr/Jahre für welche die Abfrage durchgeführt wird, das Datum der Abfrage, die Bezeichnung der Person welche die Abfrage durchgeführt hat und die GZAntragsId. Das Feld GZAntragsId enthält die Kennung des Geschäftsfalls aus der Suchanfrage von maximal 40 Zeichen. Das Element ist leer, wenn im Request keine Kennung übermittelt wurde.

Abbildung 13: Auszugdetails

</AuszugDetails>

AbfragejahrVon Short

1..1 Beginnjahr des Abfragezeitraums Format: JJJJ

AbfragejahrBis Short

1..1 Endjahr des Abfragezeitraums Format: JJJJ

AbfrageDatum Date

1..1 Datum wann die Abfrage erstellt wurde.

Format: JJJ-MM-DD AbfragePerson

String

1..1 Common-Name aus dem PVP-Header der Person, welche die Abfrage erstellt hat.

GZAntragsId String

0..1 Kennung des Geschäftsfalls aus der Suchanfrage. Max. 40 Zeichen. Das Element ist leer wenn im Request keine Kennung übermittelt wurde.

(23)

4.3.2 Leistungsempfänger

Der Leistungsempfänger kann eine natürliche oder nicht natürliche Person sein. Wurde eine gemeinsame personenbezogene Abfrage (Siehe S.11) durchgeführt, so werden mehrere Leistungsempfänger zurückgegeben.

Ein Hinweis wird etwa dann geliefert, wenn im Zuge der Abfrage eine der Online-Schnittstellen zum Dachverband der Sozialversicherungsträger (DVSV), zum Arbeitsmarktservice (AMS) oder zum Bundesministerium für Finanzen (BMF) nicht verfügbar ist.

Abbildung 14: Leistungsempfänger

<Zuname>Zartl</Zuname>

<Vorname>Rudolf</Vorname>

</Leistungsempfaenger>

NatuerlichePerson NatuerlichePerson_Type

0..* Container für Daten, wenn der Leistungsempfänger eine natürliche Person ist.

NichtNatuerlichePerson NichtNatuerlichePerson_Type

0..* Container für Daten, wenn der Leistungsempfänger eine nicht natürliche Person ist.

Hinweis Hinweis_Type

0..* Hinweise über nicht verfügbare Schnittstellen (Siehe 0)

(24)

4.3.2.1 Natürliche Person

Ist der Leistungsempfänger eine natürliche Person, so wird Vorname, Zuname und Geburtsdatum in der Abfrage zurückgeliefert.

Abbildung 15: Natürliche Person

<Zuname>Zartl</Zuname>

<Vorname>Rudolf</Vorname>

Vorname String

1..1 Vorname des Leistungsempfängers

Zuname String

1..1 Zuname des Leistungsempfängers

Geburtsdatum Date

1..1 Geburtsdatum des Leistungsempfängers Format: JJJJ-MM-DD

(25)

4.3.2.2 Nicht natürliche Person

Bei nicht natürlichen Personen wird der Unternehmensname, Unternehmenssitz und die KUR zurückgeliefert. Der Unternehmensvertreter wird im Behördenabfrage-WS nicht verwendet.

Abbildung 16: Nicht natürliche Person

<Firmensitz>Hintere Zollamtsstr. 4 - 1140 Wien</Firmensitz>

<Firmenname>Faonline Testunternehmen</Firmenname>

</NichtNatuerlichePerson>

Firmenname String

1..1 Name der Firma

Firmensitz String

1..1 Sitz der Firma

Unternehmensvertreter String

0..1 Wird beim behördenabfrage-WS nicht verwendet

KUR String

Kennziffer des Unternehmensregister

(26)

4.3.3 Auszugabschnitt

Die Antwort des Webservice ist in die gleichen Abschnitte wie die Transparenzportalabfrage gegliedert. Jeder Abschnitt hat eine Bezeichnung und einen oder mehrere Bereiche.

Abbildung 17: Auszug Abschnitt

<AuszugAbschnittBezeichnung>Förderungen / Transferzahlungen</AuszugAbschnittBezeichnung>

</AuszugAbschnitt>

AuszugAbschnittBezeichnung String

1..1 Bezeichnung des Abschnitts

AuszugAbschnittBereich AuszugAbschnittBereich_Type

1..* Container für die Leistungen und Hinweise

(27)

4.3.4 Bereich

AuszugAbschnittBereich dient als Container in welchem entweder Leistungen oder Hinweise des jeweiligen Abschnitts transportiert werden. Jeder Abschnitt kann mehrere Elemente Leistungen haben.

Bei der personenbezogenen Abfrage mehrerer Personen wird im Element BereichLeistungsempfänger angegeben, zu welchem abgefragten Leistungsempfänger diese Leistungen gehören. Wird nur ein Leistungsempfänger abgefragt entfällt dieses Element.

Abbildung 18: Bereich

<ns3:AuszugAbschnittBereich>

<ns3:BereichLeistungsempfaenger>Mustermann Max</ns3:BereichLeistungsempfaenger>

</ns3:AuszugAbschnittBereich>

<ns3:Leistung>[..]</ns3:Leistung>

<ns3:Hinweis>[..]</ns3:Hinweis>

BereichLeistungsempfaenger String

0..1 Leistungsempfänger der Leistungen. Bei der Abfrage mehrerer Jahre wird das Jahr ebenfalls mitgeliefert

Leistung Leistung_Type

0..* Container für die Leistungen

Hinweis Hinweis_Type

0..* Hinweise zu den Leistungen

(28)

4.3.5 Leistungen

Im Element Leistung sind die Leistungsdaten des Auszugs enthalten. Dieses Element kann entweder Daten zu einem Förderungsfall oder einer Auszahlung enthalten. Es werden die vorhandenen Details zu dieser Leistung zurückgeliefert. Die Bedarfsgemeinschaft gibt an, ob ein Leistungsbezieher eine Leistung selbst oder als Vertreter einer Gemeinschaft erhalten hat. VerpflichtungLeistungAnDritte gibt an, ob die Leistung an einen anderen Endbegünstigten weitergegeben wird. Summen zu einem Abschnitt werden als Element Leistung_Type zurückgegeben, dabei wird das Element ShowAsSumme als true geliefert.

Abbildung 19: Leistung

(29)

Beispiel Förderungsfall mit Auszahlung

<ShowAsSumme>false</ShowAsSumme>

<BezLaid>i2 - Die Börse für Business Angels</BezLaid>

<Bezeichnung>i2 - Die Börse für Business Angels</Bezeichnung>

<Foerdergegenstand>Beratung Investition</Foerdergegenstand>

<Foerdergegenstand>Beratung und sonstige Dienstleistungen Investition</Foerdergegenstand>

<Status>gewährt</Status>

<Foerdergeber>Bundesministerium XY</Foerdergeber>

<FoerdergeberKontakt>Bezeichnung</FoerdergeberKontakt>

<ShowAsSumme>false</ShowAsSumme>

<BezLaid>i2 - Die Börse für Business Angels</BezLaid>

<Bezeichnung>TEST Auszahlung</Bezeichnung>

<Foerdergeber>Land Niederösterreich</Foerdergeber>

<FoerdergeberKontakt>Bezeichnung</FoerdergeberKontakt>

<CoFinanziert>Nicht Kofinanziert</CoFinanziert>

</Auszahlung>

</Leistung>

ShowAsSumme Boolean

1..1

Laid String

0..1 Identifikationsnummer der Förderung.

BezLaid String

0..1 Bezeichnung der Förderung

Bezeichnung String

0..1 Bezeichnung der Leistung

Foerdergegenstand String

0..* Es werden alle Förderungsgegenstände zurückgeliefert die dem Förderungsfall zugeordnet wurden.

Datum String

0..1 Datum wann der Status eingetreten ist.

Status String

0..1 Status der Leistung

BetragStatus 0..1 Betrag zum Status. Z.B. beim Status „gewährt“ wird der gewährte

(30)

Name / Type ^min/max Definition String

SummeStatus String

0..1 Summe aller Statusbeträge

SummeLeist String

0..1 Summe aller Leistungen

ZeitraumVon String

0..1 Beginn des Leistungszeitraums

ZeitraumBis String

0..1 Ende des Leistungszeitraums

Foerdergeber String

0..1 Abwicklungsstelle, welche die Auszahlung getätigt hat

FoerdergeberKontakt String

0..1 Bezeichnung der Abwicklungsstelle

FoerdergeberTel String

0..1 Telefonnummer der Abwicklungsstelle

FoerdergeberMail String

0..1 E-Mail der Abwicklungsstelle

DeminimisRelevant Boolean

0..1 Indikation, ob die Leistung De-minimis relevant ist.

Bedarfsgemeinschaft Boolean

0..1 Gibt an ob ein Leistungsbezieher eine Leistung selbst oder als Vertreter einer Gemeinschaft erhalten hat.

VerpflichtungLeistungAnDritte Boolean

0..1 Gibt an, ob die Leistung an andere Endbegünstigte weitergegeben wird

CoFinanziert String

0..1 Wenn die Auszahlung durch mehrere Stellen finanziert wird, wird die kofinanzierende Stelle in diesem Feld angegeben.

AnmerkungDsgvo String

0..1 Wurde ein Antrag auf Berichtigung lt. DSGVO gestellt, so wird in diesem Element die entsprechende Anmerkung mitgeliefert.

Auszahlung Lesitung_Type

0..* Sind zu dem Förderungsfall Auszahlungen vorhanden, so werden diese als Auszahlung zurückgeliefert.

(31)

4.3.6 Hinweise

Abbildung 20: Hinweis

<Text>*) BG: Auszahlung wurde vom Förderungsempfänger für eine Bedarfsgemeinschaft empfangen</Text>

</Hinweis>

Text String

1..1 Hinweistext

Betrag String

0..1 Betrag zum Hinweis

In einigen Fällen wird dem Hinweis ein Betrag mitgeliefert. Dies kann zum Beispiel beim Einkommen der Fall sein.

Abbildung 21: Beispiel Betrag bei Hinweis

(32)

4.4 Leistungsdatenauszug als PDF oder Excel

Wird im Request angefordert, dass die Leistungsdaten auch als PDF oder Excel geliefert werden sollen, enthält die Antwort das Element PdfAuszug bzw. ExcelAuszug. Inhalte dieser Elemente sind die Leistungsdaten der Person in Base64-codierter Form, der Dateiname sowie der Mime-Type.

Abbildung 22: Dokumente

<Daten>UEsDBBQACAgIAA9Nq[...]GgbAAAAAA==</Daten>

<Dateiname>20200511_8976_TDB_Personenbezogene_Abfrage.xlsx</Dateiname>

<Mimetype>application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</Mimetype>

</ExcelAuszug>

Daten Base64Binary

1..1 Base64 codiertes Dokument

Dateiname String

1..1 Name der Datei

Mimetype String

1..1 Verwendeter Mime Type

(33)

Anhang

Beispiel Webservice Request mit PVP-ChainedToken-Header (natürliche Person)

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sec="http://schemas.xmlsoap.org/ws/2002/04/secext"

xmlns:pvp1="http://egov.gv.at/pvp1.xsd" xmlns:beh="http://transparenzportal.gv.at/behoerdenabfrageV2">

<soapenv:Header>

<sec:Security>

<pvp1:pvpToken version="1.9">

<pvp1:authenticate>

<pvp1:systemPrincipal>

<pvp1:cn/>

</pvp1:systemPrincipal>

<pvp1:pvpChainedToken version="1.9">

<pvp1:authenticate>

<pvp1:userPrincipal>

<pvp1:cn/>

<pvp1:gvGid>tdb.test@bmf.gv.at</pvp1:gvGid>

</pvp1:userPrincipal>

<pvp1:authorize>

<pvp1:role value="TDB_Personenabfrage_WS">

<pvp1:param>

<pvp1:key>OKZ</pvp1:key>

<pvp1:value>BMF-II-12</pvp1:value>

</pvp1:param>

</pvp1:role>

</pvp1:authorize>

</pvp1:pvpChainedToken>

</pvp1:pvpToken>

</sec:Security>

</soapenv:Header>

<soapenv:Body>

<beh:BehoerdenabfrageRequest>

<RequestAbV2_00>

<Zuname>Mustermann</Zuname>

<Value>iO9A77oeaIEhk5VdszkXsSa[..]hSDlCebOD8kYLAlBUGE=</Value>

<Type>urn:publicid:gv.at:ecdid+BMF+ZP-TD</Type>

</Identification>

</Leistungsempfaenger>

</LeistungsangebotIDsZustimmung>

</LeistungsangebotIDsZustimmung>

<PdfAuszug>false</PdfAuszug>

</RequestAbV2_00>

</beh:BehoerdenabfrageRequest>

(34)

Beispiel Response bei fehlender Zustimmung im Request

<SOAP-ENV:Header/>

<SOAP-ENV:Body>

<ns4:BehoerdenabfrageResponse

xmlns:ns3="http://transparenzportal.gv.at/behoerdenabfrageV2/TDB-Auszug_v2_00"

xmlns:ns4="http://transparenzportal.gv.at/behoerdenabfrageV2">

<ResponseV2_00>

<Leistungsbezeichnung>Einkommen</Leistungsbezeichnung>

<Leistungsbezeichnung>Audit Pflegeundfamilie</Leistungsbezeichnung>

<Leistungsbezeichnung>Familienbeihilfe</Leistungsbezeichnung>

<Leistungsbezeichnung>Freifahrt für Lehrlinge</Leistungsbezeichnung>

<Leistungsbezeichnung>Gewinnfreibetrag</Leistungsbezeichnung>

</ResponseV2_00>

</ns4:BehoerdenabfrageResponse>

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>

(35)

Beispiel Webservice Response (natürliche Person)

<SOAP-ENV:Header/>

<SOAP-ENV:Body>

<ns4:BehoerdenabfrageResponse xmlns:ns3="http://transparenzportal.gv.at/behoerdenabfrageV2/TDB-Auszug_v2_00"

xmlns:ns4="http://transparenzportal.gv.at/behoerdenabfrageV2">

<ResponseV2_00>

<ns3:TDBAuszug>

<ns3:AuszugDetails>

<ns3:AbfragejahrVon>2020</ns3:AbfragejahrVon>

<ns3:AbfragejahrBis>2020</ns3:AbfragejahrBis>

<ns3:AbfrageDatum>2020-05-11</ns3:AbfrageDatum>

<ns3:AbfragePerson/>

</ns3:AuszugDetails>

<ns3:Leistungsempfaenger>

<ns3:NatuerlichePerson>

<ns3:Zuname>Zartl</ns3:Zuname>

<ns3:Vorname>Rudolf</ns3:Vorname>

<ns3:Geburtsdatum>1961-02-13</ns3:Geburtsdatum>

</ns3:NatuerlichePerson>

</ns3:Leistungsempfaenger>

<ns3:AuszugAbschnitt>

<ns3:AuszugAbschnittBezeichnung>Förderungen / Transferzahlungen</ns3:AuszugAbschnittBezeichnung>

<ns3:Leistung>

<ns3:ShowAsSumme>false</ns3:ShowAsSumme>

<ns3:Laid>1002641</ns3:Laid>

<ns3:BezLaid>i2 - Die Börse für Business Angels</ns3:BezLaid>

<ns3:Bezeichnung>i2 - Die Börse für Business Angels</ns3:Bezeichnung>

<ns3:Foerdergegenstand>Beratung Investition</ns3:Foerdergegenstand>

<ns3:Foerdergegenstand>Beratung und sonstige Dienstleistungen Investition</ns3:Foerdergegenstand>

<ns3:Datum>11.05.2020</ns3:Datum>

<ns3:Status>gewährt</ns3:Status>

<ns3:BetragStatus>300,00</ns3:BetragStatus>

<ns3:Foerdergeber>Land Niederösterreich</ns3:Foerdergeber>

<ns3:FoerdergeberKontakt>Bezeichnung</ns3:FoerdergeberKontakt>

<ns3:FoerdergeberTel>0100000</ns3:FoerdergeberTel>

<ns3:FoerdergeberMail>test@test.at</ns3:FoerdergeberMail>

<ns3:VerpflichtungLeistungAnDritte>true</ns3:VerpflichtungLeistungAnDritte>

<ns3:Auszahlung>

<ns3:ShowAsSumme>false</ns3:ShowAsSumme>

<ns3:Laid>1002641</ns3:Laid>

<ns3:BezLaid>i2 - Die Börse für Business Angels</ns3:BezLaid>

<ns3:Bezeichnung>TEST Auszahlung</ns3:Bezeichnung>

<ns3:Datum>11.05.2020</ns3:Datum>

<ns3:BetragLeist>400,00</ns3:BetragLeist>

<ns3:ZeitraumVon>01.01.2020</ns3:ZeitraumVon>

<ns3:ZeitraumBis>29.02.2020</ns3:ZeitraumBis>

<ns3:Foerdergeber>Land Niederösterreich</ns3:Foerdergeber>

<ns3:FoerdergeberKontakt>Bezeichnung</ns3:FoerdergeberKontakt>

<ns3:FoerdergeberTel>0100000</ns3:FoerdergeberTel>

<ns3:FoerdergeberMail>test@test.at</ns3:FoerdergeberMail>

<ns3:VerpflichtungLeistungAnDritte>true</ns3:VerpflichtungLeistungAnDritte>

<ns3:CoFinanziert>Nicht Kofinanziert</ns3:CoFinanziert>

</ns3:Auszahlung>

</ns3:Leistung>

<ns3:Leistung>

<ns3:ShowAsSumme>true</ns3:ShowAsSumme>

<ns3:Bezeichnung>Zwischensumme</ns3:Bezeichnung>

<ns3:SummeStatus>300,00</ns3:SummeStatus>

<ns3:SummeLeist>400,00</ns3:SummeLeist>

</ns3:Leistung>

<ns3:Hinweis>

<ns3:Text>*) BG: Auszahlung wurde vom Förderungsempfänger für eine Bedarfsgemeinschaft empfangen</ns3:Text>

</ns3:Hinweis>

<ns3:Hinweis>

<ns3:Text>*) LV: Auszahlung wurde vom Förderungsempfänger als Leistungsverpflichteter empfangen, die Auszahlung wurde an Dritte weitergegeben</ns3:Text>

</ns3:Hinweis>

</ns3:AuszugAbschnitt>

<ns3:HinweisGesamt>

<ns3:Text>Alle angeführten Beträge in Euro</ns3:Text>

</ns3:HinweisGesamt>

</ns3:TDBAuszug>

<Daten>UEsDBBQACAgIAA9Nq[...]GgbAAAAAA==</Daten>

<Dateiname>20200511_8976_TDB_Personenbezogene_Abfrage.xlsx</Dateiname>

<Mimetype>application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</Mimetype>

</ExcelAuszug>