OASIS Web Services Specification Release 6.0 - published on 19.05.2021

Page created by Melvin Young
 
CONTINUE READING
OASIS Web Services Specification Release 6.0 - published on 19.05.2021
OASIS
Web Services Specification Release 6.0
published on 19.05.2021
1. Introduction

Table of Contents

1 Introduction ....................................................................................................................... 6

1.1     Glossary of terms .......................................................................................................... 6

2 Interface functions and XML Schema .............................................................................. 7

2.1     Interface functions ......................................................................................................... 7

2.2     HTTP-Header Specification ......................................................................................... 10

3 Rights and Roles in OASIS WS ...................................................................................... 11

4 Table of Responses......................................................................................................... 12

5 Character Set ................................................................................................................... 16

5.1     Permitted Characters .................................................................................................. 16
        5.1.1        Identification documents Usage ...................................................................................16
        5.1.2        Alphabetic characters ...................................................................................................16
        5.1.3        Numeric characters ......................................................................................................17
        5.1.4        Special characters ........................................................................................................17

5.2     Character Set Categories ............................................................................................ 18
        5.2.1        Category 1: Permitted characters for Gambler Status Query ......................................18
        5.2.2        Category 2: Permitted characters for the creation or modification of a ban .................19

6 OASIS basic data types .................................................................................................. 20

6.1     Simple data types in the Schema oasisBasistypen.xsd ............................................... 20

6.2     Complex data types in the Schema oasisBasistypen.xsd ............................................ 21

7 Query Gambler Status ..................................................................................................... 23

7.1     Parameter ................................................................................................................... 23

7.2     Example ...................................................................................................................... 24
        7.2.1        Request ........................................................................................................................24
        7.2.2        Response .....................................................................................................................25

7.3     Response Codes ......................................................................................................... 25

8 Ban Maintenance ............................................................................................................. 26

                                                OASIS Web Services Interface Specification                                                   Seite 2
1. Introduction

8.1       Creation of long-term and short-term bans .................................................................. 26
          8.1.1       Parameter .....................................................................................................................27
          8.1.2       Example long-term ban ................................................................................................28
          8.1.3       Example short-term ban ...............................................................................................29

8.2       Response Messages ................................................................................................... 31

8.3       Modification of long-term and short-term bans............................................................. 31
          8.3.1       Parameter .....................................................................................................................32
          8.3.2       Example long-term ban ................................................................................................33
          8.3.3       Example short-term ban ...............................................................................................34

8.4       Response Messages ................................................................................................... 36

8.5       Creation of a temporary ban (24-hr. ban) .................................................................... 36
          8.5.1       Parameter .....................................................................................................................37
          8.5.2       Example temporary ban ...............................................................................................38

8.6       Response Messages ................................................................................................... 39

8.7       Modification of a temporary ban .................................................................................. 40
          8.7.1       Parameter .....................................................................................................................40
          8.7.2       Example temporary ban ...............................................................................................41

8.8       Response Messages ................................................................................................... 43

9 Retrieve Catalogs ............................................................................................................ 43

9.1       Country catalog ........................................................................................................... 44
          9.1.1       Parameter .....................................................................................................................44
          9.1.2       Example ........................................................................................................................44

9.2       Cause for ban Catalog ................................................................................................ 45
          9.2.1       Parameter .....................................................................................................................45
          9.2.2       Example ........................................................................................................................45

10 Own ban list ................................................................................................................... 46

10.1 Retrieve own ban list ................................................................................................... 46
          10.1.1      Parameter .....................................................................................................................46
          10.1.2      Example ........................................................................................................................46

10.2 Search own ban list using gambler data ...................................................................... 47
          10.2.1      Parameter .....................................................................................................................47
          10.2.2      Example long-term ban ................................................................................................48
          10.2.3      Example short-term ban ...............................................................................................49

10.3 Search own ban list using ID ....................................................................................... 50
          10.3.1      Parameter .....................................................................................................................50

Seite 3                                     OASIS Web Services Interface Specification
1. Introduction

        10.3.2       Example long-term ban ................................................................................................51
        10.3.3       Beispiel short-term ban ................................................................................................51

10.4 Response Messages ................................................................................................... 52

11 Modify Password ........................................................................................................... 53

11.1 Parameter ................................................................................................................... 53

11.2 Example ...................................................................................................................... 53
        11.2.1       Request ........................................................................................................................53
        11.2.2       Response .....................................................................................................................54

11.3 Response Messages ................................................................................................... 54

12 Check Concession Status............................................................................................. 54

12.1 Parameter ................................................................................................................... 55

12.2 Example ...................................................................................................................... 55
        12.2.1       Request ........................................................................................................................55
        12.2.2       Response .....................................................................................................................55

12.3 Response Messages ................................................................................................... 56

13 Check Availability .......................................................................................................... 56

13.1 Parameter ................................................................................................................... 56

13.2 Example ...................................................................................................................... 57
        13.2.1       Request ........................................................................................................................57
        13.2.2       Response .....................................................................................................................57

13.3 Response Messages ................................................................................................... 57

14 Bonus and Rebates ....................................................................................................... 57

14.1 Parameter ................................................................................................................... 58

14.2 Example ...................................................................................................................... 58
        14.2.1       Request ........................................................................................................................58
        14.2.2       Response .....................................................................................................................59

14.3 Response Messages ................................................................................................... 59

15 Batch            60

15.1 Submit Batch job ......................................................................................................... 61

                                                OASIS Web Services Interface Specification                                                   Seite 4
1. Introduction

          15.1.1     Parameter .....................................................................................................................61
          15.1.2     Example ........................................................................................................................62
          15.1.3     Response Messages ....................................................................................................64

15.2 Retrieve Batch job Results .......................................................................................... 65
          15.2.1     Parameter .....................................................................................................................65
          15.2.2     Example ........................................................................................................................65
          15.2.3     Response Messages ....................................................................................................67

15.3 Request status of Batch jobs ....................................................................................... 69
          15.3.1     Parameter .....................................................................................................................69
          15.3.2     Example ........................................................................................................................69
          15.3.3     Response Messages ....................................................................................................70

16 Response Messages from Operations ......................................................................... 72

16.1 Example ...................................................................................................................... 72
          16.1.1     XML for Response Message 0052 ...............................................................................72
          16.1.2     XML for Response Message 0053 ...............................................................................72

17 Modifications with respect to Release 4.6 ................................................................... 73

18 Modifications with respect to Release 4.8 ................................................................... 73

19 Modifications with respect to Release 5.0 ................................................................... 73

20 Modifications with respect to Release 5.2 ................................................................... 73

21 Modifications with respect to Release 5.4 ................................................................... 74

22 Modifications with respect to Release 5.6 ................................................................... 74

23 Modifications with respect to Release 5.8 ................................................................... 75

23.1 Modifications with respect to the last version of this document (Release 6.0 Sprint 5). 77

23.2 Modifications with respect to the last version of this document (Release 6.0 Sprint 6). 78

23.3 Modifications with respect to the last version of this document (Release 6.0 Sprint 7). 78

23.4 Modifications with respect to the last version of this document (Release 6.0 Sprint 8). 78

23.5 Modifications with respect to the last version of this document (R6.0 Sprint 9) ............ 78

Seite 5                                    OASIS Web Services Interface Specification
1. Introduction

1 Introduction
This document contains the specification for the OASIS Web Service. This service is used to maintain
and query the online gambler ban list.

The specification for the online gambler ban list and its usage is based on the German Interstate Treaty
on Gambling (GlüStV).

Revisions in the current version of this document are highlighted in yellow to ensure they are easily
recognizable. In addition, the change history of the document is recorded in the last chapter.

The title of this specification document contains the release number of the current OASIS release in-
stead of the version number, since each function has its own version number.

Please note that the Namespace-Prefixes can vary from those provided in the examples.

Disclaimer:

This interface specification is a translation of the original document which is available in the german
language („Beschreibung OASIS-Webservice“). The original document in the german language consti-
tutes the sole binding version of the interface specification. No responsibility is accepted for the correct-
ness, validity or completeness of the translated english version. No liability arising from errors or omis-
sions is accepted.

1.1 Glossary of terms

 Term                Term in german             Description

 Gambler             Spieler                    A natural person who intends to participate in a betting
                                                game organized by a gambling organization (synonyms:
                                                better, wagerer).

 Gambling orga-      Veranstalter               A gambler organizer offers one or more types of betting /
 nizer                                          gambling games and is in possession of a license to use
                                                OASIS Web Services.

 Gambling ope-       Betriebsstätte             A gambling operator operates on behalf of a gambling or-
 rator                                          ganization.

 Ban                 Spielersperre              A ban entry in OASIS contains the personal data of the
                                                gambler who is to be denied access to gambling facilities
                                                / website.

                                      OASIS Web Services Interface Specification                      Seite 6
2. Interface functions and XML Schema

 Long-term Ban          Unbefristete Sperre         A ban that begins on the day that it is entered into OASIS
                                                    and has no End-Date.

 Short-term Ban         Befristete Sperre           A ban that is limited in its validity by Start- and End-Dates.

 Temporary Ban          Kurzzeitsperre              A ban that is effective for 24-hours and is automatically
                                                    terminated. The right to create temporary bans is limited
                                                    to certain types of gambling operators. See Rights and
                                                    Roles in OASIS WS

Table 1: Glossary of terms

2 Interface functions and XML Schema
The OASIS Web Service is based on the REST architecture. Requests in the form of XML documents
are transmitted via http. The transmitted XML documents are validated used the relevant XML Schema
for the document. Furthermore, certain portions of the XML documents are subject to additional rules-
based validation. The business rules for this additional validation are specified at the relevant points
within this document.

The XML-Tag sequence is defined in the XSD-Files.

The OASIS Web Service is stateless and executes synchronously.

Only UTF-8 without BOM is supported.

2.1 Interface functions
OASIS Interface functions

Please refer to the chapter Rights and Roles in OASIS WS for an overview of the functions that are
available for your OASIS operator account.

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

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

 No.      Function       http-       URL               Request-Pay-      Response-Payload              Valid
                         method                        load                                            Version(s)

 1        Query gamb-    POST        /spielersta-      spielerSuchpa-    statusabfrageTreffer.xsd      4.8 (deprecated)
          ler-status                 tus               rameter.xsd                                     6.0

 2        Create ban     POST        /sperren          sperrdaten.xsd    sperreAnlegenAendernEr-       6.0
                                                                         gebnis.xsd

Seite 7                           OASIS Web Services Interface Specification
2. Interface functions and XML Schema

 3       Modify ban        PUT            /sper-           sperrdaten.xsd       sperreAnlegenAendernEr-           6.0
                                          ren/{sperrid}                         gebnis.xsd

 4       Retrieve          GET            /kataloge/la-    -                    oasisKatalog.xsd                  4.8 (deprecated)
         country ca-                      ender                                                                   6.0
         talog

 5       Retrieve          GET            /kata-           -                    oasisKatalog.xsd                  4.8 (deprecated)
         cause for                        loge/sper-                                                              6.0
         ban catalog                      ranlaesse

 6       Modify pass-      PUT            /betriebs-       -                    meldungskatalogItem.xsd           4.8 (deprecated)
         word                             staette/pass                                                            6.0
                                          wort

 7       Check con-        GET            /betriebs-       -                    konzessionsdaten.xsd              4.8 (deprecated)
         cession sta-                     staette/kon-                                                            6.0
         tus                              zession

 8       Retrieve own      GET            /betriebs-       -                    eigeneSperren.xsd                 6.0
         ban list                         staette/sper
                                          ren

 9       Search own        POST           /betriebs-       spielerSuchpa-       eigeneSperren.xsd                 6.0
         ban list using                   staette/sper     rameter.xsd
         gambler data                     ren

 10      Search own        GET            /betriebs-       -                    eigeneSperren.xsd                 6.0
         ban list using                   staette/sper
         ID                               ren/{sper-
                                          rId}

 11      Check             GET            /verfuegbar-     -                    meldungskatalogItem.xsd           4.8 (deprecated)
         availability                     keit                                                                    6.0

 12      Create tem-       POST           /kurzzeit-       kurzzeitsperr-       sperreAnlegenAendernEr-           6.0
         porary ban                       sperren          daten.xsd            gebnis.xsd
         (*)

 13      Modify tem-       PUT            /kurzzeit-       kurzzeitsperr-       sperreAnlegenAendernEr-           6.0
         porary ban                       sper-            daten.xsd            gebnis.xsd
                                          ren/{sperrid}

Table 2: OASIS Webservices
(*) The implementation of the API for the creation of a temporary ban is mandatory for Online Betting Organisations.

Batch-Functions

                                           OASIS Web Services Interface Specification                                   Seite 8
2. Interface functions and XML Schema

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

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

 15       Submit batch     POST    /batch             batchAnlegenPay-      batchAnlegenErgebnis.xsd         4.8 (deprecated)
          job                                         load.xsd (gzip)                                        6.0

 16       Request status   GET     /auftraege         -                     batchJobs.xsd                    4.8 (deprecated)
          of batch jobs                                                                                      6.0

 17       Retrieve batch   GET     /batch/{batchId}   -                     batchErgebnis.xsd (gzip)         4.8 (deprecated)
          job results                                                                                        6.0

Table 3: OASIS Batch Webservices

Bonus and Rebates

Production URL-BuR-Root = https://oasis.hessen.de/oasisburws/

IntegrationTestsystem URL-BuR-Root = https://oasis-tst-crt.hessen.de/oasisburws/

 1        Bonus and        POST         URL-BuR-          bonirabatteab-      meldungskatalogi-        6.0
          Rebates query                 Root              fragedaten.xsd      tem.xsd

Seite 9                            OASIS Web Services Interface Specification
2. Interface functions and XML Schema

2.2 HTTP-Header Specification

 Name                  Description                      Pattern                     Bemerkung

 Kennung               Gambling operator ID             [0-9A-Z]{1,30}

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

 PasswortNeu           New Password for the modifi-     [\wÄäÖöÜüß!#$%'()*+,-       Only required for the Modify Pass-
                       cation of the Webservices        ./:;=?|~§_]{8,20}           word Function
                       Superuser Password

 Accept                text/plain; charset=UTF-8;                                   Each function has its own individual
                       version=x.x                                                  version.The declaration of the ver-
                       (for all functions except Re-                                sion is mandatory. The request will
                       trieval of batch job results)                                be rejected, when the version is not
                                                                                    declared.
                       application/gzip; char-
                       set=UTF-8; version=x.x
                       (Retrieve batch job results)

 Aufhebungsgrund       Reason for the termination of    ^[0-9]{1,10}$^              Required only for the termination of
                       an ban that has not reached                                  ban list entries that have not
                       the minimal statutory period.                                reached the minimal statutory pe-
                                                                                    riod.

                                                                                    For HSpielHG and GlüStV bans is
                                                                                    the minimal statutory period 1 year.

 Content-Length                                                                     Required for all functions with a Re-
                                                                                    quest-Payload

 Content-Type          application/gzip                                             Required for the submission of a
                       (for the submission of a batch                               batch job
                       job function)

Table 4: HTTP-Header Specification

                                       OASIS Web Services Interface Specification                         Seite 10
3. Rights and Roles in OASIS WS

3 Rights and Roles in OASIS WS
                                                                                                                                                                        Long-
                                                                                                                                                                      term and Tem-
                                                                                                                                                                        Short- porary
                                                     Own ban list
                                                                                                                                                                         term   bans
                                                                                                                                                                         bans

                                                                                                                                                                                                                                              Check concession status
                                                                                                                                Query gambler-status
                                  Modify password

                                                                                                                                                                                                                                                                                                                     Check availability
                                                                                                                                                                                                                                                                        Retrieve catalogs

                                                                                                                                                                                                                                                                                                   Batch Functions
                                                                                                                                                       Bonus/Rebate
  Gruppen

              Betriebsstätten-

                                                                             Search using gambler data

                                                                                                                                                                                                                       Modify temporary ban
                                                                                                                                                                                                Create temporary ban
                                                                                                         Search using SperrID
                    Typ                               Retieve own ban list

                                                                                                                                                                                   Modify ban
                                                                                                                                                                      Create ban
        Spielhalle
        staatliche Lotteriege-
        sellschaft
  Wit- Spielbank
  hout Sportwetten terrest-                                                                                                                                                                                                                                                                 At this time alot-
 Rights risch                                                                                                                                                                                                                                                                                 ment of new
   for  Pferdewetten im In-            x              x                       x                             x                         x                x                 x            x                                                       x                         x                   Batch-slots is not             x
  tem- ternet                                                                                                                                                                                                                                                                               possible due to
 porary Gewerblicher Spiel-                                                                                                                                                                                                                                                                   legal reasons
  bans vermittler
            Lotterieanbieter
        Buchmacher
        Aufsteller § 33c Abs. 1
        GewO
        Veranstalter       von
        Sportwetten
  With Veranstalter/Ver-
 Rights mittler von virtuellen
   for  Automatenspielen
                                       x              x                       x                             x                         x                x                 x            x         x                      x                      x                         x                                                  x
  tem- Veranstalter/Ver-
 porary mittler von Online-
  bans Poker
        Veranstalter/Ver-
        mittler von Online-
        Casinospielen

Table 5: Rights in OASIS WS

Seite 11                                            OASIS Web Services Interface Specification
4. Table of Responses

4 Table of Responses
Following is a list of all OASIS responses. The usage is listed in the individual interface function de-
scriptions.

     Code        Type                        Response Text                                    Notes

                         „Sie haben keine Berechtigung“ oder „Sie haben            The passwort ist false or
                         keine Berechtigung (kein gültiges Zertifikat)“            the certificate is not valid
     0001          E
                         Translation: „You are not authorized“ or „Your certifi-   for the used account.
                         cate is invalid“
                         Ihr Zugang wurde gesperrt. Bitte wenden Sie sich an       The Super-User pass-
                         den Super-User. Als Super-User wenden Sie sich            word can be reset by the
                         bitte an die Hotline (Tel 06652/1872212)                  OASIS IT-Service Desk.
     0002          E
                         Translation: „Your access has been inactivated.
                         Please contact your Super-User. Super-Users should
                         contact the hotline (Tel 06652/1872212).“
                         Es ist ein Serverfehler aufgetreten. Bitte wenden Sie
                         sich an die Hotline (Tel 06652/1872212).
     0003          E
                         Translation: „A server error has occurred. Please con-
                         tact the hotline (Tel 06652/1872212).“
                                                                                   The termination or modi-
                         Änderung oder Beenden der Sperre ist nicht möglich:
                                                                                   fication of ban list entries
                         es wurde kein Sperreintrag zum Spieler gefunden.
     0004          E                                                               that do not belong to the
                         Translation: „Modification/Termination of the ban not
                                                                                   logged-in User cannot be
                         possible: no entry found for this person“
                                                                                   executed.
                         Die Person wurde mit Datum  erfolg-
                         reich gesperrt.
     0007          I
                         Translation: „A ban was successfully created for this
                         person on ”
                         Sie haben keine Berechtigung, diese Sperre zu än-         The ban belongs to
                         dern.                                                     another gambling opera-
     0008          E
                         Translation: „You do not have the permission to mod-      tor
                         ify this ban”
                         Die Spielerdaten wurden am  erfolg-
                         reich geändert.
     0009          I
                         Translation: „The ban was successfully modified on
                         ”
                         Das XML ist nicht schemakonform.                          General error
     0014          E
                         Translation: „XML does not conform to schema“
                         Es ist ein Plausibilisierungsfehler aufgetreten. 
     0015          E
                         Translation: „A plausibility error has occurred.
4. Table of Responses

                                                                             A ban that matches the
                                                                             query has been found.
                   Der Spieler ist gesperrt.
     0018      W                                                             The response contains
                   Translation: „A ban exists for the gambler.“
                                                                             the gambling operator,
                                                                             who is responsible for
                                                                             the entry.
                   Der Spieler ist nicht gesperrt.                           No match was found in
     0019      I
                   Translation: „No ban exists for the gambler.”             OASIS.
                   Das Passwort wurde erfolgreich geändert.
     0020      I   Translation: „The password was successfully modi-
                   fied.“
                   Sie dürfen OASIS WS nicht verwenden
     0021      E   Translation: „You do not have the permission to use
                   OASIS WS.
                   Sie dürfen OASIS WEB nicht verwenden                      OASIS WEB ONLY
     0022      E   Translation: „You do not have the permission to use
                   OASIS WEB.
                                                                            More than one ban was
                                                                            found that matches the
                   Der Spieler ist gesperrt. Es gab mehr als einen Treffer
                                                                            query. It is possible to
                   für Ihre Abfrage.
     0023      W                                                            isolate the matching en-
                   Translation: „A ban exists for gambler. More than one
                                                                            try by repeating the
                   entry was found for your query.“
                                                                            query with addtional at-
                                                                            tributes.
                                                                            More than one ban was
                                                                            found that matches the
                   Der Spieler ist gesperrt. Es gab mehr als einen Treffer
                                                                            query. It is not possible
                   für Ihre Abfrage.
     0024      W                                                            to isolate the matching
                   Translation: „A ban exists for the gambler. More than
                                                                            entry since all attributes
                   one entry was found for your query.“
                                                                            have been supplied in
                                                                            the query.
                   Diese Schnittstelle steht vorübergehend nicht zur Ver-
                   fügung. Bitte wählen Sie einen anderen Zeitpunkt für The Bonus and Rebate
 0030 / 0033   W   Ihre Abfrage.                                            function is temporarily
                   Translation: „This function is temporarily unavailable. unavailable.
                   Please retry later.”
                   Der Spieler darf Boni oder Rabatte erhalten.
                                                                            according to § 8 Abs. 4
     0031      I   Translation: „It is allowed to offer the gambler a bonus
                                                                            GlüStV 2021
                   or rebate.”
                   Der Spieler darf keine Boni oder Rabatte erhalten.
                                                                            according to § 8 Abs. 4
     0032      W   Translation: „It is NOT allowed to offer the gambler a
                                                                            GlüStV 2021
                   bonus or rebate.”
                   Die Daten werden gerade von einem anderen Benut-
                   zer geändert.
     0040      E
                   Translation: „The data is currently being modified by
                   another user.“
                   Sie müssen Ihr Initialpasswort ändern.                   OASIS WEB ONLY
     0041      W
                   Translation: „Please change your initial password.“
                   Der Benutzer wurde erfolgreich angelegt.                 OASIS WEB ONLY
     0042      I   Translation: „The user account was successfully cre-
                   ated.“
                   Passwortänderung fehlgeschlagen, da der angege-          OASIS WEB ONLY
                   bene Benutzer nicht bekannt ist.
     0043      E
                   Translation: „Password modification unsuccessful; u-
                   ser unknown.“

Seite 13                 OASIS Web Services Interface Specification
4. Table of Responses

                        Für den angegebenen Benutzer dürfen Sie das Pass-        OASIS WEB ONLY
                        wort nicht ändern.
     0044          E
                        Translation: „You are not permitted to modify the
                        password for this user.“
                        Das neue Passwort muss sich von dem bisherigen
                        unterscheiden.
     0045          E
                        Translation: „The new password must differ from the
                        previous password.“
                        Die Angaben zum Benutzer wurden erfolgreich geän-
     0047          I    dert.
                        Translation: „User data successfully modified.“
                        Die Abfrage wurde erfolgreich durchgeführt.
     0049          I
                        Translation: „Query was successfully executed.“
                        Ihre Zugangsberechtigung wurde deaktiviert-bitte
                        wenden Sie sich an die Hotline (Tel 06652/1872212)
     0051          E    Translation: „Your access rights have been deacti-
                        vated. Please contact the hotline (Tel.
                        06652/1872212).“
                        Derzeit werden geplante Wartungsarbeiten am              OASIS Operations will
                        OASIS-Service durchgeführt.                              activate a ‚maintenance‘
     0052          I
                        Translation: „Planned maintenance work is currently      response-page during a
                        in progress“                                             planned maintenance.
                                                                                 OASIS Operations will
                        Derzeit liegt eine Störung von OASIS vor. An der Ent-
                                                                                 activate an ‚error‘ re-
                        störung wird derzeit gearbeitet.
     0053          E                                                             sponse-page, when a
                        Translation: „The system is currently experiencing
                                                                                 system error occurs and
                        problems. These are being resolved at the moment.“
                                                                                 OASIS is not available..
                        Einstellen von Batchanfragen: Die maximale Anzahl
                        gleichzeitig laufender Batchabfragen ist erreicht. Bitte
                        versuchen Sie es später nochmal.
     0054         W
                        Translation: „ Submission of Batch Job: The maximum
                        concurrent number of batch jobs has been reached.
                        Please try again later.“
                        Einstellen von Batchanfragen: Übertragener Inhalt
                        kann nicht in eine Batchanfrage konvertiert werden
     0060          E
                        Translation: „Submission of Batch Job: Content can-
                        not be converted for batch job“
                        Einstellen von Batchanfragen: Batch beinhaltet zu
                        viele Datensätze
     0061          E
                        Translation: „Submission of Batch Job: Batch contains
                        too many records“
                        Einstellen von Batchanfragen: Identischer Batch          Identical batch jobs sub-
                        wurde bereits beauftragt                                 mitted within a timeslot
     0062          E
                        Translation: „Submission of Batch Job: Identical Batch will be rejected.
                        has already been uploaded“
                        Einstellen von Batchanfragen: Batch wurde nicht im
                        korrekten Zeitfenster beauftragt
     0063          E
                        Translation: „Submission of Batch Job: Batch has
                        been uploaded in wrong timeslot“
                        Einstellen von Batchanfragen: Betriebsstätte ist nicht
                        berechtigt einen Batch zu beauftragen
     0064          E
                        Translation: „Submission of Batch Job: You are not
                        authorised to use Batch“
                        Einstellen von Batchanfragen: Maximale Anzahl von
                        Batches pro Zeitfenster überschritten
     0065          E
                        Translation: „Trigger Batch Job: Maximal number of
                        batch jobs in timeslot has been reached“

                                 OASIS Web Services Interface Specification                    Seite 14
4. Table of Responses

                              Einstellen von Batchanfragen: Batchverarbeitung
                              wurde aus betrieblichen Gründen temporär gesperrt
     0066           E
                              Translation: „Submission of Batch Job: Batch proces-
                              sing has been temporarily disabled“
                              Ergebnisse von Batchanfragen: Fehler bei der Verar-
                              beitung eines Batch aufgetreten
     0070           E
                              Translation: „Batch Job Results Retrieval: An error in
                              the processing of batch job has occured“.
                              Ergebnisse von Batchanfragen: Batchverarbeitung
                              wurde manuell abgebrochen
     0071           E
                              Translation: „Batch Job Results Retrieval: Batch job
                              processing has been manually cancelled“.
                              Ergebnisse von Batchanfragen: Berechtigung zur
                              Batchverarbeitung wurde entzogen
     0072           E
                              Translation: „Batch Job Results Retrieval: You are no
                              longer authorized to use Batch“
                              Ergebnisse von Batchanfragen: Der Batch existiert
                              nicht oder nicht mehr
     0073           E
                              Translation: „Batch Job Results Retrieval: Batch job
                              does not exist or doesn’t exist anymore“
                              Ergebnisse von Batchanfragen: Das Ergebnis steht
                              nicht mehr zur Verfügung, da es bereits am
                               abgeholt wurde
     0074           E
                              Translation: „Batch Job Results Retrieval: The batch
                              results are no longer available, because they were
                              downloaded on
5. Character Set

5 Character Set
XML-Documents are to be encoded in Unicode UTF-8. In addition, the character set for certain ele-
ments are further limited to the DIN SPEC 91379 „Normative Zeichen“. This character set contains all
latin characters within Unicode UTF-8, including diacritical symbols and ligatures.

This character set latinchars.xsd is no longer used in the XML Schema and therefore no longer in the
XSDs.

5.1 Permitted Characters
Permitted characters are those from the character set DIN SPEC 91379. Invalid characters should be
removed before the request is submitted to OASIS.

5.1.1 Identification documents Usage
The personal data (latin alphabet) in the visual inspection zone (VIZ) from the identification document
must be used for creating and maintaining bans. Usage of the personal data from the machine readable
zone (MRZ) is not valid.

5.1.2 Alphabetic characters
In addition to the alphabetic characters [A-z], the following are permitted:

 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̦ ĹĺĻļĽľĿŀŁłḶḷḺḻ

                                         OASIS Web Services Interface Specification            Seite 16
5. Character Set

 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̇ ÙÚÛÛ̄ ùúûû̄ ŨũŪūŬŭŮůŰűŲųƯưǓǔỤỤ̄ Ụ̈ ụụ̄ ụ̈ ỦủỨứỪừỬửỮữỰự
 ÜüǕǖǗǘǙǚǛǜ
 ŴŵẀẁẂẃẄẅẆẇ
 Ẍẍ
 Ýýÿÿ́ ŶŷŸȲȳẎẏỲỳỴỵỶỷỸỹ
 Z̀ Z̄Z̆Z̈Z̧z̀z̄z̆z̈z̧ŹźŻżŽŽ̦ Ž̧žž̦ ž̧ƷǮǯʒẐẑẒẓẔẕ

Figure 1: Diacritical symbols and ligatures

5.1.3 Numeric characters
 0123456789

Figure 2: Numeric characters

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

Figure 3: Special characters

Please note that for some of the special characters the use of xml-notation is required, otherwise they
will be misinterpretated as control characters.

 Character           XML-Notation

 <                   <

 >                   >

Seite 17                                OASIS Web Services Interface Specification
5. Character Set

 &                 &

 "                 "

 '                 '

Figure 4: XML-Notation of special characters

5.2 Character Set Categories
The allowed characters are limited further in the functions.

5.2.1 Category 1: Permitted characters for Gambler Status Query
In a query for gambler status all characters in DIN SPEC 91379 are permitted. This is necessary in order
to ensure that bans migrated from previous systems (not conforming to the OASIS rules) can be reliably
queried.

                                                            Permitted numeric
                                                                 characters
                                    Permitted alpha-                                 Permitted special
                                                            (see Chapter Feh-
           Element                   betic characters                                   characters
                                                             ler! Verweisquelle
                                   (see Chapter 5.1.2)                              (see Chapter 5.1.4)
                                                            konnte nicht gefun-
                                                                den werden.)

 V (Vorname)                                   All                  0-9                     All

 N (Nachname)                                  All                  0-9                     All

 D (Geburtsdatum)                          None                     0-9                      -

 G (Geburtsname)                               All                  0-9                     All

 O (Geburtsort)                                All                  0-9                     All

 Anschrift.P (PLZ)                             All                  0-9                     All

 Anschrift.W (Ort)                             All                  0-9                     All

 Anschrift.S (Strasse)                         All                  0-9                     All

 Anschrift.H (Hausnr)                          All                  0-9                     All

 Anschrift.Z (Adresszusatz)                    All                  0-9                     All

Table 7: Permitted characters for Query Gambler Status

                                       OASIS Web Services Interface Specification                 Seite 18
5. Character Set

5.2.2 Category 2: Permitted characters for the creation or modifica-
      tion of a ban
The DIN SPEC 91379 character set is further restricted in the creation and modification of a ban in order
to ensure that ban list entries can be reliably queried.

                                     Permitted alpha-          Permitted numeric      Permitted special
             Element                  betic characters              charaters            characters
                                    (see Chapter 5.1.2)        (see Chapter 5.1.3)   (see Chapter 5.1.4)

           V (Vorname)                        All                          None             .-´`'
        N (Nachname)                          All                          None             .-´`'
      D (Geburtsdatum)                       None                          0-9                -
       G (Geburtsname)                        All                          None             .-´`'
           O (Geburtsort)                     All                          None          .-´`',/()
       Anschrift.P (PLZ)                      All                          0-9                -
       Anschrift.W (Ort)                      All                          None          .-´`',/()
     Anschrift.S (Strasse)                    All                          0-9             .-´`',/
     Anschrift.H (Hausnr)                     All                          0-9              -/.,
 Anschrift.Z (Adresszusatz)                   All                          0-9         .-´`',;/()&+
Table 8: Permitted characters for the creation and modification of a ban

Seite 19                            OASIS Web Services Interface Specification
6. OASIS basic data types

6 OASIS basic data types

6.1 Simple data types in the Schema oasisBasistypen.xsd
 Data type name        Data type         Usage                               Restrictions
 in XML Schema

 t_adresszusatz        Din-              Residential address       supple-   Max. 256 Characters
                       Spec91379Nor-     ment (of the gambler)
                       mativ

 t_geburtsdatum        xs:string         Date of birth (of gambler)          ([0-9]{4})\-([0-9]{2}|-{2})\-
                                                                             ([0-9]{2}|-{2})

 t_land                xs:string         3 digit numeric country code, in    ([0-9]{3})?
                                         accordance with the table of
                                         countries issued by Destatis.

                                         The table is provided by the OA-
                                         SIS web service as XML.

 t_name                Din-              Data type for first name(s), sur-   Max. 85 Characters
                       Spec91379Nor-     name, name at birth, place of
                       mativ             birth and city of residence (of
                                         the gambler)

 t_passwort            xs:string         Data type for a password in OA-     Min. 8, Max. 16 Characters
                                         SIS.
                                                                             [0-9a-zA-Z!#$%'()*+,-
                                                                             ./:;=?|~§_äÄöÖüÜß]{8,20}

 t_plz_hausnum-        Din-              Data type for the residential       Max. 20 Characters
 mer                   Spec91379Nor-     postcode and house number (of
                       mativ             the gambler)

 t_sperrgrund          xs:string-based   Reason for the ban, permitted       FREMD, SELBST
                       Enumeration       values are SELBST (self) and
                                         FREMD (3rd party)

 t_sperrid             xs:integer        Data type for the SperrID (Ban      [Integer]
                                         ID). This is generated automati-
                                         cally by OASIS and uniquely
                                         identifies the ban.

 t_strasse             Din-              Data type for the residential       Maximal 150 Characters
                       Spec91379Nor-     street (of the gambler)
                       mativ

 t_meldungsart         xs:string-ba-     Request status                      I, W, E
                       sierte Enume-
                       ration

 t_schluessel          xs:string         Return code for a response          [0-9]{4}

                                    OASIS Web Services Interface Specification                       Seite 20
6. OASIS basic data types

 t_meldung_text         xs:string            Response      text          from    Min. 1 Character, max.
                                                                   4000 Characters

 t_kbez1                xs:string                                                Min. 1 Character, max. 10
                                             Name of catalog item                Characters

                                                                                 [0-9]*

 t_kbez2                xs:string                                                Min. 1 Character, max. 10
                                             Short description of catalog        Characters
                                             item
                                                                                 [A-Za-z0-9\-–]*

 t_lbez                 xs:string                                                Min. 0 Characters, max.
                                             Long description of catalog item
                                                                                 150 Characters

 t_besitzer_namen       xs:string                                                Maximal 200 Characters

 t_besitzer_telefon     xs:string                                                Maximal 50 Characters

 t_besitzer_mail        xs:string                                                Maximal 100 Characters

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

 t_batch_id             xs:string                                                [\d]{1,9}

 t_ds_id                xs:string                                                [\d]{1,7}

 Din-                   xs:string            Data Type for latin characters in   See Chapter 5.1
 Spec91379Nor-                               unicode according to Din-
 mativ                                       Spec91379Normativ

Table 9: Simple data types in the Schema oasisBasistypen.xsd

6.2 Complex data types in the Schema oa-
    sisBasistypen.xsd
 Type in Schema          Contains Elements              Usage

 t_anschrift             P (PLZ)                        Complete residential address of the gambler, re-
                                                        quired for the creation and modification of a ban. All
                         W (WOHNORT)
                                                        elements with the exception of address supplement
                         S (STRASSE)                    (ADDRESSZUSATZ) are required.
                         H (HAUSNUMMER)

                         Z (ADDRESZUSATZ)

                         L (LAND)

 t_anschrift_status      P (PLZ)                        Residential address of the gambler, required for an
                                                        ban list status query. All elements are optional.
                         W (WOHNORT)
                         S (STRASSE)

Seite 21                            OASIS Web Services Interface Specification
6. OASIS basic data types

                        H (HAUSNUMMER)

                        Z (ADDRESZUSATZ)

                        L (LAND)

 t_spieler              V (VORNAME)                Gambler-data, required for the creation or modifica-
                                                   tion of a ban in OASIS. All elements are required for
                        N (NACHNAME)
                                                   these operations.
                        G (GEBURTSNAME)

                        D (GEBURTSDATUM)

                        O (GEBURTSORT)

                        A (ANSCHRIFT)

 t_spieler_status       V (VORNAME)                Gambler-data required to verify a ban; required el-
                                                   ements are VORNAME, NACHNAME und
                        N (NACHNAME)
                                                   GEBURTSDATUM (first name, surname and date
                        G (GEBURTSNAME)            of birth).
                        D (GEBURTSDATUM)

                        O (GEBURTSORT)

                        A (ANSCHRIFT)

 t_besitzer             NAME                       Ban owner (Gambling operator)

                        ANSPRECHPARTNER

                        TELEFON

                        EMAIL

 t_sperre               SPERRID                    Ban

                        SPERRDATUM

                        SPERRGRUND

                        ANLASS

                        FRIST_ENDE

 t_sperrinformation     SPERRID                    ID and owner of ban

                        BESITZER

 t_katalog_item         KBEZ1                      Catalog entry description

                        KBEZ2

                        LBEZ
                        SORTNR

                        ZULAESSIG

 t_datum_uhrzeit        DATUM                      Example:

                        FORMAT-PATTERN             DATUM: 23.01.2020 10:34:12

                                   OASIS Web Services Interface Specification                    Seite 22
7. Query Gambler Status

                                                           FORMAT-PATTERN: dd.MM.yyyy HH:mm:ss

                                                           (Java-Forma Pattern)

 t_meldungskata-         ART                               Response Catalog item description.
 log_item
                         SCHLUESSEL

                         MELDUNG

Table 10: Complex data types in the Schema oasisBasistypen.xsd

7 Query Gambler Status
With the Gambler Status Query function in OASIS it is possible to query whether a ban exists for the
named gambler.

The Gambler Status Query does not rely on exact character matches but searches for „similar“ entries.
Within OASIS this is also denoted as transliterated search, as characters are transliterated for use in
the search process.

7.1 Parameter
URL: /spielerstatus
http-method: POST
Request-Payload: spielersuchParameter.xsd
Response-Payload: statusabfrageTreffer.xsd
Header-Parameter: Kennung, Passwort, Accept („text/plain; charset=UTF-8; version=see Interface
functions“), Content-Type (text/plain; charset=UTF-8), Content-Length

 XML-Structure                     Description                                    Type              Charac-      max
                                                                                                    ter Set      length
                                                                                                    Category
 SPIELER       V [1/1]             Vorname (First Name)                           t_name            1            85
 [1/1]         N [1/1]             Nachname (Surname)                             t_name            1            85
 Gambler       G [0/1]             Geburtsname (Name given at birth)              t_name            1            85
               D [1/1]             Geburtsdatum: (Date of birth)                  t_geburtsdatum    1            10
                                   ([0-9]{4})\-([0-9]{2}|-{2})\-([0-9]{2}|-{2})
               O [0/1]             Geburtsort (birthplace)                        t_name            1            85
               A [0/1]   P [0/1]   Anschrift PLZ (Postal code)                    t_plz_hausnum-    1            20
               Ad-                                                                mer
               dress     W[0/1]    Anschrift Wohnort (City)                       t_name            1            85
                         S [0/1]   Anschrift Strasse (Street)                     t_strasse         1            150
                         H [0/1]   Anschrift Hausnummer (Number)                  t_plz_hausnum-    1            20
                                                                                  mer

Seite 23                           OASIS Web Services Interface Specification
7. Query Gambler Status

                          Z [0/1]   Anschrift Adresszusatz (supplemental    t_addresszusatz   1             256
                                    address data)
                          L [0/1]   Anschrift Land: Gebiets-Code (3-digit   t_land            In accord-    In ac-
                                    area code from the country catalog)                       ance with     cordance
                                                                                              the coun-     with the
                                                                                              try catalog   country
                                                                                                            catalog
[MinOccurs/MaxOccurs] are placed in brackets:
[1/1] = must exist at least once / only one instance is allowed

7.2 Example
Please note that the Namespace-Prefixes can vary from those provided in the examples.

7.2.1 Request
URL
 /spielerstatus

http-method
POST

Header-Parameters
Kennung: xxxxxxxx
Passwort: xxxxxxxxxxxxxxxx
Accept: text/plain; charset=UTF-8; version=6.0
Content-type: text/plain; charset=UTF-8
Content-Length:xx

XML

            Hans Herbert
            Bertsel
            1971-04-01
         
                                       OASIS Web Services Interface Specification                      Seite 24
7. Query Gambler Status

7.2.2 Response

7.2.2.1 Match found:
W0018Der Spieler
ist gesperrt.2486465FT2000PlayWiesbadenSamoht Retsnil0815-4711ws@test.test

7.2.2.2 No match found:
I0019Der Spieler
ist nicht gesperrt.

7.3 Response Codes
    Code      Type                       Response Text                                     Notes

                     „Sie haben keine Berechtigung“ oder „Sie haben            The passwort ist false or
                     keine Berechtigung (kein gültiges Zertifikat)“            the certificate is not valid
    0001       E
                     Translation: „You are not authorized“ or „Your certifi-   for the used account.
                     cate is invalid“
                     Ihr Zugang wurde gesperrt. Bitte wenden Sie sich an       The Super-User password
                     den Super-User. Als Super-User wenden Sie sich            can be reset by the OASIS
                     bitte an die Hotline (Tel 06652/1872212)                  IT-Service Desk.
    0002       E
                     Translation: „Your access has been inactivated.
                     Please contact your Super-User. Super-Users should
                     contact the hotline (Tel 06652/1872212).“
                     Es ist ein Serverfehler aufgetreten. Bitte wenden Sie
                     sich an die Hotline (Tel 06652/1872212).
    0003       E
                     Translation: „A server error has occurred. Please con-
                     tact the hotline (Tel 06652/1872212).“
                     Das XML ist nicht schemakonform.                          General error
    0014       E
                     Translation: „XML does not conform to schema“
                     Es ist ein Plausibilisierungsfehler aufgetreten. 
    0015       E
                     Translation: „A plausibility error has occurred.
8. Ban Maintenance

                        „Sie haben keine gültige Konzession/Erlaubnis.“ oder
                        „Sie haben keinen Zugang zum System, da Ihre Kon-
                        zession/Erlaubnis ruht.“
    0016         E
                        Translation: „You do not possess a valid conces-
                        sion/license “or “Your concession/license is sus-
                        pended.“
                                                                                 A ban that matches the
                                                                                 query has been found.
                        Der Spieler ist gesperrt.
    0018         W
                        Translation: „A ban exists for the gambler.“            The response contains the
                                                                                gambling operator, who is
                                                                                responsible for the entry.
                        Der Spieler ist nicht gesperrt.                         No match was found in
    0019         I
                        Translation: „No ban exists for the gambler.”           OASIS.
                                                                                More than one ban was
                        Der Spieler ist gesperrt. Es gab mehr als einen Treffer found that matches the
                        für Ihre Abfrage.                                       query. It is possible to iso-
    0023         W
                        Translation: „A ban exists for gambler. More than one late the matching entry by
                        entry was found for your query.“                        repeating the query with
                                                                                addtional attributes.
                                                                                More than one ban was
                        Der Spieler ist gesperrt. Es gab mehr als einen Treffer found that matches the
                        für Ihre Abfrage.                                       query. It is not possible to
    0024         W
                        Translation: „A ban exists for the gambler. More than isolate the matching entry
                        one entry was found for your query.“                    since all attributes have
                                                                                been supplied in the query.

8 Ban Maintenance
There are three types of bans: long-term, short-term and temporary. All OASIS-clients can maintain
long-term and short-term bans. Temporary bans can only be created by certain gambling operator ac-
count types (see Rights and Roles in OASIS WS).

8.1 Creation of long-term and short-term bans
The creation of a ban in OASIS results in a gambling ban for the named person. A subsequent status
query willl result in a match being found for the person.

The data entered for a gambler is based on the identification documents provided to the gambling or-
ganization. Additional required information not displayed in official identification papers must be pro-
vided in the form of further documents confirming the identity of the gambler.

The data entered must conform exactly to the information provided in the identification documents. This
applies to the characters as well as their order.

Remarks:
The submission of the optional date ban-end (FRIST_ENDE) creates a short-term ban. A short-term
ban is effective upon its creation, as are all types of bans (FRIST_BEGINN no longer exists as XML-
Element.).

                                   OASIS Web Services Interface Specification                     Seite 26
8. Ban Maintenance

The FRIST_ENDE should be at least 3 months after the FRIST_BEGINN. In the case when the submit-
ted duration of a short-term ban is less than 3 months it will be automatically extended to 3 months. The
ban is valid for entire days (from 00:00 until 23:59:59), that means that any time that has been entered
in FRIST_BEGINN and FRIST_ENDE will be ignored.

8.1.1 Parameter
URL: /sperren
http-method: POST
Request-Payload: sperrdaten.xsd
Response-Payload: sperreAnlegenAendernErgebnis.xsd
Header-Parameter: Kennung, Passwort, Accept („text/plain; charset=UTF-8; version= see Interface
functions“), Content-Type (text/plain; charset=UTF-8), Content-Length

 XML-Structure                        Description                                Type                Charac-       max
                                                                                                     ter Set       Feld-
                                                                                                     Category      länge

 SPERRGRUND                   [1/1]   „SELBST „ oder „FREMD“                     t_sperrgrund        See           See
 Reason for ban                       self or 3rd party                                              Descrip-      Descrip-
                                                                                                     tion          tion
 SPIELER          V [1/1]             Vorname (First Name)                       t_name              2             85
 [1/1]                                Should the gambler have no first
 Gambler                              name(s), the entry ‘–‘ (minus sign)
                                      is required in their place
                  N [1/1]             Nachname (Surname)                         t_name              2             85
                  G [1/1]             Geburtsname (Name given at birth)          t_name              2             85
                  D [1/1]             Geburtsdatum: (Date of birth)              t_geburtsdatum      2             10
                                      ([0-9]{4})\-([0-9]{2}|-{2})\-([0-9]{2}|-
                                      {2})
                  O [1/1]             Geburtsort (birthplace)                    t_name              2             85
                  A [1/1]   P [1/1]   Anschrift PLZ (Postal code)                t_plz_hausnum-      2             20
                  Ad-                                                            mer
                  dress     W[1/1]    Anschrift Wohnort (City)                   t_name              2             85
                            S [1/1]   Anschrift Strasse (Street)                 t_strasse           2             150
                            H [1/1]   Anschrift Hausnummer (Number)              t_plz_hausnum-      2             20
                                                                                 mer
                            Z [0/1]   Anschrift    Adresszusatz       (supple-   t_addresszusatz     2             256
                                      mental address data)
                            L [1/1]   Anschrift Land: Gebiets-Code (3-           t_land              In accord-    In ac-
                                      digit area code from the country cat-                          ance with     cordance
                                      alog)                                                          the coun-     with the
                                                                                                     try catalog   country
                                                                                                                   catalog
 ANLASS           KBEZ1               2-digit code from the cause of ban         t_kbez1             In accord-    In       ac-
 [1/99]           [1/1]               catalg. Multiple causal codes are al-                          ance with     cordance
 Cause for ban                                                                                       the cause     with     the

Seite 27                          OASIS Web Services Interface Specification
8. Ban Maintenance

                                          lowed, but the code 99 ‘cause un-                           for   ban     cause for
                                          known’ should not be combined with                          catalog       ban cata-
                                          other causal codes and is no longer                                       log
                                          allowed for   3rd   party bans.The sys-
                                          tem ignores duplicate causal codes
                                          and will save only one instance of
                                          each delivered causal code.
                  1
 FRIST_ENDE                               Short-term ban end-date                   t_datum_uhrzeit
 [0/1] ban-end
[MinOccurs/MaxOccurs] are placed in brackets: [1/99] = must exist at least once / 99 instances allowed
1 required   attribute for short-term bans and not allowed for long-term bans

8.1.2 Example long-term ban
Please note that the Namespace-Prefixes can vary from those provided in the examples.

8.1.2.1 Request
URL
 /sperren

http-method
POST

Header-Parameters
Kennung: xxxxxxxx
Passwort: xxxxxxxxxxxxxxxx
Accept: text/plain; charset=UTF-8; version=6.0
Content-type: text/plain; charset=UTF-8
Content-Length:xx

XML

         SELBST
         
                      Karl
                      Karlsen
                      Blubbding
                      1970-01-01
                      Halle
                      
                             58500
                             Halle
                             Richard-Wagner-Straße

                                          OASIS Web Services Interface Specification                            Seite 28
8. Ban Maintenance

                         17
                         Vorderhaus
                         000
                  
                  02
           
8.1.2.2 Response
I0007Die Person wurde mit Datum vom
18.03.2021 15:13:31 erfolgreich gesperrt.257340718.03.2021 15:13:31dd.MM.yyyy
HH:mm:ssSELBSTKarlKarlsenBlubbding1970-01-
01Halle58500HalleRichard-Wagner-Straße17Vorder-
haus00002Finanzielle Verpflichtungen
werden nicht eingehalten3true

8.1.3 Example short-term ban
Please note that the Namespace-Prefixes can vary from those provided in the examples.

8.1.3.1 Request
URL
 /sperren

http-method
POST

Header-Parameters
Kennung: xxxxxxxx
Passwort: xxxxxxxxxxxxxxxx
Accept: text/plain; charset=UTF-8; version=6.0
Content-type: text/plain; charset=UTF-8
Content-Length:xx

XML

Seite 29                        OASIS Web Services Interface Specification
8. Ban Maintenance

       SELBST
       
               Karl
               Karlinger
               Blubbding
               1970-01-01
               Halle
               
                       58500
                       Halle
                       Richard-Wagner-Straße
                       17
                       Vorderhaus
                       000
               
               02
       
               31.05.2021
               dd.MM.yyyy
       
8.1.3.2 Response
I0007Die Person wurde mit Datum vom
18.03.2021 15:21:39 erfolgreich gesperrt.257340818.03.2021 00:00:00dd.MM.yyyy
HH:mm:ssSELBSTKarlKarlingerBlubbding1970-01-
01Halle58500HalleRichard-Wagner-Straße17Vorder-
haus00002Finanzielle Verpflichtungen
werden nicht eingehalten3true31.05.2021 23:59:59dd.MM.yyyy HH:mm:ss

                                   OASIS Web Services Interface Specification          Seite 30
8. Ban Maintenance

8.2 Response Messages
  Schlüssel    Art                           Meldung                                     Bemerkung

                      „Sie haben keine Berechtigung“ oder „Sie haben
                      keine Berechtigung (kein gültiges Zertifikat)“
    0001        E
                      Translation: „You are not authorized“ or „Your certifi-
                      cate is invalid“
                      Ihr Zugang wurde gesperrt. Bitte wenden Sie sich an
                      den Super-User. Als Super-User wenden Sie sich
                      bitte an die Hotline (Tel 06652/1872212)
    0002        E
                      Translation: „Your access has been inactivated.
                      Please contact your Super-User. Super-Users should
                      contact the hotline (Tel 06652/1872212).“
                      Es ist ein Serverfehler aufgetreten. Bitte wenden Sie
                      sich an die Hotline (Tel 06652/1872212)
    0003        E
                      Translation: „A server error has occurred. Please con-
                      tact the hotline (Tel 06652/1872212).“
                      Die Person wurde mit Datum  erfolg-
                      reich gesperrt.                                            The ban was successfully
    0007         I
                      Translation: „A person was successfully banned on          created
                      .“
                      Die Person wurde mit Datum  erfolg-
                      reich gesperrt. < Eine befristete Sperre darf nicht kür-
                      zer als 3 Monate sein. Wird eine kürzere Dauer als 3       In the case when the sub-
                      Monate angegeben, gilt dies als Angabe von 3 Mona-         mitted duration of a short-
                      ten (siehe § 8a Abs. 6 S. 2 GlüStV 2021).>                 term ban is less than 3
    0007         I
                      Translation: „A person was successfuly banned on           months it will be automati-
                      .
8. Ban Maintenance

8.3.1 Parameter
URL: /sperren/{ban id}
http-method: PUT
Request-Payload: sperrdaten.xsd
Response-Payload: sperreAnlegenAendernErgebnis.xsd
Header-Parameter: Kennung, Passwort, Accept („text/plain; charset=UTF-8; version= see Interface
functions“), Content-Type (text/plain; charset=UTF-8), Content-Length

 XML-Structure                             Description                                Type              Charac-        max
                                                                                                        ter Set        Feld-
                                                                                                        Category       länge

 SPERRGRUND                      [1/1]     „SELBST „ oder „FREMD“                     t_sperrgrund      See            See
 Reason for ban                            self or 3rd party                                            Descrip-       Descrip-
                                                                                                        tion           tion
 SPIELER          V [1/1]                  Vorname (First Name)                       t_name            2              85
 [1/1]                                     Should the gambler have no first
 Gambler                                   name(s), the entry ‘–‘ (minus
                                           sign) is required in their place
                  N [1/1]                  Nachname (Surname)                         t_name            2              85
                  G [1/1]                  Geburtsname (Name given at                 t_name            2              85
                                           birth)
                  D [1/1]                  Geburtsdatum: (Date of birth)              t_geburtsdatum    2              10
                                           ([0-9]{4})\-([0-9]{2}|-{2})\-([0-9]{2}|-
                                           {2})
                  O [1/1]                  Geburtsort (birthplace)                    t_name            2              85
                  A [1/1]   P [1/1]        Anschrift PLZ (Postal code)                t_plz_hausnum-    2              20
                  Ad-                                                                 mer
                  dress     W[1/1]         Anschrift Wohnort (City)                   t_name            2              85
                            S [1/1]        Anschrift Strasse (Street)                 t_strasse         2              150
                            H [1/1]        Anschrift Hausnummer (Number)              t_plz_hausnum-    2              20
                                                                                      mer
                            Z [0/1]        Anschrift Adresszusatz (supple-            t_addresszusatz   2              256
                                           mental address data)
                            L [1/1]        Anschrift Land: Gebiets-Code (3-           t_land            In accord-     In ac-
                                           digit area code from the country                             ance with      cordance
                                           catalog)                                                     the coun-      with the
                                                                                                        try catalog    country
                                                                                                                       catalog
 ANLASS           KBEZ1                    2-digit code from the cause of ban         t_kbez1           In accord-     In       ac-
 [1/99]           [1/1]                    catalg. Multiple causal codes are                            ance with      cordance
 Cause for ban                             allowed, but the code 99 ‘cause                              the cause      with     the
                                           unknown’ should not be combined                              for    ban     cause for
                                           with other causal codes and is no                            catalog        ban cata-
                                           longer allowed for 3rd party bans.                                          log
                                           The system ignores duplicate

                                         OASIS Web Services Interface Specification                                Seite 32
You can also read