OASIS Beschreibung OASIS-Webservice - OASIS Version 4.8 Veröffentlicht am 09.08.2018 - Hessen.de

Die Seite wird erstellt Hella Wiegand
 
WEITER LESEN
OASIS Beschreibung OASIS-Webservice - OASIS Version 4.8 Veröffentlicht am 09.08.2018 - Hessen.de
OASIS
Beschreibung OASIS-Webservice
OASIS Version 4.8
Veröffentlicht am 09.08.2018
1. Zusammenfassung

Inhaltsverzeichnis

      Zusammenfassung...................................................................................................... 6

      Schnittstellenfunktionen und XML-Schema .............................................................. 6

2.1   Schnittstellenfunktionen ................................................................................................ 7

2.2   HTTP-Header Parameter .............................................................................................. 8

      Meldungen ................................................................................................................... 9

3.1   Meldungskatalog ........................................................................................................... 9

      Verwendeter Zeichensatz ......................................................................................... 11

4.1   Erlaubte Zeichen ......................................................................................................... 12
      4.1.1        Buchstaben ...................................................................................................................12
      4.1.2        Ziffern ...........................................................................................................................13
      4.1.3        Sonderzeichen..............................................................................................................13

4.2   Zeichensätze Kategorien ............................................................................................. 14
      4.2.1        Kategorie 1: Erlaubte Zeichen für die Abfrage des Spielerstatus ................................14
      4.2.2        Kategorie 2: Erlaubte Zeichen für das Anlegen und Ändern einer neuen Sperre ........14

      Übersicht Basistypen ................................................................................................ 15

5.1   Einfache Typen im Schema oasisBasistypen.xsd ........................................................ 15

5.2   Komplexe Typen im Schema oasisBasistypen.xsd ...................................................... 17

      Statusabfrage ............................................................................................................ 18

6.1   Parameter ................................................................................................................... 18

6.2   Beispiel 19
      6.2.1        Request ........................................................................................................................19
      6.2.2        Response .....................................................................................................................20

6.3   Response Meldungen ................................................................................................. 20

      Bearbeitung der Sperren .......................................................................................... 21

7.1   Anlegen einer Sperre .................................................................................................. 21
      7.1.1        Parameter .....................................................................................................................22

                                                     OASIS Schnittstellenbeschreibung                                                         Seite 2
1. Zusammenfassung

          7.1.2       Beispiel .........................................................................................................................23

7.2       Response Meldungen ................................................................................................. 24

7.3       Ändern einer Sperre .................................................................................................... 24
          7.3.1       Parameter .....................................................................................................................25
          7.3.2       Beispiel .........................................................................................................................26

7.4       Response Meldungen ................................................................................................. 27

7.5       Aufheben einer Spielersperre ...................................................................................... 28
          7.5.1       Parameter .....................................................................................................................28
          7.5.2       Beispiel .........................................................................................................................28
          7.5.3       Response Meldungen ..................................................................................................29

          Kataloge laden........................................................................................................... 30

8.1       Länderkatalog ............................................................................................................. 30
          8.1.1       Parameter .....................................................................................................................30
          8.1.2       Beispiel .........................................................................................................................30

8.2       Katalog Sperranlässe .................................................................................................. 31
          8.2.1       Parameter .....................................................................................................................31
          8.2.2       Beispiel .........................................................................................................................31

8.3       Katalog Aufhebungsgründe ......................................................................................... 32
          8.3.1       Parameter .....................................................................................................................32
          8.3.2       Beispiel .........................................................................................................................32

8.4       Response Meldungen ................................................................................................. 33

          Eigene Sperren .......................................................................................................... 34

9.1       Eigene Sperren abfragen ............................................................................................ 34
          9.1.1       Parameter .....................................................................................................................34
          9.1.2       Beispiel .........................................................................................................................34

9.2       Einige Sperren suchen mit Spielerdaten...................................................................... 35
          9.2.1       Parameter .....................................................................................................................35
          9.2.2       Beispiel .........................................................................................................................36

9.3       Eigene Sperren suchen mit SperrID ............................................................................ 37
          9.3.1       Parameter .....................................................................................................................37
          9.3.2       Beispiel .........................................................................................................................37

9.4       Response Meldungen ................................................................................................. 38

Seite 3                                            OASIS Schnittstellenbeschreibung
1. Zusammenfassung

        Passwort ändern ....................................................................................................... 38

10.1 Parameter ................................................................................................................... 38

10.2 Beispiel 38
        10.2.1       Request ........................................................................................................................38
        10.2.2       Response .....................................................................................................................39

10.3 Response Meldungen ................................................................................................. 39

        Konzession prüfen .................................................................................................... 39

11.1 Parameter ................................................................................................................... 40

11.2 Beispiel 40
        11.2.1       Request ........................................................................................................................40
        11.2.2       Response .....................................................................................................................40

11.3 Response Meldungen ................................................................................................. 40

        Verfügbarkeit prüfen ................................................................................................. 41

12.1 Parameter ................................................................................................................... 41

12.2 Beispiel 41
        12.2.1       Request ........................................................................................................................41
        12.2.2       Response .....................................................................................................................42

12.3 Response Meldungen ................................................................................................. 42

        Batch       42

13.1 Anlegen einer Batchabfrage ........................................................................................ 43
        13.1.1       Parameter .....................................................................................................................43
        13.1.2       Beispiel .........................................................................................................................44
        13.1.3       Response Meldungen ..................................................................................................46

13.2 Abholen eines Batchjob-Ergebnisses .......................................................................... 47
        13.2.1       Parameter .....................................................................................................................47
        13.2.2       Beispiel .........................................................................................................................47
        13.2.3       Response Meldungen ..................................................................................................50

13.3 Statusabfrage eigener Batchjobs................................................................................. 51
        13.3.1       Parameter .....................................................................................................................51
        13.3.2       Beispiel .........................................................................................................................51
        13.3.3       Response Meldungen ..................................................................................................52

                                                       OASIS Schnittstellenbeschreibung                                                        Seite 4
1. Zusammenfassung

          Rechte in OASIS WS ................................................................................................. 53

          Änderungen gegenüber Version 1.0 ........................................................................ 53

          Änderungen gegenüber Version 1.1 ........................................................................ 54

          Änderungen gegenüber Version 1.2 ........................................................................ 54

          Änderungen gegenüber Version 1.8 ........................................................................ 54

          Änderungen gegenüber Version 2.0 ........................................................................ 55

          Änderungen gegenüber Version 3.0 ........................................................................ 56

          Änderungen gegenüber Version 3.2 ........................................................................ 56

          Änderungen gegenüber Version 3.4 ........................................................................ 57

          Änderungen gegenüber Version 3.6 ........................................................................ 58

          Änderungen gegenüber Version 4.0 ........................................................................ 59

          Änderungen gegenüber Version 4.2 ........................................................................ 59

          Änderungen gegenüber Version 4.4 ........................................................................ 60

          Änderungen gegenüber Version 4.6 ........................................................................ 60

Seite 5                                       OASIS Schnittstellenbeschreibung
1. Zusammenfassung

    Zusammenfassung
Dieses Dokument beinhaltet die Beschreibung des OASIS-Webservices auf Basis des

      Glücksspielstaatsvertrages (GlüStV),

      des Hessischen Glückspielgesetzes (HGlüG) sowie des

      Hessischen Spielhallengesetzes (HessSpielhG),

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.

Die Versionsnummer des vorliegenden Dokuments richtet sich nach der Releasenummer von OASIS,
in der die Schnittstellenspezifikationen umgesetzt sind.

Mit OASIS Version 4.8 wurden die Web Sevices Schnittstellen, sowohl in Funktion als auch deren URLs
überarbeitet. Alle OASIS Version 4.6 Funktionen wurden auf „deprecated“ gesetzt und sind daher nicht
in diesem Dokument beschrieben. Die Beschreibung der Version 4.6 Funktionen sind der Beschreibung
OASIS- Webservice OASIS Version 4.6‘ zu entnehmen.

Die Schnittstellen zur Abfrage der Versionsnummer und zum Abfragen der aktuellen Informationen ent-
fallen ersatzlos.

    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 sind durch die XSD-Dateien definiert.

Der OASIS-Webservice ist zustandslos und arbeitet synchron.

                                     OASIS Schnittstellenbeschreibung                        Seite 6
2. Schnittstellenfunktionen und XML-Schema

2.1 Schnittstellenfunktionen
OASIS Schnittstellenfunktionen

Produktion URL-Root = https://oasis.hessen.de/oasisws/

Integrationstestumgebung URL-Root = https://oasis-tst-crt.hessen.de/oasisws/

 Nr.      Funktion           http-    URL                Request-Payload          Response-Payload
                             method

 1        Statusabfrage      POST     /spielerstatus     spielerSuchparame-       statusabfrageTreffer.xsd
                                                         ter.xsd

 2        Sperre anlegen     POST     /sperren           sperrdaten.xsd           sperreAnlegenAendernErgeb-
                                                                                  nis.xsd

 3        Sperre ändern      PUT      /sperren/{sper-    sperrdaten.xsd           sperreAnlegenAendernErgeb-
                                      rid}                                        nis.xsd

 4        Sperre aufheben    DELETE   /sperren/{sper-    -                        sperreAufhebenErgebnis.xsd
                                      rid}

 5        Länderkatalog      GET      /kataloge/laen-    -                        oasisKatalog.xsd
          holen                       der

 6        Katalog Sperran-   GET      /kataloge/sper-    -                        oasisKatalog.xsd
          lässe holen                 ranlaesse

 7        Katalog Aufhe-     GET      /kataloge/aufhe-   -                        oasisKatalog.xsd
          bungsgründe ho-             bungsgruende
          len

 8        Passwort ändern    PUT      /betriebs-         -                        meldungskatalogItem.xsd
                                      staette/passwort

 9        Konzession ab-     GET      /betriebs-         -                        konzessionsdaten.xsd
          fragen                      staette/konzes-
                                      sion

 10       Alle eigenen       GET      /betriebs-         -                        eigeneSperren.xsd
          Sperren abfragen            staette/sperren

Seite 7                               OASIS Schnittstellenbeschreibung
2. Schnittstellenfunktionen und XML-Schema

 11     eigene Sperren        POST         /betriebs-            spielerSuchparame-    eigeneSperren.xsd
        mit Spielerdaten                   staette/sperren       ter.xsd
        suchen

 12     eine Sperre mit       GET          /betriebs-            -                     eigeneSperren.xsd
        bekannter Sper-                    staette/sper-
        rID abfragen                       ren/{sperrId}

 13     Verfügbarkeits-       GET          /verfuegbarkeit       -                     meldungskatalogItem.xsd
        abfrage

Batch-Funktionen

Produktion URL-Root = https://oasis.hessen.de/oasisbatchws/

Integrationstestumgebung URL-Root = https://oasis-tst-crt.hessen.de/oasisbatchws/

 15     Batchjob einstel-     POST         /batch                batchAnlegenPay-      batchAnlegenErgebnis.xsd
        len                                                      load.xsd (gzip)

 16     Status eigener        GET          /auftraege            -                     batchJobs.xsd
        Batchjobs abfra-
        gen

 17     Ergebnis eines        GET          /batch/{batchId}      -                     batchErgebnis.xsd (gzip)
        Batchjobs abfra-
        gen

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

                                               OASIS Schnittstellenbeschreibung                             Seite 8
3. Meldungen

 Accept                  text/plain; charset=UTF-8;                           Jede Funktion hat eine eigene Ver-
                         version=x.x                                          sion.
                         (für alle Funktionen außer
                         Abholen eines Batch-Ergeb-                           Die Angabe der Versionsnummer im
                         nisses)                                              Accept Header ist Pflicht. Anfragen,
                                                                              die dies nicht gesetzt haben, wer-
                         application/gzip; char-                              den abgelehnt.
                         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 die
                         lauf der Mindestfrist                                Mindestfrist der Sperre nicht erreicht
                                                                              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).
                             Änderung oder Beenden der Sperre ist nicht möglich:
     0004           E
                             es wurde kein Sperreintrag zum Spieler gefunden.

Seite 9                                   OASIS Schnittstellenbeschreibung
3. Meldungen

                   Die Person wurde mit Datum  erfolg-
    0007       I
                   reich gesperrt.
                   Die Spielerdaten wurden am  erfolg-
    0009       I
                   reich geändert.
                   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.

    0018       W   Der Spieler ist gesperrt.

    0019       I   Der Spieler ist nicht gesperrt.

    0020       I   Das Passwort wurde erfolgreich geändert.
                   Der Spieler ist gesperrt. Es gab mehr als einen Treffer
    0023       W
                   für Ihre Abfrage.
                   Der Spieler ist gesperrt. Es gab mehr als einen Treffer
    0024       W
                   für Ihre Abfrage.
                   Die Daten werden gerade von einem anderen Benut-
    0040       E
                   zer geändert.
    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.
                   Die maximale Anzahl gleichzeitig laufender Batchab-
    0054       W   fragen ist erreicht. Bitte versuchen Sie es später
                   nochmal.

                                 OASIS Schnittstellenbeschreibung                          Seite 10
4. Verwendeter Zeichensatz

                             Einstellen von Batchanfragen: Übertragener Inhalt
     0060           E
                             kann nicht in eine Batchanfrage konvertiert werden
                             Einstellen von Batchanfragen: Batch beinhaltet zu
     0061           E
                             viele Datensätze
                             Einstellen von Batchanfragen: Identischer Batch
     0062           E
                             wurde bereits beauftragt
                             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
                             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
                             Ergebnisse von Batchanfragen: Der Batch befindet
     0075           E        sich noch in Bearbeitung. Das Ergebnis liegt noch
                             nicht vor
                             Ergebnisse von Batchanfragen: Der Batch wurde
     0076           E
                             noch nicht begonnen
                             Einstellen von Batchanfragen: Die Batchabfrage
     0077           I
                             wurde erfolgreich hochgeladen
                             Ergebnisse von Batchanfragen: kein Fehler aufgetre-
     0078           I
                             ten
                             Ergebnisse von Batchanfragen: Batchabfrage mit
     0079           W
                             Warnungen beendet
                             Ergebnisse von Batchanfragen: Batchabfrage mit
     0080           E
                             Fehlern beendet
                             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 KOSIT in XÖV herausgegebenen Standard „Lateinische Zeichen in Unicode“ ein-
geschränkt. Dieser Zeichensatz beinhaltet die lateinischen Zeichen aus Unicode einschließlich diakriti-
scher Zeichen und Ligaturen.

Der Zeichensatz ist im XML-Schema latinchars.xsd beschrieben.

Seite 11                               OASIS Schnittstellenbeschreibung
4. Verwendeter Zeichensatz

Hinweis: Das durch KOSIT zur Verfügung gestellte XML-Schema hat als Schema-Attribut „element-
FormDefault“ den Wert „qualified“. Da OASIS durchgängig mit dem Wert „unqualified“ arbeiten soll,
weicht die hier ausgelieferte XML-Schema-Datei von der durch KOSIT zur Verfügung gestellten in die-
sem Punkt ab.

4.1 Erlaubte Zeichen
Die erlaubten Zeichen sind die des Zeichensatzes String.Latin. Unerlaubte Sonderzeichen sollten bei
der Anfrage unterbunden und nicht an OASIS geschickt werden.

4.1.1 Buchstaben
Erlaubte Buchstaben sind [A-z] sowie:

 ÀÁÂÃàáâãĀāĂ㥹ǍǎǞǟǺǻẠạẪẫẬªẢảẤấẦầẮắẰằẲẳẴẵẶ
 ặ
 ÄÆäæǼǽ
 Åå
 Ḃḃ
 ÇçĆćĊċČč
 Ð ð Ď ď Đ đ Ḋ ḋ Ḑ ḑ D̂ d̂
 ÈÉÊËèéêëĒēĔĕĖėĘęĚěƏəẽỄễẸẹẺẻẼỀềẾếỆệ
 Ḟḟ
 ĞğĠġĢģǤǥǦǧǴǵḠḡ
 ĦħȞȟḤḥḦḧ
 ÌÍÎÏìíîïĨĩĪīĬĭĮįİıǏǐỊịỈỉ
 Ĵ ĵ ǰ J̌
 ĶķĸǨǩḰḱ
 Ĺ ĺ Ļ ļ Ľ ľ Ŀ ŀ Ł ł L̂ l̂
 M̂ m̂ Ṁ ṁ
 N̂ n̂ Ñ ñ Ń ń Ņ ņ Ň ň ʼn Ŋ ŋ Ṅ ṅ
 ÒÓÔÕòóôõŌōŎŏŐőƠơǑǒǪǫǬǭǾǿȪȫȮȯȰȱỌọỎỏỖỗºỒồ
 ỐốỘộỜờỚớ
 ÖØöøŒœ
 Ṗṗ
 ŔŕŖŗŘř

                                        OASIS Schnittstellenbeschreibung                    Seite 12
4. Verwendeter Zeichensatz

 ŚśŞşŠšȘșṠṡṢṣ
 ßẞ
 ŢţŤťŦŧȚțṪṫ
 Þþ
 ÙÚÛùúûŨũŪūŮůŰűŲųƯưǓǔỤụỦủỨứỪừỬửỮữỰự
 Üü
 ŴŵẀẁẂ ẃẄ ẅ
 Ẍẍ
 ÝýÿŶŷŸƷǮǯȲȳʒẎẏỲỳỸỹỴỵỶỷ
 ŹźŻżŽžẐẑẒẓ

Abbildung 1: Diakritika und Ligaturen

4.1.2 Ziffern
 0123456789

Abbildung 2: numerische Zeichen

4.1.3 Sonderzeichen
 !"'´`#%&()*,-./:;?@[\]_{}¡«·»¿$+^|~¢£¤¥¦§©¬®°±¶×÷€¸¨¯ , sowie das Leerzeichen

Abbildung 3: Sonderzeichen

Hinweis: Einige Zeichen haben in einem XML-Dokument eine besondere Bedeutung und dürfen deshalb
NICHT so als Werte in einem XML Dokument auftauchen. Für dieses Zeichen müssen die XML-Notation
verwendet werden.

 Zeichen           XML-Notation

 <                 <

 >                 >

 &                 &

 "                 "

 '                 '

Abbildung 4: Sonderzeichen und XML-Notation

Seite 13                                OASIS Schnittstellenbeschreibung
4. Verwendeter Zeichensatz

4.2 Zeichensätze Kategorien
Die erlaubten Zeichen werden nach Funktion eingeschränkt.

4.2.1 Kategorie 1: Erlaubte Zeichen für die Abfrage des Spielersta-
      tus
Bei einer Statusabfrage werden alle nach String.Latin erlaubten Zeichen zugelassen. Dies wurde nötig,
um auch Datensätze finden zu können, die Zeichen enthalten, die nicht den OASIS Restriktionen genü-
gen, aber dennoch aus Vorsystemen übernommen werden mussten.

                                         Erlaubte                     Erlaubte              Erlaubte
                                        Buchstaben                     Ziffern            Sonderzeichen
            Element
                                     (siehe Abschnitt            (siehe Abschnitt        (siehe Abschnitt
                                           4.1.1)                      4.1.2)                  4.1.3)

 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 String.Latin erlaubten 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.3)
                                           4.1.1)                     4.1.2)

 V (Vorname)                                 „alle“                    „keine“                 .-´`'

                                             OASIS Schnittstellenbeschreibung                           Seite 14
5. Übersicht Basistypen

 N (Nachname)                              „alle“                   „keine“                        .-´`'
 D (Geburtsdatum)                          keine                       0-9                           -
 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                      String.Latin    in Spieleranschrift             Maximal 256 Zeichen

 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                              String.Latin    Datentyp für Vorname,           Maximal 85 Zeichen
                                                     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

Seite 15                                OASIS Schnittstellenbeschreibung
5. Übersicht Basistypen

                                                                      [\wÄäÖöÜüß!#$%'()*+,-
                                                                      \./:;=?|~§_]{8,20}

 t_plz_hausnummer         String.Latin   Datentyp für die Postleit-   Maximal 20 Zeichen
                                         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                String.Latin   Datentyp für die Straße      Maximal 150 Zeichen
                                         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

                                OASIS Schnittstellenbeschreibung                        Seite 16
5. Übersicht Basistypen

 t_freitext                         xs:string                                  [\wÄäÖöÜüß\s\-/()]{1,16}

 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)

Seite 17                               OASIS Schnittstellenbeschreibung
6. Statusabfrage

 t_besitzer             NAME                         Besitzer einer Sperre (Betriebsstätte)

                        ANSPRECHPARTNER
                        TELEFON

                        EMAIL

 t_sperre               SPERRID                      Ein Sperreintrag

                        SPERRDATUM
                        SPERRGRUND

                        ANLASS

 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

                        FORMAT-PATTERN

 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 transilitierete Zeichen abgelegt und werden über die Statusabfrage ge-
sucht.

6.1 Parameter
URL: /spielerstatus
http-method: POST
Request-Payload: spielersuchParameter.xsd
Response-Payload: statusabfrageTreffer.xsd

                                         OASIS Schnittstellenbeschreibung                      Seite 18
6. Statusabfrage

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

6.2.1 Request
URL
 /spielerstatus

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

Seite 19                               OASIS Schnittstellenbeschreibung
6. Statusabfrage

XML

                   Hans Herbert
                   Bert
                   1970-04-01
                   
                          000
                   
6.2.2 Response

6.2.2.1 Treffer:
W0018Der Spieler
ist gesperrt.260972SpielbankSilvia Jackmann12345sj@spbk.de

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)“

                                         OASIS Schnittstellenbeschreibung                Seite 20
7. Bearbeitung der Sperren

                       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

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.

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.

Seite 21                            OASIS Schnittstellenbeschreibung
7. Bearbeitung der Sperren

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.
                                  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

                                           OASIS Schnittstellenbeschreibung                                    Seite 22
7. Bearbeitung der Sperren

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
           Bert
           Bladi-Blubb
           1971-04-01
           Halle (Saale)
           
                    03451
                    HALLE
                    Richard-Wagner-Straße
                    17
                    Hinterhof rechts
                    000
           
           02
       
           03

Seite 23                            OASIS Schnittstellenbeschreibung
7. Bearbeitung der Sperren

7.1.2.2 Response
I0007Die Person wurde mit Datum 11.07.2018
erfolgreich gesperrt.26166311.07.2018 12:27:48dd.MM.yyyy HH:mm:ssSELBSTHans Her-
bertBertBladi-Blubb1990-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. 
                        „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.

                                       OASIS Schnittstellenbeschreibung                        Seite 24
7. Bearbeitung der Sperren

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
                        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

Seite 25                               OASIS Schnittstellenbeschreibung
7. Bearbeitung der Sperren

7.3.2 Beispiel

7.3.2.1 Request
URL
 /sperren/269073

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
           Bert
           Bladi-Blubb
           1971-04-25
           Halle (Saale)
           
                   65185
                   Wiesbaden
                   Friedrich-Ebert-Strass
                   42
                   000
           
           01
      
           03
      
                                      OASIS Schnittstellenbeschreibung    Seite 26
7. Bearbeitung der Sperren

7.3.2.2 Response
I0009Die Spielerdaten wurden am 07.05.2018
13:12:59 erfolgreich geändert.26097313.04.2018 08:57:55dd.MM.yyyy HH:mm:ssSELBSTHans Her-
bertBertBladi-Blubb1971-04-25Halle
(Saale)65185WiesbadenFriedrich-Ebert-Strass42-
0000103

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-
                                                                                   dern von Sperren, die
                                                                                   nicht dem angemeldeten
                                                                                   Veranstalter zugeordnet
                        Änderung oder Beenden der Sperre ist nicht möglich:
     0004           E                                                              sind, kann auch mit
                        es wurde kein Sperreintrag zum Spieler gefunden.
                                                                                   Kenntnis der SperrID
                                                                                   nicht durchgeführt wer-
                                                                                   den.

     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.“

Seite 27                          OASIS Schnittstellenbeschreibung
7. Bearbeitung der Sperren

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/260973

http-method
DELETE

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
Aufhebungsgrund: 02

7.5.2.2 Response

7.5.2.2.1   Erfolgreich

                                      OASIS Schnittstellenbeschreibung                        Seite 28
7. Bearbeitung der Sperren

I0011Die Spieler-
sperre wurde am 07.05.2018 erfolgreich aufgehoben.26097313.04.2018 08:57:55dd.MM.yyyy HH:mm:ssSELBSTHans HerbertBertBladi-Blubb1971-04-25Halle
(Saale)65185WiesbadenFriedrich-Ebert-Strass42-
000010307.05.2018 13:23:35dd.MM.yyyy
HH:mm:ss02

7.5.2.2.2   Fehler 0015: Aufhebungsgrund wurde bei der Aufhebung einer Sperre vor Ablauf
            der Mindestfrist nicht angegeben

E0015MSG_0015:
Aufhebungsgrund ist erforderlich, da die Mindestsperrdauer unterschritten ist. 

7.5.3 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 Ändern
                                                                                 von Sperren, die nicht dem
                                                                                 angemeldeten Veranstalter
                        Änderung oder Beenden der Sperre ist nicht möglich:      zugeordnet sind, kann
    0004          E
                        es wurde kein Sperreintrag zum Spieler gefunden.         auch mit Kenntnis der
                                                                                 SperrID nicht durchgeführt
                                                                                 werden.

                        Die Spielersperre wurde am  erfolg-
    0011          I
                        reich aufgehoben.

    0014          E     Die Datei ist kein schemakonformes XML.

Seite 29                            OASIS Schnittstellenbeschreibung
8. Kataloge laden

                        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.“

      Kataloge laden
OASIS stellt den Länderkatalog, den Katalog der Sperranlässe und den Katalog der Aufhebungsgründe
zur Verfügung. Die Kataloge werden über die festgelegte URL mit dem Standard-Header geholt. Es gibt
kein Request-Payload.

8.1 Länderkatalog
Grundlage bietet der aktuelle durch Destatis veröffentlichte Katalog vom 01.01.2016, auf den in OASIS
Bezug genommen wird.

Jeder Eintrag im Katalog besteht aus der amtlichen Kurzform des Gebiets, dem 3stelligen numerischen
Gebietsschlüssel (Gebiet: Destatis-BEV-Code ) und dem 2stelligen alphanumerischen Länderkürzel
(ISO-3166 Alpha 2).

8.1.1 Parameter
URL: /kataloge/laender
http-method: GET
Request-Payload: keine
Response-Payload: oasisKatalog.xsd
Erwartete Header-Parameter: Kennung, Passwort, Accept („text/plain; charset=UTF-8; version=4.8“)

8.1.2 Beispiel

8.1.2.1 Request
URL
/kataloge/laender

http-method
GET

Header-Parameters
Kennung: xxxxxxxx

                                       OASIS Schnittstellenbeschreibung                      Seite 30
8. Kataloge laden

Passwort: xxxxxxxxxxxxxxxx
Accept: text/plain; charset=UTF-8; version=4.8

8.1.2.2 Response
I0049Die Abfrage wurde erfolgreich durchge-
führt.Länder423AFAFGHANISTAN

. . .

8.2 Katalog Sperranlässe

8.2.1 Parameter
URL: /kataloge/sperranlaesse
http-method: GET
Request-Payload: keine
Response-Payload: oasisKatalog.xsd
Erwartete Header-Parameter: Kennung, Passwort, Accept („text/plain; charset=UTF-8; version=4.8“)

8.2.2 Beispiel

8.2.2.1 Request
URL
/kataloge/sperranlaesse

http-method
GET

Header-Parameters
Kennung: xxxxxxxx
Passwort: xxxxxxxxxxxxxxxx
Accept: text/plain; charset=UTF-8; version=4.8

Seite 31                          OASIS Schnittstellenbeschreibung
8. Kataloge laden

8.2.2.2 Response
I0049Die Abfrage wurde erfolgreich durchge-
führt.Sperranlässe99kein Grund angegeben101Spielsucht/Spielsuchtgefährdung202Finanzielle Verpflichtungen werden nicht eingehal-
ten303Überschul-
dung404Spieleinsätze stehen nicht im
Verhältnis zu Einkommen/Vermögen5

8.3 Katalog Aufhebungsgründe

8.3.1 Parameter
URL: /kataloge/aufhebungsgruende
http-method: GET
Request-Payload: keine
Response-Payload: oasisKatalog.xsd
Erwartete Header-Parameter: Kennung, Passwort, Accept („text/plain; charset=UTF-8; version=4.8“)

8.3.2 Beispiel

8.3.2.1 Request
URL
/kataloge/aufhebungsgruende

http-method
GET

Header-Parameters
Kennung: xxxxxxxx
Passwort: xxxxxxxxxxxxxxxx
Accept: text/plain; charset=UTF-8; version=4.8

                                     OASIS Schnittstellenbeschreibung                      Seite 32
8. Kataloge laden

8.3.2.2 Response
I0049Die Abfrage wurde erfolgreich durchge-
führt.Aufhebungsgründe01Doppeleintragung102Testsperre203Vorlage gerichtlicher Beschluss304Missbrauch durch Mitarbeiter405Sperrantrag durch unberechtigte Person506Änderung des Sperrantrags607Bedrohung durch Spieler7

8.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)
                     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.“
    0049        I    Die Abfrage wurde erfolgreich durchgeführt.

Seite 33                         OASIS Schnittstellenbeschreibung
9. Eigene Sperren

      Eigene Sperren

9.1 Eigene Sperren abfragen

9.1.1 Parameter
URL: /betriebsstaette/sperren
http-method: GET
Request-Payload: keine
Response-Payload: eigeneSperren.xsd
Erwartete Header-Parameter: Kennung, Passwort, Accept („text/plain; charset=UTF-8; version=4.8“)

9.1.2 Beispiel

9.1.2.1 Request
URL
/betriebsstaette/sperren

http-method
GET

Header-Parameters
Kennung: xxxxxxxx
Passwort: xxxxxxxxxxxxxxxx
Accept: text/plain; charset=UTF-8; version=4.8

9.1.2.2 Response
I0049Die Abfrage wurde erfolgreich durchge-
führt.26097313.04.2018 08:57:55dd.MM.yyyy HH:mm:ssSELBSTHans HerbertBertBladi-
Blubb1971-04-01Halle (Saale)03451HALLERichard-Wagner-
Straße17Hinterhof rechts00002Finanzielle Verpflichtungen werden nicht eingehal-
ten303Überschul-
dung426097213.04.2018 08:27:59dd.MM.yyyy HH:mm:ss
9. Eigene Sperren

TERN>SELBSTMatthiasSchmidtSchmidt1980-01-01Heimers-
heim12345MalersdorfHaupstrasse18-
00001Spielsucht/Spielsuchtgefähr-
dung2

9.2 Einige Sperren suchen mit Spielerdaten

9.2.1 Parameter
URL: /betriebsstaette/sperren
http-method: POST
Request-Payload: spielerSuchParameter.xsd
Response-Payload: eigeneSperren.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

Seite 35                               OASIS Schnittstellenbeschreibung
9. Eigene Sperren

9.2.2 Beispiel

9.2.2.1 Request
URL
/betriebsstaette/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

                Hans Herbert
                Bert
                1971-04-01
                
                       000
                
9.2.2.2 Response
I0049Die Abfrage wurde erfolgreich durchge-
führt.26097313.04.2018 08:57:55dd.MM.yyyy HH:mm:ssSELBSTHans HerbertBertBladi-
Blubb1971-04-01Halle (Saale)03451HALLERichard-Wagner-
Straße17Hinterhof rechts00002Finanzielle Verpflichtungen werden nicht eingehal-
ten303Überschul-
dung4

                                      OASIS Schnittstellenbeschreibung                 Seite 36
Sie können auch lesen