OASIS Beschreibung OASIS-Webservice Release 5.8 - veröffentlicht am 26.01.2021 - ADD RLP
←
→
Transkription von Seiteninhalten
Wenn Ihr Browser die Seite nicht korrekt rendert, bitte, lesen Sie den Inhalt der Seite unten
OASIS Beschreibung OASIS-Webservice Release 5.8 veröffentlicht am 26.01.2021
1. Zusammenfassung
Inhaltsverzeichnis
Zusammenfassung...................................................................................................... 7
Schnittstellenfunktionen und XML-Schema .............................................................. 7
2.1 Schnittstellenfunktionen ................................................................................................ 7
2.2 HTTP-Header Parameter .............................................................................................. 9
Meldungen ................................................................................................................. 10
3.1 Meldungskatalog ......................................................................................................... 10
Verwendeter Zeichensatz ......................................................................................... 14
4.1 Erlaubte Zeichen ......................................................................................................... 14
4.1.1 Hinweise zur Schreibweise - Grundsatz.......................................................................14
4.1.2 Buchstaben ...................................................................................................................15
4.1.3 Ziffern ...........................................................................................................................16
4.1.4 Sonderzeichen..............................................................................................................16
4.2 Zeichensätze Kategorien ............................................................................................. 16
4.2.1 Kategorie 1: Erlaubte Zeichen für die Abfrage des Spielerstatus ................................17
4.2.2 Kategorie 2: Erlaubte Zeichen für das Anlegen und Ändern einer neuen Sperre ........17
Übersicht Basistypen ................................................................................................ 18
5.1 Einfache Typen im Schema oasisBasistypen.xsd ........................................................ 18
5.2 Komplexe Typen im Schema oasisBasistypen.xsd ...................................................... 20
Statusabfrage ............................................................................................................ 21
6.1 Parameter ................................................................................................................... 22
6.2 Beispiel 22
6.2.1 Request ........................................................................................................................22
6.2.2 Response .....................................................................................................................23
6.3 Response Meldungen ................................................................................................. 23
Bearbeitung der Sperren Version 4.8....................................................................... 24
7.1 Anlegen einer Sperre .................................................................................................. 24
OASIS Schnittstellenbeschreibung Seite 21. Zusammenfassung
7.1.1 Parameter .....................................................................................................................25
7.1.2 Beispiel .........................................................................................................................26
7.2 Response Meldungen ................................................................................................. 27
7.3 Ändern einer Sperre .................................................................................................... 28
7.3.1 Parameter .....................................................................................................................28
7.3.2 Beispiel .........................................................................................................................29
7.4 Response Meldungen ................................................................................................. 30
7.5 Aufheben einer Spielersperre ...................................................................................... 31
7.5.1 Parameter .....................................................................................................................31
7.5.2 Beispiel .........................................................................................................................31
7.5.3 Response Meldungen ..................................................................................................32
Bearbeitung der Sperren Version 5.4....................................................................... 33
8.1 Anlegen einer Sperre .................................................................................................. 34
8.1.1 Parameter .....................................................................................................................34
8.1.2 Beispiel unbefristete Sperre .........................................................................................35
8.1.3 Beispiel befristete Sperre .............................................................................................36
8.2 Response Meldungen ................................................................................................. 38
8.3 Ändern einer Sperre .................................................................................................... 38
8.3.1 Parameter .....................................................................................................................39
8.3.2 Beispiel Ändern einer unbefristeten Sperre .................................................................40
8.3.3 Beispiel Ändern einer befristeten Sperre .....................................................................41
8.4 Response Meldungen ................................................................................................. 43
8.5 Aufheben einer Spielersperre ...................................................................................... 44
8.5.1 Parameter .....................................................................................................................44
8.5.2 Beispiel unbefristete Sperre .........................................................................................44
8.5.3 Beispiel befristete Sperre .............................................................................................45
8.5.4 Response Meldungen ..................................................................................................46
Kataloge laden........................................................................................................... 47
9.1 Länderkatalog ............................................................................................................. 47
9.1.1 Parameter .....................................................................................................................47
9.1.2 Beispiel .........................................................................................................................47
9.2 Katalog Sperranlässe .................................................................................................. 48
9.2.1 Parameter .....................................................................................................................48
9.2.2 Beispiel .........................................................................................................................48
Seite 3 OASIS Schnittstellenbeschreibung1. Zusammenfassung
9.3 Katalog Aufhebungsgründe ......................................................................................... 49
9.3.1 Parameter .....................................................................................................................49
9.3.2 Beispiel .........................................................................................................................49
9.4 Response Meldungen ................................................................................................. 50
Eigene Sperren Version 4.8 ...................................................................................... 50
10.1 Eigene Sperren abfragen ............................................................................................ 51
10.1.1 Parameter .....................................................................................................................51
10.1.2 Beispiel .........................................................................................................................51
10.2 Eigene Sperren suchen mit Spielerdaten .................................................................... 52
10.2.1 Parameter .....................................................................................................................52
10.2.2 Beispiel .........................................................................................................................52
10.3 Eigene Sperren suchen mit SperrID ............................................................................ 53
10.3.1 Parameter .....................................................................................................................53
10.3.2 Beispiel .........................................................................................................................54
10.4 Response Meldungen ................................................................................................. 54
Eigene Sperren Version 5.4 ...................................................................................... 55
11.1 Eigene Sperren abfragen ............................................................................................ 55
11.1.1 Parameter .....................................................................................................................55
11.1.2 Beispiel .........................................................................................................................55
11.2 Eigene Sperren suchen mit Spielerdaten .................................................................... 57
11.2.1 Parameter .....................................................................................................................57
11.2.2 Beispiel unbefristete Sperre .........................................................................................57
11.2.3 Beispiel befristete Sperre .............................................................................................58
11.3 Eigene Sperren suchen mit SperrID ............................................................................ 59
11.3.1 Parameter .....................................................................................................................60
11.3.2 Beispiel unbefristete Sperre .........................................................................................60
11.3.3 Beispiel befristete Sperre .............................................................................................60
11.4 Response Meldungen ................................................................................................. 61
Passwort ändern ....................................................................................................... 62
12.1 Parameter ................................................................................................................... 62
12.2 Beispiel 62
12.2.1 Request ........................................................................................................................62
12.2.2 Response .....................................................................................................................63
OASIS Schnittstellenbeschreibung Seite 41. Zusammenfassung
12.3 Response Meldungen ................................................................................................. 63
12.4 Konzession prüfen....................................................................................................... 63
12.5 Parameter ................................................................................................................... 63
12.6 Beispiel 64
12.6.1 Request ........................................................................................................................64
12.6.2 Response .....................................................................................................................64
12.7 Response Meldungen ................................................................................................. 64
Verfügbarkeit prüfen ................................................................................................. 65
13.1 Parameter ................................................................................................................... 65
13.2 Beispiel 65
13.2.1 Request ........................................................................................................................65
13.2.2 Response .....................................................................................................................66
13.3 Response Meldungen ................................................................................................. 66
Batch 66
14.1 Anlegen einer Batchabfrage ........................................................................................ 67
14.1.1 Parameter .....................................................................................................................67
14.1.2 Beispiel .........................................................................................................................68
14.1.3 Response Meldungen ..................................................................................................70
14.2 Abholen eines Batchjob-Ergebnisses .......................................................................... 71
14.2.1 Parameter .....................................................................................................................71
14.2.2 Beispiel .........................................................................................................................71
14.2.3 Response Meldungen ..................................................................................................74
14.3 Statusabfrage eigener Batchjobs................................................................................. 75
14.3.1 Parameter .....................................................................................................................75
14.3.2 Beispiel .........................................................................................................................75
14.3.3 Response Meldungen ..................................................................................................76
Betriebliche Response Meldungen .......................................................................... 77
15.1 Beispiel 77
15.1.1 Response XML für 0052 Meldung ................................................................................77
15.1.2 Response XML für 0053 Meldung ................................................................................77
Rechte in OASIS WS ................................................................................................. 78
Seite 5 OASIS Schnittstellenbeschreibung1. Zusammenfassung
Änderungen gegenüber Release 4.6 ........................................................................ 78
Änderungen gegenüber Release 4.8 ........................................................................ 79
Änderungen gegenüber Release 5.0 ........................................................................ 79
Änderungen gegenüber Release 5.2 ........................................................................ 79
Änderungen gegenüber Release 5.4 ........................................................................ 80
Änderungen gegenüber Release 5.6 ........................................................................ 80
OASIS Schnittstellenbeschreibung Seite 61. Zusammenfassung
Zusammenfassung
Dieses Dokument beinhaltet die Beschreibung des OASIS-Webservices auf Basis des
Glücksspielstaatsvertrages (GlüStV)
des Hessischen Glückspielgesetzes (HGlüG)
Hessischen Spielhallengesetzes (HSpielhG)
Landesglücksspielgesetzes Rheinland-Pfalz (LGlüG-RP)
der beim Zugriff auf OASIS zu verwenden ist.
Sofern im Dokument Änderungen gegenüber der Vorgänger-Version vorgenommen werden, werden
sie im Text gelb markiert. Dies soll der einfacheren Lesbarkeit des Dokuments im Abgleich mit der
Vorgänger-Version dienen. Eine Zusammenfassung der aktuellen Änderungen je Version ist im letzten
Kapitel des Dokuments aufgelistet.
Statt Versionsnummer wird der Titel des vorliegenden Dokuments die aktuellen Releasenummer von
OASIS beinhalten,weil jede Schnittstellenfunktion eine eigene Version hat.
Bitte beachten Sie, dass die in den Beispielen aufgeführten Namespace-Präfixe nur Beispiele sind und
variieren können.
Schnittstellenfunktionen und XML-Schema
Der OASIS-Webservice ist an REST angelehnt. Anfragen an den Webservice verlaufen via http und
enthalten im Content XML-Dateien. Zur Validierung der XML-Dateien liegen XML-Schemata vor. Neben
der Validierung gegen die XML-Schemata wird an einzelnen Stellen noch weitergehend validiert. Dies
ist in der folgenden Beschreibung jeweils gesondert aufgeführt.
Die Reihenfolge der XML-Tags ist durch die XSD-Dateien definiert.
Der OASIS-Webservice ist zustandslos und arbeitet synchron.
Grundsatz:
Unterstützt wird ausschließlich UTF-8 ohne BOM.
2.1 Schnittstellenfunktionen
OASIS Schnittstellenfunktionen
Produktion URL-Root = https://oasis.hessen.de/oasisws/
Integrationstestumgebung URL-Root = https://oasis-tst-crt.hessen.de/oasisws/
Seite 7 OASIS Schnittstellenbeschreibung2. Schnittstellenfunktionen und XML-Schema
Nr Funktion http- URL Request-Pay- Response-Payload Gültige
. method load Version(en)
1 Statusabfrage POST /spielerstatus spielerSuchpa- statusabfrageTref- 4.8
rameter.xsd fer.xsd
2 Sperre anlegen POST /sperren sperrdaten.xsd sperreAnlegenA- 4.8 (deprecated)
endernErgebnis.xsd 5.4 (*)
3 Sperre ändern PUT /sperren/{sper- sperrdaten.xsd sperreAnlegenA- 4.8 (deprecated)
rid} endernErgebnis.xsd 5.4 (*)
4 Sperre aufhe- DELETE /sperren/{sper- - sperreAufhebenEr- 4.8 (deprecated)
ben rid} gebnis.xsd 5.4 (*)
5 Länderkatalog GET /kataloge/laen- - oasisKatalog.xsd 4.8
holen der
6 Katalog Sper- GET /kataloge/sper- - oasisKatalog.xsd 4.8
ranlässe holen ranlaesse
7 Katalog Aufhe- GET /kataloge/aufhe- - oasisKatalog.xsd 4.8
bungsgründe bungsgruende
holen
8 Passwort än- PUT /betriebs- - meldungskatalogI- 4.8
dern staette/passwort tem.xsd
9 Konzession ab- GET /betriebs- - konzessionsda- 4.8
fragen staette/konzes- ten.xsd
sion
10 Alle eigenen GET /betriebs- - eigeneSperren.xsd 4.8 (deprecated)
Sperren abfra- staette/sperren 5.4
gen
11 eigene Sperren POST /betriebs- spielerSuchpa- eigeneSperren.xsd 4.8 (deprecated)
mit Spielerda- staette/sperren rameter.xsd 5.4
ten suchen
12 eine Sperre mit GET /betriebs- - eigeneSperren.xsd 4.8 (deprecated)
bekannter staette/sper- 5.4
SperrID abfra- ren/{sperrId}
gen
OASIS Schnittstellenbeschreibung Seite 82. Schnittstellenfunktionen und XML-Schema
13 Verfügbarkeits- GET /verfuegbarkeit - meldungskatalogI- 4.8
abfrage tem.xsd
(*) Im Falle des Inkrafttretens des GlüStV 2021 ab dem 1. Juli 2021 gilt diese Schnittstelle als deprecated.
Weitere Informationen dazu finden Sie in Kapitel 22.
Batch-Funktionen
Produktion URL-Batch-Root = https://oasis.hessen.de/oasisbatchws/
Integrationstestumgebung URL-Batch-Root = https://oasis-tst-crt.hessen.de/oasisbatchws/
15 Batchjob ein- POST /batch batchAnlegen- batchAnlegenErgeb- 4.8
stellen Payload.xsd nis.xsd
(gzip)
16 Status eigener GET /auftraege - batchJobs.xsd 4.8
Batchjobs ab-
fragen
17 Ergebnis eines GET /batch/{bat- - batchErgebnis.xsd 4.8
Batchjobs ab- chId} (gzip)
fragen
Tabelle 1 : Schnittstellenfunktionen
2.2 HTTP-Header Parameter
Im Folgenden werden die möglichen Header-Parameter beschrieben. Die Verwendung ist bei den
Schnittstellen beschrieben.
Name Inhalt Pattern Bemerkung
Kennung Kennung der Betriebsstätte [0-9A-Z]{1,30}
Passwort Passwort des Superusers WS [\wÄäÖöÜüß!#$%'()*+,-
der Betriebsstätte ./:;=?|~§_]{8,20}
PasswortNeu neues Passwort beim Ändern [\wÄäÖöÜüß!#$%'()*+,- nur erforderlich in der Funktion
des Betriebsstättenpassworts ./:;=?|~§_]{8,20} Passwort ändern
Accept text/plain; charset=UTF-8; Jede Funktion hat eine eigene Ver-
version=x.x sion.
(für alle Funktionen außer
Die Angabe der Versionsnummer im
Accept-Header ist Pflicht. Anfragen,
Seite 9 OASIS Schnittstellenbeschreibung3. Meldungen
Abholen eines Batch-Ergeb- die dies nicht gesetzt haben, wer-
nisses) den abgelehnt.
application/gzip; char-
set=UTF-8; version=x.x
(Abholen enes Batch-
Ergebnisses)
Aufhebungsgrund Aufhebungsgrund für die Auf- ^[0-9]{1,10}$^ Nur erforderlich in der Funktion
hebung einer Sperre vor Ab- „Sperre Aufheben“, und zwar, wenn
lauf der Mindestfrist die Mindestfrist der Sperre nicht er-
reicht wurde
Content-Length Erforderlich für alle Funktionen mit
Request-Payload
Content-Type application/gzip (für die Funk- Erforderlich für die Funktion „Anle-
tion Anlegen einer Batchab- gen einer Batchabfrage“
frage)
Tabelle 2: HTTP-Header Parameter
Meldungen
3.1 Meldungskatalog
Im Folgenden werden alle mögliche Meldungen beschrieben. Die Verwendung wird bei den Schnittstel-
len beschrieben.
Schlüssel Art Meldung Bemerkung
Das Passwort ist falsch
„Sie haben keine Berechtigung“ oder „Sie haben oder das Zertifikat ist
0001 E
keine Berechtigung (kein gültiges Zertifikat)“ nicht gültig für das ange-
gebene Konto
Das Super-User Pass-
Ihr Zugang wurde gesperrt. Bitte wenden Sie sich an
wort kann durch den
0002 E den Super-User. Als Super-User wenden Sie sich
OASIS IT-Service Desk
bitte an die Hotline (Tel 06652/1872212)
zurückgesetzt werden.
Es ist ein Serverfehler aufgetreten. Bitte wenden Sie
0003 E
sich an die Hotline (Tel 06652/1872212).
Das Beenden oder Än-
dern von Sperren, die
Änderung oder Beenden der Sperre ist nicht möglich:
0004 E nicht dem angemeldeten
es wurde kein Sperreintrag zum Spieler gefunden.
Veranstalter zugeordnet
sind, kann auch mit
OASIS Schnittstellenbeschreibung Seite 103. Meldungen
Kenntnis der SperrID
nicht durchgeführt wer-
den.
Die Person wurde mit Datum erfolg- Das Anlegen der Sperre
0007 I
reich gesperrt. war erfolgreich
Sie haben keine Berechtigung, diese Sperre zu än- Sperre gehört einer an-
0008 E
dern. deren Betriebsstätte
Die Spielerdaten wurden am erfolg-
0009 I
reich geändert.
Sie haben keine Berechtigung, diese Sperre aufzuhe- Sperre gehört einer an-
0010 E
ben. deren Betriebsstätte
Die Spielersperre wurde am erfolg-
0011 I
reich aufgehoben.
0014 E Das XML ist nicht schemakonform. Allgemeiner Fehler
Es ist ein Plausibilisierungsfehler aufgetreten.
„Sie haben keine gültige Konzession/Erlaubnis.“ oder
0016 E „Sie haben keinen Zugang zum System, da Ihre Kon-
zession/Erlaubnis ruht.“
0017 I Die Konzession/Erlaubnis ist gültig.
Ein Sperreintrag anhand
der Abfrage konnte ein-
deutig identifiziert wer-
den.
0018 W Der Spieler ist gesperrt.
Enthält einen Verweis
auf den Veranstalter, der
für die Sperre ände-
rungsberechtigt ist.
Es gab keinen zur Ab-
0019 I Der Spieler ist nicht gesperrt. frage passenden Eintrag
in OASIS
0020 I Das Passwort wurde erfolgreich geändert.
0021 E Sie dürfen OASIS WS nicht verwenden
0022 E Sie dürfen OASIS WEB nicht verwenden NUR OASIS WEB
Es gibt mehr als einen
Sperreintrag zur Abfrage,
aber die Abfrage wurde
mit wenigen Attributen
Der Spieler ist gesperrt. Es gab mehr als einen Treffer
0023 W geführt. Die Abfrage
für Ihre Abfrage.
kann mit mehr Attributen
wiederholt werden, um
Eindeutigkeit zu errei-
chen.
Es gibt mehr als einen
Der Spieler ist gesperrt. Es gab mehr als einen Treffer Sperreintrag zur Abfrage,
0024 W
für Ihre Abfrage. aber die Abfrage kann
nicht erweitert werden.
Die Daten werden gerade von einem anderen Benut-
0040 E
zer geändert.
Seite 11 OASIS Schnittstellenbeschreibung3. Meldungen
0041 W Sie müssen Ihr Initialpasswort ändern. NUR OASIS WEB
0042 I Der Benutzer wurde erfolgreich angelegt. NUR OASIS WEB
Passwortänderung fehlgeschlagen, da der angege- NUR OASIS WEB
0043 E
bene Benutzer nicht bekannt ist.
Für den angegebenen Benutzer dürfen Sie das Pass- NUR OASIS WEB
0044 E
wort nicht ändern.
Das neue Passwort muss sich von dem bisherigen
0045 E
unterscheiden.
Die Angaben zum Benutzer wurden erfolgreich geän-
0047 I
dert.
0049 I Die Abfrage wurde erfolgreich durchgeführt.
0050 I
Ihre Zugangsberechtigung wurde deaktiviert - bitte
0051 E
wenden Sie sich an die Hotline (Tel 06652/1872212)
Eine Wartungsmeldung
wird durch OASIS Be-
Derzeit werden geplante Wartungsarbeiten am
0052 I trieb eingeschaltet, wenn
OASIS-Service durchgeführt.
eine Wartung ausgeführt
wird.
Eine Störungsmeldung
Derzeit liegt eine Störung von OASIS vor. An der Ent- wird durch OASIS Be-
0053 E
störung wird derzeit gearbeitet. trieb eingeschaltet, falls
eine Störung vorliegt.
Einstellen von Batchanfragen: Die maximale Anzahl
0054 W gleichzeitig laufender Batchabfragen ist erreicht. Bitte
versuchen Sie es später nochmal.
Einstellen von Batchanfragen: Übertragener Inhalt
0060 E
kann nicht in eine Batchanfrage konvertiert werden
Die maximal erlaubte An-
zahl der Datensätze wer-
den individuell vertraglich
Einstellen von Batchanfragen: Batch beinhaltet zu
0061 E vereinbart, und im Sys-
viele Datensätze
tem hinterlegt. Eine
Überschreitung ist tech-
nisch nicht möglich.
Ein identischer Batch
kann innerhalb eines
Einstellen von Batchanfragen: Identischer Batch
0062 E Zeitfensters nur genau 1-
wurde bereits beauftragt
mal hochgeladen wer-
den.
Einstellen von Batchanfragen: Batch wurde nicht im
0063 E
korrekten Zeitfenster beauftragt
Einstellen von Batchanfragen: Betriebsstätte ist nicht
0064 E
berechtigt einen Batch zu beauftragen
Einstellen von Batchanfragen: Maximale Anzahl von
0065 E
Batches pro Zeitfenster überschritten
Einstellen von Batchanfragen: Batchverarbeitung
0066 E
wurde aus betrieblichen Gründen temporär gesperrt
Ergebnisse von Batchanfragen: Fehler bei der Verar-
0070 E
beitung eines Batch aufgetreten
Ergebnisse von Batchanfragen: Batchverarbeitung
0071 E
wurde manuell abgebrochen
OASIS Schnittstellenbeschreibung Seite 123. Meldungen
Ergebnisse von Batchanfragen: Berechtigung zur
0072 E
Batchverarbeitung wurde entzogen
Ergebnisse von Batchanfragen: Der Batch existiert
0073 E
nicht oder nicht mehr
Ergebnisse von Batchanfragen: Das Ergebnis steht
0074 E nicht mehr zur Verfügung, da es bereits am
abgeholt wurde
Diese Fehlermeldung
wird erzeugt, wenn ver-
Ergebnisse von Batchanfragen: Der Batch befindet
sucht wird das Ergebnis
0075 E sich noch in Bearbeitung. Das Ergebnis liegt noch
einer Batch-Abfrage ab-
nicht vor
zuholen, die noch in Be-
arbeitung ist.
Diese Fehlermeldung
wird erzeugt, wenn ver-
Ergebnisse von Batchanfragen: Der Batch wurde sucht wird das Ergebnis
0076 E
noch nicht begonnen einer Batch-Abfrage ab-
zuholen, die noch nicht
begonnen wurde.
Einstellen von Batchanfragen: Die Batchabfrage
0077 I
wurde erfolgreich hochgeladen
Der Batchlauf wurde
Ergebnisse von Batchanfragen: kein Fehler aufgetre-
0078 I ohne Warnung oder Feh-
ten
ler beendet.
Bei mindestens einer
Spielerstatusabfrage
sind Fehler aufgetre-
ten.Die Batchverarbei-
tung konnte aber mit
dem nächsten zu verar-
beitenden Datensatz fort-
fahren.
Globale Meldung im Ele-
ment : „Batch-
0079 W
Warnungen beendet abfrage mit Warnungen
beendet“
Welcher Datensatz / wel-
che Datensätze Fehler
verursacht hat / haben,
ist im Element des Datensatzes
einzusehen.
Die Batchabfrage als
Ergebnisse von Batchanfragen: Batchabfrage mit Ganzes konnte nicht
0080 E
Fehlern beendet ausgeführt werden, z.B.
nicht valides XML, oder
Seite 13 OASIS Schnittstellenbeschreibung4. Verwendeter Zeichensatz
die Datenbank steht nicht
zur Verfügung, etc.
Da es hierführ mehrere
Fehlermöglichkeiten gibt,
steht in < MELDUNG >
die entsprechende Feh-
lermedung und kein fes-
ter Text.
Einstellen von Batchanfragen: Hochgeladene Datei
0081 E
konnte nicht als gzip entpackt werden
Tabelle 3: Meldungskatalog
Verwendeter Zeichensatz
Für die XML-Nachrichten ist als Encoding UTF-8 zu verwenden. Für einzelne Felder wird der Zeichen-
satz auf den durch DIN SPEC 91379 herausgegebenen Standard „Normative Zeichen“ (Zeichen der
Gruppen, die als normativ bezeichnet werden) eingeschränkt. Dieser Zeichensatz beinhaltet die latei-
nischen Zeichen aus Unicode einschließlich diakritischer Zeichen und Ligaturen.
Der Zeichensatz im XML-Schema latinchars.xsd wird nicht mehr explizit verwendet.
Hinweis: Das durch DIN SPEC 91379 zur Verfügung gestellte XML-Schema hat als Schema-Attribut
„elementFormDefault“ mit dem Wert „qualified“. Da OASIS durchgängig mit dem Wert „unqualified“
arbeiten soll, weicht die hier ausgelieferte XML-Schema-Datei von der durch DIN SPEC 91379 zur
Verfügung gestellten in diesem Punkt ab.
4.1 Erlaubte Zeichen
Die erlaubten Zeichen sind die Zeichen der Gruppen, die als normativ bezeichnet werden. Unerlaubte
Sonderzeichen sollten bei der Anfrage unterbunden und nicht an OASIS geschickt werden.
4.1.1 Hinweise zur Schreibweise - Grundsatz
Die Eingabe der Daten muss genau in der Form erfolgen, wie sie im lesbaren Bereich in einem amtli-
chen Ausweisdokument in lateinischer Schrift festgelegt ist.
Der maschinenlesbare Bereich wird nicht unterstützt.
OASIS Schnittstellenbeschreibung Seite 144. Verwendeter Zeichensatz
4.1.2 Buchstaben
Erlaubte Buchstaben sind [A-z] sowie:
A̋a̋ÀÁÂÃàáâãĀāĂ㥹ǍǎȧẠẠ̈ạạ̈ẢảẤấẦầẨẩẪẫẬậẮắẰằẲẳẴẵẶặ
ÄÆäæǞǟǢǣǼǽ
ÅåǺǻ
ḂḃḆḇ
C̀C̄C̆C̈C̕C̣C̦C̆ ̨ c̀c̄c̆c̈c̕c ̣c̦c̨̆ ÇÇ̆çç̆ĆćĈĉĊċČČ̕Č̣čč̕čƇ
̣ ƈ
D̂d̂ÐðĎďĐđḊḋḌḍḎḏḐḑ
ÈÉÊËèéêëĒēĔĕĖėĘęĚěƏȨȩəḜḝẸẹẺẻẼẽẾếỀềỂểỄễỆệ
F̀ F̄f̀f̄Ḟḟ
G̀g̀ĜĝĞğĠġĢģǤǥǦǧǴǵḠḡ
H̄H̦H̱h̄h̦ĤĥĦħȞȟḢḣḤḥḦḧḨḩḪḫẖ
ÌÍÎÏìíîïĨĩĪĪ́īī́ĬĭĮįİıƗǏǐɨḯỈỉỊị
J́J̌ ȷĴ́ ĵǰ
IJij
K̀ K̂K̄K̇ K̕K̛ K̦k̀ k̂k̄k̇ k̕k̛ k̦ĶķĸǨǩḰḱḲḲ̄ ḳḳ̄ Ḵḵ
K͟ H K͟ h k͟ h
L̂L̥ L̥̄ L̦l̂l̥ l̥̄ l̦ ĹĺĻļĽľĿŀŁłḶḷḺḻ
M̀M̂M̆M̐ m̀m̂m̆m̐ ṀṁṂṃ
N̂N̄N̆N̦n̂n̄n̆n̦ÑñŃńŅņŇňʼnŊŋǸǹṄṅṆṇṈṉ
ÒÓÔÕòóôõŌōŎŏŐőƠơǑǒǪǫǬǭȬȭȮȯȰȱṒṓỌỌ̈ ọọ̈ ỎỏỐốỒồỔổỖỗỘộỚớỜờỞởỠ
ỡỢợ
ÖØöøŒœǾǿȪȫ
P̀P̄P̕P̣p̀p̄p̕pṔṕṖṗ
̣
R̆R̥ R̄ ̥ r̆ r̥ r̥ ̄ ŔŕŖŗŘřȒȓṘṙṚṛṞṟ
S̀S̄S̛̄ S̱s̀s̄s̄ ̛ s̱ŚśŜŝŞşŠšȘșṠṡṢṢ̄ ṣṣ̄
ßẞ
T̀ T̄T̈T̕T̛ t̀t̄t̕t̛ ŢţŤťŦŧȚțṪṫṬṬ̄ ṭṭ̄ Ṯṯẗ
Þþ
U̇ u̇ ÙÚÛÛ̄ ùúûû̄ ŨũŪūŬŭŮůŰűŲųƯưǓǔỤỤ̄ Ụ̈ ụụ̄ ụ̈ ỦủỨứỪừỬửỮữỰự
Seite 15 OASIS Schnittstellenbeschreibung4. Verwendeter Zeichensatz
ÜüǕǖǗǘǙǚǛǜ
ŴŵẀẁẂẃẄẅẆẇ
Ẍẍ
Ýýÿÿ́ ŶŷŸȲȳẎẏỲỳỴỵỶỷỸỹ
Z̀ Z̄Z̆Z̈Z̧z̀z̄z̆z̈z̧ŹźŻżŽŽ̦ Ž̧žž̦ ž̧ƷǮǯʒẐẑẒẓẔẕ
Abbildung 1: Diakritika und Ligaturen
4.1.3 Ziffern
0123456789
Abbildung 2: numerische Zeichen
4.1.4 Sonderzeichen
!"'´`#%&()*,-./:;?@[\]_{}¡«·»¿$+^|~¢£¤¥¦§©¬®°±¶×÷€¸¨¯ , sowie das Leerzeichen
Abbildung 3: Sonderzeichen
Hinweis: Einige Zeichen haben in einem XML-Dokument eine besondere Bedeutung und dürfen deshalb
NICHT als Werte in einem XML Dokument auftauchen. Für diese Zeichen muss die XML-Notation ver-
wendet werden.
Zeichen XML-Notation
< <
> >
& &
" "
' '
Abbildung 4: Sonderzeichen und XML-Notation
4.2 Zeichensätze Kategorien
Die erlaubten Zeichen werden nach Funktion eingeschränkt.
OASIS Schnittstellenbeschreibung Seite 164. Verwendeter Zeichensatz
4.2.1 Kategorie 1: Erlaubte Zeichen für die Abfrage des Spielersta-
tus
Bei einer Statusabfrage werden die nach DIN SPEC 91379 herausgegebenen „Normative Zeichen“
(Zeichen der Gruppen, die als normativ bezeichnet werden) als erlaubte Zeichen zugelassen. Dies
wurde nötig, um auch Datensätze finden zu können, die Zeichen enthalten, die nicht den OASIS Rest-
riktionen genügen, aber aus Vorsystemen übernommen werden mussten.
Erlaubte Erlaubte Erlaubte
Buchstaben Ziffern Sonderzeichen
Element
(siehe Abschnitt (siehe Abschnitt (siehe Abschnitt
4.1.2) 4.1.3) 4.1.44)
V (Vorname) „alle“ 0-9 „alle“
N (Nachname) „alle“ 0-9 „alle“
D (Geburtsdatum) keine 0-9 -
G (Geburtsname) „alle“ 0-9 „alle“
O (Geburtsort) „alle“ 0-9 „alle“
Anschrift.P (PLZ) „alle“ 0-9 „alle“
Anschrift.W (Ort) „alle“ 0-9 „alle“
Anschrift.S (Strasse) „alle“ 0-9 „alle“
Anschrift.H (Hausnr) „alle“ 0-9 „alle“
Anschrift.Z (Adresszusatz) „alle“ 0-9 „alle“
Tabelle 4: Kategorie 1: Erlaubte Zeichen für die Abfrage des Spielerstatus
4.2.2 Kategorie 2: Erlaubte Zeichen für das Anlegen und Ändern ei-
ner neuen Sperre
Beim Anlegen einer neuen Sperre werden die nach DIN SPEC 91379 herausgegebenen „Normative
Zeichen“ weiter eingeschränkt, um eine zuverlässigere Identifikation von Datensätzen zu ermöglichen.
erlaubte erlaubte
erlaubte
Buchstaben Ziffern
Element Sonderzeichen
(siehe Kapitel (siehe Kapitel
(siehe Kapitel 4.1.44)
4.1.12) 4.1.33)
V (Vorname) „alle“ „keine“ .-´`'
N (Nachname) „alle“ „keine“ .-´`'
D (Geburtsdatum) keine 0-9 -
Seite 17 OASIS Schnittstellenbeschreibung5. Übersicht Basistypen
G (Geburtsname) „alle“ „keine“ .-´`'
O (Geburtsort) „alle“ „keine“ .-´`',/()
Anschrift.P (PLZ) „alle“ 0-9 -
Anschrift.W (Ort) „alle“ „keine“ .-´`',/()
Anschrift.S (Strasse) „alle“ 0-9 .-´`',/
Anschrift.H (Hausnr) „alle“ 0-9 -/.,
Anschrift.Z (Adresszusatz) „alle“ 0-9 .-´`',;/()&+
Tabelle 5: Kategorie 2: Erlaubte Zeichen für das Anlegen und Ändern einer neuen Sperre
Übersicht Basistypen
5.1 Einfache Typen im Schema oasisBasistypen.xsd
Typname im XML- Schema Datentyp Verwendung Einschränkungen
t_adresszusatz DIN SPEC in Spieleranschrift Maximal 256 Zeichen
91379
t_geburtsdatum xs:string Geburtsdatum eines ([0-9]{4})\-([0-9]{2}|-{2})\-
Spielers ([0-9]{2}|-{2})
t_land xs:string 3stelliger numerischer ([0-9]{3})?
Schlüssel für das Land
entsprechend dem durch
Destatis veröffentlichten
Länderkatalog. Der Kata-
log wird durch den
OASIS-Webservice als
XML bereitgestellt
t_name DIN SPEC Datentyp für Vorname, Maximal 85 Zeichen
91379 Nachname, Geburts-
name, Geburtsort und
Wohnort eines Spielers
t_passwort xs:string Datentyp für ein Pass- Mindestens 8, höchstens
wort in OASIS. 16 Zeichen
[\wÄäÖöÜüß!#$%'()*+,-
\./:;=?|~§_]{8,20}
OASIS Schnittstellenbeschreibung Seite 185. Übersicht Basistypen
t_plz_hausnummer DIN SPEC Datentyp für die Postleit- Maximal 20 Zeichen
91379 zahl bzw. die Hausnum-
mer der Anschrift eines
Spielers
t_sperrgrund xs:string- Grund der Sperre; er- FREMD, SELBST
basierte laubt sind nur SELBST
Enumera- und FREMD
tion
t_sperrid xs:integer Datentyp für die SperrID, [Integer]
die automatisch generiert
wird und jede Sperre ein-
deutig referenziert
t_strasse DIN SPEC Datentyp für die Straße Maximal 150 Zeichen
91379 der Anschrift eines Spie-
lers
t_meldungsart xs:string- Meldet, ob die Anfrage I, W, E
basierte an OASIS erfolgreich
Enumera- war.
tion
t_schluessel xs:string Gibt den eindeutigen [0-9]{4}
Schlüssel zur Meldung
an
t_meldung_text xs:string Gibt die Meldung in Mindestens 1 Zeichen,
Textform an, die durch höchstens 4000 Zeichen
festge-
legt ist
t_kbez1 xs:string Mindestens 1 Zeichen,
KatalogItem: Kennung höchstens 10 Zeichen
[0-9]*
t_kbez2 xs:string Mindestens 1 Zeichen,
KatalogItem: Kurzbe- höchstens 10 Zeichen
zeichnung
[A-Za-z0-9\-–]*
t_lbez xs:string KatalogItem: Langbe- Mindestens 0 Zeichen,
zeichnung höchstens 150 Zeichen
t_besitzer_namen xs:string Maximal 200 Zeichen
t_besitzer_telefon xs:string Maximal 50 Zeichen
t_besitzer_mail xs:string Maximal 100 Zeichen
t_freitext xs:string [\wÄäÖöÜüß\s\-/()]{1,16}
Seite 19 OASIS Schnittstellenbeschreibung5. Übersicht Basistypen
t_batch_id xs:string [\d]{1,9}
t_ds_id xs:string [\d]{1,7}
Tabelle 6: Einfache Typen im Schema oasisBasistypen.xsd
5.2 Komplexe Typen im Schema oasisBasistypen.xsd
Typ im Schema enthaltene Elemente Verwendung
t_anschrift P (PLZ) Vollständige Wohnanschrift eines Spielers; erfor-
derlich beim Eintragen und Ändern einer Spieler-
W (WOHNORT)
sperre; alle Elemente bis auf ADRESSZUSATZ
S (STRASSE) sind Pflichtfelder (s.u.)
H (HAUSNUMMER)
Z (ADDRESZUSATZ)
L (LAND)
t_anschrift_status P (PLZ) Wohnanschrift eines Spielers, die bei einer Abfrage
des Spielerstatus erforderlich ist; kein Element ist
W (WOHNORT)
Pflichtfeld bei einer Spielerstatusabfrage (s.u.)
S (STRASSE)
H (HAUSNUMMER)
Z (ADDRESZUSATZ)
L (LAND)
t_spieler V (VORNAME) Daten eines Spielers, die zum Eintragen bzw. Än-
dern einer Sperre in OASIS erforderlich sind; alle
N (NACHNAME)
Elemente sind Pflichtfelder bei diesen beiden Akti-
G (GEBURTSNAME) onen
D (GEBURTSDATUM)
O (GEBURTSORT)
A (ANSCHRIFT)
t_spieler_status V (VORNAME) Daten eines Spielers, die zur Identifizierung einer
Sperre erforderlich sind; nur die Elemente V (VOR-
N (NACHNAME)
NAME), N (NACHNAME) und D (GEBURTSDA-
G (GEBURTSNAME) TUM) sind Pflichtfelder bei diesen Aktionen
D (GEBURTSDATUM)
O (GEBURTSORT)
A (ANSCHRIFT)
t_besitzer NAME Besitzer einer Sperre (Betriebsstätte)
OASIS Schnittstellenbeschreibung Seite 206. Statusabfrage
ANSPRECHPARTNER
TELEFON
EMAIL
t_sperre SPERRID Ein Sperreintrag
SPERRDATUM
SPERRGRUND
SPIELER
ANLASS
FRIST_BEGINN
FRIST_ENDE
t_sperrinformation SPERRID Information über einen Sperreintrag, bestehend
aus SperrId und Besitzer
BESITZER
t_katalog_item KBEZ1 Datensatzbeschreibung eines Katalogseintrags
KBEZ2
LBEZ
SORTNR
ZULAESSIG
t_datum_uhrzeit DATUM Beispiel:
FORMAT-PATTERN DATUM: 23.01.2020 10:34:12
FORMAT-PATTERN: dd.MM.yyyy HH:mm:ss
(Java-Formatpattern)
t_meldungskata- ART Daten eines Meldungskatalog-Items. Inhalte ent-
log_item sprechen den im Meldungskatalog enthaltenen Ein-
SCHLUESSEL
trägen.
MELDUNG
Tabelle 7: Komplexe Typen im Schema oasisBasistypen.xsd
Statusabfrage
Die Statusabfrage in OASIS hat das Ziel, zu ermitteln, ob für einen Spieler ein Sperreintrag vorhanden
ist. Die Spielerdaten sind als transilitierte Zeichen abgelegt und werden über die Statusabfrage gesucht.
Seite 21 OASIS Schnittstellenbeschreibung6. Statusabfrage
6.1 Parameter
URL: /spielerstatus
http-method: POST
Request-Payload: spielersuchParameter.xsd
Response-Payload: statusabfrageTreffer.xsd
Erwartete Header-Parameter: Kennung, Passwort, Accept („text/plain; charset=UTF-8; version=4.8“),
Content-Type (text/plain; charset=UTF-8), Content-Length
XML-Struktur Fachliche Beschreibung Typ Zeichen max
Katego- Feld-
rie länge
SPIELER V [1/1] Vorname t_name 2 85
[1/1] N [1/1] Nachname t_name 2 85
G [0/1] Geburtsname t_name 2 85
D [1/1] Geburtsdatum: t_geburtsdatum 2 10
([0-9]{4})\-([0-9]{2}|-{2})\-([0-9]{2}|-{2})
O [0/1] Geburtsort t_name 2 85
A [0/1] P [0/1] Anschrift PLZ t_plz_hausnum- 2 20
mer
W[0/1] Anschrift Wohnort t_name 2 85
S [0/1] Anschrift Strasse t_strasse 2 150
H [0/1] Anschrift Hausnummer t_plz_hausnum- 2 20
mer
L [0/1] Anschrift Land: dreistelliger Gebiets- t_land gemäß gemäß
Code aus dem Länderkatalog Länder- Länder-
katalog katalog
Z [0/1] Anschrift Adresszusatz t_addresszusatz 2 256
[MinOccurs/MaxOccurs] sind in eckigen Klammern angegeben:
[1/1] = muss einmal existieren / darf nur einmal angegeben werden
6.2 Beispiel
Bitte beachten Sie, dass die in den Beispielen aufgeführten Namespace-Präfixe nur Beispiele sind und
variieren können.
6.2.1 Request
URL
/spielerstatus
http-method
POST
OASIS Schnittstellenbeschreibung Seite 226. Statusabfrage
Header-Parameters
Kennung: xxxxxxxx
Passwort: xxxxxxxxxxxxxxxx
Accept: text/plain; charset=UTF-8; version=4.8
Content-type: text/plain; charset=UTF-8
Content-Length:xx
XML
Hans Herbert
Bertsen
1971-04-01
6.2.2 Response
6.2.2.1 Treffer:
W0018Der Spieler
ist gesperrt.2486456FT2000PlayWiesbadenSamoht Retsnil0815-4711ws@test.test
6.2.2.2 Kein Treffer:
I0019Der Spieler
ist nicht gesperrt.
6.3 Response Meldungen
Schlüssel Art Meldung Bemerkung
„Sie haben keine Berechtigung“ oder „Sie haben
0001 E
keine Berechtigung (kein gültiges Zertifikat)“
Seite 23 OASIS Schnittstellenbeschreibung7. Bearbeitung der Sperren Version 4.8
Ihr Zugang wurde gesperrt. Bitte wenden Sie sich an
0002 E den Super-User. Als Super-User wenden Sie sich
bitte an die Hotline (Tel 06652/1872212)
Es ist ein Serverfehler aufgetreten. Bitte wenden Sie
0003 E
sich an die Hotline (Tel 06652/1872212)
0014 E Die Datei ist kein schemakonformes XML.
Es ist ein Plausibilisierungsfehler aufgetreten.
„Sie haben keine gültige Konzession/Erlaubnis.“ oder
0016 E „Sie haben keinen Zugang zum System, da Ihre Kon-
zession/Erlaubnis ruht.“
Ein Sperreintrag anhand
der Abfrage konnte ein-
deutig identifiziert werden.
0018 W Der Spieler ist gesperrt.
Enthält einen Verweis auf
den Veranstalter, der für
die Sperre änderungsbe-
rechtigt ist.
Es gab keinen zur Abfrage
0019 I Der Spieler ist nicht gesperrt. passenden Eintrag in
OASIS
Es gibt mehr als einen
Sperreintrag zur Abfrage,
aber die Abfrage wurde mit
Der Spieler ist gesperrt. Es gab mehr als einen Treffer wenigen Attributen geführt.
0023 W
für Ihre Abfrage. Die Abfrage kann mit mehr
Attributen wiederholt wer-
den, um Eindeutigkeit zu
erreichen.
Es gibt mehr als einen
Der Spieler ist gesperrt. Es gab mehr als einen Treffer Sperreintrag zur Abfrage,
0024 W
für Ihre Abfrage. aber die Abfrage kann
nicht erweitert werden.
Bearbeitung der Sperren Version 4.8
Version 4.8 wurde auf ‚deprecated‘ gesetzt.
7.1 Anlegen einer Sperre
Grundlage der Erfassung bildet der Identitätsnachweis des Spielers beim Veranstalter. Die in den amt-
lichen Dokumenten nicht enthalten Angaben sollen aus anderen Identitätsnachweisen des Spielers er-
gänzt werden.
OASIS Schnittstellenbeschreibung Seite 247. Bearbeitung der Sperren Version 4.8
Diese Daten müssen wie in den Identitätsnachweisen hinterlegt übermittelt werden. Das betrifft sowohl
die Reihenfolge, als auch die Zeichen: die Reihenfolge darf nicht geändert werden, diakritische Zeichen
und Ligaturen dürfen nicht transliteriert werden.
7.1.1 Parameter
URL: /sperren
http-method: POST
Request-Payload: sperrdaten.xsd
Response-Payload: sperreAnlegenAendernErgebnis.xsd
Erwartete Header-Parameter: Kennung, Passwort, Accept („text/plain; charset=UTF-8; version=4.8“),
Content-Type (text/plain; charset=UTF-8), Content-Length
XML-Struktur Fachliche Beschreibung Typ Zeichen max
Katego- Feld-
rie länge
SPERRGRUND [1/1] „SELBST „ oder „FREMD“ t_sperrgrund gemäß gemäß
fachliche fachliche
Beschrei- Beschrei-
bung bung
SPIELER V [1/1] Vorname. Hat ein Spieler keinen Vor- t_name 2 85
[1/1] namen, so ist dies durch den Eintrages
eines – (Minus-Zeichens) kenntlich zu
machen
N [1/1] Nachname t_name 2 85
G [1/1] Geburtsname t_name 2 85
D [1/1] Geburtsdatum: t_geburtsdatum 2 10
([0-9]{4})\-([0-9]{2}|-{2})\-([0-9]{2}|-{2})
O [1/1] Geburtsort t_name 2 85
A [1/1] P [1/1] Anschrift PLZ t_plz_hausnum- 2 20
mer
W[1/1] Anschrift Wohnort t_name 2 85
S [1/1] Anschrift Strasse t_strasse 2 150
H [1/1] Anschrift Hausnummer t_plz_hausnum- 2 20
mer
L [1/1] Anschrift Land: dreistelliger Gebiets- t_land gemäß gemäß
Code aus dem Länderkatalog Länder- Länder-
katalog katalog
Z [0/1] Anschrift Adresszusatz t_addresszusatz 2 256
ANLASS KBEZ1 zweistelliger Schlüssel aus dem Kata- t_kbez1 gemäß gemäß
[1/99] [1/1] log Sperranlässe. Mehrere Anlässe Sperran- Sperran-
sind erlaubt, jedoch kann der Anlass 99 lässe-Kat- lässe-
(“kein Grund”) nicht mit anderen Anläs- alog Katalog
sen kombiniert werden.
Seite 25 OASIS Schnittstellenbeschreibung7. Bearbeitung der Sperren Version 4.8
(*) Im Falle des Inkrafttretens des GlüStV
2021 ab dem 1. Juli 2021 gibt es Änderun-
gen an den Parametern dieses Requests.
Weitere Informationen dazu finden Sie in
Kapitel 22.
Werden mehrmals die gleichen Schlüs-
sel geliefert, so sorgt das System für
Eindeutigkeit.
[MinOccurs/MaxOccurs] sind in eckigen Klammern angegeben:
[1/99] = muss einmal existieren / darf maximal 99-mal wiederholt werden
7.1.2 Beispiel
7.1.2.1 Request
URL
/sperren
http-method
POST
Header-Parameters
Kennung: xxxxxxxx
Passwort: xxxxxxxxxxxxxxxx
Accept: text/plain; charset=UTF-8; version=4.8
Content-type: text/plain; charset=UTF-8
Content-Length:xx
XML
SELBST
Hans Herbert
Bertsen
Bladi-Blubb
1971-04-01
Halle (Saale)
03451
OASIS Schnittstellenbeschreibung Seite 267. Bearbeitung der Sperren Version 4.8
HALLE
Richard-Wagner-Straße
17
Hinterhof rechts
000
02
03
7.1.2.2 Response
I0007Die Person wurde mit Datum vom
25.11.2020 erfolgreich gesperrt.248645625.11.2020 14:43:44dd.MM.yyyy
HH:mm:ssSELBSTHans Her-
bertBertsenBladi-Blubb1971-04-01Halle
(Saale)03451HALLERichard-Wagner-Straße17Hinterhof
rechts0000203
7.2 Response Meldungen
Schlüssel Art Meldung Bemerkung
„Sie haben keine Berechtigung“ oder „Sie haben
0001 E
keine Berechtigung (kein gültiges Zertifikat)“
Ihr Zugang wurde gesperrt. Bitte wenden Sie sich an
0002 E den Super-User. Als Super-User wenden Sie sich
bitte an die Hotline (Tel 06652/1872212)
Es ist ein Serverfehler aufgetreten. Bitte wenden Sie
0003 E
sich an die Hotline (Tel 06652/1872212)
Die Person wurde mit Datum erfolg- Das Anlegen der Sperre
0007 I
reich gesperrt. war erfolgreich
0014 E Die Datei ist kein schemakonformes XML.
Es ist ein Plausibilisierungsfehler aufgetreten.
Seite 27 OASIS Schnittstellenbeschreibung7. Bearbeitung der Sperren Version 4.8
„Sie haben keine gültige Konzession/Erlaubnis.“ oder
0016 E „Sie haben keinen Zugang zum System, da Ihre Kon-
zession/Erlaubnis ruht.“
7.3 Ändern einer Sperre
Jede erzeugte Spielersperre erhält automatisch eine SperrID, die diese Sperre eindeutig identifiziert.
Nach dem Anlegen einer Spielersperre wird im Meldungstext die erzeugte SperrID übermittelt. Mit
Kenntnis dieser SperrID können Sperren geändert werden. Die SperrID wird als Path-Parameter der
URL übergeben.
7.3.1 Parameter
URL: /sperren/{sperrid}
http-method: PUT
Request-Payload: sperrdaten.xsd
Response-Payload: sperreAnlegenAendernErgebnis.xsd
Erwartete Header-Parameter: Kennung, Passwort, Accept („text/plain; charset=UTF-8; version=4.8“),
Content-Type (text/plain; charset=UTF-8), Content-Length
XML-Struktur Fachliche Beschreibung Typ Zeichen max
Katego- Feld-
rie länge
SPERRGRUND [1/1] „SELBST „ oder „FREMD“ t_sperrgrund gemäß gemäß
fachliche fachliche
Beschrei- Beschrei-
bung bung
SPIELER V [1/1] Vorname. Hat ein Spieler keinen Vor- t_name 2 85
[1/1] namen, so ist dies durch den Eintrages
eines – (Minus-Zeichens) kenntlich zu
machen
N [1/1] Nachname t_name 2 85
G [1/1] Geburtsname t_name 2 85
D [1/1] Geburtsdatum: t_geburtsdatum 2 10
([0-9]{4})\-([0-9]{2}|-{2})\-([0-9]{2}|-{2})
O [1/1] Geburtsort t_name 2 85
A [1/1] P [1/1] Anschrift PLZ t_plz_hausnum- 2 20
mer
W[1/1] Anschrift Wohnort t_name 2 85
S [1/1] Anschrift Strasse t_strasse 2 150
H [1/1] Anschrift Hausnummer t_plz_hausnum- 2 20
mer
OASIS Schnittstellenbeschreibung Seite 287. Bearbeitung der Sperren Version 4.8
L [1/1] Anschrift Land: dreistelliger Gebiets- t_land gemäß gemäß
Code aus dem Länderkatalog Länder- Länder-
katalog katalog
Z [0/1] Anschrift Adresszusatz t_addresszusatz 2 256
ANLASS KBEZ1 zweistelliger Schlüssel aus dem Kata- t_kbez1 gemäß gemäß
[1/99] [1/1] log Sperranlässe. Mehrere Anlässe Sperran- Sperran-
sind erlaubt, jedoch kann der Anlass 99 lässe-Kat- lässe-
(“kein Grund”) nicht mit anderen Anläs- alog Katalog
sen kombiniert werden.
Werden mehrmals die gleichen Schlüs-
sel geliefert, so sorgt das System für
Eindeutigkeit.
[MinOccurs/MaxOccurs] sind in eckigen Klammern angegeben:
[1/99] = muss einmal existieren / darf maximal 99-mal wiederholt werden
7.3.2 Beispiel
7.3.2.1 Request
URL
/sperren/2486456
http-method
PUT
Header-Parameters
Kennung: xxxxxxxx
Passwort: xxxxxxxxxxxxxxxx
Accept: text/plain; charset=UTF-8; version=4.8
Content-type: text/plain; charset=UTF-8
Content-Length:xx
XML
SELBST
Hans Herbert
Bertsen
Bladi-Blubb
1971-04-01
Halle (Saale)
Seite 29 OASIS Schnittstellenbeschreibung7. Bearbeitung der Sperren Version 4.8
65185
Wiesbaden
Friedrich-Ebert-Straße
42
000
01
03
7.3.2.2 Response
I0009Die Spielerdaten wurden am 25.11.2020
14:51:19 erfolgreich geändert.248645625.11.2020 14:43:44dd.MM.yyyy HH:mm:ssSELBSTHans HerbertBert-
senBladi-Blubb1971-04-01Halle (Saale)65185Wiesba-
denFriedrich-Ebert-Straße420000103
7.4 Response Meldungen
Schlüssel Art Meldung Bemerkung
„Sie haben keine Berechtigung“ oder „Sie haben
0001 E
keine Berechtigung (kein gültiges Zertifikat)“
Ihr Zugang wurde gesperrt. Bitte wenden Sie sich an
0002 E den Super-User. Als Super-User wenden Sie sich
bitte an die Hotline (Tel 06652/1872212)
Es ist ein Serverfehler aufgetreten. Bitte wenden Sie
0003 E
sich an die Hotline (Tel 06652/1872212)
Das Beenden oder Än-
Änderung oder Beenden der Sperre ist nicht möglich: dern von Sperren, die
0004 E
es wurde kein Sperreintrag zum Spieler gefunden. nicht dem angemeldeten
Veranstalter zugeordnet
OASIS Schnittstellenbeschreibung Seite 307. Bearbeitung der Sperren Version 4.8
sind, kann auch mit
Kenntnis der SperrID
nicht durchgeführt wer-
den.
Sperre gehört einer ande-
Sie haben keine Berechtigung, diese Sperre zu än-
0008 E ren Betriebsstätte
dern.
Die Spielerdaten wurden am erfolg-
0009 I
reich geändert.
0014 E Die Datei ist kein schemakonformes XML.
Es ist ein Plausibilisierungsfehler aufgetreten.
„Sie haben keine gültige Konzession/Erlaubnis.“ oder
0016 E „Sie haben keinen Zugang zum System, da Ihre Kon-
zession/Erlaubnis ruht.“
7.5 Aufheben einer Spielersperre
Jede erzeugte Spielersperre erhält automatisch eine SperrID, die diese Sperre eindeutig identifiziert.
Nach dem Anlegen einer Spielersperre wird im Meldungstext die erzeugte SperrID übermittelt. Mit
Kenntnis dieser SperrID können Sperren beendet werden.
Ab OASIS Version 4.8 ist die Angabe eines Aufhebungsgrunds Pflicht, wenn die Mindestfrist der Sperre
nicht erreicht wurde.
7.5.1 Parameter
URL: /sperren/{sperrid}
http-method: DELETE
Request-Payload: keine
Response-Payload: sperreAufhebenErgebnis.xsd
Erwartete Header-Parameter: Kennung, Passwort, Accept („text/plain; charset=UTF-8; version=4.8“),
Aufhebungsgrund (wenn die Mindestfrist der Sperre nicht erreicht wurde. Die Mindestfrist für HSpielHG
und GlüStV beträgt 1 Jahr.)
7.5.2 Beispiel
7.5.2.1 Request
URL
/sperren/2486456
Seite 31 OASIS SchnittstellenbeschreibungSie können auch lesen
