OASIS Web Services Specification Release 5.6 published on 13.07.2020 - Hessen.de
←
→
Page content transcription
If your browser does not render page correctly, please read the page content below
OASIS Web Services Specification Release 5.6 published on 13.07.2020
1. Introduction
Table of Contents
1 Introduction ....................................................................................................................... 7
1.1 Glossary of terms .......................................................................................................... 7
2 Interface functions and XML Schema .............................................................................. 8
2.1 Interface functions ......................................................................................................... 8
2.2 HTTP-Header Specification ......................................................................................... 10
3 Table of Responses......................................................................................................... 12
4 Character Set ................................................................................................................... 16
4.1 Permitted Characters in Latinchars.xsd ....................................................................... 16
4.1.1 Alphabetic characters ...................................................................................................16
4.1.2 Numeric characters ......................................................................................................17
4.1.3 Special characters ........................................................................................................17
4.2 Character Set Categories ............................................................................................ 18
4.2.1 Category 1: Permitted characters for Gambler Status Query ......................................18
4.2.2 Category 2: Permitted characters for the creation or modification of a ban .................18
5 OASIS basic data types .................................................................................................. 20
5.1 Overview of the basic data types ................................................................................. 20
5.1.1 Simple data types in the Schema oasisBasistypen.xsd ...............................................20
5.1.2 Complex data types in the Schema oasisBasistypen.xsd ............................................21
6 Query Gambler Status ..................................................................................................... 23
6.1 Parameter ................................................................................................................... 23
6.2 Example ...................................................................................................................... 24
6.2.1 Request ........................................................................................................................24
6.2.2 Response .....................................................................................................................25
6.3 Response Codes ......................................................................................................... 25
7 Ban Maintenance Version 4.8 ......................................................................................... 26
7.1 Creation of a ban ......................................................................................................... 26
7.1.1 Parameter .....................................................................................................................26
7.1.2 Example ........................................................................................................................27
OASIS Web Services Interface Specification Seite 21. Introduction
7.2 Response Messages ................................................................................................... 29
7.3 Modification of a ban ................................................................................................... 29
7.3.1 Parameter .....................................................................................................................29
7.3.2 Example ........................................................................................................................30
7.4 Response Messages ................................................................................................... 32
7.5 Termination of a ban ................................................................................................... 33
7.5.1 Parameter .....................................................................................................................33
7.5.2 Example ........................................................................................................................33
7.5.3 Response Messages ....................................................................................................34
8 Ban Maintenance Version 5.4 ......................................................................................... 35
8.1 Creation of a ban ......................................................................................................... 35
8.1.1 Parameter .....................................................................................................................35
8.1.2 Example long-term ban ................................................................................................37
8.1.3 Example short-term ban ...............................................................................................38
8.2 Response Messages ................................................................................................... 39
8.3 Modification of a ban ................................................................................................... 40
8.3.1 Parameter .....................................................................................................................40
8.3.2 Example long-term ban ................................................................................................41
8.3.3 Example short-term ban ...............................................................................................43
8.4 Response Messages ................................................................................................... 44
8.5 Termination of a ban ................................................................................................... 45
8.5.1 Parameter .....................................................................................................................45
8.5.2 Example of long-term ban ............................................................................................46
8.5.3 Example short-term ban ...............................................................................................47
8.5.4 Response Messages ....................................................................................................47
9 Retrieve Catalogs ............................................................................................................ 48
9.1 Country catalog ........................................................................................................... 48
9.1.1 Parameter .....................................................................................................................49
9.1.2 Example ........................................................................................................................49
9.2 Cause for ban Catalog ................................................................................................ 50
9.2.1 Parameter .....................................................................................................................50
9.2.2 Example ........................................................................................................................50
9.3 Reasons for ban termination Catalog .......................................................................... 51
9.3.1 Parameter .....................................................................................................................51
9.3.2 Example ........................................................................................................................51
Seite 3 OASIS Web Services Interface Specification1. Introduction
9.4 Response Messages ................................................................................................... 52
10 Own ban list Version 4.8 ............................................................................................... 52
10.1 Retrieve own ban list ................................................................................................... 52
10.1.1 Parameter .....................................................................................................................52
10.1.2 Example ........................................................................................................................53
10.2 Search own ban list using gambler data ...................................................................... 53
10.2.1 Parameter .....................................................................................................................53
10.2.2 Example ........................................................................................................................54
10.3 Search own ban list using ID ....................................................................................... 55
10.3.1 Parameter .....................................................................................................................55
10.3.2 Example ........................................................................................................................55
10.4 Response Messages ................................................................................................... 56
11 Own ban list Version 5.4 ............................................................................................... 57
11.1 Retrieve own ban list ................................................................................................... 57
11.1.1 Parameter .....................................................................................................................57
11.1.2 Example ........................................................................................................................57
11.2 Search own ban list using gambler data ...................................................................... 59
11.2.1 Parameter .....................................................................................................................59
11.2.2 Example long-term ban ................................................................................................59
11.2.3 Example short-term ban ...............................................................................................60
11.3 Search own ban list using ID ....................................................................................... 61
11.3.1 Parameter .....................................................................................................................61
11.3.2 Example long-term ban ................................................................................................62
11.3.3 Beispiel short-term ban ................................................................................................62
11.4 Response Messages ................................................................................................... 63
12 Modify Password ........................................................................................................... 64
12.1 Parameter ................................................................................................................... 64
12.2 Example ...................................................................................................................... 64
12.2.1 Request ........................................................................................................................64
12.2.2 Response .....................................................................................................................64
12.3 Response Messages ................................................................................................... 65
13 Check Concession Status............................................................................................. 65
OASIS Web Services Interface Specification Seite 41. Introduction
13.1 Parameter ................................................................................................................... 65
13.2 Example ...................................................................................................................... 66
13.2.1 Request ........................................................................................................................66
13.2.2 Response .....................................................................................................................66
13.3 Response Messages ................................................................................................... 66
14 Check Availability .......................................................................................................... 67
14.1 Parameter ................................................................................................................... 67
14.2 Example ...................................................................................................................... 67
14.2.1 Request ........................................................................................................................67
14.2.2 Response .....................................................................................................................68
14.3 Response Messages ................................................................................................... 68
15 Batch 68
15.1 Submit Batch job ......................................................................................................... 69
15.1.1 Parameter .....................................................................................................................69
15.1.2 Example ........................................................................................................................70
15.1.3 Response Messages ....................................................................................................72
15.2 Retrieve Batch job Results .......................................................................................... 73
15.2.1 Parameter .....................................................................................................................73
15.2.2 Example ........................................................................................................................74
15.2.3 Response Messages ....................................................................................................76
15.3 Request status of Batch jobs ....................................................................................... 77
15.3.1 Parameter .....................................................................................................................77
15.3.2 Example ........................................................................................................................77
15.3.3 Response Messages ....................................................................................................78
16 Response Messages from Operations ......................................................................... 80
16.1 Example ...................................................................................................................... 80
16.1.1 XML for Response Message 0052 ...............................................................................80
16.1.2 XML for Response Message 0053 ...............................................................................80
17 Rights and Roles in OASIS WS .................................................................................... 81
18 Modifications with respect to Release 4.6 ................................................................... 81
19 Modifications with respect to Release 4.8 ................................................................... 82
Seite 5 OASIS Web Services Interface Specification1. Introduction
20 Modifications with respect to Release 5.0 ................................................................... 82
21 Modifications with respect to Release 5.2 ................................................................... 82
22 Modifications with respect to Release 5.4 ................................................................... 83
OASIS Web Services Interface Specification Seite 61. 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 following agreements:
German Interstate Treaty on Gambling (GlüStV)
Gambling Act Hessen (HGlüG)
Amusement Hall Act Hessen (HSpielhG)
Amusement Hall Act Rheinland-Palitinate (LGlüG RP)
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.
Seite 7 OASIS Web Services Interface Specification2. Interface functions and XML Schema
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.
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.
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.
2.1 Interface functions
OASIS Interface functions
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
ler-status tus rameter.xsd
2 Create ban POST /sperren sperrdaten.xsd sperreAnlegenAendernEr- 4.8 (deprecated)
gebnis.xsd 5.4
3 Modify ban PUT /sper- sperrdaten.xsd sperreAnlegenAendernEr- 4.8 (deprecated)
ren/{sperrid} gebnis.xsd 5.4
OASIS Web Services Interface Specification Seite 82. Interface functions and XML Schema
4 Terminate DELETE /sper- - sperreAufhebenErgeb- 4.8 (deprecated)
ban ren/{sperrid} nis.xsd 5.4
5 Retrieve GET /kataloge/la- - oasisKatalog.xsd 4.8
country ca- ender
talog
6 Retrieve GET /kata- - oasisKatalog.xsd 4.8
cause for loge/sper-
ban catalog ranlaesse
7 Retrieve rea- GET /kata- - oasisKatalog.xsd 4.8
sons for ban- loge/aufhe-
termination bungsgru-
catalog ende
8 Modify pass- PUT /betriebs- - meldungskatalogItem.xsd 4.8
word staette/pass
wort
9 Check con- GET /betriebs- - konzessionsdaten.xsd 4.8
cession sta- staette/kon-
tus zession
10 Retrieve own GET /betriebs- - eigeneSperren.xsd 4.8 (deprecated)
ban list staette/sper 5.4
ren
11 Search own POST /betriebs- spielerSuchpa- eigeneSperren.xsd 4.8 (deprecated)
ban list using staette/sper rameter.xsd 5.4
gambler data ren
12 Search own GET /betriebs- - eigeneSperren.xsd 4.8 (deprecated)
ban list using staette/sper 5.4
ID ren/{sper-
rId}
13 Check GET /verfuegbar- - meldungskatalogItem.xsd 4.8
availability keit
Batch-Functions
Production URL-Batch-Root = https://oasis.hessen.de/oasisbatchws/
IntegrationTestsystem URL-Batch-Root = https://oasis-tst-crt.hessen.de/oasisbatchws/
Seite 9 OASIS Web Services Interface Specification2. Interface functions and XML Schema
15 Submit batch POST /batch batchAnlegenPay- batchAnlegenErgebnis.xsd 4.8
job load.xsd (gzip)
16 Request status GET /auftraege - batchJobs.xsd 4.8
of batch jobs
17 Retrieve batch GET /batch/{batchId} - batchErgebnis.xsd (gzip) 4.8
job results
Table 1: Interface functions
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
OASIS Web Services Interface Specification Seite 102. Interface functions and XML Schema
Content-Type application/gzip Required for the submission of a
(for the submission of a batch batch job
job function)
Table 2: HTTP-Header Specification
Seite 11 OASIS Web Services Interface Specification3. Table of Responses
3 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
”
Sie haben keine Berechtigung, diese Sperre aufzuhe- The ban belongs to
ben. another gambling opera-
0010 E
Translation: „You do not have the permission to termi- tor
nate this ban”
Die Spielersperre wurde am erfolg-
reich aufgehoben.
0011 I
Translation: „The ban was successfully terminated 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.3. Table of Responses
„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.“
Die Konzession/Erlaubnis ist gültig.
0017 I
Translation: „The concession/license is valid.“
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.
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.“
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.“
Seite 13 OASIS Web Services Interface Specification3. Table of Responses
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.“
0050 I
Translation: „.“
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“
Einstellen von Batchanfragen: Batchverarbeitung
0066 E
wurde aus betrieblichen Gründen temporär gesperrt
OASIS Web Services Interface Specification Seite 143. Table of Responses
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 on4. Character Set
4 Character Set
XML-Documents are to be encoded in Unicode UTF-8. In addition, the character set for certain ele-
ments must be further limited to the UTF-8 subset „Latin Characters in Unicode“. This character set
contains all latin characters within Unicode UTF-8, including diacritical symbols and ligatures, and is
published by the german standardisation body KOSIT.
This character set is defined in the XML Schema latinchars.xsd.
Note: The XML Schema supplied by KOSIT assigns the value „qualified“ to the Schema attribute „el-
ementFormDefault“. This conflicts with the OASIS approach of using the value „unqualified“ for all
Schema attributes. The OASIS version of this XML-Schema differs therefore from the version supplied
by KOSIT. The OASIS version is to be used.
4.1 Permitted Characters in Latinchars.xsd
Permitted characters are those from the character set String.Latin. Invalid characters should be removed
before the request is submitted to OASIS.
4.1.1 Alphabetic characters
In addition to the alphabetic characters [A-z], the following are permitted:
ÀÁÂÃàáâãĀāĂ㥹ǍǎǞǟǺǻẠạẪẫẬªẢảẤấẦầẮắẰằẲẳẴẵẶ
ặ
ÄÆäæǼǽ
Åå
Ḃḃ
ÇçĆćĊċČč
Ð ð Ď ď Đ đ Ḋ ḋ Ḑ ḑ D̂ d̂
ÈÉÊËèéêëĒēĔĕĖėĘęĚěƏəẽỄễẸẹẺẻẼỀềẾếỆệ
Ḟḟ
ĞğĠġĢģǤǥǦǧǴǵḠḡ
ĦħȞȟḤḥḦḧ
ÌÍÎÏìíîïĨĩĪīĬĭĮįİıǏǐỊịỈỉ
Ĵ ĵ ǰ J̌
ĶķĸǨǩḰḱ
Ĺ ĺ Ļ ļ Ľ ľ Ŀ ŀ Ł ł L̂ l̂
M̂ m̂ Ṁ ṁ
N̂ n̂ Ñ ñ Ń ń Ņ ņ Ň ň ʼn Ŋ ŋ Ṅ ṅ
OASIS Web Services Interface Specification Seite 164. Character Set
ÒÓÔÕòóôõŌōŎŏŐőƠơǑǒǪǫǬǭǾǿȪȫȮȯȰȱỌọỎỏỖỗºỒồ
ỐốỘộỜờỚớ
ÖØöøŒœ
Ṗṗ
ŔŕŖŗŘř
ŚśŞşŠšȘșṠṡṢṣ
ßẞ
ŢţŤťŦŧȚțṪṫ
Þþ
ÙÚÛùúûŨũŪūŮůŰűŲųƯưǓǔỤụỦủỨứỪừỬửỮữỰự
Üü
ŴŵẀẁẂ ẃẄ ẅ
Ẍẍ
ÝýÿŶŷŸƷǮǯȲȳʒẎẏỲỳỸỹỴỵỶỷ
ŹźŻżŽžẐẑẒẓ
Figure 1: Diacritical symbols and ligatures
4.1.2 Numeric characters
0123456789
Figure 2: Numeric characters
4.1.3 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 Specification4. Character Set
' '
4.2 Character Set Categories
The allowed characters are limited further in the functions.
4.2.1 Category 1: Permitted characters for Gambler Status Query
In a query for gambler status all characters in String.Latin 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 Permitted special
characters characters
Permitted alpha- (see Chapter Feh- (see Chapter Fehler!
Element betic characters ler! Verweisquelle Verweisquelle konnte
(see Chapter 4.1.1) konnte nicht gefun- nicht gefunden wer-
den werden.) den.)
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 4: Permitted characters for Query Gambler Status
4.2.2 Category 2: Permitted characters for the creation or modifica-
tion of a ban
The String.Latin 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.
OASIS Web Services Interface Specification Seite 184. Character Set
Permitted alpha- Permitted numeric Permitted special
Element betic characters charaters characters
(see Chapter 4.1.1) (see Chapter 4.1.2) (see Chapter 4.1.3)
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 5: Permitted characters for the creation and modification of a ban
Seite 19 OASIS Web Services Interface Specification5. OASIS basic data types
5 OASIS basic data types
5.1 Overview of the basic data types
5.1.1 Simple data types in the Schema oasisBasistypen.xsd
Data type name Data type Usage Restrictions
in XML Schema
t_adresszusatz String.Latin Residential address supplement Max. 256 Characters
(of the gambler)
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 String.Latin Data type for first name(s), sur- Max. 85 Characters
name, name at birth, place of
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- String.Latin Data type for the residential Max. 20 Characters
mer postcode and house number (of
the gambler)
t_sperrgrund xs:string-ba- Reason for the ban, permitted FREMD, SELBST
sed Enumera- values are SELBST (self) and
tion 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 String.Latin Data type for the residential Maximal 150 Characters
street (of the gambler)
t_meldungsart xs:string-ba- Request status I, W, E
sierte Enume-
ration
OASIS Web Services Interface Specification Seite 205. OASIS basic data types
t_schluessel xs:string Return code for a response [0-9]{4}
t_meldung_text xs:string Response text from 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 item Characters
[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}
Table 6: Simple data types in the Schema oasisBasistypen.xsd
5.1.2 Complex data types in the Schema oasisBasistypen.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)
H (HAUSNUMMER)
Z (ADDRESZUSATZ)
L (LAND)
Seite 21 OASIS Web Services Interface Specification5. OASIS basic data types
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_BEGINN
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
FORMAT-PATTERN: dd.MM.yyyy HH:mm:ss
(Java-Forma Pattern)
OASIS Web Services Interface Specification Seite 226. Query Gambler Status
t_meldungskata- ART Response Catalog item description.
log_item
SCHLUESSEL
MELDUNG
Table 7: Complex data types in the Schema oasisBasistypen.xsd
6 Query Gambler Status
Using the Gambler Status Query 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.
6.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=4.8“), 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 2 85
[1/1] N [1/1] Nachname (Surname) t_name 2 85
Gambler G [0/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 [0/1] Geburtsort (birthplace) t_name 2 85
A [0/1] P [0/1] Anschrift PLZ (Postal code) t_plz_hausnum- 2 20
Ad- mer
dress W[0/1] Anschrift Wohnort (City) t_name 2 85
S [0/1] Anschrift Strasse (Street) t_strasse 2 150
H [0/1] Anschrift Hausnummer (Number) t_plz_hausnum- 2 20
mer
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
Seite 23 OASIS Web Services Interface Specification6. Query Gambler Status
country
catalog
Z [0/1] Anschrift Adresszusatz (supplemental t_addresszusatz 2 256
address data)
[MinOccurs/MaxOccurs] are placed in brackets:
[1/1] = must exist at least once / only one instance is allowed
6.2 Example
Please note that the Namespace-Prefixes can vary from those provided in the examples.
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
XML
Hans Herbert
Bert
1970-04-01
000
OASIS Web Services Interface Specification Seite 246. Query Gambler Status
6.2.2 Response
6.2.2.1 Match found:
W0018Der Spieler
ist gesperrt.260972SpielbankSilvia Jackmann12345sj@spbk.de
6.2.2.2 No match found:
I0019Der Spieler
ist nicht gesperrt.
6.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.7. Ban Maintenance Version 4.8
„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.
7 Ban Maintenance Version 4.8
Version 4.8 is deprecated
7.1 Creation of a ban
The creation of a ban in OASIS results in a permanent gambling ban for the named person. A subse-
quent 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.
7.1.1 Parameter
URL: /sperren
http-method: POST
Request-Payload: sperrdaten.xsd
OASIS Web Services Interface Specification Seite 267. Ban Maintenance Version 4.8
Response-Payload: sperreAnlegenAendernErgebnis.xsd
Header-Parameter: Kennung, Passwort, Accept („text/plain; charset=UTF-8; version=4.8“), 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
L [1/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
Z [0/1] Anschrift Adresszusatz (supplemental t_addresszusatz 2 256
address data)
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- anc with cordanc
Cause for lowed, but the code 99 ‘cause un- the cause with the
ban known’ should not be combined with for ban cause for
other causal codes. The system ig- catalog ban cata-
nores duplicate causal codes and will log
save only one instance of each deliv-
ered causal code.
[MinOccurs/MaxOccurs] are placed in brackets:
[1/99] = must exist at least once / 99 instances allowed
7.1.2 Example
Please note that the Namespace-Prefixes can vary from those provided in the examples.
Seite 27 OASIS Web Services Interface Specification7. Ban Maintenance Version 4.8
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
7.1.2.2 Response7. Ban Maintenance Version 4.8
ITEM>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 Messages
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- The ban was successfully
0007 I
reich gesperrt. created
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 Modification of a ban
For each new ban, an ID is automatically generated which uniquely identifies the entry. The XML re-
sponse to the create request contains the generated ID. The ban can subsequently be modified or ter-
minated using its unique ID. This ID is submitted as Path-Parameter in the URL.
7.3.1 Parameter
URL: /sperren/{ban id}
http-method: PUT
Request-Payload: sperrdaten.xsd
Response-Payload: sperreAnlegenAendernErgebnis.xsd
Seite 29 OASIS Web Services Interface Specification7. Ban Maintenance Version 4.8
Header-Parameter: Kennung, Passwort, Accept („text/plain; charset=UTF-8; version=4.8“), 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
mer
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
L [1/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
Z [0/1] Anschrift Adresszusatz (supplemental t_addresszusatz 2 256
address data)
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- anc with cordanc
Cause for lowed, but the code 99 ‘cause un- the cause with the
ban known’ should not be combined with for ban cause for
other causal codes. The system ig- catalog ban cata-
nores duplicate causal codes and will log
save only one instance of each deliv-
ered causal code.
[MinOccurs/MaxOccurs] are placed in brackets:
[1/99] = must exist at least once / 99 instances allowed
7.3.2 Example
Please note that the Namespace-Prefixes can vary from those provided in the examples.
OASIS Web Services Interface Specification Seite 307. Ban Maintenance Version 4.8
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
7.3.2.2 Response
I0009Die Spielerdaten wurden am 07.05.2018
Seite 31 OASIS Web Services Interface Specification7. Ban Maintenance Version 4.8
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 Messages
Schlüssel Art Meldung Bemerkung
„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)
0002 E OASIS IT-Service Desk.
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. that do not belong to the
0004 E
Translation: „Modification/Termination of the ban not logged-in User cannot be
possible: no entry found for this person“
executed.
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.You can also read
