diff options
Diffstat (limited to 'modules/authmodule-eIDAS-v2/src/main/resources/wsdl/zmr_client/xsd/zmr/ErnpAbfrage.xsd')
| -rw-r--r-- | modules/authmodule-eIDAS-v2/src/main/resources/wsdl/zmr_client/xsd/zmr/ErnpAbfrage.xsd | 89 |
1 files changed, 40 insertions, 49 deletions
diff --git a/modules/authmodule-eIDAS-v2/src/main/resources/wsdl/zmr_client/xsd/zmr/ErnpAbfrage.xsd b/modules/authmodule-eIDAS-v2/src/main/resources/wsdl/zmr_client/xsd/zmr/ErnpAbfrage.xsd index 12ecd771..c86b4a73 100644 --- a/modules/authmodule-eIDAS-v2/src/main/resources/wsdl/zmr_client/xsd/zmr/ErnpAbfrage.xsd +++ b/modules/authmodule-eIDAS-v2/src/main/resources/wsdl/zmr_client/xsd/zmr/ErnpAbfrage.xsd @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8"?>
<!--
Name: ErnpAbfrage.xsd
-Zweck: ersetzt Szr_Einzel und Kombi-Abfrage, wird aus Ernp3 aufgerufen
+Zweck: ersetzt alle SZR Abfragen (Einzel, Kombi, Personenbindung, Suche) und wird im Rahmen von Ernp3 Suchen aufgerufen (sowohl normal als auch Suchwizard)
Author(s): Richard Mayrhofer xmayrh2
-->
<xsd:schema targetNamespace="http://bmi.gv.at/namespace/zmr-su/zmr/20040201#"
@@ -22,14 +22,15 @@ Author(s): Richard Mayrhofer xmayrh2 <xsd:complexType>
<xsd:sequence>
<xsd:element ref="ErnpAbfrageInfo"/>
- <xsd:element name="ErnpSuchPerson" minOccurs="1" maxOccurs="100">
+ <xsd:element name="ErnpSuchPerson" minOccurs="1" maxOccurs="100"> <!-- ERNP Personen können zwecks Performance massenweise abfragt werden. Personenbezogene Fehler kommen pro Ergebniseintrag in den Response, einige globale Fehler machen aber den gesamten Response zu einem Fehler -->
<xsd:complexType>
- <xsd:sequence>
+ <xsd:sequence> <!-- Im ZMR kann nach Basiszahl (=Zmr Zahl), Personendaten, Adressen und Reisedokumenten gesucht werden. Pre ist ein optionaler Zusatz welcher nur bei der Suchwizard Suche genutzt wird -->
<xsd:element ref="base:ZMRZahl" minOccurs="0" />
<xsd:element ref="cio:NatuerlichePerson" minOccurs="0" />
<xsd:element ref="cio:PostAdresse" minOccurs="0" />
+ <xsd:element ref="EidasSuchdaten" minOccurs="0" />
<xsd:element ref="DokumentSuchdaten" minOccurs="0" />
- <xsd:element ref="Pre" minOccurs="0" maxOccurs="unbounded"/>
+ <xsd:element ref="Pre" minOccurs="0" maxOccurs="unbounded"/> <!-- Nur für Suchwizard Suche. Das ERNP macht seine eigene Preselektion und übergibt potentielle Treffer ans ZMR, damit das ZMR alle ErnpPersonen für die Endselektion hat. Kann auch leer sein wenn die ERNP Preselektion nichts findet -->
</xsd:sequence>
</xsd:complexType>
</xsd:element>
@@ -37,20 +38,20 @@ Author(s): Richard Mayrhofer xmayrh2 </xsd:complexType>
</xsd:element>
- <xsd:element name="Pre">
+ <xsd:element name="Pre"> <!-- ZMR-3986: Hilfsobjekt um Preselektions-ERNP-Personen an das ZMR zu übergeben. Nachdem dieses Objekt massenweise benutzt wird, sind die Tags bewusst kompakt um Requests nicht unnötig groß zu machen (in Logs etc) -->
<xsd:complexType>
<xsd:sequence>
- <xsd:element name="Vn" type="xsd:string" minOccurs="0" nillable="true"/>
- <xsd:element name="Fn" type="xsd:string" minOccurs="0" nillable="true"/>
- <xsd:element name="Nve" type="xsd:string" minOccurs="0"/>
- <xsd:element ref="Gd" minOccurs="0"/>
- <xsd:element name="Go" type="xsd:string" minOccurs="0" nillable="true"/>
- <xsd:element name="Ges" type="xsd:string" minOccurs="0" nillable="true"/>
- <xsd:element name="Str" type="xsd:string" minOccurs="0" nillable="true"/>
- <xsd:element name="Plz" type="xsd:string" minOccurs="0" nillable="true"/>
- <xsd:element name="Ort" type="xsd:string" minOccurs="0" nillable="true"/>
- <xsd:element name="Eid" type="xsd:long"/>
- <xsd:element name="Bz" type="base:OrdnungsZahlType" minOccurs="0"/>
+ <xsd:element name="Vn" type="xsd:string" minOccurs="0"/> <!-- Vorname -->
+ <xsd:element name="Fn" type="xsd:string" minOccurs="0"/> <!-- Familienname -->
+ <xsd:element name="Nve" type="xsd:string" minOccurs="0"/> <!-- Name vor Ehe -->
+ <xsd:element ref="Gd" minOccurs="0"/> <!-- Geburtsdatum -->
+ <xsd:element name="Go" type="xsd:string" minOccurs="0"/> <!-- Geburtsort -->
+ <xsd:element name="Ges" type="xsd:string" minOccurs="0"/> <!-- Geschlecht -->
+ <xsd:element name="Str" type="xsd:string" minOccurs="0"/> <!-- Anschrift-Straße -->
+ <xsd:element name="Plz" type="xsd:string" minOccurs="0"/> <!-- Anschrift-Postleitzahl -->
+ <xsd:element name="Ort" type="xsd:string" minOccurs="0"/> <!-- Anschrift-Ort -->
+ <xsd:element name="Eid" type="xsd:long"/> <!-- Kitverfolgte EntityId -->
+ <xsd:element name="Bz" type="base:OrdnungsZahlType" minOccurs="0"/> <!-- Kitverfolgte Basiszahl (=Ordnungsnummer weil es nur ERNP Personen sind) -->
</xsd:sequence>
</xsd:complexType>
</xsd:element>
@@ -67,54 +68,43 @@ Author(s): Richard Mayrhofer xmayrh2 <xsd:element name="ErnpAbfrageInfo">
<xsd:complexType>
<xsd:sequence>
- <xsd:element name="ErnpRequestId" type="xsd:string" minOccurs="0" />
+ <xsd:element name="ErnpRequestId" type="xsd:string" minOccurs="0" /> <!-- Eine konstante RequestId die bereits vom ERNP Aufrufer and ERNP übergeben wird (ist somit nicht die ERNP TransactionId, sondern eine ID die auch aus ERNP Sicht von außen kommt) -->
<xsd:element name="TrefferLimit" type="xsd:int"/>
<xsd:element ref="base:Bezugsfeld" />
- <xsd:element name="Suchkriterien" type="SuchkriterienType"/>
- <xsd:element name="Suchwizard" type="xsd:boolean" minOccurs="0"/>
+ <xsd:element name="Suchkriterien" type="SuchkriterienType"/> <!-- Die "klassischen ZMR Suchkriterien" welches es auch im ERNP gibt. Besonderheiten: ErweiterteSuchoptionen ist entweder null oder "Teilnamen" wenn im Ernp isSucheMitNamensteilen true ist; SucheHistorisch ist nur true wenn im ERNP mit AKTUELL_UND_HISTORISCH abgefragt wurde -->
+ <xsd:element name="Suchwizard" type="xsd:boolean" minOccurs="0"/> <!-- wenn true wird mit Suchwizard gesucht. Wird immer in Kombination mit Kitverfolgung=true genutzt. Vom Ablauf muss das ERNP vorher seine eigene Preselektion gemacht haben und alle Preselektionsdaten als Pre Objekte übergeben -->
<xsd:element ref="ErgebnisKriterienPerson"/>
<xsd:element ref="ErgebnisKriterienMeldung"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
- <xsd:element name="ErgebnisKriterienPerson" >
+ <xsd:element name="ErgebnisKriterienPerson" > <!-- ERNPDREI-654: Achtung: Die History wird im ERNP vereinfacht behandelt (es gibt kein Strang-Konzept etc) daher soll das ZMR Personen immer so liefern wie sie aktuell aussehen. D.h. die Option InklusiveHistorische=true bezieht sich nur auf die Person! Für Meldungen gibts sowieso separate Optionen und für andere Entities soll immer der aktuelle Zustand geleifert werden (d.h. nie historische Daten, außer bei beendeten Personen die letztgültigen Daten) -->
<xsd:complexType>
<xsd:sequence>
- <!-- OhneHistorie: default=true -->
- <xsd:element name="InklusiveHistorische" type="xsd:boolean"/>
- <!-- ohneSperren: wenn true, werden Auskunftssperren gefiltert -->
- <xsd:element name="InklusiveAuskunftsgesperrte" type="xsd:boolean"/>
- <!-- Kitverfolgung: sollen gekittete Personen bis zur aktuellsten Person verfolgt werden, default: true -->
- <xsd:element name="Kitverfolgung" type="xsd:boolean"/>
- <!-- Liste von auszufilternden BeginnCodes -->
- <xsd:element name="ExklusiveBeginnCodes" type="BeginnCode"/>
- <!-- Liste der zu liefernden Sub-Entitaeten einer Person -->
- <xsd:element name="AbhaengigeEntitaeten" type="EntitaetenPerson"/>
+ <xsd:element name="InklusiveHistorische" type="xsd:boolean"/> <!-- wenn false werden historische Personen Personen aus dem Ergebnis geworfen (inkl angehängter Entitäten wie Meldung, Dokumente, ...) -->
+ <xsd:element name="InklusiveAuskunftsgesperrte" type="xsd:boolean"/> <!-- wenn false werden auskunftgesperrte Personen aus dem Ergebnis geworfen (inkl angehängter Entitäten wie Meldung, Dokumente, ...). AuskSperren auf Meldungen werden hier nicht berücksichtigt -->
+ <xsd:element name="Kitverfolgung" type="xsd:boolean"/> <!-- wenn true werden Personen die ein Kitziel haben bis zur aktuellsten Zielperson verfolgt -->
+ <xsd:element name="ExklusiveBeginnCodes" type="BeginnCode"/> <!-- eine Liste an Beginncodes. Hat eine Ergebnisperson einen dieser Beginncodes wird sie aus dem Ergebnis geworfen (inkl angehängter Entitäten wie Meldung, Dokumente, ...). Aktuell ist die Liste entweder leer oder hat nur das Element PERS_ABSCHLIESSEN aber wir haben es bewusst flexibel in der API implementiert -->
+ <xsd:element name="AbhaengigeEntitaeten" type="EntitaetenPerson"/> <!-- eine Liste an Entitäten die mit den Ergebnispersonen returniert werden soll. zb für SZR Operationen die nur manche Entitäten ausliefern, dann muss man die sonstigen Entitäten nicht aus der DB auslesen und nicht aus dem ZMR rausgeben (somit ist auch das Protokoll korrekter) -->
</xsd:sequence>
</xsd:complexType>
</xsd:element>
- <xsd:element name="ErgebnisKriterienMeldung">
+ <xsd:element name="ErgebnisKriterienMeldung"> <!-- ERNPDREI-654: Standardreihung ist "H aktuell > N aktuell > O aktuell > H hist > N hist > O hist". Innerhalb der jeweiligen Kategorie werden sie von jung bis alt gereiht. Danach werden Einträge gemäß der folgenden Filter entfernt und schlussendlich der Eintrag ganz links returniert -->
<xsd:complexType>
<xsd:sequence>
- <!-- OhneHistorie: default=true -->
- <xsd:element name="InklusiveHistorische" type="xsd:boolean"/>
- <!-- ohneSperren: wenn true, werden Auskunftssperren gefiltert -->
- <xsd:element name="InklusiveAuskunftsgesperrte" type="xsd:boolean"/>
- <!-- wie werden die Wohnsitze gereiht (geliefert wird nur der erste) -->
- <xsd:element name="WohnsitzPrioritaet" type="WohnsitzPrioritaet"/>
- <!-- Liste der zu liefernden Sub-Entitaeten einer Meldung -->
- <xsd:element name="AbhaengigeEntitaeten" type="EntitaetenMeldung"/>
+ <xsd:element name="InklusiveHistorische" type="xsd:boolean"/> <!-- wenn false werden alle hist entfernt -->
+ <xsd:element name="InklusiveAuskunftsgesperrte" type="xsd:boolean"/> <!-- wenn false werden alle auskunftgesperrten Meldungen entfernt. AuskSperren auf Personen werden hier nicht berücksichtigt -->
+ <xsd:element name="WohnsitzPrioritaet" type="WohnsitzPrioritaet"/> <!-- wenn juengsterHWS werden alle N und O aus der Liste entfernt (egal ob aktuell oder hist) -->
+ <xsd:element name="AbhaengigeEntitaeten" type="EntitaetenMeldung"/> <!-- derzeit ungenutzt! Das ERNP wird hier immer eine leere Liste lassen -->
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:simpleType name="WohnsitzPrioritaet">
<xsd:restriction base="xsd:string">
- <!-- nur aktuellster Hauptwohnsitz -->
- <xsd:enumeration value="juengsterHWS" />
- <!-- aktuellster Wohnsitz, Reihenfolge Haupt- oder Nebenwohnsitz oder Obdachlos -->
+ <xsd:enumeration value="juengsterHWS" /> <!-- entfernt NWS und OWS aus dem Ergebnis -->
<xsd:enumeration value="juengsterHNO" />
</xsd:restriction>
</xsd:simpleType>
@@ -122,7 +112,7 @@ Author(s): Richard Mayrhofer xmayrh2 <xsd:simpleType name="BeginnCode">
<xsd:list itemType="xsd:string" />
</xsd:simpleType>
-
+
<!-- Liste der gewählten Sub-Entities einer Person -->
<xsd:simpleType name="EntitaetenMeldung">
<xsd:list itemType="EntitaetMeldung"/>
@@ -150,6 +140,7 @@ Author(s): Richard Mayrhofer xmayrh2 <xsd:enumeration value="STDDOKUMENT" />
<xsd:enumeration value="STAATSANGEHOERIGKEIT" />
<xsd:enumeration value="AUSKUNFTSSPERRE"/>
+ <xsd:enumeration value="EIDAS"/>
</xsd:restriction>
</xsd:simpleType>
@@ -157,7 +148,7 @@ Author(s): Richard Mayrhofer xmayrh2 <xsd:complexType>
<xsd:sequence>
<xsd:element ref="base:Message"/>
- <xsd:element ref="base:ServerTransaktionNr"/>
+ <xsd:element ref="base:ServerTransaktionNr"/> <!-- ZMR-TransaktionsId (zwecks Nachverfolgung) -->
<xsd:element ref="ErnpPersonResult" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
@@ -169,7 +160,7 @@ Author(s): Richard Mayrhofer xmayrh2 <xsd:element ref="base:Message"/>
<xsd:choice>
<xsd:element ref="Ergebnissatz" minOccurs="0" maxOccurs="unbounded"/>
- <xsd:element name="ZMRZahlen" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
+ <xsd:element name="ZMRZahlen" type="xsd:string" minOccurs="0" maxOccurs="unbounded" /> <!-- Nur befüllt wenn Vorgang "ZMR_VO_ERNP_Zmrzahl_Abfrage" ist. Ziel ist ein kompakterer Response wenn sowieso nur ZMR Zahlen benötigt werden. Im Vorgang "ZMR_VO_ERNP_Personen_Abfrage" ist das Feld immer leer -->
</xsd:choice>
</xsd:sequence>
</xsd:complexType>
@@ -178,12 +169,12 @@ Author(s): Richard Mayrhofer xmayrh2 <xsd:element name="Ergebnissatz">
<xsd:complexType>
<xsd:sequence>
- <xsd:element name="StarRating" type="xsd:float" minOccurs="0"/>
- <xsd:element name="Register" type="xsd:string" minOccurs="0"/>
+ <xsd:element name="StarRating" type="xsd:float" minOccurs="0"/> <!-- Nur für Suchwizard Suche. Enthält Sternebewertung der Endselektion vom ZMR -->
+ <xsd:element name="Register" type="xsd:string" minOccurs="0"/> <!-- Nur für Suchwizard Suche. In dem Fall können ERNP Personen aus der ERNP-Preselektion im ZMR Ergebnis retour kommen. Daher braucht man das Register um ERNP und ZMR Personen zu unterscheiden -->
<xsd:element name="PersonErgebnis" type="PersonErgebnisType" minOccurs="0"/>
- <xsd:element name="AuskunftssperrePerson" type="xsd:boolean" default="false" minOccurs="0"/>
+ <xsd:element name="AuskunftssperrePerson" type="xsd:boolean" default="false" minOccurs="0"/> <!-- true wenn die Person eine Auskunftssperre hat -->
<xsd:element name="Meldedaten" type="MeldedatenType" minOccurs="0"/>
- <xsd:element name="AuskunftssperreMeldung" type="xsd:boolean" default="false" minOccurs="0"/>
+ <xsd:element name="AuskunftssperreMeldung" type="xsd:boolean" default="false" minOccurs="0"/> <!-- true wenn die Meldung eine Auskunftssperre hat -->
</xsd:sequence>
</xsd:complexType>
</xsd:element>
|