SlideShare ist ein Scribd-Unternehmen logo
1 von 42
Downloaden Sie, um offline zu lesen
Registerportal
Feinkonzept „Verwaltungsschnittstelle“
(Webservice für öffentliche Bedarfsträger)
Hagen, 15.Juli 2022
Seite 2 / 42
Änderungshistorie
Nr. Datum Version Änderungsgrund durchgeführt von
1 11.08.2021 0.1 Neuanlage Heike Potter
2 27.08.2021 0.2 Überarbeitung Heike Potter
3 23.09.2021 0.3 Einarbeitung von Ver-
besserungsvorschlägen
Heike Potter
4 21.10.2021 0.4 Einarbeitung weiterer
Verbesserungsvorschläge
Heike Potter
5 13.12.2021 0.5 Neue Methode: Suche mit
Städtenamen anstelle des
Gerichtskennzeichens und
Ermittlung von Gerichten
Heike Potter
6 11.01.2022 0.6 Registernummer ohne OKZ Heike Potter
7 21.01.2022 0.7 Länderkürzel ergänzt bei
registerdaten_per_akz_mit_stadt
und gerichte
Heike Potter
8 04.04.2022 0.8 Angabe von Längen und
Pflichtfelder der Rückgabewerten
Heike Potter
9 12.05.2022 0.9 Felder der Indexerweiterung
hinzugefügt, neuer http-Status 230,
falls eine Abrufsperre für das SI-
Dokument vorliegt, Statistikdaten
pro User, kleinere Korrekturen
eingepflegt
Heike Potter
10 30.06.2022 0.10 Erweiterung für das
Ortskennzeichen, Wertelist für die
Rechtsform hinzugefügt
Heike Potter
11 15.07.2022 0.11 Erweiterung der Struktur Error, bei
http-Status 404/409 mögliche
Angabe eines Choice Elementes.
Heike Potter
Seite 3 / 42
Seite 4 / 42
Inhaltsverzeichnis
1 Einführung...................................................................................................................... 7
2 Anforderungen ............................................................................................................... 8
2.1 Eindeutige Ergebnisse ............................................................................................ 8
2.2 Datenmenge ........................................................................................................... 8
2.3 SI ............................................................................................................................ 8
2.4 Statistik ................................................................................................................... 8
2.5 Benutzeridentifizierung............................................................................................ 8
2.6 Fehlerbehandlung ................................................................................................... 8
3 Webservice .................................................................................................................... 9
3.1 Identifizierung eines eindeutigen Rechtsträgers ...................................................... 9
3.2 Verhalten bei nicht eindeutiger Identifizierung eines Rechtsträgers......................... 9
3.3 Flag zur Anforderung des „Strukturierten Inhalts“ (SI) ............................................10
3.4 Definition der Inhalte aus den Indexdaten, die übertragen werden .........................10
4 Schnittstellendefinition...................................................................................................11
4.1 Strukturen ..............................................................................................................11
4.1.1 Dokument........................................................................................................12
4.1.2 Historien..........................................................................................................15
4.1.3 Pseudonyme ...................................................................................................15
4.1.4 Zweigniederlassungen ....................................................................................16
4.1.5 Vertretungsberechtigte....................................................................................16
4.1.6 GerichtStadtZuordnungen ...............................................................................17
4.1.6.1 altGerichtStadt.............................................................................................17
4.1.6.2 gerichtStadt .................................................................................................18
4.1.7 Error................................................................................................................18
4.1.8 Choices...........................................................................................................18
4.1.9 Echo................................................................................................................19
4.2 Methoden...............................................................................................................19
4.2.1 Echo................................................................................................................19
4.2.1.1 http-Methode GET .......................................................................................19
4.2.1.2 Pfad „/echo“.................................................................................................19
Seite 5 / 42
4.2.1.3 Input ............................................................................................................19
4.2.1.4 Header.........................................................................................................20
4.2.1.5 Output..........................................................................................................20
4.2.1.6 Beispiel........................................................................................................20
4.2.2 Anmeldung......................................................................................................21
4.2.2.1 http-Methode POST.....................................................................................21
4.2.2.2 Pfad „/authentication“...................................................................................21
4.2.2.3 Header (Input) .............................................................................................21
4.2.2.4 Output..........................................................................................................21
4.2.2.5 Header (Output)...........................................................................................22
4.2.2.6 Beispiele......................................................................................................23
4.2.3 Zugriff über Euid..............................................................................................24
4.2.3.1 http-Methode GET .......................................................................................24
4.2.3.2 Pfad „/registerdaten_per_euid“ ....................................................................24
4.2.3.3 Input ............................................................................................................24
4.2.3.4 Header (Input) .............................................................................................25
4.2.3.5 Output..........................................................................................................25
4.2.4 Zugriff über Registerart/Registernummer/Gerichtskennzeichen ......................27
4.2.4.1 http-Methode GET .......................................................................................27
4.2.4.2 Pfad „/registerdaten_per_aktenzeichen“ ......................................................27
4.2.4.3 Input ............................................................................................................27
4.2.4.4 Header (Input) .............................................................................................28
4.2.4.5 Output..........................................................................................................28
4.2.4.6 Beispiel........................................................................................................30
4.2.5 Zugriff über Registerart/Registernummer/Gericht-Städtenamen/Länderkürzel 30
4.2.5.1 http-Methode GET .......................................................................................30
4.2.5.2 Pfad „/registerdaten_per_akz_mit_stadt“ .....................................................31
4.2.5.3 Input ............................................................................................................31
4.2.5.4 Header (Input) .............................................................................................32
4.2.5.5 Output..........................................................................................................32
4.2.5.6 Beispiel........................................................................................................34
4.2.6 Ausgabe von Gerichten und den zugehörigen Städtenamen...........................34
Seite 6 / 42
4.2.6.1 http-Methode GET .......................................................................................34
4.2.6.2 Pfad „/gerichte“............................................................................................35
4.2.6.3 Header (Input) .............................................................................................35
4.2.6.4 Output..........................................................................................................35
4.2.6.5 Beispiel........................................................................................................36
4.2.7 OPTIONS........................................................................................................36
4.2.7.1 http-Methode OPTIONS ..............................................................................36
4.2.7.2 Pfad „/options“ .............................................................................................37
4.2.7.3 Output..........................................................................................................37
4.2.7.4 Header (output) ...........................................................................................37
4.2.7.5 Beispiel........................................................................................................37
5 Ortskennzeichen ...........................................................................................................38
6 Wertelisten ....................................................................................................................39
6.1 Rechtsform.............................................................................................................39
7 Logging .........................................................................................................................40
8 Statistik .........................................................................................................................41
9 Registrierung zur Nutzung des Dienstes .......................................................................41
9.1 Registrierung..........................................................................................................41
9.2 Speicherung der Nutzer in der Datenbank..............................................................41
10 Notwendige Erweiterung der Infrastruktur..................................................................42
Seite 7 / 42
1 Einführung
Im Rahmen der Aktivitäten zur Umsetzung des OZG wird das Registerportal um eine
maschinelle Schnittstelle erweitert.
Die Schnittstelle wird einheitlich für Nutzer bereitgestellt, die bereits heute kostenfrei auf das
Registerportal zugreifen dürfen. Nutzer können Verwaltungsfachverfahren oder Onlineportale
sein, die Anträge zur Dateneinlieferung in ein Fachverfahren entgegennehmen. Es handelt
sich bei der Verwaltungsschnittstelle um die vollautomatische Bereitstellung einer
klassischen Querschnittsleistung. Registrierte Unternehmensträger benötigen bei
Antragstellungen üblicherweise einen aktuellen Handelsregisterausdruck, um ihre Existenz
und ihre rechtlichen Verhältnisse, wie etwa Vertretungsbefugnisse, nachweisen zu können.
Dieser Nachweis soll zukünftig nicht extra durch das antragstellende Unternehmen
beigebracht werden, sondern automatisiert im Antragsverfahren oder bei der
Antragsbearbeitung elektronisch beschafft werden. Wie die Umsetzung in dem einzelnen
Verwaltungsverfahren erfolgt, ist dem jeweiligen Träger der Verwaltungsleistung vorbehalten.
Trägern öffentlicher Verwaltungen werden Informationen aus dem Registerportal über eine
vollautomatische Verwaltungsschnittstelle in Form eines Webservice bereitgestellt. Der
Webservice wird so ausgestaltet, dass an der Schnittstelle Anfragen zugelassen werden, die
eine eindeutige Identifizierung eines bestimmten Rechtsträgers ermöglichen. Aus dem
Registerportal wird sodann eine Datei mit fest definierten Inhalten und in einer einheitlichen
Datenstruktur geliefert. Dabei handelt es sich um Indexdaten, die aus dem Registerportal
stammen, sowie einen maschinenlesbaren strukturierten Registerabdruck (SI).
Der Strukturierte Registerinhalt (SI) ist eine XML Datei, die alle Informationen eines Aktuellen
Abdrucks aus dem Handelsregister beinhaltet. Diese Datei wird aus dem Handelsregister-
Fachverfahren des Bundeslandes des registerführenden Gerichts abgerufen.
Die Verwaltungsschnittstelle wird durch Anpassung der bestehenden Funktionalität der
kostenlosen Abrufe für Sondernutzer realisiert. Detailanpassungen an der bisherigen
Nutzerdatenbank sind notwendig.
Die Registrierung und Freigabe der Nutzung der Verwaltungsschnittstelle erfolgt auf Antrag
eines Nutzers über die Servicestelle. Dabei wird für die Erfassung der erforderlichen
Kontaktdaten die bestehende Oberfläche zur Nutzerregistrierung genutzt. Die Servicestelle
prüft die Berechtigung und löst durch die Freigabe eine automatische Eintragung der für die
Nutzung der Verwaltungsschnittstelle erforderlichen Berechtigungen im Registerportal aus.
Alle notwendigen Schnittstellenbeschreibungen werden als Dokumente bei der Servicestelle
hinterlegt und können dort angefordert werden.
Seite 8 / 42
2 Anforderungen
2.1 Eindeutige Ergebnisse
Der Webservice liefert die Information für genau einen Unternehmensträger zurück. Führen
die vorgegebenen Daten nicht zu einem eindeutigen Ergebnis, wird dies als Fehler quittiert.
2.2 Datenmenge
Es werden die Daten zurück geliefert, die aktuell in der Indexdatenbank beim Registerportal
gespeichert sind. Auch als gelöscht markierte Rechtsträger werden zurückgegeben.
Firmendaten, die für die Suche gesperrt sind, werden dagegen nicht zurückgegeben.
2.3 SI
Bei jedem Aufruf der Verwaltungsschnittstelle kann zusätzlich der strukturierte Registerinhalt
„SI“ mit angefordert werden.
Ist der Abruf eines SI gewünscht, aber aufgrund einer Sperre nicht möglich, werden die
Unternehmensdaten ohne den SI zurückgegeben. Kommt es bei dem SI-Abruf aus den
Landesportalen zu Fehlern, werden die Daten ohne den SI übermittelt. Über den
Rückgabestatus kann identifiziert werden, ob der SI-Abruf erfolgreich war.
2.4 Statistik
Die Häufigkeit der Verwendung der Verwaltungsschnittstelle und deren Ergebnisse wird
statistisch nachgehalten.
2.5 Benutzeridentifizierung
Eine Authentifizierung ist erforderlich, es wird die Nutzerverwaltungsdatenbank der bereits
bestehenden Web-Anwendung des Registerportals verwendet. Weitere erforderliche
Anpassungen, um einen Benutzer das Recht zur Benutzung der Verwaltungsschnittstelle zu
geben, werden von der Servicestelle vorgenommen. Eine Anpassung der
Servicestellenfunktionalität ist erforderlich, um ein zusätzliches Recht zu vergeben.
2.6 Fehlerbehandlung
Fehlerbehandlung bzw. Logging sind erforderlich, um im Fehlerfall geeignete Informationen
zur Fehlerursache und deren Behebung zu haben.
Seite 9 / 42
3 Webservice
3.1 Identifizierung eines eindeutigen Rechtsträgers
Anfragen an die Verwaltungsschnittstelle müssen eine eindeutige Identifizierung eines
bestimmten Rechtsträgers zulassen. Zur eindeutigen Identifizierung sind die nachfolgend
aufgeführten Felder notwendig:
 Registerart
 Registernummer
 Registergericht
 Altgericht
oder:
 EUID
Das Altgericht ist erforderlich, weil Rechtsträger existieren, die sich bei gleicher Kombination
von Registergericht / Registerart / Registernummer nur durch das Altgericht eindeutig
zuordnen lassen. Abfragen ohne Altgerichtsangabe werden mit dem Eintrag ohne Altgericht
beantwortet. Wird jedoch auf eine Anfrage ohne Altgericht ein nicht eindeutiges Ergebnis
erzielt, wird dies als Fehler behandelt.
Als alternatives Identifikationsmerkmal dient die EUID, die wie die Suche ohne Altgericht
nicht unbedingt ein eindeutiges Ergebnis erzielt. Ein nicht eindeutiges Ergebnis bei der
Suche über die EUID wird als Fehler behandelt.
In einer späteren Version kann hier auch die zukünftige „bundeseinheitliche
Wirtschaftsnummer“ aus dem Basisregister verwendet werden.
Es können aktuelle und gelöschte Rechtsträger beauskunftet werden. Rechtsträger, die für
die Recherchesuche gesperrt sind, werden als „nicht gefunden“ behandelt.
3.2 Verhalten bei nicht eindeutiger Identifizierung eines Rechtsträgers
Anfragen an das Registerportal, die nicht eindeutig Identifiziert werden können, werden mit
einer Fehlermeldung beantwortet. Indexdaten oder der SI werden nicht übertragen.
Mögliche Fehlersituationen werden in diesem Dokument spezifiziert und die zugehörigen
Fehlermeldungen werden definiert.
Diese können z.B. auftreten, wenn
 Parameter nicht korrekt gefüllt sind
 der Rechtsträger nicht vorhanden ist
Seite 10 / 42
 die Suche nach einem Rechtsträger mit den vorgegebenen Suchparametern kein
eindeutiges Ergebnis liefert
3.3 Flag zur Anforderung des „Strukturierten Inhalts“ (SI)
Bei eindeutig identifiziertem Rechtsträger liefert der Webservice immer einen Auszug aus
den im Registerportal aktuell gespeicherten Daten (Indexdaten).
In der Anforderung kann ein Flag zur Auslieferung des Strukturierten Registerinhalts (SI)
gesetzt werden. Ist dieses Flag nicht gesetzt, erfolgt keine automatische Sendung des SI. Ist
dieses Flag gesetzt, wird der SI zusammen mit dem Auszug aus den Indexdaten geliefert.
Der SI wird jedoch nur zusätzlich abgerufen, wenn für das Dokument keine Sperre, weder
auf Länder- noch auf Dokumentenebene, vorliegt und in den Indexdaten hinterlegt ist, dass
ein SI existiert. Für eine gelöschte Firma SI wird versucht den SI abzurufen, sofern kein
Sperrvermerk gesetzt ist.
3.4 Definition der Inhalte aus den Indexdaten, die übertragen werden
Im Folgenden ist eine Aufzählung der Felder, die in dem bestehenden Index-Datenbank
Bestand zur Verfügung stehen und bei einer Anfrage zurückgeliefert werden:
- Firmenname
- Firmensitz
- EUID
- Rechtsform der Firma
- Aktenzeichen mit den Feldern Bundesland, Registerart, Registernummer und
Gerichtskennung
- Anschrift mit den Feldern Postleitzahl, Ort, Straße, Hausnummer, Postfach
- Großkunden-Anschrift mit den Feldern Postleitzahl, Ort
- Zusätzlich erfasste Firmenbezeichnungen (sog. Aliase oder Pseudonyme)
- Eintragungsdatum
- Bemerkungsfeld
- Kennzeichnung der Existenz der Dokumentart SI
- Historie der Änderungen von Firmennamen und Sitz
- Daten zu Zweigniederlassungen
- Status zum Rechtsträger: aktuell oder gelöscht
- Gegenstand des Rechtsträgers
- Geschäftszweck des Rechtsträgers
- Bundeseinheitliche Wirtschaftsnummer
- Angabe, ob bei einer Zweigniederlassung einer Kapitalgesellschaft ausländischen
Rechts die zugehörige Hauptniederlassung in einem an BRIS teilnehmenden Staat
registriert ist
Seite 11 / 42
- Vertretungsberechtige mit Nachname, Geburtsname, Vorname, Geburtsdatum und
Rollenbezeichnung
Die Daten werden so ausgeliefert, wie sie dem Registerportal von den Landesportalen
zur Speicherung geliefert wurden.
4 Schnittstellendefinition
Der Webservice ist in Java geschrieben und implementiert ein Rest-API. Die einzelnen
Services werden per URL/URI angesprochen. Die HTTP-Methoden (GET, POST, OPTIONS)
geben an, welche Operation ein Dienst ausführen soll. Die erfolgreiche Verarbeitung einer
Anfrage kann über den http-Statuscode verifiziert werden. Erforderliche Parameter sind in
UTF-8 anzugeben.
Die Url lautet: https://<IP_des_Produktivrechners>/rp_vss/api/vss
„<IP des Produktivrechners>“ ist ein Platzhalter für die eigentliche IP-Adresse oder den
Rechnernamen des Produktivrechners.
Beim Aufruf eines http-Requests können diverse http-Fehlermeldungen auftreten. In der
folgenden Beschreibung werden nicht alle möglichen http-Returnstatus beschrieben,
sondern nur die http-Returnwerte, die explizit auch von der Applikation gesetzt werden. D.h.
bei den Methoden werden Fehler, die auftreten, in http-Returncodes umgesetzt. Die weiteren
allgemeinen http-Statuscodes können in den einschlägigen Dokumentationen nachgelesen
werden. Interne, unerwartete Fehler, wie z.B. Nullpointer Exception oder unerwartete SQL-
Fehler werden in den http-Status 500 umgewandelt. In der Errormessage der „Error-Struktur“
kann eine genauere Erklärung stehen.
Die bei den Methoden dargestellten Beispiele zeigen die Benutzung von http, in der
produktiven Umgebung wird jedoch nur das https-Protokoll unterstützt werden.
4.1 Strukturen
Um die Rückgabewerte in den Methoden nicht mehrfach zu beschreiben, werden hier die
möglichen Strukturen beschrieben.
Ist der Datentyp Liste angegeben, kann die Struktur mehrfach vorkommen.
Feldnamen und Listen, die als Pflicht angegeben sind, sind mit Daten gefüllt, alle anderen
Felder/Listen können, aber müssen keine Daten enthalten.
Seite 12 / 42
4.1.1 Dokument
Feldname Datentyp Pflicht Kommentar Beispiel
firmenname String, max
Länge:3276
7
ja Name des
Rechtsträgers
Müller Blumengroßhandel
firmensitz String, max.
Länge: 255
ja Ort Solingen
EUID String, max.
Länge: 255
ja DER2402.HRA8639
rechtsform String, max.
Länge: 255
ja Bezeichnung der
Rechtsform
Aktiengesellschaft,
eingetragene
Genossenschaft etc.
aktenzeichen String, max.
Länge: 30
ja Setzt sich
zusammen aus
den bis zu 5
Feldern getrennt
durch einen „_“ :
Bundesland
Registerart
Registernummer
Gerichtskennzeic
hen_neu
Gerichtskennzeic
hen_alt (Optional)
NW_HRB_2739_R2402
HE_GnR_204_M1406_M14
01
postleitzahl String, max.
Länge:10
nein Teil der Anschrift 48485
ort String, max.
Länge: 255
nein Teil der Anschrift Neuenkirchen
strasse String, max.
Länge: 255
nein Teil der Anschrift Schulstraße
hausnummer String, max.
Länge: 255
nein Teil der Anschrift 21
Seite 13 / 42
postfach String, max.
Länge: 50
nein Teil der Anschrift 12345 Musterstadt
postleitzahlGrosskunde String, max.
Länge: 10
nein 48485
ortGrosskunde String, max.
Länge: 255
nein Neuenkirchen
pseudonyme Liste nein Siehe
Beschreibung
Pseudonyme
eintragungsDatum String, max.
Länge: 10
nein Datum in der
Form:
yyyy-mm-dd
2006-06-13
bemerkung String, max.
Länge: 255
nein
siExists boolean ja Schalter, ob ein SI
im Landesportal
existiert: true/false
true
historien Liste nein Siehe
Beschreibung
Historien
zweigniederlassungen Liste nein Siehe
Beschreibung
Zweigniederlassu
ngen
status String, max.
Länge: 255
nein Status: mögliche
Werte aktuell /
gelöscht
gelöscht
siDokument String,
unbegrenzt
nein Null oder das
Dokument in der
Form, wie es zum
Abrufzeitpunkt
beim
Landesportal
Seite 14 / 42
zurückgeliefert
wird.
gegenstand String,
unbegrenzt
nein Gegenstand des
Rechtsträgers
Der Handel mit
Bekleidungstextilien und
Schmuck
geschaeftszweck String,unbe
grenzt
nein Geschäftszweck
des Rechtsträgers
Der Geschäftszweck liegt
im Aufbau und Betrieb von
erlebnisgastronomischen
Einrichtungen
wirtschaftsnr String,
unbegrenzt
nein Bundeseinheit-
liche Wirtschafts-
nummer
hnAuslandBris boolean nein hat den Wert
'true', sofern bei
einer
Zweignieder-
lassung einer
Kapital-
gesellschaft
(juristische
Person mit
beschränkter
Haftung) auslän-
dischen Rechts
die zugehörige
Hauptnieder-
lassung in einem
an BRIS
teilnehmenden
Staat
(Europäischer
Wirtschaftsraum
(EWR)) registriert
ist. Bei einem
nicht an BRIS
teilnehmenden
Staat ist der Wert
'false'.
true oder false, falls
vorhanden
Seite 15 / 42
vertretungsberechtigte Liste nein Siehe
Beschreibung
Vertretungs-
berechtigte
4.1.2 Historien
Die historischen Daten zu Firmensitz und Firmenname. Die aktuell gültigen
Firmeninformationen werden nicht in der Liste aufgeführt, sondern stehen in den
Einzelfeldern Firmensitz und Firmenname.
Feldname Datentyp Pflicht Kommentar Beispiel
name String, max.
Länge:
32767
ja Name des
Rechtsträgers
Müller Blumengroßhandel
sitz String, max.
Länge: 255
ja Ort Solingen
status String, max.
Länge: 255
ja Status: mögliche
Werte aktuell /
gelöscht
aktuell
version Numerisch,
ganzzahlig,
>0
ja Reihenfolge der
Mitteilungsanlage
beginnend mit dem
kleinsten Wert
2
4.1.3 Pseudonyme
Feldname Datentyp Pflicht Kommentar Beispiel
pseudonym String, max.
Länge:
32767
ja Alternativer Name
des Rechtsträgers
BAUREINIGUNG
Seite 16 / 42
4.1.4 Zweigniederlassungen
Feldname Datentyp Pflicht Kommentar Beispiel
zweigniederlassungName String,
max.
Länge
32767
ja Name der
Zweigniederlassung
Müller
Blumengroßhandel,
Zweigniederlassung
Remscheid
zweigniederlassungSitz String,
max.
Länge 255
ja Ort Remscheid
zweigniederlassungPlz String,
max.
Länge:10
ja Postleitzahl 42859
zweigniederlassungStatus String,
max.
Länge:
255
ja Status: mögliche
Werte aktuell /
gelöscht
aktuell
4.1.5 Vertretungsberechtigte
Feldname Datentyp Pflicht Kommentar Beispiel
name String ja Nachname des
Vertretungsberechtig
ten
Müller
geburtsname String nein Geburtsname des
Vertretungsberechtig
en
Meyer
vorname String, nein Vorname des
Vertretungsberechtig
ten
Hans-Werner
Seite 17 / 42
geburtsdatum String,
max.
Länge: 10
nein Geburtsdatum in der
Form: YYYY-MM-
DD, YYYY-MM oder
YYYY
1945-01
rollenbezeichnung String ja Rolle des
Vertretungsberechtig
en, zulässige Werte,
Stand 05/2022:
Geschäftsführer(in),
Vorstand,
Prokurist(in),
Liquidator(in),
Abwickler(in),
Persönlich
haftende(r)
Gesellschafter(in),
Sonstiges
Geschäftsführer(in)
4.1.6 GerichtStadtZuordnungen
4.1.6.1 altGerichtStadt
Feldname Datentyp Pflicht Kommentar Beispiel
altGericht String, max.
Länge: 5
ja 5 stelliges Kennzeichen
des Altgerichts
R2801
stadt String, max.
Länge: 255
ja Stadtname Beverungen
kzLand String, max.
Länge: 2
ja Länderkürzel NW
Seite 18 / 42
4.1.6.2 gerichtStadt
Feldname Datentyp Pflicht Kommentar Beispiel
gericht String,
max.Länge: 5
ja 5 stelliges Kennzeichen
des Gerichts
M1607
stadt String, max.
Länge: 255
ja Stadtname Kassel
kzLand String, max.
Länge:2
ja Länderkürzel HE
4.1.7 Error
Feldname Datentyp Pflicht Kommentar Beispiel
errormsg String, max.
Länge: 255
ja Beschreibung des
aufgetretenen Fehlers
Registerart darf nicht leer
sein.
errorcode Numerisch,
ganzzahlig,
>0
ja Errorcode, identisch zum
http-Statuscode
400
choices Liste nein Siehe Beschreibung
Choices
4.1.8 Choices
Bei der Suche nach Rechtsträger können die folgenden Situationen eintreten:
1) Es wird kein Eintrag gefunden -> httpStatus 404
2) Es werden mehrere Einträge gefunden -> httpStatus 409
Um das Auffinden der Rechtsträger bei den oben genannten http-Status zu erleichtern,
werden in der Tabelle Choices mögliche Altgerichte angeben, sofern die Suche ohne
Altgericht durchgeführt wurde.
Seite 19 / 42
Feldname Datentyp Pflicht Kommentar Beispiel
altGericht String, max.
Länge: 5
ja Mögliches Altgericht, zu
dem Rechtsträger
vorliegen
R2801
4.1.9 Echo
Feldname Datentyp Pflicht Kommentar Beispiel
echoString String, keine
Begrenzung
ja Hallo
4.2 Methoden
4.2.1 Echo
Über die Echo-Funktion kann ein erster Test über die Erreichbarkeit der Applikation
durchgeführt werden. Diese Methode nimmt keine Authentifizierung vor und liefert den
übergebenen String als ein Echo zurück.
4.2.1.1 http-Methode GET
4.2.1.2 Pfad „/echo“
4.2.1.3 Input
Feldname Datentyp Pflichtfeld Kommentar Beispiel
echoString String, UTF-8 Ja, Query Text, der 1 zu 1
zurückgegeben
wird
Hallo
Seite 20 / 42
4.2.1.4 Header
Headername Inhalt
Accept application/xml;charset=UTF-8
oder
application/json;charset=UTF-8
4.2.1.5 Output
http Status Beschreibung Schema
200 Alles okay Echo
500 Interner Fehler Error
4.2.1.6 Beispiel
Seite 21 / 42
4.2.2 Anmeldung
Die Credentials für die Anmeldung werden in einem Autorisierungsheader mitgegeben.
Username und Passwort werden mit einem Doppelpunkt verbunden, Base64 endcodiert und
nach dem Schlüsselwort „Basic“ getrennt durch ein Leerzeichen in den Autorisierungsheader
geschrieben.
Beispiel für den User „Schmidt“ mit dem Passwort „meinSicheresPasswort“
Basic U2NobWlkdDptZWluU2ljaGVyZXNQYXNzd29ydA==
Als Rückgabewert erhält man ebenfalls im Autorisierungsheader ein JWT-Token, das für die
weiteren Suchzugriffe genutzt werden muss. Der Wert, wann ein Token seine Gültigkeit (in
Minuten) verliert, ist über eine Konfigurations-Datenbankeinstellung
„RpVss.TokenTimeoutAfterMinutes“ konfigurierbar. Als Defaultwert sind 15 Minuten
eingestellt. Mit einem abgelaufenen Token ist kein Zugriff mehr möglich, es muss ein neues
Token abgerufen werden. Das Token wird mit dem Schlüsselwort „Bearer“, gefolgt von einem
Space in dem Autorisierungsheader angegeben.
4.2.2.1 http-Methode POST
4.2.2.2 Pfad „/authentication“
4.2.2.3 Header (Input)
Headername Inhalt
Accept application/xml;charset=UTF-8
oder
application/json;charset=UTF-8
Authorization Basic <Base64 encodiert user:passwort>
4.2.2.4 Output
http Status Beschreibung Schema Kommentar
200 Alles okay JWT Token im Header
401 Authentisierungsfehler Error Mögliche Fehlerursachen:
 Userkennung ist falsch
 Passwort ist falsch
Seite 22 / 42
 Token ist abgelaufen
 User wurde gesperrt
oder noch nicht aktiviert
 User ist nicht für die
Verwaltungsschnittstelle
freigegeben
 Zu viele
Anmeldeversuche mit
dem falschen Passwort
500 Interner Fehler Error Mögliche Fehlerursachen:
 Unerwarteter SQL-
Fehler
 Null Pointer Exception
4.2.2.5 Header (Output)
Headerna
me
Inhalt
Authorizatio
n
Beispiel:
eyJhbGciOiJIUzUxMiJ9.eyJqdGkiOiI5NjhjNDlkNzM1MWY0YmM1YTN
iMTRm
MWRlOTNkMWNhMSIsImlhdCI6MTYyODc2Nzg2NiwiZXhwIjoxNjI4
Nzk2MjY
2LCJzdWIiOiJycF92c3Nfc29uZGVyIiwiaXNzIjoiaHR0cDovL2xvY2FsaG
9zdDo4M
DgwL3JwX3ZzcyJ9._5UZthtbpLrZljHJtfRq-n6-spzm3ndDBZ8N_AsX-
h5tBqS0vz3hwYCVDr8Sr8HAskmbV_fQIvuLjZu0wtuhxg
Seite 23 / 42
4.2.2.6 Beispiele
Fehlerfall:
Seite 24 / 42
4.2.3 Zugriff über Euid
Für die Suche über die EUID ist ein JWT-Token erforderlich, dass über ein vorangehendes
„authentication“ bezogen werden kann.
Die Indexdaten, die zu dem Suchzeitpunkt in der Datenbank des Registerportals abgelegt
sind, werden nach der EUID durchsucht.
Ein Datensatz wird nur zurückgegeben, wenn das Ergebnis der Suche eindeutig ist. Die
Syntax der EUID wird vor der Suche geprüft.
Wird bei der Anfrage ein SI angefordert, kann es vorkommen, dass die Daten zwar in der
Registerportal Datenbank erfolgreich gefunden wurden, der Abruf auf das Länderportal
jedoch zu Fehlern führt. In diesem Fall werden in der Schnittstelle die gefundenen Daten
zurückgegeben, über den http-Status (206/230) ist dann erkennbar, dass es sich nur um ein
Teilergebnis handelt.
4.2.3.1 http-Methode GET
4.2.3.2 Pfad „/registerdaten_per_euid“
4.2.3.3 Input
Feldname Datentyp Pflichtfeld Kommentar Beispiel
euid String,
UTF-8
Ja, Query EUID DEB2609.HRB222
DER2108_R2106.GnR204
siFlag boolean Ja, Query Gibt an, ob zusätzlich
zu den Daten das SI-
Dokument aus den
Landesportalen
abgerufen werden soll,
mögliche Werte:
true/false
false
Seite 25 / 42
4.2.3.4 Header (Input)
Headername Inhalt
Accept application/xml;charset=UTF-8
oder
application/json;charset=UTF-8
Authorization Bearer <JWT-Token aus authentication>
4.2.3.5 Output
http Status Beschreibung Schema Kommentar
200 Alles okay Dokument
206 Ergebnis nicht
vollständig
Dokument Der Datensatz wurde
gefunden. Allerdings konnte
das angeforderte SI-
Dokumentes nicht vom
Landesportal gelesen
werden.
230 Ergebnis nicht
vollständig
Dokument Der Datensatz wurde
gefunden. Das angeforderte
SI-Dokument wurde nicht
vom Landesportal gelesen,
da eine Sperre vorliegt.
400 Validierungsfehler Error Mögliche Fehlerursachen:
 Pflichtfelder nicht
gefüllt
 Syntaxprüfung der
EUID
fehlgeschlagen
401 Authentisierungsfehler Error Mögliche Fehlerursachen:
 Token zu alt
Seite 26 / 42
404 Nicht gefunden Error Zu dem vorgegebenen
Suchkriterium wurde kein
Rechtsträger gefunden
409 Konflikt Error Zu dem vorgegebenen
Suchkriterium wurde mehr
als ein Rechtsträger
gefunden
500 Interner Fehler Error Mögliche Fehlerursachen:
 Unerwarteter SQL-
Fehler
 NullPointerException
4.2.3.6 Beispiel
Seite 27 / 42
4.2.4 Zugriff über Registerart/Registernummer/Gerichtskennzeichen
4.2.4.1 http-Methode GET
Für die Suche über Registerart/Registernummer und Gerichtskennzeichen ist ein JWT-
Token erforderlich, dass über ein vorangehendes „authentication“ bezogen werden kann.
Die Indexdaten, die zu dem Suchzeitpunkt in der Datenbank des Registerportals abgelegt
sind, werden anhand der Registerart, Registernummer und den Gerichtskennzeichen
durchsucht. Ein Ergebnis wird nur zurück geliefert, wenn es eindeutig ist.
Die Syntax der Eingabefelder wird geprüft, es wird jedoch nicht gesondert geprüft, ob die
Gerichtskennzeichen an sich gültig sind, in diesem Fall würden keine Daten gefunden
werden und der Returncode „404“ gesetzt werden.
Wird bei der Anfrage ein SI angefordert, kann es vorkommen, dass die Daten zwar in der
Registerportal Datenbank erfolgreich gefunden wurden, der Abruf auf das Länderportal
jedoch zu Fehlern führt. In diesem Fall werden in der Schnittstelle die gefundenen Daten
zurückgegeben, über den http-Status (206/230) ist dann erkennbar, dass es sich nur um ein
Teilergebnis handelt.
4.2.4.2 Pfad „/registerdaten_per_aktenzeichen“
4.2.4.3 Input
Feldname Datentyp Pflichtfeld Kommentar Beispiel
registerArt String Ja, Query Gültige Werte zur Zeit:
HRB/HRA/VR/PR/GnR
HRA
registerNr String,
Maximallänge
10
Ja, Query Numerischer Wert 789
gkzNeu String,
Maximallänge
5
Ja, Query P2408
gkzAlt String,
Maximallänge
5
Nein,
Query
P2407
Seite 28 / 42
siFlag boolean Ja, Query Gibt an, ob zusätzlich zu den
Daten das SI-Dokument aus
den Landesportalen
abgerufen werden soll,
mögliche Werte: true/false
false
4.2.4.4 Header (Input)
Headername Inhalt
Accept application/xml;charset=UTF-8
oder
application/json;charset=UTF-8
Authorization Bearer < JWT-Token aus authentication>
4.2.4.5 Output
http Status Beschreibung Schema Kommentar
200 Alles okay Dokument
206 Ergebnis nicht
vollständig
Dokument Der Datensatz wurde
gefunden. Allerdings konnte
das angeforderte SI-
Dokumentes nicht vom
Landesportal gelesen
werden.
230 Ergebnis nicht
vollständig
Dokument Der Datensatz wurde
gefunden. Das angeforderte
SI-Dokument wurde nicht
vom Landesportal gelesen,
da eine Sperre vorliegt.
400 Validierungsfehler Error Mögliche Fehlerursachen:
 Pflichtfelder nicht
gefüllt
Seite 29 / 42
 Syntaxprüfung von
Registerart,
Registernummer
oder
Gerichtskennzeichen
fehlgeschlagen
401 Authentisierungsfehler Error Mögliche Fehlerursachen:
 Token zu alt
 Signatur des Tokens
fehlerhaft
404 Nicht gefunden Error Zu den vorgegebenen
Suchkriterien wurde kein
Rechtsträger gefunden
409 Konflikt Error Zu den vorgegebenen
Suchkriterien wurde mehr
als ein Rechtsträger
gefunden.
500 Interner Fehler Error Mögliche Fehlerursachen:
 Unerwarteter SQL-
Fehler
 Null Pointer
Exception
Seite 30 / 42
4.2.4.6 Beispiel
4.2.5 Zugriff über Registerart/Registernummer/Gericht-Städtenamen/Länderkürzel
4.2.5.1 http-Methode GET
Für die Suche über Registerart/Registernummer und Städtenamen ist ein JWT-Token
erforderlich, dass über ein vorangehendes „authentication“ bezogen werden kann.
Die angegebenen Städtenamen werden anhand der Tabelle in Gerichtskennzeichen
umgewandelt. Da Städtenamen nicht eindeutig sind, ist die zusätzliche Angabe des
Länderkennzeichens erforderlich. Anschließend werden die Indexdaten, die zu dem
Suchzeitpunkt in der Datenbank des Registerportals abgelegt sind, anhand der Registerart,
Registernummer und den Gerichtskennzeichen durchsucht. Ein Ergebnis wird nur zurück
geliefert, wenn es eindeutig ist.
Die Syntax der Eingabefelder wird geprüft. Kann ein Städtename nicht in ein
Gerichtskennzeichen umgewandelt werden, wird ein Validierungsfehler mit dem Returncode
„400“ gesetzt.
Seite 31 / 42
Wird bei der Anfrage ein SI angefordert, kann es vorkommen, dass die Daten zwar in der
Registerportal Datenbank erfolgreich gefunden wurden, der Abruf auf das Länderportal
jedoch zu Fehlern führt. In diesem Fall werden in der Schnittstelle die gefundenen Daten
zurückgegeben, über den http-Status (206/230) ist dann erkennbar, dass es sich nur um ein
Teilergebnis handelt.
4.2.5.2 Pfad „/registerdaten_per_akz_mit_stadt“
4.2.5.3 Input
Feldname Datentyp Pflichtfeld Kommentar Beispiel
registerArt String Ja, Query Gültige Werte zur Zeit:
HRB/HRA/VR/PR/GnR
HRA
registerNr String
Maximallänge
10
Ja, Query Numerischer Wert 789
kzLand String,
Maximallänge
2
Ja, Query Länderkennzeichen, in
dem sich die Städte
(stadtNeu, eventuell
statdtAlt) befinden.
Erlaubte Werte:
BE - Berlin
BR – Brandenburg
BW – Baden-Württemberg
BY – Bayern
HB – Bremen
HE – Hessen
HH – Hamburg
MV – Mecklenburg-
Vorpommern
NI – Niedersachsen
NW – Nordrhein-
Westfalen
RP – Rheinland-Pfalz
SH – Schleswig-Holstein
SL – Saarland
SN – Sachsen
ST – Sachsen-Anhalt
NI
Seite 32 / 42
TH – Thüringen
stadtNeu String,
Maximallänge
50
Ja, Query Hildesheim
stadtAlt String,
Maximallänge
50
Nein, Query Bad Harzburg
siFlag boolean Ja, Query Gibt an, ob zusätzlich zu
den Daten das SI-
Dokument aus den
Landesportalen abgerufen
werden soll, mögliche
Werte: true/false
false
4.2.5.4 Header (Input)
Headername Inhalt
Accept application/xml;charset=UTF-8
oder
application/json;charset=UTF-8
Authorization Bearer < JWT-Token aus authentication>
4.2.5.5 Output
http Status Beschreibung Schema Kommentar
200 Alles okay Dokument
206 Ergebnis nicht
vollständig
Dokument Der Datensatz wurde
gefunden. Allerdings konnte
das angeforderte SI-
Dokumentes nicht vom
Seite 33 / 42
Landesportal gelesen
werden.
230 Ergebnis nicht
vollständig
Dokument Der Datensatz wurde
gefunden. Das angeforderte
SI-Dokument wurde nicht
vom Landesportal gelesen,
da eine Sperre vorliegt.
400 Validierungsfehler Error Mögliche Fehlerursachen:
 Pflichtfelder nicht
gefüllt
 Syntaxprüfung von
Registerart,
Registernummer
oder Stadt
fehlgeschlagen
401 Authentisierungsfehler Error Mögliche Fehlerursachen:
 Token zu alt
 Signatur des Tokens
fehlerhaft
404 Nicht gefunden Error Zu den vorgegebenen
Suchkriterien wurde kein
Rechtsträger gefunden
409 Konflikt Error Zu den vorgegebenen
Suchkriterien wurde mehr
als ein Rechtsträger
gefunden.
500 Interner Fehler Error Mögliche Fehlerursachen:
 Unerwarteter SQL-
Fehler
 Null Pointer
Exception
Seite 34 / 42
4.2.5.6 Beispiel
4.2.6 Ausgabe von Gerichten und den zugehörigen Städtenamen
4.2.6.1 http-Methode GET
Für die Rückgabe der Gericht-Stadtname Zuordnungen ist ein JWT-Token erforderlich, dass
über ein vorangehendes „authentication“ bezogen werden kann.
Es wird jeweils eine Tabelle für aktuelle Gerichte und für Altgerichte zurückgegeben. Die
Liste umfasst die Daten, die für die Abfragen akzeptiert werden.
Seite 35 / 42
4.2.6.2 Pfad „/gerichte“
4.2.6.3 Header (Input)
Headername Inhalt
Accept application/xml;charset=UTF-8
oder
application/json;charset=UTF-8
Authorization Bearer < JWT-Token aus authentication>
4.2.6.4 Output
http Status Beschreibung Schema Kommentar
200 Alles okay Dokument
401 Authentisierungsfehler Error Mögliche Fehlerursachen:
 Token zu alt
 Signatur des Tokens
fehlerhaft
500 Interner Fehler Error Mögliche Fehlerursachen:
 Unerwarteter SQL-
Fehler
 Null Pointer
Exception
Seite 36 / 42
4.2.6.5 Beispiel
4.2.7 OPTIONS
4.2.7.1 http-Methode OPTIONS
Mit der OPTIONS-Methode kann ein Client abfragen, welche http-Methoden der Server
unterstützt. Diese Methode erwartet keine Authentifizierung.
Seite 37 / 42
4.2.7.2 Pfad „/options“
4.2.7.3 Output
http Status Beschreibung Schema Kommentar
200 Alles okay
4.2.7.4 Header (output)
Headername Inhalt
Access-Control-Allow-Methods Aufzählung der erlaubten http-Methoden,
zur Zeit: GET, PUT, OPTIONS
Access-Control-Allow-Headers Aufzählung möglicher Header, zur Zeit
Accept, Content-Type, Authorization
4.2.7.5 Beispiel
Seite 38 / 42
5 Ortskennzeichen
Im Registersystem Aureg kann das Ortskennzeichen (OKZ) Bestandteil der Registernummer
eines Rechtsträgers sein.
Bundesland Ortskennzeichen Gerichtskennzeichen
im Registerportal
Ort
BE B F1103 Berlin (Charlottenburg)
BR CB G1103 Cottbus
BR FF G1207 Frankfurt/Oder
BR NP G1309 Neuruppin
BR P G1312 Potsdam
HB BHV H1102 Bremerhaven
HB HB H1101 Bremen
SH AH X1711 Ahrensburg
SH BB X1511 Bad Bramstedt
SH BS X1713 Bad Schwartau
SH EC X1514 Eckernförde
SH EL X1312 Elmshorn
SH EU X1716 Eutin
SH FL X1112 Flensburg
SH GE X1717 Geesthacht
SH HL X1721 Lübeck
SH HU X1115 Husum
SH IZ X1315 Itzehoe
SH KA X1116 Kappeln
SH KI X1517 Kiel
SH ME X1319 Meldorf
SH MÖ X1722 Mölln
SH NI X1118 Niebüll
SH NM X1519 Neumünster
SH NO X1526 Norderstedt
SH OD X1712 Bad Oldesloe
SH OL X1724 Oldenburg (Holstein)
(Oldenburg)
SH PI X1321 Pinneberg
SH PL X1522 Plön
SH RD X1524 Rendsburg
SH RE X1726 Reinbek
SH RZ X1725 Ratzeburg
SH SB X1728 Schwarzenbek
SH SE X1512 Bad Segeberg
SH SL X1119 Schleswig
In der Verwaltungsschnittstelle wird das Ortskennzeichen nicht unterstützt, d.h. das
Ortskennzeichen muss in Form eines Gerichtskennzeichens in der Schnittstelle übergeben
werden, um die gewünschten Datensätze zu finden.
Seite 39 / 42
Für die Bundesländer gelten unterschiedliche Regeln:
BE: das zum Ortskennzeichen gehörende Gerichtskennzeichen des Registerportals als
Neugericht übergeben, das Altgericht mit '00000' füllen
BR: das zum Ortskennzeichen gehörende Gerichtskennzeichen des Registerportals als
Neugericht übergeben, das Altgericht mit '00000' füllen
HB: das zum Ortskennzeichen gehörende Gerichtskennzeichen des Registerportals als
Altgericht übergeben
SH: das zum Ortskennzeichen gehörende Gerichtskennzeichen des Registerportals als
Altgericht übergeben
6 Wertelisten
6.1 Rechtsform
Beim Registerportal bekannte Rechtsformen Stand 6/2022:
Rechtsform
eingetragene Genossenschaft
eingetragener Verein
Einzelkauffrau
Einzelkaufmann
Europäische wirtschaftliche
Interessenvereinigung
HRA Juristische Person
Kommanditgesellschaft
Offene Handelsgesellschaft
Partnerschaft
Rechtsform ausländischen Rechts GnR
Rechtsform ausländischen Rechts HRA
Rechtsform ausländischen Rechts PR
Seite 40 / 42
Seerechtliche Gesellschaft
Versicherungsverein auf Gegenseitigkeit
Anstalt öffentlichen Rechts
Bergrechtliche Gewerkschaft
Körperschaft öffentlichen Rechts
Europäische Genossenschaft (SCE)
Stiftung privaten Rechts
Stiftung öffentlichen Rechts
HRA sonstige Rechtsformen
Sonstige juristische Person
Einzelkaufmann / Einzelkauffrau
Partnerschaftsgesellschaft
Aktiengesellschaft
Kommanditgesellschaft auf Aktien
Gesellschaft mit beschränkter Haftung
Europäische Aktiengesellschaft (SE)
Rechtsform ausländischen Rechts HRB
7 Logging
Es wird ein Logging implementiert, das in Abhängigkeit der Wichtigkeit von Meldungen
entscheidet, ob sie geschrieben werden sollen oder nicht. Fehlermeldungen werden über
den Loglevel „Error“ protokolliert, Schnittstellen und Laufzeit mit dem Loglevel „Info“.
Zusätzliche Meldungen können über den Loglevel „Debug“ bei Bedarf für die Fehlersuche
und Tests eingeschaltet werden. Die Konfiguration für die einzelnen Systeme
(Test/Produktion) erfolgt individuell über eine XML-Datei.
Seite 41 / 42
8 Statistik
Um Nachhalten zu können, wie oft die Verwaltungsschnittstelle pro User benutzt wird,
werden Informationen über die Aufrufe und deren Ergebnisse festgehalten. Die Anzahl der
Aufrufe mit den Informationen, ob sie erfolgreich oder nicht waren, wird in der Tagesstatistik
unter den Gesamtabrufen festgehalten. Zusätzlich wird noch festgehalten, bei wie vielen
Aufrufen der SI angefordert wurde. Weitere statistische Erhebungen sind nicht geplant.
9 Registrierung zur Nutzung des Dienstes
Die Verwaltungsschnittstelle wird öffentlichen Bedarfsträgern, die bereits heute kostenlosen
Zugriff auf die Inhalte des Registerportals haben, zur Verfügung gestellt. Dabei geht IT.NRW
davon aus, dass die Abrufe für die öffentlichen Bedarfsträger kostenbefreit sind und sie somit
uneingeschränkten kostenlosen Zugriff auf Daten aller Bundesländer haben und keine
Einschränkungen auf bestimmte Bundesländer bestehen.
Eine direkte Verbindung zu bisher bestehenden Nutzern des Registerportals ist nicht
zwingend erforderlich. Für die Verwaltungsschnittstelle wird eine Nutzerkennung angelegt,
die für diese genutzt werden kann. Bis zu einer möglichen zukünftigen Änderung der
Kostenverrechnung und einer Öffnung des Registerportals für generellen kostenlosen
Zugriff, ist die Berechtigung der Bedarfsträger zu prüfen und freizugeben. Dieses erfolgt
durch die Servicestelle.
9.1 Registrierung
Die Registrierung erfolgt direkt bei der Servicestelle.
Um einen neuen User für die Verwaltungsschnittstelle anzulegen, erfassen die Nutzer ihre
Daten über die bisher bestehende Oberfläche des Registerportals und informieren die
Servicestelle, dass es sich um einen Nutzer für die Verwaltungsschnittstelle handelt. Nach
Prüfung der Berechtigung gibt die Servicestelle den Nutzer mittels eines Skriptes für die
Nutzung der Verwaltungsschnittstelle frei. Um das Skript nicht manuell starten zu müssen, ist
es erforderlich, dass eine Änderung an der Nutzerverwaltung der Servicestellenfunktion
erfolgt. Durch das Anklicken einer Checkbox wird beim Aktivieren des Nutzers das Skript
gestartet. Wenn die Servicestelle den Nutzer für die Verwaltungsschnittstelle frei gibt, trägt
das Skript diesen Nutzer als neuen Sondernutzer in der Datenbank ein. Eventuelle
Änderungen oder Neuanforderungen für das Kennwort sind über die Standard-
Weboberfläche der Nutzerverwaltung möglich.
9.2 Speicherung der Nutzer in der Datenbank
Im Hinblick auf eine zukünftige kostenlose Bereitstellung der Daten aus dem Registerportal,
werden mittel- bzw. langfristig die Komponenten zur Kostenprotokollierung wegfallen können
und damit eine Anpassung der aktuellen Nutzer-DB erforderlich werden. Anstelle der
Seite 42 / 42
Kostenprotokollierung gibt es dann eine Abrufprotokollierung in einer eigenen Datenbank
oder Tabelle.
Bis die Erstellung einer neuen Nutzer-DB abgeschlossen ist, wird die bestehende
Nutzerdatenbank so erweitert, dass die Nutzer der Verwaltungsschnittstelle aufgenommen
werden können.
Die Verwaltung wird ähnlich dem bisherigen Vorgehen für „Sondernutzer“ aufgebaut, d.h.
über eine neue Spalte „rp_vss_aufruf“ als Erweiterung der bestehenden Tabelle für
Sondernutzer kann das Recht zur Nutzung der Verwaltungsschnittstelle gesetzt oder
entzogen werden.
10 Notwendige Erweiterung der Infrastruktur
Der Webservice für die Verwaltungsschnittstelle sollte auf einem eigenen Webserver laufen,
um die Zugriffe und die damit verbundene Last vom standardmäßigen Betrieb des
Registerportals zu entkoppeln.
Dabei geht IT.NRW aus Gründen der Redundanz initial von zwei zusätzlichen Webservern
für die produktive Umgebung aus. Abhängig von der Anzahl zukünftiger Nutzer und der
Auslastung des Service kann eine Erweiterung der Ressourcen / Anzahl Sever notwendig
werden.

Weitere ähnliche Inhalte

Ähnlich wie Schnittstelle HR.pdf

Stack- und Heap-Overflow-Schutz bei Windows XP und Windows Vista
Stack- und Heap-Overflow-Schutz bei Windows XP und Windows Vista Stack- und Heap-Overflow-Schutz bei Windows XP und Windows Vista
Stack- und Heap-Overflow-Schutz bei Windows XP und Windows Vista Johannes Hohenbichler
 
Diplom arbeit lotfi_faik_2005
Diplom arbeit lotfi_faik_2005Diplom arbeit lotfi_faik_2005
Diplom arbeit lotfi_faik_2005Lotfi Faik
 
2014 gnepper,tom entwicklung eines application programming interface, bachelo...
2014 gnepper,tom entwicklung eines application programming interface, bachelo...2014 gnepper,tom entwicklung eines application programming interface, bachelo...
2014 gnepper,tom entwicklung eines application programming interface, bachelo...Markus Schneider
 
HTML5 und CSS3 Übersicht
HTML5 und CSS3 ÜbersichtHTML5 und CSS3 Übersicht
HTML5 und CSS3 ÜbersichtSven Brencher
 
Technikerarbeit: Technische Dokumentation in der Ersatzteillogistik
Technikerarbeit: Technische Dokumentation in der ErsatzteillogistikTechnikerarbeit: Technische Dokumentation in der Ersatzteillogistik
Technikerarbeit: Technische Dokumentation in der ErsatzteillogistikTheRealWolf
 
Whitepaper: Indoor Positionsbestimmung in Industrie & Logistik
Whitepaper: Indoor Positionsbestimmung in Industrie & LogistikWhitepaper: Indoor Positionsbestimmung in Industrie & Logistik
Whitepaper: Indoor Positionsbestimmung in Industrie & Logistikinfsoft GmbH
 

Ähnlich wie Schnittstelle HR.pdf (6)

Stack- und Heap-Overflow-Schutz bei Windows XP und Windows Vista
Stack- und Heap-Overflow-Schutz bei Windows XP und Windows Vista Stack- und Heap-Overflow-Schutz bei Windows XP und Windows Vista
Stack- und Heap-Overflow-Schutz bei Windows XP und Windows Vista
 
Diplom arbeit lotfi_faik_2005
Diplom arbeit lotfi_faik_2005Diplom arbeit lotfi_faik_2005
Diplom arbeit lotfi_faik_2005
 
2014 gnepper,tom entwicklung eines application programming interface, bachelo...
2014 gnepper,tom entwicklung eines application programming interface, bachelo...2014 gnepper,tom entwicklung eines application programming interface, bachelo...
2014 gnepper,tom entwicklung eines application programming interface, bachelo...
 
HTML5 und CSS3 Übersicht
HTML5 und CSS3 ÜbersichtHTML5 und CSS3 Übersicht
HTML5 und CSS3 Übersicht
 
Technikerarbeit: Technische Dokumentation in der Ersatzteillogistik
Technikerarbeit: Technische Dokumentation in der ErsatzteillogistikTechnikerarbeit: Technische Dokumentation in der Ersatzteillogistik
Technikerarbeit: Technische Dokumentation in der Ersatzteillogistik
 
Whitepaper: Indoor Positionsbestimmung in Industrie & Logistik
Whitepaper: Indoor Positionsbestimmung in Industrie & LogistikWhitepaper: Indoor Positionsbestimmung in Industrie & Logistik
Whitepaper: Indoor Positionsbestimmung in Industrie & Logistik
 

Schnittstelle HR.pdf

  • 1. Registerportal Feinkonzept „Verwaltungsschnittstelle“ (Webservice für öffentliche Bedarfsträger) Hagen, 15.Juli 2022
  • 2. Seite 2 / 42 Änderungshistorie Nr. Datum Version Änderungsgrund durchgeführt von 1 11.08.2021 0.1 Neuanlage Heike Potter 2 27.08.2021 0.2 Überarbeitung Heike Potter 3 23.09.2021 0.3 Einarbeitung von Ver- besserungsvorschlägen Heike Potter 4 21.10.2021 0.4 Einarbeitung weiterer Verbesserungsvorschläge Heike Potter 5 13.12.2021 0.5 Neue Methode: Suche mit Städtenamen anstelle des Gerichtskennzeichens und Ermittlung von Gerichten Heike Potter 6 11.01.2022 0.6 Registernummer ohne OKZ Heike Potter 7 21.01.2022 0.7 Länderkürzel ergänzt bei registerdaten_per_akz_mit_stadt und gerichte Heike Potter 8 04.04.2022 0.8 Angabe von Längen und Pflichtfelder der Rückgabewerten Heike Potter 9 12.05.2022 0.9 Felder der Indexerweiterung hinzugefügt, neuer http-Status 230, falls eine Abrufsperre für das SI- Dokument vorliegt, Statistikdaten pro User, kleinere Korrekturen eingepflegt Heike Potter 10 30.06.2022 0.10 Erweiterung für das Ortskennzeichen, Wertelist für die Rechtsform hinzugefügt Heike Potter 11 15.07.2022 0.11 Erweiterung der Struktur Error, bei http-Status 404/409 mögliche Angabe eines Choice Elementes. Heike Potter
  • 4. Seite 4 / 42 Inhaltsverzeichnis 1 Einführung...................................................................................................................... 7 2 Anforderungen ............................................................................................................... 8 2.1 Eindeutige Ergebnisse ............................................................................................ 8 2.2 Datenmenge ........................................................................................................... 8 2.3 SI ............................................................................................................................ 8 2.4 Statistik ................................................................................................................... 8 2.5 Benutzeridentifizierung............................................................................................ 8 2.6 Fehlerbehandlung ................................................................................................... 8 3 Webservice .................................................................................................................... 9 3.1 Identifizierung eines eindeutigen Rechtsträgers ...................................................... 9 3.2 Verhalten bei nicht eindeutiger Identifizierung eines Rechtsträgers......................... 9 3.3 Flag zur Anforderung des „Strukturierten Inhalts“ (SI) ............................................10 3.4 Definition der Inhalte aus den Indexdaten, die übertragen werden .........................10 4 Schnittstellendefinition...................................................................................................11 4.1 Strukturen ..............................................................................................................11 4.1.1 Dokument........................................................................................................12 4.1.2 Historien..........................................................................................................15 4.1.3 Pseudonyme ...................................................................................................15 4.1.4 Zweigniederlassungen ....................................................................................16 4.1.5 Vertretungsberechtigte....................................................................................16 4.1.6 GerichtStadtZuordnungen ...............................................................................17 4.1.6.1 altGerichtStadt.............................................................................................17 4.1.6.2 gerichtStadt .................................................................................................18 4.1.7 Error................................................................................................................18 4.1.8 Choices...........................................................................................................18 4.1.9 Echo................................................................................................................19 4.2 Methoden...............................................................................................................19 4.2.1 Echo................................................................................................................19 4.2.1.1 http-Methode GET .......................................................................................19 4.2.1.2 Pfad „/echo“.................................................................................................19
  • 5. Seite 5 / 42 4.2.1.3 Input ............................................................................................................19 4.2.1.4 Header.........................................................................................................20 4.2.1.5 Output..........................................................................................................20 4.2.1.6 Beispiel........................................................................................................20 4.2.2 Anmeldung......................................................................................................21 4.2.2.1 http-Methode POST.....................................................................................21 4.2.2.2 Pfad „/authentication“...................................................................................21 4.2.2.3 Header (Input) .............................................................................................21 4.2.2.4 Output..........................................................................................................21 4.2.2.5 Header (Output)...........................................................................................22 4.2.2.6 Beispiele......................................................................................................23 4.2.3 Zugriff über Euid..............................................................................................24 4.2.3.1 http-Methode GET .......................................................................................24 4.2.3.2 Pfad „/registerdaten_per_euid“ ....................................................................24 4.2.3.3 Input ............................................................................................................24 4.2.3.4 Header (Input) .............................................................................................25 4.2.3.5 Output..........................................................................................................25 4.2.4 Zugriff über Registerart/Registernummer/Gerichtskennzeichen ......................27 4.2.4.1 http-Methode GET .......................................................................................27 4.2.4.2 Pfad „/registerdaten_per_aktenzeichen“ ......................................................27 4.2.4.3 Input ............................................................................................................27 4.2.4.4 Header (Input) .............................................................................................28 4.2.4.5 Output..........................................................................................................28 4.2.4.6 Beispiel........................................................................................................30 4.2.5 Zugriff über Registerart/Registernummer/Gericht-Städtenamen/Länderkürzel 30 4.2.5.1 http-Methode GET .......................................................................................30 4.2.5.2 Pfad „/registerdaten_per_akz_mit_stadt“ .....................................................31 4.2.5.3 Input ............................................................................................................31 4.2.5.4 Header (Input) .............................................................................................32 4.2.5.5 Output..........................................................................................................32 4.2.5.6 Beispiel........................................................................................................34 4.2.6 Ausgabe von Gerichten und den zugehörigen Städtenamen...........................34
  • 6. Seite 6 / 42 4.2.6.1 http-Methode GET .......................................................................................34 4.2.6.2 Pfad „/gerichte“............................................................................................35 4.2.6.3 Header (Input) .............................................................................................35 4.2.6.4 Output..........................................................................................................35 4.2.6.5 Beispiel........................................................................................................36 4.2.7 OPTIONS........................................................................................................36 4.2.7.1 http-Methode OPTIONS ..............................................................................36 4.2.7.2 Pfad „/options“ .............................................................................................37 4.2.7.3 Output..........................................................................................................37 4.2.7.4 Header (output) ...........................................................................................37 4.2.7.5 Beispiel........................................................................................................37 5 Ortskennzeichen ...........................................................................................................38 6 Wertelisten ....................................................................................................................39 6.1 Rechtsform.............................................................................................................39 7 Logging .........................................................................................................................40 8 Statistik .........................................................................................................................41 9 Registrierung zur Nutzung des Dienstes .......................................................................41 9.1 Registrierung..........................................................................................................41 9.2 Speicherung der Nutzer in der Datenbank..............................................................41 10 Notwendige Erweiterung der Infrastruktur..................................................................42
  • 7. Seite 7 / 42 1 Einführung Im Rahmen der Aktivitäten zur Umsetzung des OZG wird das Registerportal um eine maschinelle Schnittstelle erweitert. Die Schnittstelle wird einheitlich für Nutzer bereitgestellt, die bereits heute kostenfrei auf das Registerportal zugreifen dürfen. Nutzer können Verwaltungsfachverfahren oder Onlineportale sein, die Anträge zur Dateneinlieferung in ein Fachverfahren entgegennehmen. Es handelt sich bei der Verwaltungsschnittstelle um die vollautomatische Bereitstellung einer klassischen Querschnittsleistung. Registrierte Unternehmensträger benötigen bei Antragstellungen üblicherweise einen aktuellen Handelsregisterausdruck, um ihre Existenz und ihre rechtlichen Verhältnisse, wie etwa Vertretungsbefugnisse, nachweisen zu können. Dieser Nachweis soll zukünftig nicht extra durch das antragstellende Unternehmen beigebracht werden, sondern automatisiert im Antragsverfahren oder bei der Antragsbearbeitung elektronisch beschafft werden. Wie die Umsetzung in dem einzelnen Verwaltungsverfahren erfolgt, ist dem jeweiligen Träger der Verwaltungsleistung vorbehalten. Trägern öffentlicher Verwaltungen werden Informationen aus dem Registerportal über eine vollautomatische Verwaltungsschnittstelle in Form eines Webservice bereitgestellt. Der Webservice wird so ausgestaltet, dass an der Schnittstelle Anfragen zugelassen werden, die eine eindeutige Identifizierung eines bestimmten Rechtsträgers ermöglichen. Aus dem Registerportal wird sodann eine Datei mit fest definierten Inhalten und in einer einheitlichen Datenstruktur geliefert. Dabei handelt es sich um Indexdaten, die aus dem Registerportal stammen, sowie einen maschinenlesbaren strukturierten Registerabdruck (SI). Der Strukturierte Registerinhalt (SI) ist eine XML Datei, die alle Informationen eines Aktuellen Abdrucks aus dem Handelsregister beinhaltet. Diese Datei wird aus dem Handelsregister- Fachverfahren des Bundeslandes des registerführenden Gerichts abgerufen. Die Verwaltungsschnittstelle wird durch Anpassung der bestehenden Funktionalität der kostenlosen Abrufe für Sondernutzer realisiert. Detailanpassungen an der bisherigen Nutzerdatenbank sind notwendig. Die Registrierung und Freigabe der Nutzung der Verwaltungsschnittstelle erfolgt auf Antrag eines Nutzers über die Servicestelle. Dabei wird für die Erfassung der erforderlichen Kontaktdaten die bestehende Oberfläche zur Nutzerregistrierung genutzt. Die Servicestelle prüft die Berechtigung und löst durch die Freigabe eine automatische Eintragung der für die Nutzung der Verwaltungsschnittstelle erforderlichen Berechtigungen im Registerportal aus. Alle notwendigen Schnittstellenbeschreibungen werden als Dokumente bei der Servicestelle hinterlegt und können dort angefordert werden.
  • 8. Seite 8 / 42 2 Anforderungen 2.1 Eindeutige Ergebnisse Der Webservice liefert die Information für genau einen Unternehmensträger zurück. Führen die vorgegebenen Daten nicht zu einem eindeutigen Ergebnis, wird dies als Fehler quittiert. 2.2 Datenmenge Es werden die Daten zurück geliefert, die aktuell in der Indexdatenbank beim Registerportal gespeichert sind. Auch als gelöscht markierte Rechtsträger werden zurückgegeben. Firmendaten, die für die Suche gesperrt sind, werden dagegen nicht zurückgegeben. 2.3 SI Bei jedem Aufruf der Verwaltungsschnittstelle kann zusätzlich der strukturierte Registerinhalt „SI“ mit angefordert werden. Ist der Abruf eines SI gewünscht, aber aufgrund einer Sperre nicht möglich, werden die Unternehmensdaten ohne den SI zurückgegeben. Kommt es bei dem SI-Abruf aus den Landesportalen zu Fehlern, werden die Daten ohne den SI übermittelt. Über den Rückgabestatus kann identifiziert werden, ob der SI-Abruf erfolgreich war. 2.4 Statistik Die Häufigkeit der Verwendung der Verwaltungsschnittstelle und deren Ergebnisse wird statistisch nachgehalten. 2.5 Benutzeridentifizierung Eine Authentifizierung ist erforderlich, es wird die Nutzerverwaltungsdatenbank der bereits bestehenden Web-Anwendung des Registerportals verwendet. Weitere erforderliche Anpassungen, um einen Benutzer das Recht zur Benutzung der Verwaltungsschnittstelle zu geben, werden von der Servicestelle vorgenommen. Eine Anpassung der Servicestellenfunktionalität ist erforderlich, um ein zusätzliches Recht zu vergeben. 2.6 Fehlerbehandlung Fehlerbehandlung bzw. Logging sind erforderlich, um im Fehlerfall geeignete Informationen zur Fehlerursache und deren Behebung zu haben.
  • 9. Seite 9 / 42 3 Webservice 3.1 Identifizierung eines eindeutigen Rechtsträgers Anfragen an die Verwaltungsschnittstelle müssen eine eindeutige Identifizierung eines bestimmten Rechtsträgers zulassen. Zur eindeutigen Identifizierung sind die nachfolgend aufgeführten Felder notwendig:  Registerart  Registernummer  Registergericht  Altgericht oder:  EUID Das Altgericht ist erforderlich, weil Rechtsträger existieren, die sich bei gleicher Kombination von Registergericht / Registerart / Registernummer nur durch das Altgericht eindeutig zuordnen lassen. Abfragen ohne Altgerichtsangabe werden mit dem Eintrag ohne Altgericht beantwortet. Wird jedoch auf eine Anfrage ohne Altgericht ein nicht eindeutiges Ergebnis erzielt, wird dies als Fehler behandelt. Als alternatives Identifikationsmerkmal dient die EUID, die wie die Suche ohne Altgericht nicht unbedingt ein eindeutiges Ergebnis erzielt. Ein nicht eindeutiges Ergebnis bei der Suche über die EUID wird als Fehler behandelt. In einer späteren Version kann hier auch die zukünftige „bundeseinheitliche Wirtschaftsnummer“ aus dem Basisregister verwendet werden. Es können aktuelle und gelöschte Rechtsträger beauskunftet werden. Rechtsträger, die für die Recherchesuche gesperrt sind, werden als „nicht gefunden“ behandelt. 3.2 Verhalten bei nicht eindeutiger Identifizierung eines Rechtsträgers Anfragen an das Registerportal, die nicht eindeutig Identifiziert werden können, werden mit einer Fehlermeldung beantwortet. Indexdaten oder der SI werden nicht übertragen. Mögliche Fehlersituationen werden in diesem Dokument spezifiziert und die zugehörigen Fehlermeldungen werden definiert. Diese können z.B. auftreten, wenn  Parameter nicht korrekt gefüllt sind  der Rechtsträger nicht vorhanden ist
  • 10. Seite 10 / 42  die Suche nach einem Rechtsträger mit den vorgegebenen Suchparametern kein eindeutiges Ergebnis liefert 3.3 Flag zur Anforderung des „Strukturierten Inhalts“ (SI) Bei eindeutig identifiziertem Rechtsträger liefert der Webservice immer einen Auszug aus den im Registerportal aktuell gespeicherten Daten (Indexdaten). In der Anforderung kann ein Flag zur Auslieferung des Strukturierten Registerinhalts (SI) gesetzt werden. Ist dieses Flag nicht gesetzt, erfolgt keine automatische Sendung des SI. Ist dieses Flag gesetzt, wird der SI zusammen mit dem Auszug aus den Indexdaten geliefert. Der SI wird jedoch nur zusätzlich abgerufen, wenn für das Dokument keine Sperre, weder auf Länder- noch auf Dokumentenebene, vorliegt und in den Indexdaten hinterlegt ist, dass ein SI existiert. Für eine gelöschte Firma SI wird versucht den SI abzurufen, sofern kein Sperrvermerk gesetzt ist. 3.4 Definition der Inhalte aus den Indexdaten, die übertragen werden Im Folgenden ist eine Aufzählung der Felder, die in dem bestehenden Index-Datenbank Bestand zur Verfügung stehen und bei einer Anfrage zurückgeliefert werden: - Firmenname - Firmensitz - EUID - Rechtsform der Firma - Aktenzeichen mit den Feldern Bundesland, Registerart, Registernummer und Gerichtskennung - Anschrift mit den Feldern Postleitzahl, Ort, Straße, Hausnummer, Postfach - Großkunden-Anschrift mit den Feldern Postleitzahl, Ort - Zusätzlich erfasste Firmenbezeichnungen (sog. Aliase oder Pseudonyme) - Eintragungsdatum - Bemerkungsfeld - Kennzeichnung der Existenz der Dokumentart SI - Historie der Änderungen von Firmennamen und Sitz - Daten zu Zweigniederlassungen - Status zum Rechtsträger: aktuell oder gelöscht - Gegenstand des Rechtsträgers - Geschäftszweck des Rechtsträgers - Bundeseinheitliche Wirtschaftsnummer - Angabe, ob bei einer Zweigniederlassung einer Kapitalgesellschaft ausländischen Rechts die zugehörige Hauptniederlassung in einem an BRIS teilnehmenden Staat registriert ist
  • 11. Seite 11 / 42 - Vertretungsberechtige mit Nachname, Geburtsname, Vorname, Geburtsdatum und Rollenbezeichnung Die Daten werden so ausgeliefert, wie sie dem Registerportal von den Landesportalen zur Speicherung geliefert wurden. 4 Schnittstellendefinition Der Webservice ist in Java geschrieben und implementiert ein Rest-API. Die einzelnen Services werden per URL/URI angesprochen. Die HTTP-Methoden (GET, POST, OPTIONS) geben an, welche Operation ein Dienst ausführen soll. Die erfolgreiche Verarbeitung einer Anfrage kann über den http-Statuscode verifiziert werden. Erforderliche Parameter sind in UTF-8 anzugeben. Die Url lautet: https://<IP_des_Produktivrechners>/rp_vss/api/vss „<IP des Produktivrechners>“ ist ein Platzhalter für die eigentliche IP-Adresse oder den Rechnernamen des Produktivrechners. Beim Aufruf eines http-Requests können diverse http-Fehlermeldungen auftreten. In der folgenden Beschreibung werden nicht alle möglichen http-Returnstatus beschrieben, sondern nur die http-Returnwerte, die explizit auch von der Applikation gesetzt werden. D.h. bei den Methoden werden Fehler, die auftreten, in http-Returncodes umgesetzt. Die weiteren allgemeinen http-Statuscodes können in den einschlägigen Dokumentationen nachgelesen werden. Interne, unerwartete Fehler, wie z.B. Nullpointer Exception oder unerwartete SQL- Fehler werden in den http-Status 500 umgewandelt. In der Errormessage der „Error-Struktur“ kann eine genauere Erklärung stehen. Die bei den Methoden dargestellten Beispiele zeigen die Benutzung von http, in der produktiven Umgebung wird jedoch nur das https-Protokoll unterstützt werden. 4.1 Strukturen Um die Rückgabewerte in den Methoden nicht mehrfach zu beschreiben, werden hier die möglichen Strukturen beschrieben. Ist der Datentyp Liste angegeben, kann die Struktur mehrfach vorkommen. Feldnamen und Listen, die als Pflicht angegeben sind, sind mit Daten gefüllt, alle anderen Felder/Listen können, aber müssen keine Daten enthalten.
  • 12. Seite 12 / 42 4.1.1 Dokument Feldname Datentyp Pflicht Kommentar Beispiel firmenname String, max Länge:3276 7 ja Name des Rechtsträgers Müller Blumengroßhandel firmensitz String, max. Länge: 255 ja Ort Solingen EUID String, max. Länge: 255 ja DER2402.HRA8639 rechtsform String, max. Länge: 255 ja Bezeichnung der Rechtsform Aktiengesellschaft, eingetragene Genossenschaft etc. aktenzeichen String, max. Länge: 30 ja Setzt sich zusammen aus den bis zu 5 Feldern getrennt durch einen „_“ : Bundesland Registerart Registernummer Gerichtskennzeic hen_neu Gerichtskennzeic hen_alt (Optional) NW_HRB_2739_R2402 HE_GnR_204_M1406_M14 01 postleitzahl String, max. Länge:10 nein Teil der Anschrift 48485 ort String, max. Länge: 255 nein Teil der Anschrift Neuenkirchen strasse String, max. Länge: 255 nein Teil der Anschrift Schulstraße hausnummer String, max. Länge: 255 nein Teil der Anschrift 21
  • 13. Seite 13 / 42 postfach String, max. Länge: 50 nein Teil der Anschrift 12345 Musterstadt postleitzahlGrosskunde String, max. Länge: 10 nein 48485 ortGrosskunde String, max. Länge: 255 nein Neuenkirchen pseudonyme Liste nein Siehe Beschreibung Pseudonyme eintragungsDatum String, max. Länge: 10 nein Datum in der Form: yyyy-mm-dd 2006-06-13 bemerkung String, max. Länge: 255 nein siExists boolean ja Schalter, ob ein SI im Landesportal existiert: true/false true historien Liste nein Siehe Beschreibung Historien zweigniederlassungen Liste nein Siehe Beschreibung Zweigniederlassu ngen status String, max. Länge: 255 nein Status: mögliche Werte aktuell / gelöscht gelöscht siDokument String, unbegrenzt nein Null oder das Dokument in der Form, wie es zum Abrufzeitpunkt beim Landesportal
  • 14. Seite 14 / 42 zurückgeliefert wird. gegenstand String, unbegrenzt nein Gegenstand des Rechtsträgers Der Handel mit Bekleidungstextilien und Schmuck geschaeftszweck String,unbe grenzt nein Geschäftszweck des Rechtsträgers Der Geschäftszweck liegt im Aufbau und Betrieb von erlebnisgastronomischen Einrichtungen wirtschaftsnr String, unbegrenzt nein Bundeseinheit- liche Wirtschafts- nummer hnAuslandBris boolean nein hat den Wert 'true', sofern bei einer Zweignieder- lassung einer Kapital- gesellschaft (juristische Person mit beschränkter Haftung) auslän- dischen Rechts die zugehörige Hauptnieder- lassung in einem an BRIS teilnehmenden Staat (Europäischer Wirtschaftsraum (EWR)) registriert ist. Bei einem nicht an BRIS teilnehmenden Staat ist der Wert 'false'. true oder false, falls vorhanden
  • 15. Seite 15 / 42 vertretungsberechtigte Liste nein Siehe Beschreibung Vertretungs- berechtigte 4.1.2 Historien Die historischen Daten zu Firmensitz und Firmenname. Die aktuell gültigen Firmeninformationen werden nicht in der Liste aufgeführt, sondern stehen in den Einzelfeldern Firmensitz und Firmenname. Feldname Datentyp Pflicht Kommentar Beispiel name String, max. Länge: 32767 ja Name des Rechtsträgers Müller Blumengroßhandel sitz String, max. Länge: 255 ja Ort Solingen status String, max. Länge: 255 ja Status: mögliche Werte aktuell / gelöscht aktuell version Numerisch, ganzzahlig, >0 ja Reihenfolge der Mitteilungsanlage beginnend mit dem kleinsten Wert 2 4.1.3 Pseudonyme Feldname Datentyp Pflicht Kommentar Beispiel pseudonym String, max. Länge: 32767 ja Alternativer Name des Rechtsträgers BAUREINIGUNG
  • 16. Seite 16 / 42 4.1.4 Zweigniederlassungen Feldname Datentyp Pflicht Kommentar Beispiel zweigniederlassungName String, max. Länge 32767 ja Name der Zweigniederlassung Müller Blumengroßhandel, Zweigniederlassung Remscheid zweigniederlassungSitz String, max. Länge 255 ja Ort Remscheid zweigniederlassungPlz String, max. Länge:10 ja Postleitzahl 42859 zweigniederlassungStatus String, max. Länge: 255 ja Status: mögliche Werte aktuell / gelöscht aktuell 4.1.5 Vertretungsberechtigte Feldname Datentyp Pflicht Kommentar Beispiel name String ja Nachname des Vertretungsberechtig ten Müller geburtsname String nein Geburtsname des Vertretungsberechtig en Meyer vorname String, nein Vorname des Vertretungsberechtig ten Hans-Werner
  • 17. Seite 17 / 42 geburtsdatum String, max. Länge: 10 nein Geburtsdatum in der Form: YYYY-MM- DD, YYYY-MM oder YYYY 1945-01 rollenbezeichnung String ja Rolle des Vertretungsberechtig en, zulässige Werte, Stand 05/2022: Geschäftsführer(in), Vorstand, Prokurist(in), Liquidator(in), Abwickler(in), Persönlich haftende(r) Gesellschafter(in), Sonstiges Geschäftsführer(in) 4.1.6 GerichtStadtZuordnungen 4.1.6.1 altGerichtStadt Feldname Datentyp Pflicht Kommentar Beispiel altGericht String, max. Länge: 5 ja 5 stelliges Kennzeichen des Altgerichts R2801 stadt String, max. Länge: 255 ja Stadtname Beverungen kzLand String, max. Länge: 2 ja Länderkürzel NW
  • 18. Seite 18 / 42 4.1.6.2 gerichtStadt Feldname Datentyp Pflicht Kommentar Beispiel gericht String, max.Länge: 5 ja 5 stelliges Kennzeichen des Gerichts M1607 stadt String, max. Länge: 255 ja Stadtname Kassel kzLand String, max. Länge:2 ja Länderkürzel HE 4.1.7 Error Feldname Datentyp Pflicht Kommentar Beispiel errormsg String, max. Länge: 255 ja Beschreibung des aufgetretenen Fehlers Registerart darf nicht leer sein. errorcode Numerisch, ganzzahlig, >0 ja Errorcode, identisch zum http-Statuscode 400 choices Liste nein Siehe Beschreibung Choices 4.1.8 Choices Bei der Suche nach Rechtsträger können die folgenden Situationen eintreten: 1) Es wird kein Eintrag gefunden -> httpStatus 404 2) Es werden mehrere Einträge gefunden -> httpStatus 409 Um das Auffinden der Rechtsträger bei den oben genannten http-Status zu erleichtern, werden in der Tabelle Choices mögliche Altgerichte angeben, sofern die Suche ohne Altgericht durchgeführt wurde.
  • 19. Seite 19 / 42 Feldname Datentyp Pflicht Kommentar Beispiel altGericht String, max. Länge: 5 ja Mögliches Altgericht, zu dem Rechtsträger vorliegen R2801 4.1.9 Echo Feldname Datentyp Pflicht Kommentar Beispiel echoString String, keine Begrenzung ja Hallo 4.2 Methoden 4.2.1 Echo Über die Echo-Funktion kann ein erster Test über die Erreichbarkeit der Applikation durchgeführt werden. Diese Methode nimmt keine Authentifizierung vor und liefert den übergebenen String als ein Echo zurück. 4.2.1.1 http-Methode GET 4.2.1.2 Pfad „/echo“ 4.2.1.3 Input Feldname Datentyp Pflichtfeld Kommentar Beispiel echoString String, UTF-8 Ja, Query Text, der 1 zu 1 zurückgegeben wird Hallo
  • 20. Seite 20 / 42 4.2.1.4 Header Headername Inhalt Accept application/xml;charset=UTF-8 oder application/json;charset=UTF-8 4.2.1.5 Output http Status Beschreibung Schema 200 Alles okay Echo 500 Interner Fehler Error 4.2.1.6 Beispiel
  • 21. Seite 21 / 42 4.2.2 Anmeldung Die Credentials für die Anmeldung werden in einem Autorisierungsheader mitgegeben. Username und Passwort werden mit einem Doppelpunkt verbunden, Base64 endcodiert und nach dem Schlüsselwort „Basic“ getrennt durch ein Leerzeichen in den Autorisierungsheader geschrieben. Beispiel für den User „Schmidt“ mit dem Passwort „meinSicheresPasswort“ Basic U2NobWlkdDptZWluU2ljaGVyZXNQYXNzd29ydA== Als Rückgabewert erhält man ebenfalls im Autorisierungsheader ein JWT-Token, das für die weiteren Suchzugriffe genutzt werden muss. Der Wert, wann ein Token seine Gültigkeit (in Minuten) verliert, ist über eine Konfigurations-Datenbankeinstellung „RpVss.TokenTimeoutAfterMinutes“ konfigurierbar. Als Defaultwert sind 15 Minuten eingestellt. Mit einem abgelaufenen Token ist kein Zugriff mehr möglich, es muss ein neues Token abgerufen werden. Das Token wird mit dem Schlüsselwort „Bearer“, gefolgt von einem Space in dem Autorisierungsheader angegeben. 4.2.2.1 http-Methode POST 4.2.2.2 Pfad „/authentication“ 4.2.2.3 Header (Input) Headername Inhalt Accept application/xml;charset=UTF-8 oder application/json;charset=UTF-8 Authorization Basic <Base64 encodiert user:passwort> 4.2.2.4 Output http Status Beschreibung Schema Kommentar 200 Alles okay JWT Token im Header 401 Authentisierungsfehler Error Mögliche Fehlerursachen:  Userkennung ist falsch  Passwort ist falsch
  • 22. Seite 22 / 42  Token ist abgelaufen  User wurde gesperrt oder noch nicht aktiviert  User ist nicht für die Verwaltungsschnittstelle freigegeben  Zu viele Anmeldeversuche mit dem falschen Passwort 500 Interner Fehler Error Mögliche Fehlerursachen:  Unerwarteter SQL- Fehler  Null Pointer Exception 4.2.2.5 Header (Output) Headerna me Inhalt Authorizatio n Beispiel: eyJhbGciOiJIUzUxMiJ9.eyJqdGkiOiI5NjhjNDlkNzM1MWY0YmM1YTN iMTRm MWRlOTNkMWNhMSIsImlhdCI6MTYyODc2Nzg2NiwiZXhwIjoxNjI4 Nzk2MjY 2LCJzdWIiOiJycF92c3Nfc29uZGVyIiwiaXNzIjoiaHR0cDovL2xvY2FsaG 9zdDo4M DgwL3JwX3ZzcyJ9._5UZthtbpLrZljHJtfRq-n6-spzm3ndDBZ8N_AsX- h5tBqS0vz3hwYCVDr8Sr8HAskmbV_fQIvuLjZu0wtuhxg
  • 23. Seite 23 / 42 4.2.2.6 Beispiele Fehlerfall:
  • 24. Seite 24 / 42 4.2.3 Zugriff über Euid Für die Suche über die EUID ist ein JWT-Token erforderlich, dass über ein vorangehendes „authentication“ bezogen werden kann. Die Indexdaten, die zu dem Suchzeitpunkt in der Datenbank des Registerportals abgelegt sind, werden nach der EUID durchsucht. Ein Datensatz wird nur zurückgegeben, wenn das Ergebnis der Suche eindeutig ist. Die Syntax der EUID wird vor der Suche geprüft. Wird bei der Anfrage ein SI angefordert, kann es vorkommen, dass die Daten zwar in der Registerportal Datenbank erfolgreich gefunden wurden, der Abruf auf das Länderportal jedoch zu Fehlern führt. In diesem Fall werden in der Schnittstelle die gefundenen Daten zurückgegeben, über den http-Status (206/230) ist dann erkennbar, dass es sich nur um ein Teilergebnis handelt. 4.2.3.1 http-Methode GET 4.2.3.2 Pfad „/registerdaten_per_euid“ 4.2.3.3 Input Feldname Datentyp Pflichtfeld Kommentar Beispiel euid String, UTF-8 Ja, Query EUID DEB2609.HRB222 DER2108_R2106.GnR204 siFlag boolean Ja, Query Gibt an, ob zusätzlich zu den Daten das SI- Dokument aus den Landesportalen abgerufen werden soll, mögliche Werte: true/false false
  • 25. Seite 25 / 42 4.2.3.4 Header (Input) Headername Inhalt Accept application/xml;charset=UTF-8 oder application/json;charset=UTF-8 Authorization Bearer <JWT-Token aus authentication> 4.2.3.5 Output http Status Beschreibung Schema Kommentar 200 Alles okay Dokument 206 Ergebnis nicht vollständig Dokument Der Datensatz wurde gefunden. Allerdings konnte das angeforderte SI- Dokumentes nicht vom Landesportal gelesen werden. 230 Ergebnis nicht vollständig Dokument Der Datensatz wurde gefunden. Das angeforderte SI-Dokument wurde nicht vom Landesportal gelesen, da eine Sperre vorliegt. 400 Validierungsfehler Error Mögliche Fehlerursachen:  Pflichtfelder nicht gefüllt  Syntaxprüfung der EUID fehlgeschlagen 401 Authentisierungsfehler Error Mögliche Fehlerursachen:  Token zu alt
  • 26. Seite 26 / 42 404 Nicht gefunden Error Zu dem vorgegebenen Suchkriterium wurde kein Rechtsträger gefunden 409 Konflikt Error Zu dem vorgegebenen Suchkriterium wurde mehr als ein Rechtsträger gefunden 500 Interner Fehler Error Mögliche Fehlerursachen:  Unerwarteter SQL- Fehler  NullPointerException 4.2.3.6 Beispiel
  • 27. Seite 27 / 42 4.2.4 Zugriff über Registerart/Registernummer/Gerichtskennzeichen 4.2.4.1 http-Methode GET Für die Suche über Registerart/Registernummer und Gerichtskennzeichen ist ein JWT- Token erforderlich, dass über ein vorangehendes „authentication“ bezogen werden kann. Die Indexdaten, die zu dem Suchzeitpunkt in der Datenbank des Registerportals abgelegt sind, werden anhand der Registerart, Registernummer und den Gerichtskennzeichen durchsucht. Ein Ergebnis wird nur zurück geliefert, wenn es eindeutig ist. Die Syntax der Eingabefelder wird geprüft, es wird jedoch nicht gesondert geprüft, ob die Gerichtskennzeichen an sich gültig sind, in diesem Fall würden keine Daten gefunden werden und der Returncode „404“ gesetzt werden. Wird bei der Anfrage ein SI angefordert, kann es vorkommen, dass die Daten zwar in der Registerportal Datenbank erfolgreich gefunden wurden, der Abruf auf das Länderportal jedoch zu Fehlern führt. In diesem Fall werden in der Schnittstelle die gefundenen Daten zurückgegeben, über den http-Status (206/230) ist dann erkennbar, dass es sich nur um ein Teilergebnis handelt. 4.2.4.2 Pfad „/registerdaten_per_aktenzeichen“ 4.2.4.3 Input Feldname Datentyp Pflichtfeld Kommentar Beispiel registerArt String Ja, Query Gültige Werte zur Zeit: HRB/HRA/VR/PR/GnR HRA registerNr String, Maximallänge 10 Ja, Query Numerischer Wert 789 gkzNeu String, Maximallänge 5 Ja, Query P2408 gkzAlt String, Maximallänge 5 Nein, Query P2407
  • 28. Seite 28 / 42 siFlag boolean Ja, Query Gibt an, ob zusätzlich zu den Daten das SI-Dokument aus den Landesportalen abgerufen werden soll, mögliche Werte: true/false false 4.2.4.4 Header (Input) Headername Inhalt Accept application/xml;charset=UTF-8 oder application/json;charset=UTF-8 Authorization Bearer < JWT-Token aus authentication> 4.2.4.5 Output http Status Beschreibung Schema Kommentar 200 Alles okay Dokument 206 Ergebnis nicht vollständig Dokument Der Datensatz wurde gefunden. Allerdings konnte das angeforderte SI- Dokumentes nicht vom Landesportal gelesen werden. 230 Ergebnis nicht vollständig Dokument Der Datensatz wurde gefunden. Das angeforderte SI-Dokument wurde nicht vom Landesportal gelesen, da eine Sperre vorliegt. 400 Validierungsfehler Error Mögliche Fehlerursachen:  Pflichtfelder nicht gefüllt
  • 29. Seite 29 / 42  Syntaxprüfung von Registerart, Registernummer oder Gerichtskennzeichen fehlgeschlagen 401 Authentisierungsfehler Error Mögliche Fehlerursachen:  Token zu alt  Signatur des Tokens fehlerhaft 404 Nicht gefunden Error Zu den vorgegebenen Suchkriterien wurde kein Rechtsträger gefunden 409 Konflikt Error Zu den vorgegebenen Suchkriterien wurde mehr als ein Rechtsträger gefunden. 500 Interner Fehler Error Mögliche Fehlerursachen:  Unerwarteter SQL- Fehler  Null Pointer Exception
  • 30. Seite 30 / 42 4.2.4.6 Beispiel 4.2.5 Zugriff über Registerart/Registernummer/Gericht-Städtenamen/Länderkürzel 4.2.5.1 http-Methode GET Für die Suche über Registerart/Registernummer und Städtenamen ist ein JWT-Token erforderlich, dass über ein vorangehendes „authentication“ bezogen werden kann. Die angegebenen Städtenamen werden anhand der Tabelle in Gerichtskennzeichen umgewandelt. Da Städtenamen nicht eindeutig sind, ist die zusätzliche Angabe des Länderkennzeichens erforderlich. Anschließend werden die Indexdaten, die zu dem Suchzeitpunkt in der Datenbank des Registerportals abgelegt sind, anhand der Registerart, Registernummer und den Gerichtskennzeichen durchsucht. Ein Ergebnis wird nur zurück geliefert, wenn es eindeutig ist. Die Syntax der Eingabefelder wird geprüft. Kann ein Städtename nicht in ein Gerichtskennzeichen umgewandelt werden, wird ein Validierungsfehler mit dem Returncode „400“ gesetzt.
  • 31. Seite 31 / 42 Wird bei der Anfrage ein SI angefordert, kann es vorkommen, dass die Daten zwar in der Registerportal Datenbank erfolgreich gefunden wurden, der Abruf auf das Länderportal jedoch zu Fehlern führt. In diesem Fall werden in der Schnittstelle die gefundenen Daten zurückgegeben, über den http-Status (206/230) ist dann erkennbar, dass es sich nur um ein Teilergebnis handelt. 4.2.5.2 Pfad „/registerdaten_per_akz_mit_stadt“ 4.2.5.3 Input Feldname Datentyp Pflichtfeld Kommentar Beispiel registerArt String Ja, Query Gültige Werte zur Zeit: HRB/HRA/VR/PR/GnR HRA registerNr String Maximallänge 10 Ja, Query Numerischer Wert 789 kzLand String, Maximallänge 2 Ja, Query Länderkennzeichen, in dem sich die Städte (stadtNeu, eventuell statdtAlt) befinden. Erlaubte Werte: BE - Berlin BR – Brandenburg BW – Baden-Württemberg BY – Bayern HB – Bremen HE – Hessen HH – Hamburg MV – Mecklenburg- Vorpommern NI – Niedersachsen NW – Nordrhein- Westfalen RP – Rheinland-Pfalz SH – Schleswig-Holstein SL – Saarland SN – Sachsen ST – Sachsen-Anhalt NI
  • 32. Seite 32 / 42 TH – Thüringen stadtNeu String, Maximallänge 50 Ja, Query Hildesheim stadtAlt String, Maximallänge 50 Nein, Query Bad Harzburg siFlag boolean Ja, Query Gibt an, ob zusätzlich zu den Daten das SI- Dokument aus den Landesportalen abgerufen werden soll, mögliche Werte: true/false false 4.2.5.4 Header (Input) Headername Inhalt Accept application/xml;charset=UTF-8 oder application/json;charset=UTF-8 Authorization Bearer < JWT-Token aus authentication> 4.2.5.5 Output http Status Beschreibung Schema Kommentar 200 Alles okay Dokument 206 Ergebnis nicht vollständig Dokument Der Datensatz wurde gefunden. Allerdings konnte das angeforderte SI- Dokumentes nicht vom
  • 33. Seite 33 / 42 Landesportal gelesen werden. 230 Ergebnis nicht vollständig Dokument Der Datensatz wurde gefunden. Das angeforderte SI-Dokument wurde nicht vom Landesportal gelesen, da eine Sperre vorliegt. 400 Validierungsfehler Error Mögliche Fehlerursachen:  Pflichtfelder nicht gefüllt  Syntaxprüfung von Registerart, Registernummer oder Stadt fehlgeschlagen 401 Authentisierungsfehler Error Mögliche Fehlerursachen:  Token zu alt  Signatur des Tokens fehlerhaft 404 Nicht gefunden Error Zu den vorgegebenen Suchkriterien wurde kein Rechtsträger gefunden 409 Konflikt Error Zu den vorgegebenen Suchkriterien wurde mehr als ein Rechtsträger gefunden. 500 Interner Fehler Error Mögliche Fehlerursachen:  Unerwarteter SQL- Fehler  Null Pointer Exception
  • 34. Seite 34 / 42 4.2.5.6 Beispiel 4.2.6 Ausgabe von Gerichten und den zugehörigen Städtenamen 4.2.6.1 http-Methode GET Für die Rückgabe der Gericht-Stadtname Zuordnungen ist ein JWT-Token erforderlich, dass über ein vorangehendes „authentication“ bezogen werden kann. Es wird jeweils eine Tabelle für aktuelle Gerichte und für Altgerichte zurückgegeben. Die Liste umfasst die Daten, die für die Abfragen akzeptiert werden.
  • 35. Seite 35 / 42 4.2.6.2 Pfad „/gerichte“ 4.2.6.3 Header (Input) Headername Inhalt Accept application/xml;charset=UTF-8 oder application/json;charset=UTF-8 Authorization Bearer < JWT-Token aus authentication> 4.2.6.4 Output http Status Beschreibung Schema Kommentar 200 Alles okay Dokument 401 Authentisierungsfehler Error Mögliche Fehlerursachen:  Token zu alt  Signatur des Tokens fehlerhaft 500 Interner Fehler Error Mögliche Fehlerursachen:  Unerwarteter SQL- Fehler  Null Pointer Exception
  • 36. Seite 36 / 42 4.2.6.5 Beispiel 4.2.7 OPTIONS 4.2.7.1 http-Methode OPTIONS Mit der OPTIONS-Methode kann ein Client abfragen, welche http-Methoden der Server unterstützt. Diese Methode erwartet keine Authentifizierung.
  • 37. Seite 37 / 42 4.2.7.2 Pfad „/options“ 4.2.7.3 Output http Status Beschreibung Schema Kommentar 200 Alles okay 4.2.7.4 Header (output) Headername Inhalt Access-Control-Allow-Methods Aufzählung der erlaubten http-Methoden, zur Zeit: GET, PUT, OPTIONS Access-Control-Allow-Headers Aufzählung möglicher Header, zur Zeit Accept, Content-Type, Authorization 4.2.7.5 Beispiel
  • 38. Seite 38 / 42 5 Ortskennzeichen Im Registersystem Aureg kann das Ortskennzeichen (OKZ) Bestandteil der Registernummer eines Rechtsträgers sein. Bundesland Ortskennzeichen Gerichtskennzeichen im Registerportal Ort BE B F1103 Berlin (Charlottenburg) BR CB G1103 Cottbus BR FF G1207 Frankfurt/Oder BR NP G1309 Neuruppin BR P G1312 Potsdam HB BHV H1102 Bremerhaven HB HB H1101 Bremen SH AH X1711 Ahrensburg SH BB X1511 Bad Bramstedt SH BS X1713 Bad Schwartau SH EC X1514 Eckernförde SH EL X1312 Elmshorn SH EU X1716 Eutin SH FL X1112 Flensburg SH GE X1717 Geesthacht SH HL X1721 Lübeck SH HU X1115 Husum SH IZ X1315 Itzehoe SH KA X1116 Kappeln SH KI X1517 Kiel SH ME X1319 Meldorf SH MÖ X1722 Mölln SH NI X1118 Niebüll SH NM X1519 Neumünster SH NO X1526 Norderstedt SH OD X1712 Bad Oldesloe SH OL X1724 Oldenburg (Holstein) (Oldenburg) SH PI X1321 Pinneberg SH PL X1522 Plön SH RD X1524 Rendsburg SH RE X1726 Reinbek SH RZ X1725 Ratzeburg SH SB X1728 Schwarzenbek SH SE X1512 Bad Segeberg SH SL X1119 Schleswig In der Verwaltungsschnittstelle wird das Ortskennzeichen nicht unterstützt, d.h. das Ortskennzeichen muss in Form eines Gerichtskennzeichens in der Schnittstelle übergeben werden, um die gewünschten Datensätze zu finden.
  • 39. Seite 39 / 42 Für die Bundesländer gelten unterschiedliche Regeln: BE: das zum Ortskennzeichen gehörende Gerichtskennzeichen des Registerportals als Neugericht übergeben, das Altgericht mit '00000' füllen BR: das zum Ortskennzeichen gehörende Gerichtskennzeichen des Registerportals als Neugericht übergeben, das Altgericht mit '00000' füllen HB: das zum Ortskennzeichen gehörende Gerichtskennzeichen des Registerportals als Altgericht übergeben SH: das zum Ortskennzeichen gehörende Gerichtskennzeichen des Registerportals als Altgericht übergeben 6 Wertelisten 6.1 Rechtsform Beim Registerportal bekannte Rechtsformen Stand 6/2022: Rechtsform eingetragene Genossenschaft eingetragener Verein Einzelkauffrau Einzelkaufmann Europäische wirtschaftliche Interessenvereinigung HRA Juristische Person Kommanditgesellschaft Offene Handelsgesellschaft Partnerschaft Rechtsform ausländischen Rechts GnR Rechtsform ausländischen Rechts HRA Rechtsform ausländischen Rechts PR
  • 40. Seite 40 / 42 Seerechtliche Gesellschaft Versicherungsverein auf Gegenseitigkeit Anstalt öffentlichen Rechts Bergrechtliche Gewerkschaft Körperschaft öffentlichen Rechts Europäische Genossenschaft (SCE) Stiftung privaten Rechts Stiftung öffentlichen Rechts HRA sonstige Rechtsformen Sonstige juristische Person Einzelkaufmann / Einzelkauffrau Partnerschaftsgesellschaft Aktiengesellschaft Kommanditgesellschaft auf Aktien Gesellschaft mit beschränkter Haftung Europäische Aktiengesellschaft (SE) Rechtsform ausländischen Rechts HRB 7 Logging Es wird ein Logging implementiert, das in Abhängigkeit der Wichtigkeit von Meldungen entscheidet, ob sie geschrieben werden sollen oder nicht. Fehlermeldungen werden über den Loglevel „Error“ protokolliert, Schnittstellen und Laufzeit mit dem Loglevel „Info“. Zusätzliche Meldungen können über den Loglevel „Debug“ bei Bedarf für die Fehlersuche und Tests eingeschaltet werden. Die Konfiguration für die einzelnen Systeme (Test/Produktion) erfolgt individuell über eine XML-Datei.
  • 41. Seite 41 / 42 8 Statistik Um Nachhalten zu können, wie oft die Verwaltungsschnittstelle pro User benutzt wird, werden Informationen über die Aufrufe und deren Ergebnisse festgehalten. Die Anzahl der Aufrufe mit den Informationen, ob sie erfolgreich oder nicht waren, wird in der Tagesstatistik unter den Gesamtabrufen festgehalten. Zusätzlich wird noch festgehalten, bei wie vielen Aufrufen der SI angefordert wurde. Weitere statistische Erhebungen sind nicht geplant. 9 Registrierung zur Nutzung des Dienstes Die Verwaltungsschnittstelle wird öffentlichen Bedarfsträgern, die bereits heute kostenlosen Zugriff auf die Inhalte des Registerportals haben, zur Verfügung gestellt. Dabei geht IT.NRW davon aus, dass die Abrufe für die öffentlichen Bedarfsträger kostenbefreit sind und sie somit uneingeschränkten kostenlosen Zugriff auf Daten aller Bundesländer haben und keine Einschränkungen auf bestimmte Bundesländer bestehen. Eine direkte Verbindung zu bisher bestehenden Nutzern des Registerportals ist nicht zwingend erforderlich. Für die Verwaltungsschnittstelle wird eine Nutzerkennung angelegt, die für diese genutzt werden kann. Bis zu einer möglichen zukünftigen Änderung der Kostenverrechnung und einer Öffnung des Registerportals für generellen kostenlosen Zugriff, ist die Berechtigung der Bedarfsträger zu prüfen und freizugeben. Dieses erfolgt durch die Servicestelle. 9.1 Registrierung Die Registrierung erfolgt direkt bei der Servicestelle. Um einen neuen User für die Verwaltungsschnittstelle anzulegen, erfassen die Nutzer ihre Daten über die bisher bestehende Oberfläche des Registerportals und informieren die Servicestelle, dass es sich um einen Nutzer für die Verwaltungsschnittstelle handelt. Nach Prüfung der Berechtigung gibt die Servicestelle den Nutzer mittels eines Skriptes für die Nutzung der Verwaltungsschnittstelle frei. Um das Skript nicht manuell starten zu müssen, ist es erforderlich, dass eine Änderung an der Nutzerverwaltung der Servicestellenfunktion erfolgt. Durch das Anklicken einer Checkbox wird beim Aktivieren des Nutzers das Skript gestartet. Wenn die Servicestelle den Nutzer für die Verwaltungsschnittstelle frei gibt, trägt das Skript diesen Nutzer als neuen Sondernutzer in der Datenbank ein. Eventuelle Änderungen oder Neuanforderungen für das Kennwort sind über die Standard- Weboberfläche der Nutzerverwaltung möglich. 9.2 Speicherung der Nutzer in der Datenbank Im Hinblick auf eine zukünftige kostenlose Bereitstellung der Daten aus dem Registerportal, werden mittel- bzw. langfristig die Komponenten zur Kostenprotokollierung wegfallen können und damit eine Anpassung der aktuellen Nutzer-DB erforderlich werden. Anstelle der
  • 42. Seite 42 / 42 Kostenprotokollierung gibt es dann eine Abrufprotokollierung in einer eigenen Datenbank oder Tabelle. Bis die Erstellung einer neuen Nutzer-DB abgeschlossen ist, wird die bestehende Nutzerdatenbank so erweitert, dass die Nutzer der Verwaltungsschnittstelle aufgenommen werden können. Die Verwaltung wird ähnlich dem bisherigen Vorgehen für „Sondernutzer“ aufgebaut, d.h. über eine neue Spalte „rp_vss_aufruf“ als Erweiterung der bestehenden Tabelle für Sondernutzer kann das Recht zur Nutzung der Verwaltungsschnittstelle gesetzt oder entzogen werden. 10 Notwendige Erweiterung der Infrastruktur Der Webservice für die Verwaltungsschnittstelle sollte auf einem eigenen Webserver laufen, um die Zugriffe und die damit verbundene Last vom standardmäßigen Betrieb des Registerportals zu entkoppeln. Dabei geht IT.NRW aus Gründen der Redundanz initial von zwei zusätzlichen Webservern für die produktive Umgebung aus. Abhängig von der Anzahl zukünftiger Nutzer und der Auslastung des Service kann eine Erweiterung der Ressourcen / Anzahl Sever notwendig werden.