MesoWebService4GIS
komplexe Datentypen
|
|
Allgemeines zu den Datentypen
Die hier beschriebenen komplexen Datentypen stellen in der Logik des MesoWebService verwendete Java-Klassen dar. Diese werden von Axis mit Hilfe von XML-Schema in XML übersetzt (serialisiert). Da XML ein plattform- und programmiersprachenunabhängiger Standard ist, kann jeder WebService-Client (Benutzer des WebServices) wieder Objekte aus der XML-Darstellung erzeugen (deserialisieren).
Jeder Datentyp muss also auf ein Objekt (z.B. eine Java-Klasse) gemappt werden. I.A. geschieht dies durch Getter- und Setter-Methoden an den entsprechenden Objekten (Java: JavaBeans). Hat also ein Datentyp einen internen Parameter nummer vom Typ int, muss das Objekt, auf welches der Datentyp gemappt wird ebenfalls eine interne Variable nummer vom Typ int, sowie die Getter-Methode int getNummer() und die Setter-Methode void setNummer(int nummer) haben. Die genaue Implementierung hängt von der verwendeten Programmiersprache ab.
Suchprofile
Suchprofile fassen Suchkriterien in einem komplexen Datentyp (Objekt) zusammen. Je nach Verwendungsbereich, also der WebService-Operation, enthalten die Suchprofile andere Daten.
| Datentyp: Suchprofil [Inhaltsverzeichnis] | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| mandant | int | Nummer des Mandanten | ja |
| Datentyp: SuchprofilEOMs [Inhaltsverzeichnis] | |||
| erweitert den Datentyp Suchprofil | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| mandant | int | Nummer des Mandanten | ja |
| eoms | long[] | Die EOM's (eindeutige Nummer) zu suchender Personen. | ja |
| eomslist | List<long> | NICHT VERWENDEN! Eine Liste von internen EOM's (eindeutige Nummer) zu suchender Personen. | |
| Datentyp: SuchprofilPerson [Inhaltsverzeichnis] | |||
| Mindestens eines der optionalen Suchkriterien muss angegeben werden. Dieses Suchprofil erweitert den Datentyp Suchprofil. | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| mandant | int | Nummer des Mandanten | ja |
| name | String | Familienname der gesuchten Personen. Groß-/Kleinschreibung wird nicht beachtet. | |
| rufname | String | Rufname der gesuchten Personen. Groß-/Kleinschreibung wird nicht beachtet. | |
| geburtsname | String | Geburtsname der gesuchten Personen. Groß-/Kleinschreibung wird nicht beachtet. | |
| geschlecht | String | Geschlecht der gesuchten Personen. Mögliche Werte: M=männlich, W=weiblich, X oder 1=unbekannt | |
| geburtsdatum | String | Das Geburtsdatum der gesuchten Personen. Format: TT.MM.JJJJ oder JJJJMMTT | |
| status | String | Einwohnerstatus der gesuchten Personen. Mögliche Werte: A=aktiv, G=verstorben, V=verzogen | |
| likeName | boolean | Gibt an, ob eine Jokersuche für Familiennamen verwendet werden soll. Es müssen dann nur die Anfangsbuchstaben des Familiennamens angegeben werden. | ja |
| likeRufname | boolean | Gibt an, ob eine Jokersuche für den Rufnamen verwednet werden soll. Wenn ja, müssen nur die Anfangsbuchstaben des Rufnamens angegeben werden. | ja |
| Datentyp: SuchprofilWohnung [Inhaltsverzeichnis] | |||
| Suchprofil mit Angaben zur Wohnung der gesuchten Personen. Mindestens eines der optionalen Felder muss angegeben werden. Dieses Suchprofil erweitert den Datentyp Suchprofil. | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| mandant | int | Nummer des Mandanten | ja |
| ort | String | Name des Ortes (Name 1 und Name 3 können angegeben werden). Groß-/Kleinschreibung wird beachtet. | |
| strasse | String | Name der Straße. Groß-/Kleinschreibung wird beachtet. | |
| ags | String | Der allgemeine Gemeindeschlüssel (acht Stellen). | |
| hausnummer | int | Die Hausnummer >= 0. -1, wenn die Hausnummer nicht beachtet werden soll. | |
| hausnummerAlpha | String | Der Alphateil der Hausnummer. | |
| likeOrt | boolean | Gibt an, ob eine Jokersuche beim angegebenen Ortsnamen verwendet werden soll. Wenn ja, genügt die Angabe der Anfangsbuchstaben des Ortes. | ja |
| likeStrasse | boolean | Gibt an, ob eine Jokersuche beim angegebenen Straßennamen verwendet werden soll. Wenn ja, genügt die Angabe des Anfangsbuchstaben der Straße. | ja |
| alleWohnungenInnerhalb | boolean | Gibt an, ob in allen Wohnungen innerhalb (Hauptwohnung, Nebenwohnungen) gesucht werden soll. Sonst wird nur in der aktuellsten Wohnung innerhalb gesucht. | ja |
| Datentyp: SuchprofilWohnungPerson [Inhaltsverzeichnis] | |||
| Suchprofil mit Angaben zur Wohnung und Persondaten der gesuchten Person. Mindestens eines der optionalen Felder muss angegeben werden. Dieses Suchprofil erweitert den Datentyp SuchprofilWohnung. | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| mandant | int | Nummer des Mandanten | ja |
| ort | String | Name des Ortes (Name 1 und Name 3 können angegeben werden). Groß-/Kleinschreibung wird beachtet. | |
| strasse | String | Name der Straße. Groß-/Kleinschreibung wird beachtet. | |
| ags | String | Der allgemeine Gemeindeschlüssel (acht Stellen). | |
| hausnummer | int | Die Hausnummer >= 0. -1, wenn die Hausnummer nicht beachtet werden soll. | ja |
| hausnummerAlpha | String | Der Alphateil der Hausnummer. | |
| likeOrt | boolean | Gibt an, ob eine Jokersuche beim angegebenen Ortsnamen verwendet werden soll. Wenn ja, genügt die Angabe der Anfangsbuchstaben des Ortes. | ja |
| likeStrasse | boolean | Gibt an, ob eine Jokersuche beim angegebenen Straßennamen verwendet werden soll. Wenn ja, genügt die Angabe des Anfangsbuchstaben der Straße. | ja |
| alleWohnungenInnerhalb | boolean | Gibt an, ob in allen Wohnungen innerhalb (Hauptwohnung, Nebenwohnungen) gesucht werden soll. Sonst wird nur in der aktuellsten Wohnung innerhalb gesucht. | ja |
| name | String | Der Familienname der gesuchten Personen. Groß-/Kleinschreibung wird nicht beachtet. | |
| rufname | String | Der Rufname der gesuchten Personen. Groß-/Kleinschreibung wird nicht beachtet. | |
| likeName | boolean | Gibt an, ob eine Jokersuche für Familiennamen verwendet werden soll. Es müssen dann nur die Anfangsbuchstaben des Familiennamens angegeben werden. | ja |
| likeRufname | boolean | Gibt an, ob eine Jokersuche für den Rufnamen verwednet werden soll. Wenn ja, müssen nur die Anfangsbuchstaben des Rufnamens angegeben werden. | ja |
| Datentyp: SuchprofilGIS [Inhaltsverzeichnis] | |||
| Suchprofil mit Gebietsangaben. Dieses Suchprofil erweitert den Datentyp Suchprofil. | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| mandant | int | Nummer des Mandanten | ja |
| geburtsdatumVon | String | Personen mit einem Geburtsdatum ab diesem Datum werden gesucht. Format: TT.MM.JJJJ oder JJJJMMTT. | |
| geburtsdatumBis | String | Personen mit einem Geburtsdatum bis zu diesem Datum werden gesucht. Format: TT.MM.JJJJ oder JJJJMMTT. | |
| deutschAuslaenderStatus | String |
Mögliche Werte: D Deutsche A Ausländer EU EU-Bürger (nicht deutsch) EU+D EU-Bürger oder Deutsche |
|
| hauptwohnungUndNebenwohnung | boolean | Sollen Personen gesucht werden, welche mit Haupt- oder Nebenwohnung gemeldet sind? Sonst nur Hauptwohnung. | ja |
| adressen | Adresse[] | Adressen. Diese stellen ein Gebiet dar. | ja |
| Datentyp: Suchprofil41 [Inhaltsverzeichnis] | |||
| erweitert den Datentyp Suchprofil um die Angabemöglichkeit eines Verfahrensnutzers | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| mandant | int | Nummer des Mandanten | ja |
| verfahrensnutzer | String | Optionaler Benutzer des zugreifenden Verfahrens. Dieser wird zur Protokollierung benutzt. | |
| Datentyp: SuchprofilEOMs41 [Inhaltsverzeichnis] | |||
| Suchprofil mit eindeutigen Personennummern. Erweitert das Suchprofil SuchprofilEOMs um die Angabemöglichkeit eines Verfahrensnutzers. Mindestens eines der optionalen Suchkriterien muss angegeben werden. | |||
| interner Typ | Datentyp | Beschreibung | Pflichtfeld |
| mandant | int | Nummer des Mandanten | ja |
| verfahrensnutzer | String | Optionaler Benutzer des zugreifenden Verfahrens. Dieser wird zur Protokollierung benutzt. | |
| eoms | long[] | Die externen EOM's oder die AKN (Ankunftsnachweisnummer) zu suchender Personen. | |
| eomslist | List<long> | NICHT VERWENDEN! Eine Liste von internen EOM's (eindeutige Nummer) zu suchender Personen. | |
| exteoms | String[] | Die externen EOM's zu suchender Personen. | |
| exteomslist | List<String> | Eine Liste von externen EOM's (eindeutige Nummer) zu suchender Personen. | |
| Datentyp: SuchprofilPerson41 [Inhaltsverzeichnis] | |||
| Suchprofil mit Personendaten. Erweitert das Suchprofil SuchprofilPerson um die Angabemöglichkeit eines Verfahrensnutzers sowie erweiterte Suchmöglichkeiten nach Namen. Mindestens eines der optionalen Suchkriterien muss angegeben werden. | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| mandant | int | Nummer des Mandanten | ja |
| verfahrensnutzer | String | Optionaler Benutzer des zugreifenden Verfahrens. Dieser wird zur Protokollierung benutzt. | |
| name | String | Familienname der gesuchten Personen. Groß-/Kleinschreibung wird nicht beachtet. | |
| rufname | String | Rufname der gesuchten Personen oder Vorname bei aktivierter Option 'alleVornamen'. Groß-/Kleinschreibung wird nicht beachtet. | |
| geburtsname | String | Geburtsname der gesuchten Personen. Groß-/Kleinschreibung wird nicht beachtet. | |
| geschlecht | String | Geschlecht der gesuchten Personen. Mögliche Werte: M=männlich, W=weiblich, X oder 1=unbekannt | |
| geburtsdatum | String | Das Geburtsdatum der gesuchten Personen. Format: TT.MM.JJJJ oder JJJJMMTT | |
| status | String | Einwohnerstatus der gesuchten Personen. Mögliche Werte: A=aktiv, G=verstorben, V=verzogen | |
| likeName | boolean | Gibt an, ob eine Jokersuche für Familiennamen verwendet werden soll. Es müssen dann nur die Anfangsbuchstaben des Familiennamens angegeben werden. | ja |
| likeRufname | boolean | Gibt an, ob eine Jokersuche für den Rufnamen verwednet werden soll. Wenn ja, müssen nur die Anfangsbuchstaben des Rufnamens angegeben werden. | ja |
| alleNamen | boolean | Gibt an, ob der angegebene Name in allen vorhandenen Namen gesucht werden soll. Dazu zählen aktuelle Namen, Geburtsnamen, fühere und weitere Namen. Die Aktivierung dieser Option verlangsamt die Suche teilweise erheblich und sollte nur verwendet werden, wenn notwendig. | ja |
| alleVornamen | boolean | Gibt an, ob der angegebene Rufname in allen vorhandenen Vornamen gesucht werden soll. Dazu zählen der aktuelle Rufname, frühere Rufnamen, der aktuelle Vorname und frühere Vornamen. Die Aktivierung dieser Option aktiviert automatisch den Parameter 'likeRufname'. Diese Option sollte nur aktiviert werden, wenn notwendig, da die Suche teilweise erheblich verlangsamt wird. | ja |
| namenszusaetze | boolean | Gibt an, ob der angegebene Familienname optional einen Namenszusatz enthalten kann. Die Aktivierung dieser Option verlangsamt die Suche und sollte nur verwendet werden, wenn notwendig. | ja |
| Datentyp: SuchprofilWohnungPerson41 [Inhaltsverzeichnis] | |||
| Suchprofil mit Personen- und Wohnungsdaten. Erweitert das Suchprofil SuchprofilWohnungPerson um die Angabemöglichkeit eines Verfahrensnutzers. Mindestens eines der optionalen Suchkriterien muss angegeben werden. | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| mandant | int | Nummer des Mandanten | ja |
| verfahrensnutzer | String | Optionaler Benutzer des zugreifenden Verfahrens. Dieser wird zur Protokollierung benutzt. | |
| ort | String | Name des Ortes (Name 1 und Name 3 können angegeben werden). Groß-/Kleinschreibung wird beachtet. | |
| strasse | String | Name der Straße. Groß-/Kleinschreibung wird beachtet. | |
| ags | String | Der allgemeine Gemeindeschlüssel (acht Stellen). | |
| hausnummer | int | Die Hausnummer >= 0. -1, wenn die Hausnummer nicht beachtet werden soll. | ja |
| hausnummerAlpha | String | Der Alphateil der Hausnummer. | |
| likeOrt | boolean | Gibt an, ob eine Jokersuche beim angegebenen Ortsnamen verwendet werden soll. Wenn ja, genügt die Angabe der Anfangsbuchstaben des Ortes. | ja |
| likeStrasse | boolean | Gibt an, ob eine Jokersuche beim angegebenen Straßennamen verwendet werden soll. Wenn ja, genügt die Angabe des Anfangsbuchstaben der Straße. | ja |
| alleWohnungenInnerhalb | boolean | Gibt an, ob in allen Wohnungen innerhalb (Hauptwohnung, Nebenwohnungen) gesucht werden soll. Sonst wird nur in der aktuellsten Wohnung innerhalb gesucht. | ja |
| name | String | Der Familienname der gesuchten Personen. Groß-/Kleinschreibung wird nicht beachtet. | |
| rufname | String | Der Rufname der gesuchten Personen. Groß-/Kleinschreibung wird nicht beachtet. | |
| namenszusaetze | String | Gibt an, ob der angegebene Familienname optional einen Namenszusatz enthalten kann. Die Aktivierung dieser Option verlangsamt die Suche und sollte nur verwendet werden, wenn notwendig. | |
| likeName | boolean | Gibt an, ob eine Jokersuche für Familiennamen verwendet werden soll. Es müssen dann nur die Anfangsbuchstaben des Familiennamens angegeben werden. | ja |
| likeRufname | boolean | Gibt an, ob eine Jokersuche für den Rufnamen verwednet werden soll. Wenn ja, müssen nur die Anfangsbuchstaben des Rufnamens angegeben werden. | ja |
| alleNamen | boolean | Gibt an, ob der angegebene Name in allen vorhandenen Namen gesucht werden soll. Dazu zählen aktuelle Namen, Geburtsnamen, fühere und weitere Namen. Die Aktivierung dieser Option verlangsamt die Suche teilweise erheblich und sollte nur verwendet werden, wenn notwendig. | ja |
| alleVornamen | boolean | Gibt an, ob der angegebene Rufname in allen vorhandenen Vornamen gesucht werden soll. Dazu zählen der aktuelle Rufname, frühere Rufnamen, der aktuelle Vorname und frühere Vornamen. Die Aktivierung dieser Option aktiviert automatisch den Parameter 'likeRufname'. Diese Option sollte nur aktiviert werden, wenn notwendig, da die Suche teilweise erheblich verlangsamt wird. | ja |
| geburtsdatum | String | Das Geburtsdatum der Person im Format TT.MM.JJJJ. | |
| Datentyp: SuchprofilWohnungPerson41Zus [Inhaltsverzeichnis] | |||
| Suchprofil mit Personen- und Wohnungsdaten. Erweitert das Suchprofil SuchprofilWohnungPerson41 um die Suchmmöglichkeiten nach Geschlecht und Postleitzahl. Mindestens eines der optionalen Suchkriterien muss angegeben werden. | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| mandant | int | Nummer des Mandanten | ja |
| verfahrensnutzer | String | Optionaler Benutzer des zugreifenden Verfahrens. Dieser wird zur Protokollierung benutzt. | |
| ort | String | Name des Ortes (Name 1 und Name 3 können angegeben werden). Groß-/Kleinschreibung wird beachtet. | |
| strasse | String | Name der Straße. Groß-/Kleinschreibung wird beachtet. | |
| ags | String | Der allgemeine Gemeindeschlüssel (acht Stellen). | |
| hausnummer | int | Die Hausnummer >= 0. -1, wenn die Hausnummer nicht beachtet werden soll. | ja |
| hausnummerAlpha | String | Der Alphateil der Hausnummer. | |
| likeOrt | boolean | Gibt an, ob eine Jokersuche beim angegebenen Ortsnamen verwendet werden soll. Wenn ja, genügt die Angabe der Anfangsbuchstaben des Ortes. | ja |
| likeStrasse | boolean | Gibt an, ob eine Jokersuche beim angegebenen Straßennamen verwendet werden soll. Wenn ja, genügt die Angabe des Anfangsbuchstaben der Straße. | ja |
| alleWohnungenInnerhalb | boolean | Gibt an, ob in allen Wohnungen innerhalb (Hauptwohnung, Nebenwohnungen) gesucht werden soll. Sonst wird nur in der aktuellsten Wohnung innerhalb gesucht. | ja |
| name | String | Der Familienname der gesuchten Personen. Groß-/Kleinschreibung wird nicht beachtet. | |
| rufname | String | Der Rufname der gesuchten Personen. Groß-/Kleinschreibung wird nicht beachtet. | |
| namenszusaetze | String | Gibt an, ob der angegebene Familienname optional einen Namenszusatz enthalten kann. Die Aktivierung dieser Option verlangsamt die Suche und sollte nur verwendet werden, wenn notwendig. | |
| likeName | boolean | Gibt an, ob eine Jokersuche für Familiennamen verwendet werden soll. Es müssen dann nur die Anfangsbuchstaben des Familiennamens angegeben werden. | ja |
| likeRufname | boolean | Gibt an, ob eine Jokersuche für den Rufnamen verwednet werden soll. Wenn ja, müssen nur die Anfangsbuchstaben des Rufnamens angegeben werden. | ja |
| alleNamen | boolean | Gibt an, ob der angegebene Name in allen vorhandenen Namen gesucht werden soll. Dazu zählen aktuelle Namen, Geburtsnamen, fühere und weitere Namen. Die Aktivierung dieser Option verlangsamt die Suche teilweise erheblich und sollte nur verwendet werden, wenn notwendig. | ja |
| alleVornamen | boolean | Gibt an, ob der angegebene Rufname in allen vorhandenen Vornamen gesucht werden soll. Dazu zählen der aktuelle Rufname, frühere Rufnamen, der aktuelle Vorname und frühere Vornamen. Die Aktivierung dieser Option aktiviert automatisch den Parameter 'likeRufname'. Diese Option sollte nur aktiviert werden, wenn notwendig, da die Suche teilweise erheblich verlangsamt wird. | ja |
| geburtsdatum | String | Das Geburtsdatum der Person im Format TT.MM.JJJJ. | |
| geschlecht | String | Geschlecht der gesuchten Personen. Mögliche Werte: M=männlich, W=weiblich, X oder 1=unbekannt | |
| postleitzahl | String | Postleitzahl der Wohnung | |
| Datentyp: SuchprofilGIS41 [Inhaltsverzeichnis] | |||
| Suchprofil mit Gebietsangaben. Dieses Suchprofil erweitert den Datentyp Suchprofil41. | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| mandant | int | Nummer des Mandanten | ja |
| verfahrensnutzer | String | Optionaler Benutzer des zugreifenden Verfahrens. Dieser wird zur Protokollierung benutzt. | |
| geburtsdatumVon | String | Personen mit einem Geburtsdatum ab diesem Datum werden gesucht. Format: TT.MM.JJJJ oder JJJJMMTT. | |
| geburtsdatumBis | String | Personen mit einem Geburtsdatum bis zu diesem Datum werden gesucht. Format: TT.MM.JJJJ oder JJJJMMTT. | |
| deutschAuslaenderStatus | String |
Mögliche Werte: D Deutsche A Ausländer EU EU-Bürger (nicht deutsch) EU+D EU-Bürger oder Deutsche |
|
| hauptwohnungUndNebenwohnung | boolean | Sollen Personen gesucht werden, welche mit Haupt- oder Nebenwohnung gemeldet sind? Sonst nur Hauptwohnung. | ja |
| adressen | Adresse[] | Adressen. Diese stellen ein Gebiet dar. | ja |
Suchergebnisse
| Datentyp: Suchergebnis [Inhaltsverzeichnis] | |||
| Basisdatentyp für die Antwort auf eine Anfrage. Von diesem werden alle anderen Suchergebnisse abgeleitet. | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| ergebnisstatus | String |
Ergebnisstatus (fett) der Anfrage (teilweise nach XMeld):
00 Leistung wurde erbracht |
ja |
| ergebnistext | String | Der Text zum Ergebnisstatus (Leistung wurde erbracht, ..). | ja |
| zusatzinformationen | String | Zusätzliche Informationen über das Suchergebnis. Dies könnte z.B. eine genauere Fehlerbeschreibung oder die maximale Anzahl der zulässigen Treffer sein. | |
| version | String | Version des MesoWebService | ja |
| zeitpunkt | String | Textuelle Darstellung des Antwortzeitpunktes im Format TT.MM.JJJJ HH:MM:SS | |
| Datentyp: SuchergebnisOrte [Inhaltsverzeichnis] | |||
| Suchergebnis mit Orten. Erweitert den Datentyp Suchergebnis. | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| ergebnisstatus | String |
Ergebnisstatus (fett) der Anfrage (teilweise nach XMeld):
00 Leistung wurde erbracht |
ja |
| ergebnistext | String | Der Text zum Ergebnisstatus (Leistung wurde erbracht, ..). | ja |
| zusatzinformationen | String | Zusäätzliche Informationen über das Suchergebnis. Dies könnte z.B. eine genauere Fehlerbeschreibung oder die maximale Anzahl der zulässigen Treffer sein. | |
| version | String | Version des MesoWebService | ja |
| zeitpunkt | String | Textuelle Darstellung des Antwortzeitpunktes im Format TT.MM.JJJJ HH:MM:SS | |
| orte | Ort[] | Array der vorhandenen Orte. | |
| Datentyp: SuchergebnisOrteGIS [Inhaltsverzeichnis] | |||
| Suchergebnis mit Orten für GIS. Erweitert den Datentyp Suchergebnis. | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| ergebnisstatus | String |
Ergebnisstatus (fett) der Anfrage (teilweise nach XMeld):
00 Leistung wurde erbracht |
ja |
| ergebnistext | String | Der Text zum Ergebnisstatus (Leistung wurde erbracht, ..). | ja |
| zusatzinformationen | String | Zusätzliche Informationen über das Suchergebnis. Dies könnte z.B. eine genauere Fehlerbeschreibung oder die maximale Anzahl der zulässigen Treffer sein. | |
| version | String | Version des MesoWebService | ja |
| zeitpunkt | String | Textuelle Darstellung des Antwortzeitpunktes im Format TT.MM.JJJJ HH:MM:SS | |
| orte | OrtGIS[] | Array der vorhandenen Orte. | |
| Datentyp: SuchergebnisOrteGIS41 [Inhaltsverzeichnis] | |||
| Suchergebnis im MesoWebSerivice4.1 mit Orten für GIS. Erweitert den Datentyp Suchergebnis. | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| ergebnisstatus | String |
Ergebnisstatus (fett) der Anfrage (teilweise nach XMeld):
00 Leistung wurde erbracht |
ja |
| ergebnistext | String | Der Text zum Ergebnisstatus (Leistung wurde erbracht, ..). | ja |
| zusatzinformationen | String | Zusätzliche Informationen über das Suchergebnis. Dies könnte z.B. eine genauere Fehlerbeschreibung oder die maximale Anzahl der zulässigen Treffer sein. | |
| version | String | Version des MesoWebService | ja |
| zeitpunkt | String | Textuelle Darstellung des Antwortzeitpunktes im Format TT.MM.JJJJ HH:MM:SS | |
| orte | OrtGIS41[] | Array der vorhandenen Orte. | |
| Datentyp: SuchergebnisStrassen [Inhaltsverzeichnis] | |||
| Suchergebnis mit Straßen. Erweitert den Datentyp Suchergebnis. | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| ergebnisstatus | String |
Ergebnisstatus (fett) der Anfrage (teilweise nach XMeld):
00 Leistung wurde erbracht |
ja |
| ergebnistext | String | Der Text zum Ergebnisstatus (Leistung wurde erbracht, ..). | ja |
| zusatzinformationen | String | Zusätzliche Informationen über das Suchergebnis. Dies könnte z.B. eine genauere Fehlerbeschreibung oder die maximale Anzahl der zulässigen Treffer sein. | |
| version | String | Version des MesoWebService | ja |
| zeitpunkt | String | Textuelle Darstellung des Antwortzeitpunktes im Format TT.MM.JJJJ HH:MM:SS | |
| strassen | Strasse[] | Array der vorhandenen Straßen. | |
| Datentyp: SuchergebnisStrassenGIS [Inhaltsverzeichnis] | |||
| Suchergbnis mit Straßen für GIS. Erweitert den Datentyp Suchergebnis. | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| ergebnisstatus | String |
Ergebnisstatus (fett) der Anfrage (teilweise nach XMeld):
00 Leistung wurde erbracht |
ja |
| ergebnistext | String | Der Text zum Ergebnisstatus (Leistung wurde erbracht, ..). | ja |
| zusatzinformationen | String | Zusätzliche Informationen über das Suchergebnis. Dies könnte z.B. eine genauere Fehlerbeschreibung oder die maximale Anzahl der zulässigen Treffer sein. | |
| version | String | Version des MesoWebService | ja |
| zeitpunkt | String | Textuelle Darstellung des Antwortzeitpunktes im Format TT.MM.JJJJ HH:MM:SS | |
| strassen | StrasseGIS[] | Array der vorhandenen Straßen. | |
| Datentyp: SuchergebnisStrassenGIS41 [Inhaltsverzeichnis] | |||
| Suchergbnis im MesoWebService4.1 mit Straßen für GIS. Erweitert den Datentyp Suchergebnis. | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| ergebnisstatus | String |
Ergebnisstatus (fett) der Anfrage (teilweise nach XMeld):
00 Leistung wurde erbracht |
ja |
| ergebnistext | String | Der Text zum Ergebnisstatus (Leistung wurde erbracht, ..). | ja |
| zusatzinformationen | String | Zusätzliche Informationen über das Suchergebnis. Dies könnte z.B. eine genauere Fehlerbeschreibung oder die maximale Anzahl der zulässigen Treffer sein. | |
| version | String | Version des MesoWebService | ja |
| zeitpunkt | String | Textuelle Darstellung des Antwortzeitpunktes im Format TT.MM.JJJJ HH:MM:SS | |
| strassen | StrasseGIS41[] | Array der vorhandenen Straßen. | |
| Datentyp: SuchergebnisPerson [Inhaltsverzeichnis] | |||
| Suchergebnis mit Personen. Erweitert den Datentyp Suchergebnis. | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| ergebnisstatus | String |
Ergebnisstatus (fett) der Anfrage (teilweise nach XMeld):
00 Leistung wurde erbracht |
ja |
| ergebnistext | String | Der Text zum Ergebnisstatus (Leistung wurde erbracht, ..). | ja |
| zusatzinformationen | String | Zusätzliche Informationen über das Suchergebnis. Dies könnte z.B. eine genauere Fehlerbeschreibung oder die maximale Anzahl der zulässigen Treffer sein. | |
| version | String | Version des MesoWebService | ja |
| zeitpunkt | String | Textuelle Darstellung des Antwortzeitpunktes im Format TT.MM.JJJJ HH:MM:SS | |
| personen | Person[] | Array der gefundenen Personen. | |
| Datentyp: SuchergebnisPerson41 [Inhaltsverzeichnis] | |||
| Suchergebnis mit Personen. Erweitert den Datentyp Suchergebnis. | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| ergebnisstatus | String |
Ergebnisstatus (fett) der Anfrage (teilweise nach XMeld):
00 Leistung wurde erbracht |
ja |
| ergebnistext | String | Der Text zum Ergebnisstatus (Leistung wurde erbracht, ..). | ja |
| zusatzinformationen | String | Zusätzliche Informationen über das Suchergebnis. Dies könnte z.B. eine genauere Fehlerbeschreibung oder die maximale Anzahl der zulässigen Treffer sein. | |
| version | String | Version des MesoWebService | ja |
| zeitpunkt | String | Textuelle Darstellung des Antwortzeitpunktes im Format TT.MM.JJJJ HH:MM:SS | ja |
| personen | Person41[] | Array der gefundenen Personen. | |
| Datentyp: SuchergebnisAdressen [Inhaltsverzeichnis] | |||
| Suchergebnis mit Adressen (=Gebiet). Erweitert den Datentyp Suchergebnis. | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| ergebnisstatus | String |
Ergebnisstatus (fett) der Anfrage (teilweise nach XMeld):
00 Leistung wurde erbracht |
ja |
| ergebnistext | String | Der Text zum Ergebnisstatus (Leistung wurde erbracht, ..). | ja |
| zusatzinformationen | String | Zusätzliche Informationen über das Suchergebnis. Dies könnte z.B. eine genauere Fehlerbeschreibung oder die maximale Anzahl der zulässigen Treffer sein. | |
| version | String | Version des MesoWebService | ja |
| zeitpunkt | String | Textuelle Darstellung des Antwortzeitpunktes im Format TT.MM.JJJJ HH:MM:SS | |
| adressen | Adresse[] | Adressen. Diese stellen ein Gebiet dar. | |
| Datentyp: SuchergebnisAdressen41 [Inhaltsverzeichnis] | |||
| Suchergebnis mit Adressen (=Gebiet). Erweitert den Datentyp Suchergebnis. | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| ergebnisstatus | String |
Ergebnisstatus (fett) der Anfrage (teilweise nach XMeld):
00 Leistung wurde erbracht |
ja |
| ergebnistext | String | Der Text zum Ergebnisstatus (Leistung wurde erbracht, ..). | ja |
| zusatzinformationen | String | Zusätzliche Informationen über das Suchergebnis. Dies könnte z.B. eine genauere Fehlerbeschreibung oder die maximale Anzahl der zulässigen Treffer sein. | |
| version | String | Version des MesoWebService | ja |
| zeitpunkt | String | Textuelle Darstellung des Antwortzeitpunktes im Format TT.MM.JJJJ HH:MM:SS | |
| adressen | Adresse41[] | Adressen. Diese stellen ein Gebiet dar. | |
| Datentyp: SuchergebnisEinteilungen [Inhaltsverzeichnis] | |||
| Suchergebnis mit den Namen der vorhandenen Einteilungen. Erweitert den Datentyp Suchergebnis. | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| ergebnisstatus | String |
Ergebnisstatus (fett) der Anfrage (teilweise nach XMeld):
00 Leistung wurde erbracht |
ja |
| ergebnistext | String | Der Text zum Ergebnisstatus (Leistung wurde erbracht, ..). | ja |
| zusatzinformationen | String | Zusätzliche Informationen über das Suchergebnis. Dies könnte z.B. eine genauere Fehlerbeschreibung oder die maximale Anzahl der zulässigen Treffer sein. | |
| version | String | Version des MesoWebService | ja |
| zeitpunkt | String | Textuelle Darstellung des Antwortzeitpunktes im Format TT.MM.JJJJ HH:MM:SS | |
| einteilungen | Einteilung[] | Die gefundenen Einteilungen. | |
| Datentyp: SuchergebnisGebietsNamen [Inhaltsverzeichnis] | |||
| Suchergebnis mit den Namen beriets vorhandener Gebiete. Erweitert den Datentyp Suchergebnis. | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| ergebnisstatus | String |
Ergebnisstatus (fett) der Anfrage (teilweise nach XMeld):
00 Leistung wurde erbracht |
ja |
| ergebnistext | String | Der Text zum Ergebnisstatus (Leistung wurde erbracht, ..). | ja |
| zusatzinformationen | String | Zusätzliche Informationen über das Suchergebnis. Dies könnte z.B. eine genauere Fehlerbeschreibung oder die maximale Anzahl der zulässigen Treffer sein. | |
| version | String | Version des MesoWebService | ja |
| zeitpunkt | String | Textuelle Darstellung des Antwortzeitpunktes im Format TT.MM.JJJJ HH:MM:SS | |
| gebietsNamen | String[] | Namen der gefundenen Gebiete. | |
Adressen
| Datentyp: Ort [Inhaltsverzeichnis] | |||
| Bei der Verwendung des Ortes als Suchoption, müssen Schlüssel und/oder der Name angegeben werden. | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| schluessel | int | Interner HSH-Schlüssel (OM) des Ortes. | |
| name | String | Name des Ortes. | |
| ags | String | Der allgemeine Gemeindeschlüssel (acht Stellen). | |
| Datentyp: OrtGIS [Inhaltsverzeichnis] | |||
| Bei der Verwendung des Ortes als Suchoption, müssen Schlüssel, externer Schlüssel und/oder der Name angegeben werden. OrtGIS ist eine Erweiterung vom Datentyp Ort. | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| schluessel | int | Interner HSH-Schlüssel (OM) des Ortes. | |
| extSchluessel | int | Externer Schlüssel für grafische Informationssysteme. In der Verzeichnisarbeit von MESO existiert ein Mapping von diesem Schlüssel auf HSH-Schlüssel. | |
| name | String | Name des Ortes. | ja |
| ags | String | Der allgemeine Gemeindeschlüssel (acht Stellen). | |
| Datentyp: OrtGIS41 [Inhaltsverzeichnis] | |||
|
Bei der Verwendung des Ortes als Suchoption, müssen Schlüssel, externer Schlüssel und/oder der
Name angegeben werden. OrtGIS41 ist eine Erweiterung vom Datentyp Ort. Im Gegensatz zu OrtGIS ist hier der externe Schlüssel von Type String. |
|||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| schluessel | int | Interner HSH-Schlüssel (OM) des Ortes. | |
| extSchluessel | String | Externer Schlüssel für grafische Informationssysteme. In der Verzeichnisarbeit von MESO existiert ein Mapping von diesem Schlüssel auf HSH-Schlüssel. | |
| name | String | Name des Ortes. | ja |
| ags | String | Der allgemeine Gemeindeschlüssel (acht Stellen). | |
| Datentyp: Strasse [Inhaltsverzeichnis] | |||
| Bei der Verwendung der Straße als Suchoption, müssen Schlüssel und/oder der Name angegeben werden. | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| schluessel | int | Interner HSH-Schlüssel (OM) der Strasse. | |
| name | String | Name der Strasse. | ja |
| Datentyp: StrasseGIS [Inhaltsverzeichnis] | |||
| Bei der Verwendung der Straße als Suchoption, müssen Schlüssel, externer Schlüssel und/oder der Name angegeben werden. StrasseGIS ist eine Erweiterung vom Datentyp Strasse. | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| schluessel | int | Interner HSH-Schlüssel (OM) der Strasse. | |
| extSchluessel | int | Externer Schlüssel für grafische Informationssysteme. In der Verzeichnisarbeit von MESO existiert ein Mapping von diesem Schlüssel auf HSH-Schlüssel. | |
| name | String | Name der Strasse. | ja |
| Datentyp: StrasseGIS41 [Inhaltsverzeichnis] | |||
|
Bei der Verwendung der Straße als Suchoption, müssen Schlüssel, externer Schlüssel und/oder
der Name angegeben werden. StrasseGIS41 ist eine Erweiterung vom Datentyp Strasse. Im Gegensatz zu StrasseGIS ist der externe Schlüssel vom Typ String. |
|||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| schluessel | int | Interner HSH-Schlüssel (OM) der Straße. | |
| extSchluessel | String | Externer Schlüssel für grafische Informationssysteme. In der Verzeichnisarbeit von MESO existiert ein Mapping von diesem Schlüssel auf HSH-Schlüssel. | |
| name | String | Name der Straße. | ja |
| Datentyp: Adresse [Inhaltsverzeichnis] | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| ort | OrtGIS | Informationen zum Ort. | ja |
| strasse | StrasseGIS | Informationen zu Straße. | ja |
| hausnummer | int | Hausnummer der Adresse. | ja |
| alpha | String | Alphateil der Hausnummer. | |
| exakt | boolean | Gibt an, ob bei nicht angegebenem Alphateil nur nach de Anschrift ohne Alphateil gesucht werden soll, sonst beliebiger Alphateil. Diese Angabe ist nur bei Verwendung als Suchoption sinnvoll. | ja |
| Datentyp: Adresse41 [Inhaltsverzeichnis] | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| ort | OrtGIS41 | Informationen zum Ort. | ja |
| strasse | StrasseGIS41 | Informationen zu Straße. | ja |
| hausnummer | int | Hausnummer der Adresse. | ja |
| alpha | String | Alphateil der Hausnummer. | |
| exakt | boolean | Gibt an, ob bei nicht angegebenem Alphateil nur nach de Anschrift ohne Alphateil gesucht werden soll, sonst beliebiger Alphateil. Diese Angabe ist nur bei Verwendung als Suchoption sinnvoll. | ja |
| Datentyp: Wohnungsart [Inhaltsverzeichnis] | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| schluessel | String |
Schlüssel der Wohnungsart: AW Alleinige Wohnung HAW Hauptwohnung NEW Nebenwohnung AMW Abmeldung nach RMW Rückmeldewohnung FHW frühere Hauptwohnung ZZW Zuzug von FNW frühere Nebenwohnung AAHW Abmeldung von Amts wegen (HAW) AANW Abmeldung von Amts wegen (NEW) FAMW frühere Abmeldewohnung FRMW frühere Rückmeldewohnung FZZW frühere Zuzugswohnung LWID letzte Wohnung in Deutschland vor Wegzug ins Ausland RMWZA Rückmeldewohnung nach Wiederzuzug aus dem Ausland FRWZA frühere Rückmeldewohnung nach Wiederzuzug aus dem Ausland WDB Wohnung der Beschäftigung |
|
| text | String | Textuelle Beschreibung der Wohnungsart (z.B. Hauptwohnung oder Nebenwohnung). | |
| Datentyp: Wohnung [Inhaltsverzeichnis] | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| art | Wohnungsart | Art der Wohnung (Hauptwohnung, Nebenwohnung, ..) | ja |
| ort | Ort | Ort der Wohnung. | ja |
| strasse | Strasse | Straße der Wohnung. | ja |
| postleitzahl | String | Postleitzahl der Wohnung. | |
| hausnummer | int | Hausnummer der Wohnung. | |
| alpha | String | Alphateil der Hausnummer der Wohnung. | |
| hausnummerzusatz | String | Zusatz zur Hausnummer. | |
| land | Staatsangehoerigkeit | Land für Wohnungen im Ausland. | |
| einzugsdatum | String | Das Einzugsdatum der Wohnung im Format TT.MM.JJJJ. | |
| auszugsdatum | String | Das Auszugsdatum der Wohnung im Format TT.MM.JJJJ. | |
| nummer | String | Nummer der Wohnung. | |
| Datentyp: Wohnung41 [Inhaltsverzeichnis] | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| art | Wohnungsart | Art der Wohnung (Hauptwohnung, Nebenwohnung, ..) | ja |
| ort | OrtGIS41 | Ort der Wohnung mit optionalen externen Ortsschlüsseln. | ja |
| strasse | StrasseGIS41 | Straße der Wohnung mit optionalen externen Straßenschlüsseln. | ja |
| postleitzahl | String | Postleitzahl der Wohnung. | |
| hausnummer | int | Hausnummer der Wohnung. -1, wenn keine Hausnummer vorhanden ist. | |
| alpha | String | Alphateil der Hausnummer der Wohnung. | |
| hausnummerzusatz | String | Zusatz zur Hausnummer. | |
| adresszusatz | String | Adresszusatz. | |
| land | Staatsangehoerigkeit | Land für Wohnungen im Ausland. | |
| einzugsdatum | String | Das Einzugsdatum der Wohnung im Format TT.MM.JJJJ. | |
| auszugsdatum | String | Das Auszugsdatum der Wohnung im Format TT.MM.JJJJ. | |
| nummer | String | Nummer der Wohnung. | |
| anmeldedatum | String | Das Anmeldedatum der Wohnung im Format TT.MM.JJJJ. | |
| abmeldedatum | String | Das Abmeldedatum der Wohnung im Format TT.MM.JJJJ. | |
| wohnungsgeber | String | Der Wohnungsgeber, -eigentümer. | |
| angemeldetVAW | boolean | Gibt an, ob die Wohnung von Amts wegen angemeldet wurde. | |
| abgemeldetVAW | boolean | Gibt an, ob die Wohnung von Amts wegen abgemeldet wurde. | |
| innerhalb | boolean | Gibt an, ob die Wohnung sich innerhalb der Gemeinde befindet. | |
| Datentyp: Einteilung [Inhaltsverzeichnis] | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| nummer | int | Eindeutige Nummer der Einteilung. | ja |
| name | String | Name der Einteilung. | ja |
Dokumente
| Datentyp: Dokumentenart [Inhaltsverzeichnis] | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| schluessel | int | Schlüssel der Dokumentenart. | ja |
| text | String | Textuelle Darstelung der Dokumentenart (z.B. Personalausweis). | ja |
| Datentyp: Dokument [Inhaltsverzeichnis] | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| art | Dokumentenart | Art des Dokumentes. | ja |
| behoerde | String | Die austellende Behörde des Dokumentes. | |
| nummer | String | Die Dokumentennummer. | |
| ausstellungsdatum | String | Datum der Ausstellung des Dokumentes im Format TT.MM.JJJJ. | |
| gueltigkeitsdatum | String | Datum der Gültigkeit des Dokumentes im Format TT.MM.JJJJ. | |
Personendaten
| Datentyp: Person [Inhaltsverzeichnis] | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| eom | long | Eindeutige Nummer (EOM) der Person. | |
| name | Name | Familienname der Person. | |
| rufname | String | Rufname der Person. | |
| vornamen | String | Alle aktuellen Vornamen der Person. | |
| geburtsname | Name | Der Geburtsname der Person. | |
| geschlecht | String | Geschlecht der Person (M=männlich, W=weiblich, X oder 1 =unbekannt). | |
| status | String | Meldestatus der Person (A=aktiv, G=verstorben, V=verzogen). | |
| geburtsdaten | Geburtsdaten | Daten zur Geburt der Person (Datum, Behörde, ..) | |
| sterbedaten | Sterbedaten | Daten zum Sterbefall. | |
| familienstand | Familienstand | Familienstand der Person (verheiratet, geschieden, ..). | |
| sperren | List<Sperre> | Auskunfts- und Übermittlungssperren der Person | |
| kennzDeutscherAuslaender | String | D=Deutscher, A=Ausländer, EU=EU-Bürger, EU+D=EU-Bürger und Deutscher | |
| staatsangehoerigkeiten | List<Staatsangehoerigkeit> | Staatsangehörigkeiten der Person. | |
| titel | List<String> | Doktortitel der Person. | |
| religion | Religion | Religion der Person. | |
| wohnungen | List<Wohnung> | Wohnungen der Person. | |
| datumEheschliessung | String | Datum der letzten Eheschließung im Format TT.MM.JJJJ. | |
| datumBeendigungLetzteEhe | String | Datum der Beendigung der letzten Ehe der Person im Format TT.MM.JJJJ. | |
| ehepartner | Person | Der Ehepartner der Person. Es ist nur die eindeutige Nummer (EOM) der Person enthalten. | |
| vater | Person | Der Vater der Person. Es ist nur die eindeutige Nummer (EOM) der Person enthalten. | |
| mutter | Person | Die Mutter der Person. Es ist nur die eindeutige Nummer (EOM) der Person enthalten. | |
| kinder | List<Person> | Kinder der Person. Es ist pro Person nur die eindeutige Nummer (EOM) enthalten. | |
| dokumente | List<Dokument> | Liste der Dokumente der Person. | |
| Datentyp: Person41 [Inhaltsverzeichnis] | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| eom | long | Eindeutige Nummer (EOM) der Person. | |
| exteom | String | Eindeutige Nummer (EOM) der Person aus einem Altverfahren. | |
| name | Name | Der aktuelle Familienname der Person. | |
| rufname | String | Der aktuelle Rufname der Person. | |
| vornamen | String | Alle aktuellen Vornamen der Person. | |
| geburtsname | Name | Der Geburtsname der Person. | |
| geschlecht | String | Geschlecht der Person (M=männlich, W=weiblich, X oder 1 =unbekannt). | |
| status | String | Meldestatus der Person (A=aktiv, G=verstorben, V=verzogen). | |
| geburtsdaten | Geburtsdaten | Daten zur Geburt der Person (Datum, Behörde, ..) | |
| sterbedaten | Sterbedaten | Daten zum Sterbefall. | |
| familienstand | Familienstand | Familienstand der Person (verheiratet, geschieden, ..). | |
| sperren | List<Sperre> | Auskunfts- und Übermittlungssperren der Person | |
| kennzDeutscherAuslaender | String | D=Deutscher, A=Ausländer, EU=EU-Bürger, EU+D=EU-Bürger und Deutscher | |
| staatsangehoerigkeiten | List<Staatsangehoerigkeit> | Staatsangehörigkeiten der Person. | |
| titel | List<String> | Doktortitel der Person. | |
| religion | Religion | Religion der Person. | |
| wohnungen | List<Wohnung41> | Wohnungen der Person. | |
| datumEheschliessung | String | Datum der letzten Eheschließung im Format TT.MM.JJJJ. | |
| datumBeendigungLetzteEhe | String | Datum der Beendigung der letzten Ehe der Person im Format TT.MM.JJJJ. | |
| ehepartner | Person41 | Der Ehepartner der Person. Es ist nur die eindeutige Nummer (EOM) der Person enthalten. | |
| vater | Person41 | Der Vater der Person. Es ist nur die eindeutige Nummer (EOM) der Person enthalten. | |
| mutter | Person41 | Die Mutter der Person. Es ist nur die eindeutige Nummer (EOM) der Person enthalten. | |
| kinder | List<Person41> | Alle Kinder der Person. Es ist pro Person nur die eindeutige Nummer (EOM) enthalten. | |
| dokumente | List<Dokument> | Dokumente der Person. | |
| fruehereNamen | List<Name41> | Frühere Namen der Person. | |
| weitereNamen | List<Name41> | Weitere Namen der Person. | |
| weitereGesetzlicheVertreter | List<GesetzlicherVertreter> | Weitere gesetzliche Vertreter der Person neben den evtl. vorhandenen Eltern. | |
| wahlrechtsausschluesse | List<Wahlrechtsausschluss> | Wahlrechtsausschlüsse der Person. | |
| waffenerlaubnisse | List<Waffenerlaubnis> | Waffenrechtliche Erlaubnisse der Person. | |
| sprengstofferlaubnisse | List<Sprengstofferlaubnis> | Sprengstofferlaubnisse der Person. | |
| eu | String | Kennzeichnet die EU-Bürgerschaft der Person. | |
| Datentyp: Familienstand [Inhaltsverzeichnis] | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| schluessel | int |
Eindeutiger Schlüssel des Familienstandes: 0: ledig 1: verheiratet 2: verwitwet 3: geschieden oder Ehe aufgehoben 4: getrennt lebend 5: verheiratet-Ehegatte im Ausland lebend 6: unbekannt 7: verheiratet-Eheg. n. uneingeschr. Steuerpfl. 8: verheiratet-Ehegatte vermißt 9: Lebenspartnerschaft 10: Lebenspartnerschaft aufgehoben 11: Lebenspartner verstorben |
ja |
| text | String | Textuelle Beschreibung des Familienstandes (z.B. ledig). | ja |
| kurform | String |
Kurzform des Familienstandes. Dieser teilt die Familienstände grob ein: LD: ledig VH: verheiratet VW: verwitwet GS: geschieden oder Ehe aufgehoben VH: getrennt lebend VH: verheiratet-Ehegatte im Ausland lebend FU: unbekannt VH: verheiratet-Eheg. n. uneingeschr. Steuerpfl. VH: verheiratet-Ehegatte vermißt LP: Lebenspartnerschaft LA: Lebenspartnerschaft aufgehoben LV: Lebenspartner verstorben |
ja |
| Datentyp: Geburtsdaten [Inhaltsverzeichnis] | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| geburtsdatum | String | Das Geburtsdatum der Person im Format TT.MM.JJJJ. | |
| geburtsort | String | Der Geburtsort der Person. | |
| geburtsland | String | Das Geburtsland der Person, falls nicht Deutschland. | |
| aktenzeichen | String | Das Aktenzeichen der Geburt. | |
| behoerde | String | Die Behörde der Geburt. | |
| Datentyp: Name [Inhaltsverzeichnis] | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| name | String | Der Name. | ja |
| namenszusatz | String | Namenszusatz zum Namen (z.B. 'von'). | |
|
Datentyp: Name41
[Inhaltsverzeichnis] Erweitert den Datentyp Name. |
|||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| name | String | Der Name. | ja |
| namenszusatz | String | Namenszusatz zum Namen (z.B. 'von'). | |
| art | Art | Art des Namens. | ja |
|
Datentyp: Art
[Inhaltsverzeichnis] Kennzeichnet allgemein eine Art im MesoWebService4.1, z.B. die Art des früheren oder weiteren Namens.. |
|||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| schluessel | int | Eindeutiger Schlüssel der Art. | ja |
| text | String | Textuelle Repräsentation der Art. | ja |
| Folgende Arten sind bekannt: | |||
|
Arten früherer Namen: 0 Geburtsname 1 früherer Name 2 frühere Vornamen 3 früherer Rufname 4 früherer Geburtsname Arten weiterer Namen: 1 Ehename 2 Ordensname 3 Künstlername 4 Lebenspartnerschaftsname 5 Passname |
Arten gesetzlicher Vertreter: 0 Pflegevater 1 Pflegemutter 2 andere natürliche g.V. 3 Betreuer (nat. Person) 4 Vater außerhalb 5 Mutter außerhalb 6 Vater (Sorgerecht) 7 Mutter (Sorgerecht) 8 andere juristische g.V. 9 Betreuer (jur. Person) |
Arten der Sprengstofferlaubnis: 0 unbekannt 1 sprengstoffr. Erl. nach §7 SprengG (gewerbl.) 2 Befähigungsschein nach §20 SprengG 3 sprengstoffr. Erl. nach §27 SprengG (nicht gew.) Art der Waffenerlaubnis: 0 unbekannt 1 Waffenschein 2 kleiner Waffenschein 3 Waffenbesitzkarte 4 Europäischer Feuerwaffenpass 5 sonstiges |
Arten des Wahlrechtsausschlusses. 1 Ausschluss vom Wahlrecht 2 Ausschluss nur von der Wählbarkeit 3 keine Wahlrechtsbescheinigung |
| Datentyp: Religion [Inhaltsverzeichnis] | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| schluessel | int | Eindeutiger Schlüssel der Religion. | |
| text | String | Textuelle Beschreibung der Religion. | |
| kurzform | String | ||
| Datentyp: Sperre [Inhaltsverzeichnis] | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| nummer | String | Eindeutige Nummer der Sperre. | ja |
| text | String | Textuelle Beschreibung der Sperre. | |
| auskunftssperre | boolean | Gibt an, ob es sich um eine Auskunftssperre handelt, sonst Übermittlungssperre. | ja |
| von | String | Anfangsdatum der Sperre im Format TT.MM.JJJJ. | |
| bis | String | Datum, an welchem die Sperre endet. Format TT.MM.JJJJ. | |
| Datentyp: Staatsangehoerigkeit [Inhaltsverzeichnis] | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| kennzeichen | String | Staatenkennzeichen. | |
| text | String | Textuelle Darstellung der Staatsangehörigkeit. | |
| adjektiv | String | Adjektiv zur Staatsangehörigkeit (z.B. griechisch). | |
| Datentyp: Sterbedaten [Inhaltsverzeichnis] | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| sterbetag | String | Sterbetag im Format TT.MM.JJJJ. | |
| ort | String | Ort | |
| aktenzeichen | String | Aktenzeichen des Sterbefalls. | |
| behoerde | String | Bearbeitende Behörde des Sterbefalls. | |
| Datentyp: GesetzlicherVertreter [Inhaltsverzeichnis] | |||
| Ein gesetzlicher Vertreter im MesoWebService4.1. | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| art | Art | Die Art des gesetzlichen Vertreters. | ja |
| vertreter | Person41 | Die Personendaten zum gesetzlichen Vertreter. | ja |
| Datentyp: Sprengstofferlaubnis [Inhaltsverzeichnis] | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| art | Art | Die Art der Sprengstofferlaubnis. | ja |
| anmeldedatum | String | Das Datum der Anmeldung im Format TT.MM.JJJJ. | |
| abmeldedatum | String | Das Datum der Abmeldung im Format TT.MM.JJJJ. | |
| anmeldeaktenzeichen | String | Das Aktenzeichen der Anmeldung. | |
| abmeldeaktenzeichen | String | Das Aktenzeichen der Abmeldung. | |
| anmeldebehoerde | String | Die Behörde der Anmeldung. | |
| abmeldebehoerde | String | Die Behörde der Abmeldung. | |
| Datentyp: Waffenerlaubnis [Inhaltsverzeichnis] | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| art | Art | Die Art der Waffenerlaubnis. | ja |
| anmeldedatum | String | Das Datum der Anmeldung im Format TT.MM.JJJJ. | |
| abmeldedatum | String | Das Datum der Abmeldung im Format TT.MM.JJJJ. | |
| anmeldeaktenzeichen | String | Das Aktenzeichen der Anmeldung. | |
| abmeldeaktenzeichen | String | Das Aktenzeichen der Abmeldung. | |
| anmeldebehoerde | String | Die Behörde der Anmeldung. | |
| abmeldebehoerde | String | Die Behörde der Abmeldung. | |
| Datentyp: Wahlrechtsausschluss [Inhaltsverzeichnis] | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| aktiv | boolean | Gibt an, ob es sich um den Ausschluss vom aktiven Wahlrecht handelt, sonst passiv. | ja |
| art | Art | Die Art des Ausschlusses vom Wahlrecht. | ja |
| behoerde | String | Behörde. | |
| aktenzeichen | String | Aktenzeichen. | |
| bis | String | Gültigkeit im Format TT.MM.JJJJ. | |
| Datentyp: Mandant [Inhaltsverzeichnis] | |||
| interner Name | Datentyp | Beschreibung | Pflichtfeld |
| nummer | int | Eindeutige Nummer des Mandanten | ja |
| name | String | Name des Mandanten. | |