OASIS Version 4.6 Released on 27.10 - Darmstadt · 1. Introduction Seite 7 OASIS web service interface specification 1 Introduction This document contains the specification for the

OASIS

Web service specification

OASIS Version 4.6

Released on 27.10.2017

1. Introduction

OASIS web service interface specification Seite 2

Table of Contents

1 Introduction ................................................................................................................. 7

1.1 Glossary of terms .......................................................................................................... 7

2 Interface functions and XML Schema ........................................................................ 8

2.1 XML Schemas ............................................................................................................... 8

2.2 Interface functions ....................................................................................................... 10

2.3 HTTP-Header Specification ......................................................................................... 12

3 Character Set ............................................................................................................. 13

3.1 Permitted Characters in Latinchars.xsd ....................................................................... 13

3.1.1 Alphabetic characters ...................................................................................................13

3.1.2 Numeric characters ......................................................................................................14

3.1.3 Special characters ........................................................................................................14

4 OASIS basic data types ............................................................................................ 16

4.1 Overview of the basic data types ................................................................................. 16

4.1.1 Simple data types in the Schema sperrsystemBasistypen.xsd ....................................16

4.1.2 Complex data types in the Schema sperrsystemBasistypen.xsd ................................17

5 Authentication and Authorisation of OASIS web service queries ......................... 20

5.1 Group AUTHENTISIERUNG (Authentication) .............................................................. 20

5.2 Group AUTHENTISIERUNG.VERANSTALTER (Betting organisation) ....................... 20

5.2.1 Element AUTHENTISIERUNG.VERANSTALTER.KENNUNG (Username) ................21

5.2.2 Element AUTHENTISIERUNG.VERANSTALTER.PASSWORT (Password) ..............21

5.2.3 Element AUTHENTISIERUNG.BENUTZER ................................................................22

6 Personal data ............................................................................................................. 22

6.1 Required/optional attributes ......................................................................................... 22

6.2 SPIELER (better) and SPIELER-NEU (new better) ..................................................... 23

6.2.1 Element VORNAME (First name(s)) ............................................................................24

6.2.2 Element NACHNAME (Family name) ...........................................................................25

6.2.3 Element GEBURTSNAME (Name at birth) ..................................................................25

6.2.4 Element GEBURTSDATUM (Date of birth) ..................................................................26

6.2.5 Element GEBURTSORT (Place of birth) ......................................................................26

1. Introduction

Seite 3 OASIS web service interface specification

6.2.6 Group ANSCHRIFT (Address) .....................................................................................26

7 Terminate an exclusion list entry using ID .............................................................. 31

7.1 Overview: Terminate an exclusion list entry using ID ................................................... 31

7.1.1 Group AUTHENTISIERUNG (Authentication) ..............................................................31

7.1.2 Element N-ART (Request type) ....................................................................................31

7.1.3 Element SPERRGRUND (Reason for exclusion) ........................................................32

7.1.4 Element SPERRID (ID) ................................................................................................32

8 Create and Modify exclusion list entry 4.0 .............................................................. 33

8.1 Create exclusion list entry 4.0 ..................................................................................... 33

8.1.1 Group AUTHENTISIERUNG (Authentification) ............................................................33


8.1.3 Group SPIELER (Better) ..............................................................................................34

8.1.4 Group ANLASS (Cause for exclusion) .........................................................................36

8.1.5 Reply to the Creation of an exclusion list entry 4.0 ......................................................38

8.2 Modify an exclusion list entry 4.0 ................................................................................. 38


8.2.2 Element SPERRID (ID) ................................................................................................39



8.2.5 Group ANLASS (Cause of exclusion) ..........................................................................42

8.2.6 Reply to the Modification of an exclusion list entry 4.0 ................................................44

9 Global Queries ........................................................................................................... 45

9.1 Similarity search .......................................................................................................... 45

9.1.1 Overview: Status query using better personal data .....................................................45



9.1.4 Permitted characters for a status query .......................................................................46

9.1.5 Better status query response .......................................................................................46

10 Organisation-based Queries .................................................................................... 47

10.1 Organisation based Queries 4.0 .................................................................................. 47

10.1.1 OASIS 4.0 Query own exclusion list .............................................................................47

10.1.2 Results for „Query own exclusion list“ 4.0 ....................................................................49

10.2 Query own exclusion list using parameters 4.0 ............................................................ 50

10.2.1 OASIS 4.0 Query own exclusion list using parameters ................................................50

10.2.2 Results for „Query own exclusion list using parameters“ 4.0 .......................................52

10.3 Query own exclusion list using SperrID 4.0 ................................................................. 52

1. Introduction


10.3.1 OASIS 4.0 Query own exclusion list using SperrID .....................................................53

10.3.2 Results „Query own exclusion list entry using SperrID“ 4.0 .........................................55

11 Modify password ....................................................................................................... 55

11.1 Overview: modify password ......................................................................................... 55


11.3 Element PASSWORT-NEU (New password) ............................................................... 56

11.4 Element ZIELOBJEKT (Target object) ......................................................................... 56

12 Verify permission ...................................................................................................... 57


13 Check availability ...................................................................................................... 58


14 Query release number .............................................................................................. 58


15 Load country table .................................................................................................... 59


15.2 Table of countries ........................................................................................................ 60

15.2.1 Element KATALOGNAME (Table name) .....................................................................60

15.2.2 Group KATALOGITEM (Table entry) ...........................................................................60

16 Retrieve cause of exclusion catalog ........................................................................ 61

16.1 Authentisierung (Authentication).................................................................................. 61

16.2 Katalog Sperranlässe (Catalog Cause of Exclusion) ................................................... 61

16.2.1 Group ANLASS (Cause) ..............................................................................................61

17 Batch 2.0 .................................................................................................................... 62

17.1 Batch 2.0 Request ....................................................................................................... 64

17.1.1 Triggering a Batch 2.0 Request ....................................................................................64

17.1.2 Response to theTriggering of a Batch 2.0 Request .....................................................68

17.2 Retrieval of Batch 2.0 Job Results ............................................................................... 68

1. Introduction


17.2.1 Retrieval of Batch 2.0 Job Results ...............................................................................68

17.2.2 Response to the Retrieval of Batch 2.0 Job Results ....................................................69

17.3 Check Status of Batch 2.0 Jobs................................................................................... 71

17.3.1 Check Status of Batch-2.0-Jobs ...................................................................................71

17.3.2 Response to Status Check of Batch-2.0-Jobs .............................................................72

18 Current Information ................................................................................................... 73

18.1 Request ………………………………………………………………………………………..73

18.2 Response .................................................................................................................... 73

18.2.1 Group SPERRSYSTEM-MELDUNG (Exclusion system response) .............................73

18.2.2 Group INFORMATION .................................................................................................73

19 Responses from OASIS ............................................................................................ 77

19.1.1 SPERRSYSTEM-MELDUNG .......................................................................................77

19.1.2 Group SPERRINFO (Exclusion information) ................................................................78

19.1.3 Group BESITZER (Owner) ...........................................................................................80

19.1.4 Group ANLASS (Cause of exclusion) ..........................................................................82

19.2 Response-Status ......................................................................................................... 82

19.2.1 Group RESPONSE-STATUS .......................................................................................83

19.3 Eigene-Sperren-Response (Own exclusion list response) ........................................... 84

19.3.1 Group RESPONSE_STATUS ......................................................................................84

19.3.2 Group EIGENE_SPERREN_RESPONSE.SPERRE (Own exclusion list entry) ..........85

19.3.3 Group ANLASS (cause of exclusion) ...........................................................................90

19.4 Response to Triggering a Batch 2.0 Job ...................................................................... 91


19.5 Retrieval Batch 2.0 Job Results................................................................................... 92


19.5.3 Group DS ......................................................................................................................94

19.6 Batch 2.0 Job Information............................................................................................ 96


19.6.2 Group BATCHINFO ......................................................................................................96

19.7 Maintenance and Incident Messages .......................................................................... 97

19.7.1 Maintenance .................................................................................................................97

19.7.2 Incident .........................................................................................................................97

19.8 Table of responses ...................................................................................................... 97

20 Rights and Roles in OASIS WS .............................................................................. 102

1. Introduction


21 Modifications with respect to Version 1.0 ............................................................. 102












1. Introduction


1 Introduction

This document contains the specification for the OASIS web service. This service is used to maintain

and query the online betting exclusion list.

The specification for the online betting exclusion list and its usage is based on the following agree-

ments:

German Interstate Treaty on Gambling (GlüStV)

Gambling Act Hessen (HGlüG)

Amusement Hall Act Hessen (HessSpielhG)

Revisions in the current version of this document are highlighted in yellow to ensure they are easily

recognisable. In addition, the change history of the document is recorded in the last chapter.

The version number of this specification document corresponds to the OASIS Version in which the

specification is implemented.

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

rectness, validity or completeness of the translated english version. No liability arising from errors or

omissions is accepted.

1.1 Glossary of terms

Better A natural person who intends to participate in a betting game organised

by a betting organisation (synonyms: gambler, wagerer, punter).

Betting organisation An organisation offering one or more types of betting / gambling games

and in possession of a licence to use the OASIS web service.

2. Interface functions and XML Schema


2 Interface functions and XML Schema

The OASIS web service is based on the REST approach. 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 XML Schemas

XML documents used in OASIS web service communication are based on the following Schemas:

Nr, Filename Description

1 authentisierung.xsd XML Schema for verifying access rights to OASIS

2 batchAnlegen.xsd XML Schema for a Batch 2.0 request XML Content as gzip

3 batchAnlegenResponse.xsd Response to a Batch 2.0 job request

4 batchBasistypen.xsd Definitions of simple and complex datatypes used in batchAb-

frage.xsd und bchtAntwort.xsd

5 batchJobsInfos.xsd XML Schema for the response to a Batch 2.0 Statuscheck

(Statuscheck for own Batch 2.0 jobs)

6 batchResponse.xsd XML Schema for the for Batch 2.0 job results

7 charset.xsd Characters set for String-Latin from XÖV

8 eigeneSperrenAbfragen.xsd XML-Schema for organisation-based queries

9 eigeneSperrenAbfragenId.xsd XML-Schema for organisation-based queries using SperrID

10 eigeneSperrenAbfragenParameter.xsd XML-Schema for organisation-based queries with parameters

11 eigeneSperrenResponse.xsd XML-Schema for organisation-based queries in 10, 11, 12

12 informationen.xsd XML-Schema for current information from OASIS

13 katalog.xsd XML Schema for OASIS lookup tables

14 latinchars.xsd Character Set „Latin Characters in Unicode“, an XÖV-Standard

published by the german standardisation body KOSIT (see

chapter 3)

Note: The Schema-Attribut „elementFormDefault“ within the

XML Schema was modified to „unqualified“.

15 passwortAenderung.xsd XML Schema for modifying a password

16 sperranlaesse.xsd XML-Schema for Sperranlässe (cause of exclusion)



17 sperreAendern.xsd XML-Schema for the modification of an exclusion entry since

OASIS 4.0

18 sperreAnlegen.xsd XML-Schema for the creation of an exclusion entry since OA-

SIS 4.0

19 sperrenPflege.xsd XML-Schema für modifying and terminating exclusion list en-

tries via an ID (exclusion list entry ID)

20 sperrsystemBasistypen.xsd Definitions of simple and complex datatypes used across mutli-

ple XML Schema

21 sperrsystemMeldung.xsd XML Schema for OASIS responses

22 spielersperrePflege.xsd XML Schema for creating, modifying and terminating an exclu-

sion list entry

23 spielerstatusAbfrage.xsd XML Schema for querying the exclusion list status of a better

using his/her personal data

Table 1: XML Schemas



2.2 Interface functions

The following table describes the interface functions provided by the OASIS web service:

Function HTTP-

Verbs URL

Message

(Content)

Response

(Content)

Chap-

ter &

Section

1.

Terminate

an exclu-

sion list

entry using

its ID

POST <server>

/oasisws/rest/oasis/sperrid/beenden

XML conforming to

sperrenPflege.xsd

XML conforming to

sperrsystem-

Meldung.xsd 7.1

2.

Similarity

search

POST <server>

/oasisws/rest/oasis/aehnlichkeitsabfrage

XML conforming to

spielerstatusAb-

frage.xsd

XML conforming to

sperrsystem-

Meldung.xsd

9.1

3.

Modify

password

POST <server>

/oasisws/rest/oasis/passwort/aendern

XML conforming to

passwortAender-

ung.xsd

XML conforming to

sperrsystem-

Meldung.xsd

11

4.

Verify

permission

POST <server>

/oasisws/rest/oasis/konzession/pruefen

XML conforming to

authentisier-

ung.xsd

XML conforming to

sperrsystem-

Meldung.xsd

12

5.

Check

availability

POST <server>

/oasisws/rest/oasis/verfuegbarkeitsabfra

ge

XML conforming to

authentisier-

ung.xsd

XML conforming to

sperrsystem-

Meldung.xsd

13

6.

Query

release

number

POST <server>

/oasisws/rest/oasis/releasenummerabfr

age

XML conforming to

authentisier-

ung.xsd

XML conforming to

sperrsystem-

Meldung.xsd

14

7.

Load

country

table

POST <server>

/oasisws/rest/oasis/laenderkatalog/hole

n

XML conforming to

authentisier-

ung.xsd

XML conforming to

katalog.xsd 15

8.

Current

Information

POST <server>

/oasisws/rest/oasis/abfragen/aktuelleinf

XML conforming to

authentisier-

XML conforming to

informationen.xsd 18



ormationen ung.xsd

9.

Create an

exclusion

list entry

POST <server>

/oasisws/rest/oasis/anlegen/sperre/4.0

XML conforming to

new Schema sper-

reAnlegen.xsd

XML conforming to

sperrsystem-

Meldung.xsd

8.1

10.

Modify an

exclusion

list entry

POST <server>

/oasisws/rest/oasis/aendern/sperre/4.0

XML conforming to

new Schema sper-

reAendern.xsd

XML conforming to

sperrsystem-

Meldung.xsd

8.2

11.

Retrieve

Cause for

Exclusion

Catalog

POST <server>

/oasisws/rest/oasis/abfragen/katalogsper

ranlass/4.0

XML conforming

to authentisier-

ung.xsd

If not authorised,

XML conforming to

Schema sperrsys-

temMeldung.xsd. In

all other cases XML

conforming to new

Schema sperran-

laesse.xsd

16

12.

Query own

exclusion

list includ-

ing cause

of exclu-

sion

POST <server>

/oasisws/rest/oasis/abfragen/eigenesperr

en/4.0

XML conforming

to new Schema

„eigeneSperren-

Abfragen.xsd“

XML conforming to

new Schema „ei-

geneSperren-

Response.xsd“

10.1

13.

Similarity

search in

own exclu-

sion list

with pa-

rameters

(translite-

rated)

POST <server>


en/parameter/4.0

XML conforming

to new Schema

„eigeneSperren-

AbfragenParame-

ter.xsd“

XML conforming to

new Schema „ei-

geneSperren-

Response.xsd“

10.2

14.

Query own

exclusion

list using ID

POST <server>


en/id/4.0

XML conforming

to new Schema

„eigeneSperren-

AbfragenId.xsd“

XML conforming to

new Schema ei-

geneSperren-

Response.xsd

10.3

15.



Submit

Batch 2.0

job (Requ-

est)

POST <server>

/oasisbatchws/rest/oasis/anlegen/auftra

g/batch/4.0

2 new HTTP-

Header-

Parameters: OA-

SIS_KENNUNG,

OASIS_PWD and

XML conforming to

Schema

batchAnlegen.xsd

XML conforming to

batchAnlegen-

Response.xsd

17.1

16.

Retrieve

Batch 2.0

job results

POST <server>

/oasisbatchws/rest/oasis/abfragen/auftr

ag/batch/4.0

2 new HTTP-

Header-

Parameters: OA-

SIS_KENNUNG,

OASIS_PWD,

BATCH_ID.

No XML-Payload

XML conforming to

batchRe-

sponse.xsd

17.2

17.

Request

Batch 2.0

job status

POST <server>

/oasisbatchws/rest/oasis/abfragen/statu

s/batch/4.0/[Batch-Id]

2 new HTTP-

Header-

Parameters: OA-

SIS_KENNUNG,

OASIS_PWD. No

XML-Payload

XML conforming to

batchJobsInfos.xsd

17.3

Table 2: Interface functions

The server <server> is the published server address for OASIS.

2.3 HTTP-Header Specification

Content-Type:

Request (Request of an OASIS function) Content-Type: text/plain

Response (Reply to an OASIS function) Content-Type: text/plain

[BATCH 2.0]

Request (Request for a Batch 2.0 Job) Content-Type: application/gzip; charset=UTF-8

Response (Retrieval of Batch 2.0 Job Results) Content-Type: application/gzip; charset=UTF-8

The Content-Type and Content-Length must be specified in the HTTP-Header.

3. Character Set


3 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, which is in turn included in the XML Schemas sperrsystemBasistypen.xsd, spielersperrePflege.xsd and spielerstatusAbfrage.xsd.

Note: The XML Schema supplied by KOSIT assigns the value „qualified“ to the Schema attribute „elementFormDefault“. 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.

3.1 Permitted Characters in Latinchars.xsd

Permitted characters are those from the character set String.Latin.

3.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̂ Ñ ñ Ń ń Ņ ņ Ň ň ŉ Ŋ ŋ Ṅ ṅ

Ò Ó Ô Õ ò ó ô õ Ō ō Ŏ ŏ Ő ő Ơ ơ Ǒ ǒ Ǫ ǫ Ǭ ǭ Ǿ ǿ Ȫ ȫ Ȯ ȯ Ȱ ȱ Ọ ọ Ỏ ỏ Ỗ ỗ º Ồ ồ Ố

3. Character Set


ố Ộ ộ Ờ ờ Ớ ớ

Ö Ø ö ø Œ œ

Ṗ ṗ

Ŕ ŕ Ŗ ŗ Ř ř

Ś ś Ş ş Š š Ș ș Ṡ ṡ Ṣ ṣ

ß ẞ

Ţ ţ Ť ť Ŧ ŧ Ț ț Ṫ ṫ

Þ þ

Ù Ú Û ù ú û Ũ ũ Ū ū Ů ů Ű ű Ų ų Ư ư Ǔ ǔ Ụ ụ Ủ ủ Ứ ứ Ừ ừ Ử ử Ữ ữ Ự ự

Ü ü

Ŵ ŵ Ẁ ẁ Ẃ ẃ Ẅ ẅ

Ẍ ẍ

Ý ý ÿ Ŷ ŷ Ÿ Ʒ Ǯ ǯ Ȳ ȳ ʒ Ẏ ẏ Ỳ ỳ Ỹ ỹ Ỵ ỵ Ỷ ỷ

Ź ź Ż ż Ž ž Ẑ ẑ Ẓ ẓ

Figure 1: Diacritical symbols and ligatures

3.1.2 Numeric characters

0 1 2 3 4 5 6 7 8 9

Figure 2: Numeric characters

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

< <

> >

& &

" "

3. Character Set


' '

4. OASIS basic data types


4 OASIS basic data types

This section describes the basic data types for OASIS.

These basic data types are defined in the file sperrsystemBasistypen.xsd, which is in turn referenced

by the XML Schemas passwortAenderung.xsd, spielerstatusAbfrage.xsd and spielersperrePflege.xsd.

4.1 Overview of the basic data types

4.1.1 Simple data types in the Schema sperrsystemBasistypen.xsd

Data type name in XML

Schema

Data type Usage Restrictions

t_adresszusatz String.Latin Residential address sup-

plement (of the better)

Max. 256 Characters

t_kennung xs:string Username for a betting

organisation within OA-

SIS. The username is

assigned by OASIS.

[0-9A-Z]{1,30}

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

([0-9]{2}|-{2})

t_land xs:string 3 digit numeric country

code, in accordance with

the table of countries

issued by Destatis.

The table is provided by

the OASIS web service

as XML.

([0-9]{3})?

t_nachrichtenart xs:string-

based Enu-

meration

Specifies the type of

maintenance transaction

transmitted to OASIS:

Z = Create

V = Modify

B = Terminate

[ZVB]

t_name String.Latin Data type for first

name(s), family name,

name at birth, place of

birth and city of resi-

dence (of the better)

Max. 85 Characters



t_passwort xs:string Data type for a password

in OASIS.

Min. 8, Max. 16 Charac-

ters

[0-9a-zA-Z!#$%'()*+,-

./:;=?|~§_äÄöÖüÜß]{8,20}

t_plz_hausnummer String.Latin Data type for the residen-

tial postcode and house

number (of the better)

Max. 20 Characters

t_sperrgrund xs:string-

based Enu-

meration

Reason for the exclusion

list entry, permitted val-

ues are SELBST (self)

and FREMD (3rd party)

FREMD, SELBST

t_sperrid xs:integer Data type for the SperrID

(Exclusion list Entry ID).

This is generated auto-

matically by OASIS and

uniquely identifies the

exclusion list entry.

[Integer]

t_anlass_sperre_kennung xs:string Cause of exclusion code [0-9]{2}

t_anlass_sperre_bezeichnung String.Latin Description of exclusion

cause

Maximal 150 Characters

t_benutzer xs:string 3-digit numeric UserID.

000 is Superuser WS,

001 is Superuser WEB.

[0-9]{3}

t_meldungsart xs:string-

basierte

Enumeration

Request status I, W, E

t_meldung_schluessel [0-9]{4} Unique Code for respon-

se

4 Digits

t_meldung_text xs:string The response text for

<t_meldung_schluessel>

Min. 1 Character, Max.

4000 Characters

Figure 4: Simple data types in the Schema sperrsystemBasistypen.xsd

4.1.2 Complex data types in the Schema sperrsystemBa-sistypen.xsd

Type in Schema Contains Elements Usage

t_anschrift PLZ

ORT

Complete residential address of the better, required

for the creation and modification of an exclusion list

entry. All elements with the exception of address

supplement (ADDRESSZUSATZ) are required (see



STRASSE

HAUSNR

ADRESSZUSATZ

LAND

below).

t_anschrift_status PLZ

ORT

STRASSE

HAUSNR

ADRESSZUSATZ

LAND

Residential address of the better, required for an

exclusion list status query. All elements are optio-

nal (see below).

t_authentisierung VERANSTALTER

BENUTZER

A betting organisation and a web service user

(=UserID) belonging to the betting organization

t_berechtigter KENNUNG

PASSWORT

Login data for an OASIS web service user.

t_spieler VORNAME

NACHNAME

GEBURTSNAME

GEBURTSDATUM

GEBURTSORT

ANSCHRIFT

Better-data, required for the creation or modification

of an exclusion list entry in OASIS. All elements are

required for these operations.

t_spieler_status VORNAME

NACHNAME

GEBURTSNAME

GEBURTSDATUM

GEBURTSORT

ANSCHRIFT

Better-data required to verify an exclusion; required

elements are VORNAME, NACHNAME und

GEBURTSDATUM (first name(s), family name and

date of birth).

t_anlass_sperre KENNUNG

BEZEICHNUNG

SORTNR

Data for the cause of exclusion. KENNUNG is a 2-

character code. BEZEICHNUNG is the description

of the exclusion cause. SORTNR is the sort-

number, that is used for the display in the GUI.

KENNUNG is required, BEZEICHNUNG and

SORTNR are optional. The content of these ele-

ments can be found in the Cause of Exclusion Cata-

log.



t_response_status ART

SCHLUESSEL

MELDUNG

Responsestatus type for the new interface func-

tions. See Table of responses

t_logindaten KENNUNG

PASSWORT

BENUTZER

Login Data for OASIS 4.0.

Figure 5: Complex data types in the Schema sperrsystemBasistypen.xsd

5. Authentication and Authorisation of OASIS web service queries


5 Authentication and Authorisation of OASIS web service queries

All interface operation calls described in chapter 2 are subject to authentication by the OASIS web

service. To this end, all XML Schemas contain an authentication group as described in this section.

5.1 Group AUTHENTISIERUNG (Authentication)

XML Tag AUTHENTISIERUNG

XML Type t_authentisierung

Property Required group for all interface functions.

Elements VERANSTALTER

BENUTZER

Table 3: Group AUTHENTISIERUNG

5.2 Group AUTHENTISIERUNG.VERANSTALTER (Betting organisation)

XML Tag VERANSTALTER

XML Type t_berechtigter

Property Use: required

Elements KENNUNG

PASSWORT

Table 4: Group AUTHENTISIERUNG.VERANSTALTER

Definition:

This group is used to transmit authentication credentials for the betting organisation. Betting organisa-

tions are organisations in possession of a valid licence to use the OASIS web service. They are pro-

vided with a username and a system-generated initial password, both of which are to be used for the

purposes of authentication and authorisation. It is recommended that the initial password be modified

using the interface function „Modify Password“.

5. Authentication and Authorisation of OASIS web service queries


5.2.1 Element AUTHENTISIERUNG.VERANSTALTER.KENNUNG (Username)

XML Tag KENNUNG

XML Type t_kennung


Length Min. 1 character, Max. 30 characters

Permitted characters Uppercase alpha A-Z (without umlauts) and digits 0-9

Table 5: Element AUTHENTISIERUNG.VERANSTALTER.KENNUNG

Definition:

This element is used to transport the username provided by OASIS for the betting organisation.

Note:

The username and password of the betting organisation are necessary for authentication and authori-

sation.

5.2.2 Element AUTHENTISIERUNG.VERANSTALTER.PASSWORT (Password)

XML Tag PASSWORT

XML Type t_passwort

Property Use: optional

Length Min. 8 characters, Max. 16 characters

Permitted characters Alphabetic characters a-z, A-Z plus ä,Ä,ö,Ö,ü,Ü,ß

Numeric characters 0-9

Special characters: ! # $ % ' ( ) * _ + , - . / : ; = ? | ~ §

Table 6: Element AUTHENTISIERUNG.VERANSTALTER.PASSWORT

Definition:

This element is used to transport the password of the betting organsation.

Plausbility check:

Although this field is defined as optional in the XML Schema, it is nonetheless required, i.e. the OA-

SIS web service verifies that the password has been provided and generates an error if not found.

Note:

The username and password of the betting organisation are necessary for authentication and authori-

sation.

6. Personal data


5.2.3 Element AUTHENTISIERUNG.BENUTZER

XML Tag BENUTZER

XML Type t_kennung



Permitted characters Uppercase alpha A-Z (without umlauts) and digits 0-9

Table 7: Element AUTHENTISIERUNG.BENUTZER

Definition:

This element contains the UserID for an employee account..

Notes:

This element is relevant only for OASIS WEB und is ignored by OASIS WS.

6 Personal data

The personal data of a better is required for identification and data maintenance purposes in order to

create, modify, terminate or query an exclusion list entry.

In order to create a new exclusion list entry, all personal data are required. To verify whether an exclu-

sion list entry exists (Status query), it is not necessary to provide all personal data. For this reason,

two separate XML data types for personal data have been created, to be used in the appropriate cir-

cumstances. These data types are described in this chapter and referenced in later chapters.

6.1 Required/optional attributes

The following table lists all personal data attributes for a better. In addition, the use property for each

attribute is categorised as either required or optional, depending on the action being taken:

Attribute XML-Name Required / Optional

for querying

Required / Optional for mainte-

nance transactions

(Create/Modify/Terminate)

First name(s) VORNAME Required Required

Family name NACHNAME Required Required

Name at birth GEBURTSNAME Optional Required

Date of birth GEBURTSDATUM Required Required

6. Personal data


Place of birth GEBURTSORT Optional Required

Postcode PLZ Optional Required

City ORT Optional Required

Street STRASSE Optional Required

House number HAUSNR Optional Required

Address supple-

ment

ADRESSZUSATZ Optional Optional

Country LAND Optional Required

Table 8: Overview of mandatory and optional elements depending on function

Better personal data required for the querying of an exclusion list entry (status query) are transmitted

in the group SPIELER with the XML data type t_spieler_status (see Section 4.1.2). Adressdata are

transmitted in the group SPIELER.ANSCHRIFT with the XML data type t_anschrift_status.

Better personal data required for the creation or modification of an exclusion list entry are transmit-

ted in the group SPIELER-NEU (new better) with the XML data type t_spieler (see Section 4.1.2).

Address data are transmitted in the group SPIELER-NEU.ANSCHRIFT with the XML data type

t_anschrift.

6.2 SPIELER (better) and SPIELER-NEU (new better)

SPIELER:

XML Tag SPIELER

XML Type t_spieler_status

Elements VORNAME, NACHNAME, GEBURTSNAME, GEBURTSDA-

TUM, GEBURTSORT, ANSCHRIFT

(First name(s), Family name, Name at birth, Date of birth,

place of birth, adress)

Table 9: Group SPIELER

SPIELER-NEU:

XML Tag SPIELER-NEU

XML Type t_spieler

Elements VORNAME, NACHNAME, GEBURTSNAME, GEBURTSDA-

TUM, GEBURTSORT, ANSCHRIFT

6. Personal data


(First name(s), Family name, Name at birth, Date of birth,

place of birth, adress)

Table 10: Group SPIELER-NEU

Note:

These two groups differ only with respect to the element property Use (required/optional) for their re-

spective elements, they are otherwise identical. The common group elements are described below; for

a description of the property Use for each group element, please refer to Section 6.1.

Definition:

These groups are used to transmit the personal data of a better.

Business rules:

The data entered for a better is based on the identification documents provided to the betting organi-

sation. Additional required information not displayed in official identification papers must be provided in

the form of further documents confirming the identity of the better.

The data entered must conform exactly to the information provided in the identification documents.

This applies to the characters as well as their order. For an example see section 6.2.2..

6.2.1 Element VORNAME (First name(s))

XML Tag VORNAME

XML Type t_name

Property Use: Required

Length Max. 85 characters

Permitted characters Latin characters in Unicode

Remark Should the better have no first name(s), the entry – (minus

sign) is required in their place.

Table 11: Element VORNAME

Definition:

This element is used to transmit the first name(s) of the better.

Business rules:

First name(s) are to be entered as they appear on the identification documentation at the time of the

initial exclusion list entry or at the time of the last entry modification. This applies to the characters as

well as their order.

The order of characters may not be changed. Diacritical characters and ligatures must conform to

identification documents and may not be transliterated for data entry.

Should the better have no first name(s), the entry – (minus sign) is required in their place.

6. Personal data


6.2.2 Element NACHNAME (Family name)

XML Tag NACHNAME

XML Type t_name




Table 12: Element NACHNAME

Definition:

This element is used to transmit the family name of the better.

Business rules:

The family name is to be entered as it appears on the identification documentation at the time of the

initial exclusion list entry or at the time of the last entry modification. This applies to the characters as

well as their order.



Example:

Surname as per identification document: Graf von Güldenberg

The surname is to be entered exactly as it appears above.

The following alternative spellings (examples only) are not permitted:

Güldenberg, Graf von Modified order of characters not permitted.

Graf von Gueldenberg Diacritical character / Ligature (here: umlaut) incorrectly omit-

ted. Transliteration (here ü -> ue) not permitted.

Von Güldenberg Title (Graf) incorrectly omitted

Table 13: Non-permitted alternative spellings for the element NACHNAME (Family name)

6.2.3 Element GEBURTSNAME (Name at birth)

XML Tag GEBURTSNAME

XML Type t_name

Property See Section 6.1



Table 14: Element GEBURTSNAME

6. Personal data


Definition:

This element is used to transmit the name at birth of the better.

Business rules:

The name at birth is to be entered as it appears on the identification documentation at the time of the

initial exclusion list entry. This applies to the characters as well as their order.



6.2.4 Element GEBURTSDATUM (Date of birth)

XML Tag GEBURTSDATUM

XML Type xs:string (Date string in the format YYYY-MM-DD, the entry

"--" is valid for month and day.)


Table 15: Element GEBURTSDATUM

Definition:

This element is used to transmit the date of birth of the better.

Plausibility check:

Valid values are between 0 and 120.

6.2.5 Element GEBURTSORT (Place of birth)

XML Tag GEBURTSORT

XML Type t_name




Table 16: Element GEBURTSORT

Definition:

This element is used to transmit the place of birth of the better.

Business rules:

The place of birth is to be entered exactly as it appears on the identification documentation at the time

of the initial exclusion list entry. This applies to the characters as well as their order.

6.2.6 Group ANSCHRIFT (Address)

XML Tag ANSCHRIFT

6. Personal data


XML Type t_anschrift_status bzw. t_anschrift


Elements PLZ, ORT, STRASSE, HAUSNR, ADRESSZUSATZ, LAND

Table 17: Group ANSCHRIFT

Definition:

This group is used to transmit the residential address of the better.

Business rules:

The residential address is to be entered exactly as it appears on the identification documentation at

the time of the initial exclusion list entry or at the time of the last entry modification.

6.2.6.1 Element ANSCHRIFT.PLZ (Postcode)

XML Tag PLZ

XML Type t_nummer




Table 18: Element ANSCHRIFT.PLZ

Definition:

This element is used to transmit the postcode in which the better resides.

Business rules:

The postcode is to be entered as it appears on the identification documentation at the time of the initial

exclusion list entry or at the time of the last entry modification.

6.2.6.2 Element ANSCHRIFT.ORT (City)

XML Tag ORT

XML Type t_name




Table 19: Element ANSCHRIFT.ORT

Definition:

This element is used to transmit the city in which the better resides.

Business rules:

The city is to be entered as it appears on the identification documentation at the time of the initial ex-

6. Personal data


clusion list entry or at the time of the last entry modification. This applies to the characters as well as

their order. The order of characters may not be changed. Diacritical characters and ligatures must

conform to identification documents and may not be transliterated for data entry.

6.2.6.3 Element ANSCHRIFT.STRASSE (Street)

XML Tag STRASSE

XML Type t_strasse




Table 20: Element ANSCHRIFT.STRASSE

Definition:

This element is used to transmit the street in which the better resides.

Business rules:

The street is to be entered as it appears on the identification documentation at the time of the initial

exclusion list entry or at the time of the last entry modification.

6.2.6.4 Element ANSCHRIFT.HAUSNR (House number)

XML Tag HAUSNR

XML Type t_nummer




Table 21: Element ANSCHRIFT.HAUSNR

Definition:

This element is used to transmit the house number at which the better resides.

Business rules:

The house number is to be entered as it appears on the identification documentation at the time of the

initial exclusion list entry or at the time of the last entry modification.

6.2.6.5 Element ANSCHRIFT.ADRESSZUSATZ (Address supplement)

XML Tag ADRESSZUSATZ

XML Type t_adresszusatz


6. Personal data




Table 22: Element ANSCHRIFT.ADRESSZUSATZ

Definition:

This element is used where required to transmit supplementary address information for the residential

address of the better.

Business rules:

The address supplement is to be entered as it appears on the identification documentation at the time

of the initial exclusion list entry or at the time of the last entry modification. This applies to the charac-

ters as well as their order. The order of characters may not be changed. Diacritical characters and

ligatures must conform to identification documents and may not be transliterated for data entry. Multip-

le entries are to be separated by a space.

6.2.6.6 Element ANSCHRIFT.LAND

XML Tag LAND

XML Type t_land


Length Exactly 3 characters

Permitted characters Numeric characters 0-9

Table 23: Element ANSCHRIFT.LAND

Definition:

This element is used to transmit the country or territory in which the better resides.

Business rules:

The table of country and territory codes issued by Destatis forms the basis of data entry for this ele-

ment. The three digit numeric code (Destatis BEV Code) is to be provided for the better.

Plausibility check:

The code provided will be validated by OASIS using the table of country codes described above. Inva-

lid codes will be rejected.

6. Personal data


7. Terminate an exclusion list entry using ID


7 Terminate an exclusion list entry using ID

An exclusion list entry can be terminated by the following interface function:

Terminate an exclusion list entry using its ID

The XML used to terminate an exclusion list entry using its ID is specified in the XML Schema spieler-

sperrePflege.xsd.

The XML-response from OASIS conforms to the XML Schema sperrsystemMeldung.xsd.

7.1 Overview: Terminate an exclusion list entry using ID

XML Schema sperrenPflege.xsd , namespace=

http://www.hzd.de/sperrenPflege

XML Root Element SPIELERSPERRE

XML Type t_spielersperre

Elements AUTHENTISIERUNG

N-ART

SPERRGRUND

SPERRGRUND_NEU

SPERRID

SPIELER_NEU

Table 24: Modify/Terminate an exclusion list entry using its ID

The individual elements of the XML to terminate an exclusion list entry using its ID are defined in the

following tables. The elements SPERRGRUND_NEU and SPIELER_NEU are not be used be the

Termination of an exclusion list entry.

7.1.1 Group AUTHENTISIERUNG (Authentication)

Section 5.1 contains a description of the group AUTHENTISIERUNG.

Use Property: Required

7.1.2 Element N-ART (Request type)

XML Tag N-ART

XML Type t_nachrichtenart


7. Terminate an exclusion list entry using ID


Length Exactly 1 character

Permitted characters B

Table 25: Element N-ART

Definition:

This element is used to transmit the type of maintenance transaction for the exclusion list entry (Ter-

minate).

Business rules:

B: Terminate an exclusion list entry

Plausibility check:

When terminating an exclusion list entry (N-ART=B), it is necessary to provide the ID of the exclusion

list entry.

7.1.3 Element SPERRGRUND (Reason for exclusion)

XML Tag SPERRGRUND

XML Type t_sperrgrund

Property Use: optional, not required for delete using ID

Length Defined by permitted values

Permitted characters SELBST, FREMD

Table 26: Element SPERRGRUND

Definition:

This element is used to transmit the reason for the exclusion list entry (self / 3rd party).

Business rules:

The entry „SELBST“ (self) ist to be used when the better him/herself requests the exclusion list entry.

The entry „FREMD“ (3rd party) is to be used when the exclusion list entry is requested by a third party.

Plausibility check:

Only the values „SELBST“ und „FREMD“ are valid.

7.1.4 Element SPERRID (ID)

XML Tag SPERRID

XML Type t_sperrid


Length Min:1 / Max: 38

Permitted characters Numeric characters 0-9

8. Create and Modify exclusion list entry 4.0


Table 27: Element SPERRID

Definition:

This element is used to transmit the unique ID for the exclusion list entry.

Business rules:

none

Plausibility check:

The number provided must be valid according to the element definition.

Note:

Only the exclusion list entries for the registered betting organisation will be searched using the ID

provided.

The modification or termination of exclusion list entries for other betting organisations is not possible,

even when the correct ID is provided.

8 Create and Modify exclusion list entry 4.0

8.1 Create exclusion list entry 4.0

The creation of an exclusion list entry results in a permanent exclusion for the named person. A sub-

sequent status query willl result in a match being found for the person.

An exclusion list entry can be created using the sperreAnlegen.xsd.

XML Schema sperreAnlegen.xsd

XML Root Element SPERRE

XML Type t_sperre_anlegen


SPERRGRUND

SPIELER

ANLASS

Table 28: Create exclustion list entry overview

The elements are described in the following subchapters.

8.1.1 Group AUTHENTISIERUNG (Authentification)





XML Tag SPERRGRUND


Property Required für creation of exclusion list entry, otherwise op-

tional

Length See permitted characters



Definition:

This element is used to transmit the reason for the exclusion list entry (self / 3rd party).

Business rules:


The entry „FREMD“ (3rd party) is to be used when the exclusion list entry is requested by a third par-

ty..

Plausibilty check:

Only the values SELBST und FREMD are valid.

8.1.3 Group SPIELER (Better)

XML Tag SPIELER

XML Type t_spieler


Elements VORNAME

NACHNAME

GEBURTSNAME

GEBURTSDATUM

GEBURTSORT

ANSCHRIFT


Definition:

This group is used to transmit the complete personal data for the better.

Business rules:



This group is mandatory for the creation of an exclusion list entry.

Note:

All elements with the exception of ANSCHRIFT.ADRESSZUSATZ are mandatory.

Section 6.2 contains a detailed description of all elements.in this group.

8.1.3.1 Permitted characters for the creation of an exclusion list entry

During the creation a new exclusion list entry, the String.Latin character set is restricted further, in

order to ensure that exclusion list entries can be reliably queried.

Elements in the group SPIELER must conform to the following additional rules when a new ex-

clusion list entry is created:

Element

Permitted alphabet-

ic characters

(see Section Fehler!

Verweisquelle konnte

nicht gefunden wer-

den.)

Permitted numeric

charaters



nicht gefunden wer-

den.)

Permitted special

characters



nicht gefunden werden.)

Vorname All None .-´`'

Nachname All None .-´`'

Geburtsdatum None 0-9 -

Geburtsname All None .-´`'

Geburtsort All None .-´`',/()

Anschrift.PLZ All 0-9 -

Anschrift.Ort All None .-´`',/()

Anschrift.Strasse All 0-9 .-´`',/

Anschrift.Hausnr All 0-9 -/.,

Anschrift.Adresszusatz All 0-9 .-´`',;/()&+

Table 31: Permitted characters fort he creation of an exclusion list entry

The use of non-permitted characters will generate an error message.



8.1.4 Group ANLASS (Cause for exclusion)

XML Tag ANLASS

XML Type t_anlass_sperre

Property Use: required. Cardinality: 1..99. (Min. 1 and max. 99)

Elements KENNUNG – mandatory 2-digit code from the catalog Sper-

ranlässe.

BEZEICHNUNG – optional. Element will be ignored.

SORTNR – optional. Element will be ignored.

Table 32: Group ANLASS

Definition:

This element is used to transmit the cause of exclusion.

Business Rule:

At lease one cause of exclusion is required for the creation of an exclusion list entry. Additional causal

codes are allowed. The element KENNUNG is required. The other two elements will be ignored.

Plausibility check:

The Kennung (Causal code) must contain a value specifed in the Cause of Exclusion catalog. Other-

wise OASIS returns the message ‚unbekannter Katalogwert Sperranlass [..]‘ (unknown Cause of Ex-

clusion catalog entry) with code 0015.

Notes:

A semantic plausibility check of the combination of the causes of exclusion is not performed. For ex-

ample, 99 – „kein Grund angegeben“ (no cause specified) combined with other causal codes will not

be rejected.

The system ignores duplicate causal codes and will save only one instance of each delivered causal

code.

8.1.4.1 Element ANLASS.KENNUNG (Causal Code)

XML Tag KENNUNG

XML Type t_anlass_sperre_kennung


Length Exactly 2 digits

Permitted characters Digits 0-9. Only those values specifed in the catalog Sperran-



lässe (Cause of Exclusion) are permitted. The values in the

catalog can be obtained using the new function „Retrieve

cause of exclusion catalog“ (See Interface Functions)

Table 33: Element ANLASS.KENNUNG

Definition:

This element is used to provide the cause of exclusion codes.

8.1.4.2 Element ANLASS.BEZEICHNUNG (Cause Description)

XML Tag BEZEICHNUNG

XML Type t_anlass_sperre_bezeichnung

Property optional

Length maximal 150 characters

Permitted characters String.Latin

Table 34: Element ANLASS.BEZEICHNUNG

Definition:

This element provides the description of the cause of exclusion.

Notes:

This element will be ignored, if it is specified in the creation or modification of an exclusion list entry. It

is recommended that this element not be specified by the creation or modification of an exclusion list

entry.

8.1.4.3 Element ANLASS.SORTNR

XML Tag SORTNR

XML Type xs:integer

Property optional

Table 35: Element ANLASS.SORTNR

Definition:

This element provides the sort order for the causes of exclusion which can be used, for example, in

OASIS Web.



Note:



entry.

Example XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<tns:SPERRE xmlns:ns2="http://www.hzd.de/authentisierung"

xmlns:tns="http://www.hzd.de/sperreAnlegen">

<AUTHENTISIERUNG>

<VERANSTALTER>

<KENNUNG>F6832171</KENNUNG>

<PASSWORT>Qwertz!2</PASSWORT>

</VERANSTALTER>

<BENUTZER>000</BENUTZER>

</AUTHENTISIERUNG>

<SPERRGRUND>FREMD</SPERRGRUND>

<SPIELER>

<VORNAME>Ronny</VORNAME>

<NACHNAME>Zocker</NACHNAME>

<GEBURTSNAME>Mayer</GEBURTSNAME>

<GEBURTSDATUM>1970-01-01</GEBURTSDATUM>

<GEBURTSORT>Niederdolm</GEBURTSORT>

<ANSCHRIFT>

<PLZ>12345</PLZ>

<ORT>Gueiqoruo</ORT>

<STRASSE>GHgsuq Straße</STRASSE>

<HAUSNR>1</HAUSNR>

<LAND>000</LAND>

</ANSCHRIFT>

</SPIELER>

<ANLASS>

<KENNUNG>01</KENNUNG>

</ANLASS>

</tns:SPERRE>

8.1.5 Reply to the Creation of an exclusion list entry 4.0

Schema-conform sperrsystemMeldung.xsd XML.

See Sperrsystem Meldung fior a description of the Schema

8.2 Modify an exclusion list entry 4.0

For each new exclusion list entry, an ID is automatically generated which uniquely identifies the entry.

The XML response to the create request contains the generated ID. The exclusion list entry can sub-

sequently be modified or terminated using its unique ID.

An exclusion list entry can be modified using the XML sperreAendern.xsd.

XML Schema sperreAendern.xsd

XML Root Element SPERRE

XML Type t_sperre_aendern




SPERRID

SPERRGRUND

SPIELER

ANLASS

Table 36: Modify an exclusion list entry 4.0

The individual elements to modify an exclusion list entry are described as follows.




8.2.2 Element SPERRID (ID)

XML Tag SPERRID

XML Type t_sperrid


Length Min:1 / Max: 38

Permitted characters Digits: 0-9


Definition:

This element is used to transmit the unique ID for the exclusion list entry..

Business Rules:

None

Plausibility check:

The number lies within the permitted values.

Notes:

Only the exclusion list entries belonging to the registered betting organisation will be searched using

the ID provided.

The modification or termination of exclusion list entries for other betting organisations is not possible,

even when the correct ID is provided.




XML Tag SPERRGRUND


Property optional

Length Defined by permitted values



Definition:

This element is used to transmit the reason for the exclusion list entry (self / 3rd party), should it have

to be changed.

Business Rules:


The entry „FREMD“ (3rd party) is to be used when the exclusion list entry is requested by a third par-

ty.The reason for exclusion will overwrite the current reason.

Plausibility check:

Only the values „SELBST“ und „FREMD“ are valid.


XML Tag SPIELER

XML Type t_spieler


Elements VORNAME

NACHNAME

GEBURTSNAME

GEBURTSDATUM

GEBURTSORT

ANSCHRIFT


Definition:

This group is used to transmit the complete better personal data for modification.



Business Rules:

It is mandatory that the complete personal data for the better specified. It is not allowed to specify ony

the modified data.

Notes:

All elements with the exception of ANSCHRIFT.ADRESSZUSATZ are mandatory.

Section 6.2 contains a detailed description of all elements in this group.

8.2.4.1 Permitted characters for the modification of an exclusion list entry

(see also Section Fehler! Verweisquelle konnte nicht gefunden werden.)

When modifying a new exclusion list entry, the String.Latin character set is restricted further, in order

to ensure that exclusion list entries can be reliably queried.

Elements in the group SPIELER-NEU must conform to the following additional rules when the existing

exclusion list entry for a better is modified.

Element

permitted

alphabetic charac-

ters



nicht gefunden wer-

den.)

permitted

numeric characters



nicht gefunden wer-

den.)

permitted

special characters



nicht gefunden werden.)

Vorname All None .-´`'

Nachname All None .-´`'

Geburtsdatum keine 0-9 -

Geburtsname All None .-´`'

Geburtsort All None .-´`',/()

Anschrift.PLZ All 0-9 -

Anschrift.Ort All None .-´`',/()

Anschrift.Strasse All 0-9 .-´`',/

Anschrift.Hausnr All 0-9 -/.,

Anschrift.Adresszusatz All 0-9 .-´`',;/()&+



Table 40: Permitted characters for the Modification an exclusion list entry

The use of non-permitted characters will generate an error message .

8.2.5 Group ANLASS (Cause of exclusion)

XML Tag ANLASS


Property optional . Cardinality: 1..99. (Min. 1 and max. 99)

Elements KENNUNG – mandatory 2-digit code from the catalog Sper-

ranlässe.

BEZEICHNUNG – optional. Element will be ignored.

SORTNR – optional. Element will be ignored..


Definition:

This element is used to transmit the cause of exclusion.

Business Rules:

If the cause of exclusion is specifed by the modification of an exclusion list entry, then it must contain

the complete information. The system replaces the existing causes of exclusion with the newly speci-

fed causes. Differences between the old and new entries will not be verified.

Plausibility check:

The Kennung (Causal code) must contain a value specifed in the Cause of Exclusion catalog. Other-

wise OASIS returns the message ‚unbekannter Katalogwert Sperranlass [..]‘ (unknown Cause of Ex-

clusion catalog entry) with code 0015.

Notes:

A semantic plausibility check of the combination of the causes of exclusion is not performed. For ex-

ample, 99 – „kein Grund angegeben“ (no cause specified) combined with other causal codes will not

be rejected.

The system ignores duplicate causal codes and will save only one instance of each delivered causal

code.

8.2.5.1 Element ANLASS.KENNUNG (Causal Code)

XML Tag KENNUNG



XML Type t_anlass_sperre_kennung


Length genau 2 Ziffern.

Permitted characters Digits 0-9. Only those values specifed in the catalog Sperran-

lässe (Cause of Exclusion) are permitted. The values in the

catalog can be obtained using the new function „Retrieve

cause of exclusion catalog“ (See Interface Functions)

Table 42: Element ANLASS.KENNUNG

Definition:

This element is used to provide the codes for cause of exclusion.

8.2.5.2 Element ANLASS.BEZEICHNUNG (Cause Description)

XML Tag BEZEICHNUNG

XML Type t_anlass_sperre_bezeichnung

Property optional


Permitted characters String.Latin

Table 43: Element ANLASS.BEZEICHNUNG

Definition:

This element provides the description of the cause of exclusion.l

Notes:



entry.

8.2.5.3 Element ANLASS.SORTNR

XML Tag SORTNR

XML Type xs:integer

Property optional



Table 44: Element ANLASS.SORTNR

Definition:

This element provides the sort order for the causes of exclusion which can be used, for example, in

OASIS Web.

Notes:



entry.

Example XML


<tns:SPERRE xmlns:ns2="http://www.hzd.de/authentisierung"

xmlns:tns="http://www.hzd.de/sperreAendern">

<AUTHENTISIERUNG>

<VERANSTALTER>

<KENNUNG>Z1234567</KENNUNG>


</VERANSTALTER>


</AUTHENTISIERUNG>

<SPERRID>42</SPERRID>

<SPERRGRUND>FREMD</SPERRGRUND>

<SPIELER>

<VORNAME>Gabi</VORNAME>

<NACHNAME>Karpfen</NACHNAME>

<GEBURTSNAME>Goldfisch</GEBURTSNAME>


<GEBURTSORT>Tangermünde</GEBURTSORT>

<ANSCHRIFT>

<PLZ>34532</PLZ>

<ORT>Stendal</ORT>

<STRASSE>Elbeweg</STRASSE>

<HAUSNR>4</HAUSNR>

<ADRESSZUSATZ>RestResourceDelegateIT</ADRESSZUSATZ>

<LAND>000</LAND>

</ANSCHRIFT>

</SPIELER>

<ANLASS>


</ANLASS>

</tns:SPERRE>

8.2.6 Reply to the Modification of an exclusion list entry 4.0

Schema-conform sperrsystemMeldung.xsd

For a description of this Schema see Sperrsystem Meldung.

9. Global Queries


9 Global Queries

Two categories of better status query exist within OASIS:

Global queries across the entire exclusion list (described in this chapter);

The better status query using exact-character match has been removed from OASIS.

The status of a better can be retrieved using the better data (Spielerstatusabfrage).

The XML format for better status queries is specified in the XML Schema spielerstatusAbfrage.xsd .


9.1 Similarity search

Using the similarity search in OASIS it is possible to query whether an exclusion list entry exists for the

named better.

The similarity search replaces the exact-character-match search.

The similarity seach does not rely on exact character matches but searches for „similar“ entries. Within

OASIS this is also denoted a transliterated search, as characters are transliterated for use in the

search process.

9.1.1 Overview: Status query using better personal data

XML Root Element STATUSABFRAGE

XML Type t_statusabfrage


SPIELER

Table 45: Overview:Status query using better personal data (Spielerstatusabfrage)





See section 6.2

9. Global Queries


9.1.4 Permitted characters for a status query

In a better status query all characters in String.Latin are permitted. This is necessary in order to en-

sure that exclusion list entries migrated from previous systems (not conforming to the OASIS rules)

can be reliably queried.

Element

Permitted

alphabetic

characters

(see chapter 3.1.1)

Permitted

numeric

characters

(see 3.1.2)

Permitted

special

characters

(see chapter 3.1.3)

Vorname „all“ 0-9 „all“

Nachname „all“ 0-9 „all“

Geburtsdatum none 0-9 -

Geburtsname „all“ 0-9 „all“

Geburtsort „all“ 0-9 „all“

Anschrift.PLZ „all“ 0-9 „all“

Anschrift.Ort „all“ 0-9 „all“

Anschrift.Strasse „all“ 0-9 „all“

Anschrift.Hausnr „all“ 0-9 „all“

Anschrift.Adresszusatz „all“ 0-9 „all“

Table 46: Permitted characters for a better status query

9.1.5 Better status query response

The OASIS response to a better status query is in the form of a „Sperrsystem-Meldung“ (exclusion list

response) (see section 21.8).

When no exclusion list entry matching the search parameters is found, the better is deemed not to be

excluded from betting. In this case the reponse contains the following data: Schlüssel 0019, Typ I and

an appropriate response text.

When a single exclusion list entry matching the search parameters is found, the better is deemed to

be excluded from betting. In this case the reponse contains the following data: Schlüssel 0018, Typ W

and an appropriate response text. In addition the response contains information regarding the betting

organisation responsible for the maintenance of the exclusion list entry.

Should a status query with limited parameters result in more than one match, OASIS may determine

that the search can be further refined by the provision of additional search parameters. In this case the

OASIS response contains the following data: Schlüssel 0023, Typ W and an appropriate response

text.

Should a status query result in more than one match, and OASIS determines that it is not possible to

refine the search further via additional parameters, the better is deemed to be excluded from betting.

10. Organisation-based Queries


In this case the reponse contains the following data: Schlüssel 0024, Typ W and an appropriate re-

sponse text.

10 Organisation-based Queries

Response to Modification an exclusion list entry 4.0.

Schema-konform XML sperrsystemMeldung.xsd.

See Sperrsystem Meldung for a description of the Schema.

Global queries across the entire exclusion list;

Organisation-based queries limited to the exclusion list for the betting organisation carrying

out the query (see this chapter)

10.1 Organisation based Queries 4.0

The cause of exclusion is newly introduced in OASIS Version 4.0. New organisation based query func-

tions have been created to retrieve this information (see Function 20 in Interface Functions).

All exclusion list entries belonging to the betting organisation carrying out the query can be retrieved

using the new XML-conform Schema eigeneSperrenAbfragen.xsd.

10.1.1 OASIS 4.0 Query own exclusion list

XML-Root-Element ABFRAGE

XML Type t_eigenesperrenabfrage

Elements LOGINDATEN

Table 47: Overview Query own exclusion lilst 4.0

10.1.1.1 Group LOGINDATEN

XML Tag LOGINDATEN

XML Type t_logindaten

Properties Login Data for an operating site



Elements KENNUNG

PASSWORT

BENUTZER

Table 48: Group ABFRAGE.LOGINDATEN

10.1.1.2 Element ABFRAGE.LOGINDATEN.KENNUNG (LOGIN ID)

XML Tag KENNUNG

XML Type t_kennung

Properties Use: Required

Length Min.1 character, Max.20 characters

Permitted characters Uppercase alpha A-Z (without Umlauts) and Digits 0-9

Table 49: Element ABFRAGE.LOGINDATEN.KENNUNG

Definition:

This element is used to transmit the unique operating site code.

Note:

The username and password of the operating site are necessary for authentication and authorisation

10.1.1.3 Element ABFRAGE.LOGINDATEN.PASSWORT (Password)

XML Tag PASSWORT

XML Type t_passwort

Properties Use: required

Length Min. 8 characters, max. 16 characters

Permitted Characters Alphabetic characters a-z, A-Z plus ä,Ä,ö,Ö,ü,Ü,ß



Table 50: Element ABFRAGE.LOGINDATEN.PASSWORT

Definition:

This element is used to transport the password of the operating site.



Plausibility check:

none

Note:

The username and password of the operating site are necessary for authentication and authorisation.

10.1.1.4 Element ABFRAGE.LOGINDATEN.BENUTZER

XML Tag BENUTZER

XML Type t_kennung

Properties optional

Length Min. 1 character, max. 30 characters


Table 51: Element ABFRAGE.LOGINDATEN.BENUTZER

Definition:

This element contains the UserID for the OASIS WS Superuser.

Notes:


Example XML (EigeneSperrenRequest)


<tns:ABFRAGE xmlns:tns="http://www.hzd.de/eigeneSperrenAbfragen">

<LOGINDATEN>




</LOGINDATEN>

</tns:ABFRAGE>

10.1.2 Results for „Query own exclusion list“ 4.0

For Schema-conform XML eigeneSperrenResponse.xsd.

Refer to Eigene Sperren Response (Own exclusion list response)for description.



10.2 Query own exclusion list using parameters 4.0


tions using parameters have been created to retrieve this information (see Function 20 in Interface

Functions.

All exclusion list entries belonging to the betting organisation carrying out the query can be retrieved

using the new XML-conform Schema eigeneSperrenAbfragen.xsd..The search uses transliteration in

the same way as the similarity search does.

10.2.1 OASIS 4.0 Query own exclusion list using parameters


XML Type t_eigenesperrensuche

Elements LOGINDATEN

VORNAME

NACHNAME

GEBURTSNAME

GEBURTSDATUM

GEBURTSORT

ANSCHRIFT

Table 52: Overview Query own exclusion list using parameters 4.0


XML Tag LOGINDATEN



Elements KENNUNG

PASSWORT

BENUTZER


10.2.1.2 Element ABFRAGE.LOGINDATEN.KENNUNG

XML Tag KENNUNG

XML Type t_kennung





Permitted characters Uppercase alpha A-Z (without Umlauts) und Digits 0-9


Definition:


Note:


10.2.1.3 Element ABFRAGE.LOGINDATEN.PASSWORT

XML Tag PASSWORT

XML Type t_passwort


Length Min. 8 characters, max.16 characters





Definition:


Plausibility check:

none

Note:



XML Tag BENUTZER



XML Type t_kennung

Properties optional

Length Min. 1 character, max.30 characters



Definition:


Notes:


10.2.1.5 Elements for Better

The Elements VORNAME, NACHNAME, GEBURTSNAME, GEBURTSDATUM, GEBURTSORT and

the group ANSCHRIFT and their property rules are described in Section 6.1

Example XML


<tns:ABFRAGE xmlns:tns="http://www.hzd.de/eigeneSperrenAbfragenParameter">

<LOGINDATEN>

<KENNUNG>F6832171</KENNUNG>



</LOGINDATEN>

<VORNAME>Gabi</VORNAME>

<NACHNAME>Goldfisch</NACHNAME>


<GEBURTSORT></GEBURTSORT>

<ANSCHRIFT>

<ADRESSZUSATZ>Hinterhaus 1.OG</ADRESSZUSATZ>

</ANSCHRIFT>

</tns:ABFRAGE>

10.2.2 Results for „Query own exclusion list using parameters“ 4.0



10.3 Query own exclusion list using SperrID 4.0


tions using SperrID have been created to retrieve this information (see Function 21 in Interface Func-

tions).



All exclusion list entries belonging to the betting organisation carrying out the qurery can be retrieved

using the new XML-conform Schema eigeneSperrenAbfragen.xsd..

10.3.1 OASIS 4.0 Query own exclusion list using SperrID


XML Type t_eigenesperrensuche

Elements LOGINDATEN

SPERRID

Table 57: Overview query own exclusion list using SperrID 4.0


XML Tag LOGINDATEN



Elements KENNUNG

PASSWORT

BENUTZER


10.3.1.2 Element ABFRAGE.LOGINDATEN.KENNUNG

XML Tag KENNUNG

XML Type t_kennung

Properties Use Required

Length Min. 1 character. Max. 30 characters

Permitted characters Uppercase alpha A-Z (without Umlauts) und Digits 0-9


Definition:


Note:




10.3.1.3 Element ABFRAGE.LOGINDATEN.PASSWORT

XML Tag PASSWORT

XML Type t_passwort

Properties Use: Required

Length Min. 8 Characters, max. 16 characters





Definition:


Plausibility check:

none

Note:



XML Tag BENUTZER

XML Type t_kennung

Properties optional




Definition:


Notes:

11. Modify password



10.3.1.5 ELEMENT ABFRAGE.SPERRID

XML Tag SPERRID

XML Type t_sperrid

Properties Use: required, exactly one element

Permitted characters Digits 0-9

Table 62: Element ABFRAGE.SPERRID

Definition:

This element is used to transmit the unique ID for the exclusion list entry. The data type is specified in

sperrsystemBasistypen-

Example XML


<tns:ABFRAGE xmlns:tns="http://www.hzd.de/eigeneSperrenAbfragenId">

<LOGINDATEN>




</LOGINDATEN>


</tns:ABFRAGE>

10.3.2 Results „Query own exclusion list entry using SperrID“ 4.0



11 Modify password

Authentication in OASIS is based on a combination of username and password and to this end the

OASIS web service offers the function „Modify password“.

The XML used for password modification is specified in the XML Schema passwortAenderung.xsd.


11.1 Overview: modify password

XML Root Element PASSWORTAENDERUNG

11. Modify password


XML Type t_pwd_aenderung


PASSWORT-NEU

ZIELOBJEKT

Table 63: Overview: modify password

The following tables describe the individual groups and elements used in password modification. The

OASIS basic data types are described in Chapter 4.


Definition:

This group is used to authenticate the betting organisation.


Chapter 5 contains a description of the group AUTHENTISIERUNG.

11.3 Element PASSWORT-NEU (New password)

XML Tag PASSWORT-NEU

XML Type t_passwort



Permitted characters Alphabetic characters a-z, A-Z , ä,Ä,ö,Ö,ü,Ü,ß

Numeric characters 0-9,

Special characters: ! # $ % ‚ ( ) * _ + , - . / : ; = ? | ~ §

Table 64: Element PASSWORT-NEU

Definition:

This element is used to transmit the new password which replaces the previous password once the

operation has been successfully completed.

Note:

The conformity to Schema and use of permitted characters are validated.

11.4 Element ZIELOBJEKT (Target object)

XML Tag ZIELOBJEKT

XML Type t_zielobjekt

12. Verify permission


Property optional

Length According to the permitted characters

Permitted characters B, V

Table 65: Element ZIELOBJEKT

Definition:

This element is used to indicate whether the password change is for a user (B) or a betting organisa-

tion (V).

Business rules:

The group AUTHENTISIERUNG.BENUTZER is not relevant in this context. Authentication is carried

out exclusively on the contents of the group AUTHENTISIERUNG.VERANSTALTER (betting organisa-

tion). Until further notice this operation refers exclusively to the password modification for a betting

organisation.

XML Type t_zielobjekt:

This XML data type is specified in the XML Schema passwortAenderung.xsd. It is xs-string based

enumeration with permitted contents V or B.

V: Modify password for betting organisation

B: Modify password for individual user

Plausibility check:

The value „B“ is currently not permitted and will be rejected until further notice.

12 Verify permission

The current validity of the OASIS licence can be verified using the OASIS web service function „Verify

permission“. Authentication is carried out using the username and password of the betting organisa-

tion.

The XML used for the permission verification is specified in the XML Schema authentisierung.xsd.


XML Root Element AUTHENTISIERUNG



BENUTZER

Table 66: Authentisierung (Authentication)

13. Check availability



Definition:




13 Check availability

The availability of the OASIS web service can be checked using the web service function „Check

availability“. Authentication is carried out using the username and password of the betting organisa-

tion.

The XML used for the availability check is specified in the XML Schema authentisierung.xsd.

The XML-response from OASIS conforms to the XML Schema sperrsystemMeldung.xsd with a value

of 049 for the „Meldungsschlüssel“ (response key) when OASIS is available.




BENUTZER

Table 67: Authentisierung


Definition:




14 Query release number

The current release number for the OASIS web service can be queried using the web service function

„Query release number“. Authentication is carried out using the username and password of the betting

organisation.

The XML used for the release number query is specified in the XML Schema authentisierung.xsd.

15. Load country table


The XML-response from OASIS conforms to the XML Schema sperrsystemMeldung.xsd with a value

of 050 for the „Meldungsschlüssel“ (response key).




BENUTZER

Table 68: Authentisierung


Definition:




15 Load country table

The function „Load country table“ can be used to retrieve the valid table of countries (territory cata-

log).

The catalog used in OASIS is based upon the list issued by Destatis from 01.01.2016.

The catalog consists of three attributes per territory:

- The official short name of the territory (british english spellings) - The 3 digit territory code (Territory: Destatis BEV code) - The internationally recognized 2 character country code (ISO-3166 Alpha 2)

The XML used for the load country table request is specified in the XML Schema authentisierung.xsd.

The XML-response from OASIS conforms to the XML Schema katalog.xsd.




BENUTZER

Table 69: Load country table

15. Load country table



Definition:



15.2 Table of countries

The table of countries is provided according to the XML Schema katalog.xsd.

XML Root Element KATALOG

Elements KATALOGNAME

KATALOGITEM

Table 70: Table of countries

15.2.1 Element KATALOGNAME (Table name)

XML Tag KATALOGNAME

XML Type t_name



Permitted characters xs:string

Table 71: Element KATALOGNAME

Definition:

This element is used to transport the name of the table.

15.2.2 Group KATALOGITEM (Table entry)

XML Tag KATALOGITEM

XML Type t_katalog_item

Property Unlimited number of items possible

Elements KBEZ1

KBEZ2

LBEZ

Table 72: Group KATALOGITEM

Definition:

Each instance of KATALOGITEM is used to transport a single entry in the table.

16. Retrieve cause of exclusion catalog


XML Tagname XML Type Property Length Meaning

KBEZ1 t_name Use:required Max. 85

characters

3 digit numeric code

(Destatis BEV Code)

KBEZ2 t_name Use:required Max. 85

characters

2 character country code

(ISO-3166 Alpha 2)

LBEZ t_name Use:required Max. 85

characters

Official short name of

country

Table 73: Definition KATALOGITEM

OASIS only accepts the 3 digit numeric country codes (Destatis BEV Code).

16 Retrieve cause of exclusion catalog

The function ‚Load cause of exclusion table‘ can be used to retrieve the valid cause of exclusion table.

(see Function 18 in Section Fehler! Verweisquelle konnte nicht gefunden werden.).

16.1 Authentisierung (Authentication)

The XML used for the load cause exclusion table request is specified in the XML Schema authentis-

ierung.xsd., see Section 5.

16.2 Katalog Sperranlässe (Catalog Cause of Exclusion)

The XML-response for the Catalog Caus of Exclusion from OASIS conforms to the XML Schema sper-

ranlässe.xsd.

XML-Root-Element KAT_SPERRANLAESSE

XML Type t_kat_sperranlaesse

Elements ANLASS

Table 74: Catalog Cause of Exclusion

16.2.1 Group ANLASS (Cause)

XML Tag ANLASS


Properties maximal 99

Elements KENNUNG – mandatory 2.digit code from the Cause of Ex-

17. Batch 2.0


clusion catalog

BEZEICHNUNG – mandatory element

SORTNR – mandatory element


Definition:

An element from the catalog will be transmitted for each cause of exclusion.

XML

Tag Name

XML Type Properties Length Description

KENNUNG t_anlass_sperre_

kennung

Mandatory Exactly 2 digits 2 digit code that is used for the

creation and modification of

exclusion list entries

BEZEICH-

NUNG

String Latin Mandatory maximal 150

characters

Description of the cause of

exclusion that is, for example,

displayed in the graphic user

interface

SORTNR int Mandatory Number used for the sort or-

der to display the catalog

items in the graphic user inter-

face. The sort order is predefi-

ned and can be ignored.

Table 76: Definition ANLASS

The 2-digit code KENNUNG is used by OASIS for the creation and modification of exclusion list en-

tries.

17 Batch 2.0

In contrast to the current batch method, Batch 2.0 process the batch queries in an asychronous man-

ner. Additionally, the batch files for Batch 2.0 are zipped (gzip), which results in a quicker upload.

The technical specifications for OASIS Batch 2.0 are described here:

https://rp-darmstadt.hessen.de/technische-vorgaben

The status of the one’s own batch requests can be queried. When the processing of a batch request is

finished, the batch results can be retrieved in the form of a gzip file.

1. Prerequisites for using the Batch 2.0 function

A prerequisite for using the Batch 2.0 function is an authorisation.

https://rp-darmstadt.hessen.de/technische-vorgaben

17. Batch 2.0


2. Points to be aware of

a. A time slot is created for each authorized operating site during which batch requests can be sub-

mitted. This could be for example, Tuesdays from 12:00 to 2:00 p.m.

b. For each time slot there is a setting for the maximal number of parallel batch requests that can be

submitted to OASIS.

c. For each batch job there is a setting for the maximal number of queries.

3. Procedure

The prerequisites under point 2 must be fulfilled, before a batch job can be submitted.

a. In order to submit a batch job, the requester must (Chapter Fehler! Verweisquelle konnte nicht

gefunden werden.)

Create a Batch-XML file,

Compress the Batch-XML file using the gzip format

b. Submit the batch job using the function “Batch 2.0 Request“ (Chapter 19.1)

Request: Submit the gzip file (see Chapter 19.1.1Fehler! Verweisquelle konnte nicht ge-

funden werden.)

Response: Evaluate the OASIS Response (see Chapter 19.1.2)

c. Optional step: Verify the status of all batch jobs from the operating site (Chapter 19.3)

Request: Submit XML-Datei (see Chapter 19.3.1Fehler! Verweisquelle konnte nicht ge-

funden werden.)


This step is optional and can be skipped. One can try to retrieve the batch results directly (see (d))

. If the results are not yet available then the current status will be returned (see (d)).

d. Retrieal of the batch job results that were submitted under (a) (Chapter 19.2)

Request: Submit XML-Datei (see Chapter 19.2.1)


The following table lists the possible status of the batch job:

Status Description

WAITING The batch job is waiting to be processed.

RUNNING The batch job is being processed.

CANCELLED The batch job was manually cancelled.

FINISHED The processing of the batch job has been completed and can be retrieved.

COMPLETED The batch job is finished and the job results have been retrieved.

ARCHIVED This is the last status of the batch job process. The submitted XML-Request Data and the

17. Batch 2.0


batch job results are deleted from the database on the basis of data protection.

17.1 Batch 2.0 Request

17.1.1 Triggering a Batch 2.0 Request

The XML file is zipped with gzip for transport.

Content-Type: application/gzip; charset=UTF-8

XML Schema: batchAnlegen.xsd

The authentication credentials are transmitted using 2 new HTTP-Header-Parameters (Betriebsstät-

tenkennung und Passwort (operating site id and password)).

Identical batch requests within the same timeslot are identified through their MD5-Hash and will be

rejected.

The validation of the body content is performed during the batch processing and not when the batch

file is uploaded.

The batch request will be rejected during the processing, when the XML of the batch request

does not conform to the Schema, or

fails a plausibility check, or

doesn’t contain any data records (no group DS)

HTTP-Header-Parameter

OASIS_KENNUNG Operating Site Code. Pattern [0-9A-Z]{1,30}

OASIS_PWD

Password for the WS Superuser for the Operating Site, min 8, max 16 characters.

Alphabetic characters a-z, A-Z, ä,Ä,ö,Ö,ü,Ü,ß



Table 77: HTTP Header Parameter

Batch Anlegen Request XML:

17. Batch 2.0


The tag names have been specifed in a very shortened form in order to minimize the payload without

any regard to the XML readability.

XML-Schema batchAnlegen.xsd

XML-Root-Element BATCH_ANLEGEN_REQUEST

XML Type t_batch_anlegen_request

Elements DS

17.1.1.1 Group BATCH_ANLEGEN_REQUEST.DS

XML Tag DS

XML Type t_batchanlegen_datensatz

Properties Data record of a batch query

Elements I

F

SP

Table 78: Group BATCH_ANLEGEN_REQUEST.DS

17.1.1.2 Element BATCH_ANLEGEN_REQUEST.DS.I

XML Tag I

XML Type t_ds_id



Permitted characters Numeric digits 0-9

Table 79: Element BATCH_ANLEGEN_REQUEST.DS.I

Definition:

The ID of the data record is unique within the XML-batch request. The delivered ID will be used for the

processing of batch request. OASIS does not verify that this ID is unique. The requestor needs to en-

sure that the DS-IDs in the submitted batch request are unique.

17. Batch 2.0


17.1.1.3 Element BATCH_ANLEGEN_REQUEST.DS.F

XML Tag F

XML Type t_freitext

Properties optional

Length Maximal 16 characters

Permitted characters Alphabetic characters a-z, A-Z, ä,Ä,ö,Ö,ü,Ü,ß



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

Table 80: BATCH_ANLEGEN_REQUEST.DS.F

Definition:

In this element additional information can be transmitted for the data record (for example, customer

number). The content of this element will be returned in the batch results.

17.1.1.4 Group BATCH_ANLEGEN_REQUEST.DS.SP

XML Tag SP

XML Type t_spielerdaten

Properties Better Data for the Query

Elements V (= Vorname) = First name

N (= Nachname) = Surname

G (= Geburtsname) = Name at birth

D (= Geburtsdatum) = Date of birth

O (= Geburtsort) = City of Birth

A (= Group Anschrift) = Group Address

Table 81: Group BATCH_ANLEGEN_REQUEST.DS.SP

Definition:

In this group the data of the better is transmitted for the query.

Plausibility Check:

The rules described in the Chapter Global Queries apply here.

17. Batch 2.0


17.1.1.5 Group BATCH_ANLEGEN_REQUEST.DS.SP.A

XML Tag A

XML Type t_anschriftdaten

Properties Address Data for the Query

Elements P (= Postleitzahl) = postal code

W (= Wohnort) = City

S (= Straße) = Street

H (= Hausnummer) = Number

Z (= Adresszusatz) = additional Address information

L (= Land) = Country

Table 82: Group BATCH_ANLEGEN_REQUEST.DS.SP.A

Definition:

In this group the address oft he better is transmitted for the query.

Plausibility Check:

The rules described in the Chapter Global Queries apply here.

Example XML (Request)


<tns:BATCH_ANLEGEN_REQUEST xmlns:tns="http://www.hzd.de/batchAnlegenRequest">



<DS> 

1

<F>Meine Anmerkung</F>

<SP> 

<V>Peter</V>

<N>Müller</N>

<G>Schmidt</G>

<D>1990-03-15</D>

<O>Hamburg</O>

<A>

12345

<W>Hamburg</W>

<S>Parkstraße</S>

<H>3</H>

<Z>3.Stock links oben</Z>

<L>000</L>

</A>

</SP>

</DS>



<DS> 

2

<F>Meine Anmerkung</F>

<SP> 

<V>Gabi</V>

<N>Goldfisch</N>

<G>Schmidt</G>

<D>1956-05-23</D>

<O>Berlin</O>

<A>

17. Batch 2.0


12345

<W>Dresden</W>

<S>Meißener Straße</S>

<H>12 a</H>

<L>000</L>

</A>

</SP>

</DS>





</tns:BATCH_ANLEGEN_REQUEST>

17.1.2 Response to theTriggering of a Batch 2.0 Request

Conforms to XML Schema batchAnlegenResponse.xsd.

XML-Schema: batchAnlegenResponse.xsd

See Chapter Response Status‚Response Status‘ for a description of the Schema.

Example XML (Response)

<?xml version="1.0" encoding="UTF-8" ?>

<tns:BATCH_ANLEGEN_RESPONSE xmlns:tns="http://www.hzd.de/batchAnlegenResponse">

<RESPONSE-STATUS>

<ART>I</ART>

<SCHLUESSEL>0077</SCHLUESSEL>

<MELDUNG>Die Abfrage wurde erfolgreich durchgeführt.</MELDUNG>

</RESPONSE-STATUS>

<BATCH-ID>42</BATCH-ID>

</tns:BATCH_ANLEGEN_RESPONSE>

17.2 Retrieval of Batch 2.0 Job Results

It is possible to download the Batch 2.0 Batch Job Results when the status of the Job is FINISHED.

When the Batch 2.0 results are downloaded, the results are deleted in the database and cannot be

downloaded again.

17.2.1 Retrieval of Batch 2.0 Job Results

Content-Type: text/plain; charset=UTF-8

The authentication credentials are transmitted using 2 HTTP-Header-Parameters (Betriebsstättenken-

nung und Passwort (operating site id and password)).The BATCH-ID is transmitted as a PATH-

Parameter. Therefore there is no XML payload necessary for the retrieval of the batch results.


OASIS_KENNUNG Operating Site Code. Pattern [0-9A-Z]{1,30}

OASIS_PWD

Password for the WS Superuser for the Operating Site, min 8, max 16 characters.


17. Batch 2.0




PATH Parameter

BATCH_ID

The BATCH_ID is returned from OASIS in the BatchAnlegenResponse.. Example

URLfor the retrieval of a batch with Batch ID <111>:

<server>/oasisbatchws/rest/oasis/abfragen/auftrag/batch/4.0/111

17.2.2 Response to the Retrieval of Batch 2.0 Job Results

Content-Type: application/gzip; charset=UTF-8

XML-Schema: batchResponse.xsd

When the status of a batch job is FINISHED, the job results can be retrieved. This means at least one

better has an exclusion entry and the XML from the job results contains at least one group DS (see

Section Group DS). The elements ANZAHL-ERFOLGREICH-VERARBEITET, ANZAHL-NICHT-

GESPERRT, ANZAHL-GESPERRT and ANZAHL-NICHT-EINDEUTIG (number of succesfully pro-

cessed records, number of better that have exclusion entry, number of betters that have an exclusion

entry, number of records that have more than one hit) contain valid values.

If the batch job has a status other than FINISHED, then the Group <DS> is missing and no data rec-

ords will be returned. The elements <ANZAHL_...> have the value 0 and <SPERRSYSTEM-

MELDUNG> contains the job status.

The group SPERRSYSTEM-MELDUNG contains Information to the response as described in theTable

of Responses.

For a description of the BatchResponse XML see Chapter Retrieval Batch 2.0 Job Results.



<tns:BATCHRESPONSE xmlns:ns2="http://www.hzd.de/sperrsystemMeldung"

xmlns:tns="http://www.hzd.de/batchResponse">


<TIMESTAMP>2016-05-11T13:25:04.304+02:00</TIMESTAMP>

<ANZAHL-ERFOLGREICH-VERARBEITET>100</ANZAHL-ERFOLGREICH-VERARBEITET>

<ANZAHL-NICHT-GESPERRT>97</ANZAHL-NICHT-GESPERRT>

<ANZAHL-GESPERRT>2</ANZAHL-GESPERRT>

<ANZAHL-NICHT-EINDEUTIG>1</ANZAHL-NICHT-EINDEUTIG>

<RESPONSE-STATUS>

<ART>I</ART>


<MELDUNG>Ergebnisse von Batchanfragen: kein Fehler aufgetreten</MELDUNG>

</RESPONSE-STATUS>

17. Batch 2.0


<DS>

<DS-ID>34</DS-ID>

<FREITEXT>123-00001</FREITEXT>

<SPERRSYSTEM-MELDUNG>

<ART>W</ART>


<MELDUNG>Der Spieler ist gesperrt</MELDUNG>

<SPERRINFO>


<BESITZER>

<NAME>Hurtigspielhölle</NAME>

<ANSPRECHPARTNER>Hugo Hurtig</ANSPRECHPARTNER>

<TELEFON>1234-56789</TELEFON>

<EMAIL>[email protected]</EMAIL>

</BESITZER>

<SPERRDATUM>2014-11-23</SPERRDATUM>

<SPERRGRUND>SELBST</SPERRGRUND>

</SPERRINFO>

</SPERRSYSTEM-MELDUNG>

</DS>

<DS>

<DS-ID>51</DS-ID>



<ART>W</ART>


<MELDUNG>Der Spieler ist gesperrt</MELDUNG>

<SPERRINFO>


<BESITZER>

<NAME>Lotto Sachsen-Anhalt</NAME>

<ANSPRECHPARTNER>Flotte Lotte</ANSPRECHPARTNER>



</BESITZER>



</SPERRINFO>


</DS>

<DS>

<DS-ID>77</DS-ID>



<ART>W</ART>


<MELDUNG>Die Abfrage ergab mehr als einen Treffer. Bitte schränken

Sie die Suche ein.</MELDUNG>

<SPERRINFO>


<BESITZER>

<NAME>Hurtigspielhölle</NAME>

<ANSPRECHPARTNER>Hugo Hurtig</ANSPRECHPARTNER>



</BESITZER>



</SPERRINFO>

<SPERRINFO>


<BESITZER>

<NAME>Spielhalle Kleinkuckucksheim</NAME>

<ANSPRECHPARTNER>Clara Fall</ANSPRECHPARTNER>



</BESITZER>



</SPERRINFO>


</DS>

</tns:BATCHRESPONSE>

17. Batch 2.0


Response codes:

No. Description

0076 This error message is returned when a batch was attempted to be retrieved before the the batch processing was started.

0075 This error message is returned when a batch was attempted to be retrieved before the the batch processing was completed.

0078

The batch processing was completed successfully without warning or error.

<RESPONSE-TEXT>: „kein Fehler aufgetreten“ Translation: „no errors”

0079

One or more of the submitted records had an error.The further processing of the batch request could be completed.

The record(s) with the error is returned in the element <SPERRSYSTEM-MELDUNG>.

<RESPONSE-TEXT>: „Batchabfrage mit Warnungen beendet“

Translation: „Batch processing completed with warning”

0080

The batch request could not be processed due to, for example, invalid XML, or the da-tabase is not available.

Since there are many possible sources for this error, there is no standard text for the <RESPONSE-TEXT>.

17.3 Check Status of Batch 2.0 Jobs

With this service, one can check the status of one’s own batch 2.0 jobs. The status of all of one’s jobs will be

returned, except those that have been archived (Status=ARCHIVED).

17.3.1 Check Status of Batch-2.0-Jobs


The authentication credentials are transmitted using 2 HTTP-Header-Parameters (Betriebsstättenken-

nung and Passwort (operating site-id and password)). There is no XML payload necessary.


OASIS_KENNUNG Operating site code. Pattern [0-9A-Z]{1,30}

OASIS_PWD Password for the WS Superuser for the Operating Site, min 8, max 16 characters.

17. Batch 2.0





17.3.2 Response to Status Check of Batch-2.0-Jobs

A successfully triggered Batch 2.0 Job request can have one of the following statuses:

17.3.2.1 Status of a Batch 2.0 Job

Status Description

WAITING The Batch 2.0 job is waitinig to be processed.

RUNNING The Batch 2.0 job is being processed.

FINISHED The processing of the Batch 2.0 job has been completed.and

the job results can be downloaded. The job request XML is

no longer available.

COMPLETED The Batch 2.0 job results have been downloaded. The job

results XML is no longer available in OASIS.

CANCELLED The Batch 2.0 job has been manually cancelled. No job re-

sults are available.

A description of the XML Schema can be found in Batch 2.0 Job Information

18. Current Information


18 Current Information

The term „Current Information“ is used to define all OASIS announcements of an urgent or important

nature. Examples are partial system failure, maintenance announcements, impending release up-

grades etc..

This information can be provided to OASIS users using a web service interface function.

18.1 Request

The XML used for the release number query is specified in the XML Schema authentisierung.xsd.

18.2 Response

The OASIS response is transmitted in a structured XML document based on the XML Schema infor-

mationen.xsd

XML Schema: informationen.xsd

XML Root Element INFORMATIONEN

XML Type t_informationen

Elements SPERRSYSTEM-MELDUNG

INFORMATION

Table 83: Structure Informationen

18.2.1 Group SPERRSYSTEM-MELDUNG (Exclusion system response)

Definition:

This group is used to transmit responses from the exclusion system.

Property: Use: Required

The group Sperrsystem-meldung is described in chapter 19.

18.2.2 Group INFORMATION

Definition:

This group is used to transmit the informational item, the timeframe for which it is valid and the date

on which it was last modified.



XML Tag INFORMATION

XML Type t_information

Property Use: optional, unlimited number of instances

Elements ID

TEXT

VON

BIS

MODIFIED

Table 84: Group Information

18.2.2.1 Element INFORMATION.ID

XML Tag ID

XML Type t_info_id


Pattern [\d]{1,9}


Table 85: Information-ID

Definition:

This element is used to transmit the ID of the informational item.

18.2.2.2 Element INFORMATION.TEXT

XML Tag TEXT

XML Type t_text


Pattern [\wÄäÖöÜüß\s\-/().:]{1,250}


Table 86: Message text for an informationalen item

Definition:

This element is used to transmit the text of the informational item.

18.2.2.3 Element INFORMATION.VON (From)

XML Tag VON



XML Type xs:date


Permitted characters xs:date

Table 87: Information valid from...

Definition:

This element is used to transmit the date from which the informational item applies.

18.2.2.4 Element INFORMATION.BIS (Until)

XML Tag BIS

XML Type xs:date



Table 88: Information valid until...

Definition:

This element is used to transmit the date until which the informational item applies.

18.2.2.5 Element INFORMATION.MODIFIED

XML Tag MODIFIED

XML Type xs:dateTime


Permitted characters xs:dateTime

Table 89: Date & Time at which the informational element was last modified

Definition:

This element is used to transmit the date and time at which the informational item was last modified.

Example of an XML Response:

<?xml version="1.0" encoding="UTF-8" ?>

<tns:INFORMATIONEN xmlns:tns="http://www.hzd.de/informationen"

xmlns:m="http://www.hzd.de/sperrsystemMeldung"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://www.hzd.de/informationen informationen.xsd ">


<ART>I</ART>


<MELDUNG>Die Abfrage wurde erfolgreich durchgeführt.</MELDUNG>


<INFORMATION>

<ID>75</ID>

<TEXT>neue Testmeldung (ThIm)</TEXT>

<VON>2015-05-11</VON>

<BIS>2015-05-12</BIS>



<MODIFIED>2015-05-11T18:24:59</MODIFIED>

</INFORMATION>

<INFORMATION>

<ID>76</ID>

<TEXT>neuere Testmeldung (ThIm)</TEXT>

<VON>2015-05-11</VON>

<BIS>2015-05-12</BIS>

<MODIFIED>2015-05-11T18:25:32</MODIFIED>

</INFORMATION>

</tns:INFORMATIONEN>

An unlimited number of informational items can be returned in the response (0:n). All elements for an

informational element are mandatory with a cardinality of 1.

19. Responses from OASIS


19 Responses from OASIS

XML responses from OASIS conform to the specification defined in the XML Schema sperrsystem-

Meldung.xsd.

Übersicht:

XML Root Element SPERRSYSTEM-MELDUNG

XML Type t_meldung

Elements ART

SCHLUESSEL

MELDUNG

SPERRINFO

Table 90: SPERRSYSTEM-MELDUNG

19.1.1 SPERRSYSTEM-MELDUNG

19.1.1.1 Element ART (Response type)

XML Tag ART

XML Type t_meldungsart from sperrsystemBasistypen.xsd

xs:string-basierte Enumeration


Permitted characters I, W, E

Table 91: Element ART

Definition:

This element is used to transmit the type of response provided by OASIS and indicates whether the

function was successfully carried out.

Business Rules:

I: Information. No errors have occurred. E.g. the response to a status query, that a better is not ex-

cluded, has the response type „I“. The response that permission to use OASIS exists, has the re-

sponse type „I“.

W: Warning. No errors have occurred. E.g. The information that a better has an exclusion list entry,

has the response type „W“.

E: Error. An error has occurred. This can for instance be due to invalid XML, infringement of business

rules, programming error or system failure.



19.1.1.2 Element SCHLUESSEL (Key)

XML Tag SCHLUESSEL

XML Type t_meldung_schluessel from sperrsystemBasistypen.xsd


Length Exactly 4 numeric digits

Permitted characters [0-9]{4}

Table 92: Element SCHLUESSEL

Definition:

This element is used to transmit the response key. The table of response keys is included in the ap-

pendix. The table may be subject to editorial changes.

19.1.1.3 Element MELDUNG (Response)

XML Tag MELDUNG

XML Type t_meldung_text from sperrsystemBasistypen.xsd


Length Min. 1 character, Max. 4000 characters


Table 93: Element MELDUNG

Definition:

This element is used to transmit detailed information about errors as well as other information relevant

to the response.

19.1.2 Group SPERRINFO (Exclusion information)

XML Tag SPERRINFO

XML Type t_sperrinformation

Properties Use: optional,

Cardinality: unlimited number of instances (0:n)

Elements SPERRID

BESITZER

SPERRDATUM

SPERRGRUND

SPIELER

ANLASS



Table 94: Group SPERRINFO

Definition:

This group is used to transmit information about an exclusion list entry. The level of detail provided

depends on the nature of the query.

19.1.2.1 Element SPERRID (Exclusion list entry ID)

XML Tag SPERRID

XML Type t_sperrid

Properties Use: required,

Cardinality: exactly 1 instance

Permitted characters sb:t_sperrid


Definition:

This element is used to uniquely identify an exclusion list entry within OASIS. The data type is defined

in Chapter 4 OASIS basic data types.

19.1.2.2 Element SPERRDATUM (Date of exclusion)

XML Tag SPERRDATUM

XML Type t_sperrid


Cardinality: Max. 1 instance


Table 96: Element SPERRDATUM

Definition:

This element is used to transmit the date on which the exclusion list entry was created.

Note:

When terminating an exclusion based on its start date, it is advisable to verify that the exclusion has

been in the system for at least one year.

19.1.2.3 Element SPERRGRUND (Reason for exclusion)

XML Tag SPERRGRUND






Permitted characters sb:t_sperrgrund


Definition:

This element is used to transmit the reason for the exclusion list entry. The data type is defined in

Chapter 4 OASIS basic data types.

19.1.2.4 Group SPIELER (Better)

XML Tag SPIELER

XML Type t_spieler



Permitted characters sb:t_spieler


Definition:

This element is used to transmit the better personal data. The data type is defined in Chapter 4 OASIS

basic data types.

19.1.3 Group BESITZER (Owner)

XML Tag BESITZER

XML Type t_sperrenbesitzer



Elements NAME

ANSPRECHPARTNER

TELEFON

EMAIL

Table 99: Group BESITZER

Definition:

This group is used to transmit data about the betting organisation responsible for the maintenance of a

particular exclusion list entry.

Note:

This element is only transmitted in the response to status queries, where the better is found to be ex-

cluded.



19.1.3.1 Element BESITZER.NAME (Name)

XML Tag NAME

XML Type xs:string



Table 100: Element BESITZER.NAME

Definition:

This element is used to transmit the name of the betting organisation.

19.1.3.2 Element BESITZER.ANSPRECHPARTNER (Contact person)

XML Tag NAME

XML Type xs:string



Table 101: Element BESITZER.ANSPRECHPARTNER

Definition:

This element is used to transmit the name of the contact person within the betting organisation.

19.1.3.3 Element BESITZER.TELEFON (Telephone number)

XML Tag NAME

XML Type xs:string



Table 102: Element BESITZER.TELEFON

Definition:

This element is used to transmit the telephone number for the betting organisation.

19.1.3.4 Element BESITZER.EMAIL (E-Mail address)

XML Tag NAME

XML Type xs:string



Table 103: Element BESITZER.EMAIL



Definition:

This element is used to transmit the email address for the betting organisation.

19.1.4 Group ANLASS (Cause of exclusion)

XML Tag ANLASS


Property maximal 99

Elements KENNUNG – mandatory 2-digit code from the cause of ex-

clusion catalog.




Definition:

A cause of exclusion will be transmitted with each exclusion entry.

XML

Tag name

XML Type Property Length Description


kennung




BEZEICH-

NUNG


characters




interface








tries.

19.2 Response-Status

The responses that are returned from the new functions from OASIS Version 4.0 and future versions

of OASIS are iin the form of a Response-Status instead of a Sperrsystemmeldung. These contain only

the elements ART, SCHLUESSEL and MELDUNG (type, code and message).



The messges that the Resonse-Status returns are listed in the Table of Responses.

19.2.1 Group RESPONSE-STATUS

XML Tag RESPONSE-STATUS

XML Type t_response_status

Property optional, unlimited number of elements

Elements ART

SCHLUESSEL

MELDUNG

Table 106: Group RESPONSE-STATUS

19.2.1.1 Element RESPONSE-STATUS.ART (Type)

XML Tag ART

XML Type xs:string-based Enumeration

Property mandatory

Permitted values I, W, E

Table 107: Element RESPONSE-STATUS.ART

Definition:

This element transmits if a request was successfully processed.

Description:

I = Information. There was no error in the processing the request.. Example: the message,

that a better has no exclusion entry has the value I. Another example is the message, that the

permission for a betting organisation is valid, has the value I.

W = Warning. There was no error in processing the request. Example: the message that a

better has an exclusion entry has the value W.

E = Error. There was an error in processing the request. This error can be caused by faulty

XML, non-compliant data, a program error or downtime from an OASIS-Service.

19.2.1.2 Element RESPONSE-STATUS.SCHLUESSEL (Code)

XML Tag SCHLUESSEL

XML Type t_meldung_schluessel

Property optional



Length Exactly 4 digits

Permitted values [0-9]{4}

Table 108: Element RESPONSE-STATUS.SCHLUESSEL

Definition:

This element transmits die code that is listed in the table of responses

19.2.1.3 Element RESPONSE-STATUS.MELDUNG( message)

XML Tag MELDUNG

XML Type t_meldung_text

Property optional

Length Min.1 character, max. 4000 characters

Permitted values xs:string

Table 109: Element RESPONSE-STATUS.MELDUNG

Definition:

The message contains detailled information describing the error and other information that is useful in

understanding the message.

19.3 Eigene-Sperren-Response (Own exclusion list re-sponse)

The response to the function ‘Query own exclusion list 4.0’ is defined using eigeneSperrenResponse.xsd.

Overview:

XML-Root-Element EIGENE_SPERREN_RESPONSE

XML Type t_eigene_sperren_response

Elements RESPONSE_STATUS

SPERRE

Table 110: Eigene-Sperren-Response (Own exlusion list response)

19.3.1 Group RESPONSE_STATUS

XML-Tag RESPONSE_STATUS

XML-Type t_response_status




Elements ART

SCHLUESSEL

MELDUNG

Table 111: Group RESPONSE_STATUS

19.3.2 Group EIGENE_SPERREN_RESPONSE.SPERRE (Own exclu-sion list entry)

XML Tag SPERRE

XML Type t_sperre


Elements SPERRID

SPERRDATUM

SPERRGRUND

VORNAME

NACHNAME

GEBURTSNAME

GEBURTSDATUM

GEBURTSORT

ANSCHRIFT

ANLASS

Table 112: Group EIGENE_SPERREN_RESPONSE.SPERRE (Own exlusion list entry)

19.3.2.1 ElementSPERRID (Exclusion list entry id)

XML Tag SPERRID

XML Type t_sperrid

Property Pflichtfeld, genau ein Element

Permitted values sb:t_sperrid

Table 113: Element EIGENE_SPERREN_RESPONSE.SPERRE.SPERRID (Exclusion list entry id)

Definition:

The SperrID uniquely identifes an exclusion list entry. The type is specified in sperrsystemBasistypen..



19.3.2.2 Element SPERRDATUM (Exclusion entry date)

XML Tag SPERRDATUM

XML Type t_sperrid

Property optional, max. 1 Element

Permitted values xs:date

Table 114: Element EIGENE_SPERREN_RESPONSE.SPERRE.SPERRDATUM

Definition:

The exclusion entry date is transmitted with this element.

Note:

It is recommended that by termination of an exclusion entry that the exclusion entry date be checked

to ensure that it is not premature.

19.3.2.3 Element SPERRGRUND (Reason for exclusion)

XML Tag SPERRGRUND


Property optional, maximal 1 element

Permitted values sb:t_sperrgrund

Table 115: Element EIGENE_SPERREN_RESPONSE.SPERRE.SPERRGRUND (Reason for exclusion)

Definition:

The type is specified in sperrsystemBasistypen.

19.3.2.4 Element VORNAME (First name)

XML Tag VORNAME

XML Type t_name



Permitted values String Latin character set in Unicode

Table 116: Element VORNAME

Definition:

This element transmits the first name of the better.



19.3.2.5 Element NACHNAME (Surname)

XML Tag NACHNAME

XML Type t_name

Property Pflichtfeld



Table 117: Element NACHNAME (Surname)

Definition:

This element transmits the surname of the betters.

19.3.2.6 Element GEBURTSNAME (Birth name)

XML Tag GEBURTSNAME

XML Type t_name

Property optional



Table 118: Element GEBURTSNAME (Birth name)

Definition:

This element transmits the birth name of the betters.

19.3.2.7 Element GEBURTSDATUM (Date of birth)

XML Tag GEBURTSDATUM

XML Type xs:string (Date in Format JJJJ-MM-TT, für Month and Day is

also "--" valid)


Table 119: Element GEBURTSDATUM (Date of Birth)

Definition:

This element transmits the date of birth of the better.

19.3.2.8 Element GEBURTSORT (City of birth)

XML Tag GEBURTSORT



XML Type t_name

Property optional



Table 120: Element GEBURTSORT (city of birth)

Definition:

This element transmits the city of birth of the better.

19.3.2.9 Group ANSCHRIFT (Address)

XML Tag ANSCHRIFT

XML Type t_anschrift_status bzw. t_anschrift

Property See section 6.1

Elements PLZ, ORT, STRASSE, HAUSNR, ADRESSZUSATZ,

LAND

Table 121: Group ANSCHRIFT (address)

Definition:

This element transmits the private address of the better.

19.3.2.9.1 Element ANSCHRIFT.PLZ (postal code)

XML Tag PLZ

XML Type t_nummer


Length maxima 20 characters

Permitted values String Latin character sset in Unicode

Table 122: Element ANSCHRIFT.PLZ (postal code)

Definition:

This element transmits the postal code of the private address of the better.

19.3.2.9.2 Element ANSCHRIFT.ORT (city)

XML Tag ORT

XML Type t_name






Table 123: Element ANSCHRIFT.ORT (city)

Definition:

This element transmits the city of the private address of the better.

19.3.2.9.3 Element ANSCHRIFT.STRASSE (Street)

XML Tag STRASSE

XML Type t_strasse




Table 124: Element ANSCHRIFT.STRASSE

Definition:

This element transmits the street of the private address of the better.

19.3.2.9.4 Element ANSCHRIFT.HAUSNR (number)

XML Tag HAUSNR

XML Type t_nummer


Length maximal 20 Characters


Table 125: Element ANSCHRIFT.HAUSNR (number)

Definition:

This element transmits the house number of the private address of the better.

19.3.2.9.5 Element ANSCHRIFT.ADRESSZUSATZ (addtional information)

XML Tag ADRESSZUSATZ

XML Type t_adresszusatz

Property optional

Length maximal 256 Characters




Table 126: Element ANSCHRIFT.ADRESSZUSATZ (addtional information)

Definition:

This element transmits addtional information for the private address of the better.

19.3.2.9.6 Element ANSCHRIFT.LAND (country)

XML Tag LAND

XML Type t_land


Length Exactly 3 Characters

Permitted values Numeric digits 0-9

Table 127: Element ANSCHRIFT.LAND (country)

Definition:

This element transmits the country where the better lives.

The table of country and territory codes issued by Destatis forms the basis of data entry for this ele-

ment. The three digit numeric code (Destatis BEV Code) is to be provided for the better. (see Staats-

angehoerigkeitsgebietsschluessel.pdf)

19.3.3 Group ANLASS (cause of exclusion)

XML Tag ANLASS


Property maximal 99 elements

Elements KENNUNG – mandatory 2-digit code from the cause of ex-

clusion catalog.



Table 128: Group ANLASS (cause of exclusion)

Definition:

An element from the catalog will be transmitted for each cause of exclusion.

XML

Tag Name

XML Type Properties Length Description


kennung






BEZEICH-

NUNG


Characters




interface








tries.

Example XML (EigeneSperrenResponse)


<tns:EIGENE_SPERREN_RESPONSE xmlns:tns="http://www.hzd.de/eigeneSperrenResponse">

<RESPONSE_STATUS>

<ART>I</ART>


<MELDUNG>Abfrage erfolgreich durchgeführt</MELDUNG>

</RESPONSE_STATUS>

<SPERRE>




<VORNAME>Klara</VORNAME>

<NACHNAME>Papp</NACHNAME>

<GEBURTSNAME>Hütchen</GEBURTSNAME>


<GEBURTSORT>Merseburg</GEBURTSORT>

<ANSCHRIFT>

<PLZ>12345</PLZ>

<ORT>Tilleda</ORT>

<STRASSE>Hauptstraße</STRASSE>

<HAUSNR>10</HAUSNR>

<LAND>000</LAND>

</ANSCHRIFT>

<ANLASS>


<BEZEICHNUNG>Suchtgefährdung</BEZEICHNUNG>

<SORTNR>1</SORTNR>

</ANLASS>

<ANLASS>


<BEZEICHNUNG>Finanzen</BEZEICHNUNG>

<SORTNR>2</SORTNR>

</ANLASS>

</SPERRE>

<SPERRE>

. . .

</SPERRE>

</tns:EIGENE_SPERREN_RESPONSE>

19.4 Response to Triggering a Batch 2.0 Job

The function ‚Triggering a Batch 2.0 Job‘ is defined using batchAnlegenResponse.xsd .



Overview:

XML-Root-Element BATCH_ANLEGEN_RESPONSE

XML Type t_batch_anlegen_response

Elements RESPONSE_STATUS

BATCH_ID

Table 130: Batch-Anlegen-Response


See Chapter Response-Status

19.4.1.1 Element BATCH_ANLEGEN_RESPONSE.BATCH_ID

XML Tag ART

XML Type t_batch_id

Property optional

Permitted values numeric

Permitted characters Numeric digits 0-9 (Pattern [\d]{1,9})

Notes This ID will be automatically generated from OASIS

Table 131: Element BATCH_ANLEGEN_RESPONSE.BATCH_ID

19.5 Retrieval Batch 2.0 Job Results

The Batch 2.0 results is delivered in compressed format (gzip) using XML conform Schema batchRe-

sponse.xsd.

Overview:

XML-Root-Element BATCHRESPONSE

XML Type t_batchresponse

Elements BATCH-ID

TIMESTAMP

ANZAHL-ERFOLGREICH-VERARBEITET

ANZAHL-NICHT-GESPERRT

ANZAHL-GESPERRT

ANZAHL-NICHT-EINDEUTIG



RESPONSE-STATUS

DS

Table 132: Batch-2.0-Response

19.5.1.1 Element BATCHRESPONSE.BATCH-ID

XML Tag ART

XML Type t_batch_id

Property optional

Zulässige Werte numerisch

Permitted values Numeric Digits 0-9 (Pattern [\d]{1,9})

Notes Diese ID wird von OASIS generiert

Table 133: Element BATCHRESPONSE.BATCH-ID

19.5.1.2 Element BATCHRESPONSE.TIMESTAMP

XML Tag TIMESTAMP

XML Type xs:dateTime


Notes The timestamp when the status of the Batchjob was set to

FINISHED.

Table 134: Element BATCHRESPONSE.TIMESTAMP

19.5.1.3 Element BATCHRESPONSE.ANZAHL-NICHT-GESPERRT

XML Tag ANZAHL-NICHT-GESPERRT

XML Type xs:integer


Notes The number of betters that do not have an exclusion list

entry.

Table 135: Element BATCHRESPONSE. ANZAHL-NICHT-GESPERRT

19.5.1.4 Element BATCHRESPONSE.ANZAHL-GESPERRT

XML Tag ANZAHL-GESPERRT



XML Type xs:integer


Notes The number of betters that do have an exclusion list entry.

Table 136: Element BATCHRESPONSE.ANZAHL-GESPERRT

19.5.1.5 Element BATCHRESPONSE.ANZAHL-NICHT-EINDEUTIG

XML Tag ANZAHL-NICHT-EINDEUTIG

XML Type xs:integer


Notes The number of betters for which more than one exclusion list

entry was found.

Table 137: Element BATCHRESPONSE. ANZAHL-NICHT-EINDEUTIG

19.5.1.6 Element BATCHRESPONSE. ANZAHL-ERFOLGREICH-VERARBEITET

XML Tag ANZAHL-ERFOLGREICH-VERARBEITET

XML Type xs:integer

Property Pflichtfeld

Notes The number of processed records.

Table 138: Element BATCHRESPONSE. ANZAHL-ERFOLGREICH-VERARBEITET


See Response Status

19.5.3 Group DS

The Group DS will not be returned in the response to the triggering of a Batch 2.0 job.

XML Tag DS

XML Type t_ds

Property optional

Elements DS-ID

FREITEXT



SPERRSYSTEM-MELDUNG

19.5.3.1 Element DS.DS-ID

XML Tag DS-ID

XML Type t_ds_id


Length

Permitted values

Notes This is the DS-ID that the requestor submitted.

In the batch response (also in responses with error!) the

”DS-ID” will returned with the same content with which it was

submitted so that the requestor can identify the data record.

Additionally, a DS-ID that does not conform to the schema

will also be returned in the response. Therefore, there are no

restrictions for field length and permitted values.

19.5.3.2 Element DS.FREITEXT

XML Tag FREITEXT

XML Type t_freitext

Property optional

Length

Permitted values

Notes This is is the text (FREITEXT) that the requestort submitted.

In the batch response (also in responses with error!) the

„Freitext“ will be returned with the same content with which it

was submitted so that the requestor can identify the data

record. Additionally, a “Freitext” that does not conform to the

schema will also be returned in the response. Therefore,

there are no restrictions for field length and permitted val-

ues.

19.5.3.3 Group SPERRSYSTEM-MELDUNG

This group is described in Group Sperrsytem Meldung

This group contains the response to the better query as described in Table of Responses.



19.6 Batch 2.0 Job Information


XML-Schema: batchJobsInfos.xsd

XML-Schema batchJobsInfos.xsd

XML-Root-Element BATCHJOBSINFOS

XML Type t_batchjobsinfos

Elements RESPONSE-STATUS

BATCHINFO



<tns:BATCHJOBSINFOS xmlns:tns="http://www.hzd.de/batchJobsInfos">

<RESPONSE-STATUS>

<ART>I</ART>


<MELDUNG> Die Abfrage wurde erfolgreich durchgeführt.</MELDUNG> </RESPONSE-STATUS>

<BATCHINFO>


<STATUS>COMPLETED</STATUS>

</BATCHINFO>

<BATCHINFO>


<STATUS>FINISHED</STATUS>

</BATCHINFO>

</tns:BATCHJOBSINFOS>


See Response Status

19.6.2 Group BATCHINFO

XML Tag BATCHINFO

XML Type t_batchinfo

Property optional

Elements BATCH-ID

STATUS

19.6.2.1 Element BATCH-ID

See Retrieval Batch 2.0 Job Results



19.6.2.2 Element STATUS

XML Tag STATUS

XML Type xs:string


Element Type xs:string with xs:enumeration

Permitted values WAITING, RUNNING, FINISHED, COMPLETED, CAN-

CELLED

19.7 Maintenance and Incident Messages

In case of a service disruption due to an incident or maintenance, Webservice-Requests will re-

ceive an XML response from OASIS conforming to the specification defined in the XML Schema

sperrsystemMeldung.

19.7.1 Maintenance

In case of a service disruption due to maintenance, Webservice-Responses (Sperrsystemeldung) will

contain a Response Type (Art) with the value I (Information) and a Key (Schlüssel) with the value

0052.

19.7.2 Incident

In case of a service disruption due to an incident, Webservice-Responses (Sperrsystemeldung) will

contain a Response Type (Art) with the value E (Error) and a Key (Schlüssel) with the value 0053.

19.8 Table of responses

The table of responses contains the following entries:

Key Type Response text

0001 E

„Sie haben keine Berechtigung“ oder „Sie haben keine Berechtigung (kein gülti-ges Zertifikat)“ Translation: „You are not authorised“ or „Your certificate is invalid“

0002 E

Ihr Zugang wurde gesperrt. Bitte wenden Sie sich an den Super-User. Als Su-per-User wenden Sie sich bitte an die Hotline (Tel 06652/1872212) Translation: „Your access has been inactivated. Please contact your Super-User. Super-Users should contact the hotline (Tel 06652/1872212).“

0003 E Es ist ein Serverfehler aufgetreten. Bitte wenden Sie sich an die Hotline (Tel 06652/1872212).. Translation: „A server error has occurred. Please contact the hotline (Tel



06652/1872212).“ “

0004 E

Änderung oder Beenden der Sperre ist nicht möglich: es wurde kein Sperrein-trag zum Spieler gefunden. Translation: „Modification/Termination of the exclusion list entry not possible: no entry found for this person“

0007 I

Die Person wurde mit Datum <TT.MM.JJJJ> erfolgreich gesperrt. Translation: „An exclusion list entry was successfully created for this person on <TT.MM.JJJJ>”

0008 E Sie haben keine Berechtigung diese Sperre zu ändern. Translation: „You are not authorised to modify this exclusion list entry“

0009 I Die Spielerdaten wurden am <TT.MM.JJJJ> erfolgreich geändert. Translation: „The better data were successfully modified on <TT.MM.JJJJ>

0010 E Sie haben keine Berechtigung diese Sperre zu beenden. Translation: „You are not authorised to terminate this exclusion list entry“

0011 I

Die Spielersperre wurde am <TT.MM.JJJJ> erfolgreich aufgehoben. Translation: „The exclusion list entry was successfully terminated on <TT.MM.JJJJ> “

0014 E Das XML ist nicht schemakonform. Translation: „XML does not conform to schema“

0015 E

Es ist ein Plausibilisierungsfehler aufgetreten. <Kontext zum Fehler, z.B. Na-chname zu lang> Translation: „A plausibility error has occurred. <Text describing the error, for example, Surname is too long>“

0016 E

Sie haben keine gültige Konzession/Erlaubnis.“ oder „Sie haben keinen Zugang zum System, da Ihre Konzession/Erlaubnis ruht.“ Translation: „You do not possess a valid concession/licence “or “Your conces-sion/licence is suspended.“

0017 I Die Konzession/Erlaubnis ist gültig. Translation: „The concession/licence is valid.“

0018 W Der Spieler ist gesperrt. Translation: „An exclusion list entry exists for the better.“

0019 I Der Spieler ist nicht gesperrt. Translation: „No exclusion list entry exists for the better.“

0020 I Das Passwort wurde erfolgreich geändert Translation: „The password was successfully modified.“ .

0021 E Sie dürfen den OASIS-Webservice nicht verwenden. Translation: „You are not permitted to use the OASIS web service.“

0022 E Sie dürfen den OASIS-Webclient nicht verwenden. Translation: „You are not permitted to use the OASIS web client.“

0023 W Der Spieler ist gesperrt. Es gab mehr als einen Treffer für Ihre Abfrage. Translation: „An exclusion list entry exists for the better. More than one entry



was found for your query.“

0024 W

Der Spieler ist gesperrt. Es gab mehr als einen Treffer für Ihre Abfrage. Translation: „An exclusion list entry exists for the better. More than one entry was found for your query.“

0040 E Die Daten werden gerade von einem anderen Benutzer geändert. Translation: „The data are currently being modified by another user.“

0041 W Sie müssen Ihr Initialpasswort ändern. Translation: „Please change your initial password.“

0042 I Der Benutzer wurde erfolgreich angelegt. Translation: „The user account was successfully created.“

0043 E

Passwortänderung fehlgeschlagen, da der angegebene Benutzer nicht bekannt ist. Translation: „Password modification unsuccessful,: user unknown.“

0044 E Für den angegebenen Benutzer dürfen Sie das Passwort nicht ändern. Translation: „You are not permitted to modify the password for this user.“

0045 E Das neue Passwort muss sich von dem bisherigen unterscheiden. Translation: „The new password must differ from the previous password.“

0046 E Für den angegebenen Benutzer dürfen Sie die Angaben nicht ändern. Translation: „You are not permitted to modify the data for this user.“

0047 I Die Angaben zum Benutzer wurden erfolgreich geändert. Translation: „User data successfully modified.“

0048 E

Änderung der Angaben zum Benutzer fehlgeschlagen, da der angegebene Be-nutzer nicht bekannt ist. Translation: „User data modification unsuccessful; user unknown.“

0049 I Die Abfrage wurde erfolgreich durchgeführt. Translation: „Query successfully executed.“

0050 I <Nummer der einheitlichen Programmversion> Translation: „<Version number>.“

0051 E

Ihre Zugangsberechtigung wurde deaktiviert-bitte wenden Sie sich an die Hotline (Tel 06652/1872212) Translation: „Your access rights have been deactivated. Please contact the hot-line (Tel. 06652/1872212).“

0052 I Derzeit werden geplante Wartungsarbeiten am OASIS-Service durchgeführt. Translation: „Planned maintenance work is currently in progress“

0053 E

Derzeit liegt eine Störung von OASIS vor. An der Entstörung wird derzeit gear-beitet. Translation: „The system is currently experiencing problems. These are being resolved at the moment.“

0054 W Die maximale Anzahl gleichzeitig laufender Batchabfragen ist erreicht. Bitte ver-suchen Sie es später nochmal. Translation: „The maximum concurrent number of batch queries has been



reached. Please try again later.“

0060 E

Einstellen von Batchanfragen: Übertragener Inhalt kann nicht in eine Batchan-frage konvertiert werden Translation: „Trigger Batch Job: Content cannot be converted for batch job“

0061 E Einstellen von Batchanfragen: Batch beinhaltet zu viele Datensätze Translation: „Trigger Batch Job: Batch contains too many records“

0062 E Einstellen von Batchanfragen: Identischer Batch wurde bereits beauftragt Translation: „Trigger Batch Job: Identical Batch has already been uploaded“

0063 E

Einstellen von Batchanfragen: Batch wurde nicht im korrekten Zeitfenster beauf-tragt Translation: „Trigger Batch Job: Batch has been uploaded in wrong timeslot“

0064 E

Einstellen von Batchanfragen: Betriebsstätte ist nicht berechtigt einen Batch zu beauftragen Translation: „Trigger Batch Job: You are not authorised to use Batch“

0065 E

Einstellen von Batchanfragen: Maximale Anzahl von Batches pro Zeitfenster überschritten Translation: „Trigger Batch Job: Maximal number of batch jobs in timeslot has been reached“

0066 E

Einstellen von Batchanfragen: Batchverarbeitung wurde aus betrieblichen Grün-den temporär gesperrt Translation: „Trigger Batch Job: Batch processing has been temporarily disab-led“

0070 E

Ergebnisse von Batchanfragen: Fehler bei der Verarbeitung eines Batch aufge-treten Translation: „Batch Job Results Retrieval: An error in the processing of batch job has occured“.

0071 E

Ergebnisse von Batchanfragen: Batchverarbeitung wurde manuell abgebrochen Translation: „Batch Job Results Retrieval: Batch job processing has been manu-ally cancelled“.

0072 E

Ergebnisse von Batchanfragen: Berechtigung zur Batchverarbeitung wurde ent-zogen Translation: „Batch Job Results Retrieval: You are no longer authorised to use Batch“ .

0073 E

Ergebnisse von Batchanfragen: Der Batch existiert nicht oder nicht mehr Translation: „Batch Job Results Retrieval: Batch job does not exist or doesn’t exist anymore“

0074 E

Ergebnisse von Batchanfragen: Das Ergebnis steht nicht mehr zur Verfügung, da es bereits am <TT.MM.JJJJ hh:mm:ss> abgeholt wurde Translation: „Batch Job Results Retrieval: The batch results are no longer available, because they were downloaded on <<TT.MM.JJJJ hh:mm:ss> “

0075 E

Ergebnisse von Batchanfragen: Der Batch befindet sich noch in Bearbeitung. Das Ergebnis liegt noch nicht vor Translation: „Batch Job Results Retrieval: The batch job is still running. The batch results are not yet available“



0076 E

Ergebnisse von Batchanfragen: Der Batch wurde noch nicht begonnen Translation: „Batch Job Results Retrieval: Processing of the batch job has not yet started. “

0077 I Einstellen von Batchanfragen: Die Batchabfrage wurde erfolgreich hochgeladen Translation: „Trigger Batch Job: The batch job has been successfully uploaded.“

0078 I Ergebnisse von Batchanfragen: kein Fehler aufgetreten Translation: „Batch Job Results Retrieval: No error “

0079 W

Ergebnisse von Batchanfragen: Batchabfrage mit Warnungen beendet Translation: „Batch Job Results Retrieval: The batch processing has been com-pleted with a warning.“

0080 E

Ergebnisse von Batchanfragen: Batchabfrage mit Fehlern beendet Translation: „Batch Job Results Retrieval: The batch processing has been com-pleted with errors.“

0081 E

Einstellen von Batchanfragen: Hochgeladene Datei konnte nicht als gzip ent-packt werden Translation: „Trigger Batch Job: The batch file could not be unzipped with gzip“

Table 139: Table of response keys

Notes:

The table of response keys may be subject to further minor modifications. The existing response keys

together with their type and meaning will not be changed. The text of the responses may change and

additional responses may be added.

20. Rights and Roles in OASIS WS


20 Rights and Roles in OASIS WS

Roles

OASIS WS Functionality - rights St

atu

s

tran

slit

eri

ert

ab

frag

en

eig

en

e S

pe

rre

n a

ufl

iste

n

Eige

ne

Sp

err

en

mit

Par

ame

tern

ab

frag

en

Eige

ne

Sp

err

en

anh

and

Sp

err

ID a

bfr

agen

Ä

hn

lich

keit

ssu

che

mit

Par

ame

tern

Sp

erre

än

de

rn

üb

er S

pe

rrID

Sper

re a

nle

gen

Sper

re b

ee

nd

en

üb

er S

pe

rrID

isA

live

Ab

frag

e

eige

ne

Ko

nze

ssio

n p

rüfe

n

Län

der

kata

log

ho

len

Eige

ne

s P

assw

ort

än

der

n

aktu

elle

Rel

ease

nu

mm

er

abfr

agen

Bat

chve

rarb

eitu

ng

Aku

tmel

du

nge

n

lese

n

Write access x x x x x x x x x x x x x Optional x

Read access x - - - - - - - x x x x x Optional x

21 Modifications with respect to Version 1.0

Version 1.1 of this document contains the following significant differences with respect to the previous

Version 1.0:

XML Schemas have been given a version number (1.1) and the Attribute elementFormDefault

now has the value „unqualified“ in order to simplify processing. For the same reason a

seoarate XML Schema for „String.Latin“ has been introduced.

The following functions were added to th OASIS Web service: „Load country table“, „Modify

password“ and „Verify permissions“.

Mandatory elements of better personal data depend on the context in which the data is trans-

ferred (Identification/Query of a better vs. Creation of a new exclusion list entry). The number

of elements required for a query have been reduced with respect to Version 1.0.

The meanings of the groups SPIELER und SPIELER-NEU have altered.

The following new elements have been added to the exclusion system response: Response

Type and betting organisation data.


The data type and permitted contents of the birthdate have been modified.

Name at birth (Spieler/Spieler-Neu) is now mandatory

23. Modifications with respect to Version 1.2


Reason for exclusion is only mandatory when creating a new entry

The table of country codes has been updated.

The table of response keys has been updated.


The naming convention for the interface specification has been modified to ensure it matches

with the matching OASIS release number.

Chapter 2 new XML Schemas

Chapter 2 new interface functions

Chapter 4 sperrsystemBasistypen.xsd extended

Chapter 7 split into Chapter 7 and 8, introduction of Exclusion list entry ID

Chapter 9 additional description of the Query using ID

Chapter 10 Description of queries in own exclusion list

Chapter 11 Description of queries in own exclusion list with parameters

Chapter 15 Description of the updated Exclusion system response from OASIS

Header and Footer modified

„Concession“ modified to „Licence“

Corrections


Chapter 2 Table of interface functions extended

Chapter 5.1.2 removed

Chapter 10/11 consolidated

Chapter 9.2 relocated to Chapter 10

Chapter 14 " Check availability" added

Chapter 15 " Query release number“ added



Chapter 17 Table of responses updated


Chapter 2 – Interface functions and XML Schemas:

o „Modify an exclusion using better personal data“ und „Terminate an exclusion using

better personal data“ removed

o Table 2: Sorted by chapter

o Addition of new functions: „Similarity search using parameters“ and „Similarity Search“

Chapter 3– Character Set

o New chapter: 3.1.1 Alphabetic characters

o New chapter: 3.1.2 Numeric characters

o New chapter: 3.1.3 Special characters

Chapter 7 Create exclusion list entry

o New chapter: Permitted characters fort he creteion of an exclusion list entry

Chapter 8 – Modify/terminate an exclusion list entry:

o DEPRECATED functions removed (Former section 8.1 „Modify/terminate an exclusion

list entry using better personal data“

o New chapter: Permitted characters for a status query

Chapter 9 – Global Queries

o New chapter 9.1.1.3 Permitted characters for a status query

Chapter 10 – Organisation-based Queries

o New Chapter 10.3 Similarity search in own exclusion list with parameters

Chapter 18.4.6 Table of responses

o Table of responses updated.

o Response 001 kann be issued with additional parameter „No valid certificate found“




Chapter 7.1 Overview: Terminate an exclusion list entry using ID

o Neues XML Element: SPERRGRUND_NEU

Chapter 16 Batchabfrage

o New interface function

Table of responses

o ID 12 and ID 13 removed


Chapter 7.1

o exact better status query in OASIS marked as DEPRECATED

Chapter 7.1.2

o Modification: multiple entries now possible

Chapter 10.2

o Query own exclusion list using parameters marked as DEPRECATED

Chapter 16.2

o Extension of pattern in the batch response

Chapter 17

o New chapter „Current Information“ added

Chapter 18.5.6

o Table of responses updated: Text for response 23 modified

o Response 51 added


Chapter 2.2:: Reference to Content-Type added

Chapter 4.1.1: Password minimum Length 8 characters, maximum 16 Characters



Chapter 5.2.2: Password minimum Length 8 characters, maximum 16 Characters

Chapter 8: The function „Query the exclusion list status of a better” (Function 4 – see Section

2.2) is implemented within OASIS using the similarity search function. The interface method

for the function „Query the exclusion list status of a better” (Function 4 – see Section Chapter

2.2) will no longer exist in future OASIS versions and is therefore marked as deprecated.

Chapter 9.1: Better Status Query (Function 4 – see Chapter 2.2) [DEPRECATED]

Chapter 21.6: Maintenance and Incident Messages: new

Chapter 21.7.1: new

Chapter 21.7.2 : new

Chapter 18.6 – Table of responses extended

o New Response 0051 added




Chapter 19 - Rights and Roles in OASIS WS: new


Chapter 2.2: 4 new interface functions were inserted. 3 interface functions were labelled as

deprecated.

Exact character match search for better has been removed (Spielerstatusabfrage)

Chapter 4.1.1: new Basic data types t_anlass_sperre_kennung und

t_anlass_sperre_bezeichnung

Chapter 4.1.2: new Basic data type t_anlass_sperre

Chapter 7.1: former interface functions have been labelled as deprecated. Cause of Exclusion

has been integrated into existing interface function.

Chapter 8.1: existing interface function has been labelled as deprecated

Chapter 9: Description of new interface functions for creation, change and termination of an

exclusion list entry.

Chapter 16: 3-digit territory codes (formerly country codes) will be used for the better’s per-

sonal address.



Chapter 17: Description for the retrieval the catalog table „Sperranlässe“ (Cause of Exclusion)

Chapter 19: New chapter for Batch 2.0

Chapter 21.4: Group SPERRSYSTEM-MELDUNG inherits the simple data types

t_meldungsart, t_meldung_schluessel and t_meldung_text from the Sperrsystem-Basic types.

New group ANLASS in the group SPERRINFO

Chapter 21.6: additional entries to the Table of responses for Batch 2.0

Chapter 23: Reference for the XML-Schemas sperreAnlegen.xsd, sperreAendern.xsd, sper-

reAufheben.xsd and sperranlaesse.xsd

Chapter 23: Reference to the XML-Schemas batchResponse.xsd, batchJobsInfos.xsd

Chapter 21: replaced <p1> in Table of responses with text

Chapter 12.1: modified note to new passwort


Chapter 2.2: New URLs for Batch 2.0: OASISBATCHWS replaces OASISWS

Chapters 21.2, 21.5 and 21.6: The XML element <RESPONSE_STATUS> was changed to

<RESPONSE-STATUS> in batchAnlegenResponse.xsd, batchResponse.xsd and batchJob-

sInfos.xsd

Chapters 19.2.2 and 21.5: The XML element <BATCH_ID> was changed to <BATCH-ID> in

the „Response to the Retrieval of Batch 2.0 Job Results“ (batchAnlegenResponse.xsd,

batchResponse.xsd, batchJobsInfos.xsd)

Chapters 19.2.2 and 21.5: The Content-Type for „Response to the Retrieval of Batch 2.0 Job

Results“ was changed from application/zip to application/gzip.

Chapter 19.1.1.2: Restriction of DS-ID

Chapter 19.2.2: added Response-Codes

Chapter 21.5.3.1: added notes for XML-Element <DS-ID> in „ Retrieval Batch 2.0 Job Re-

sults’

Chapter 21.5.3.2: added notes for XML-Element <Freitext> in „ Retrieval Batch 2.0 Job Re-

sults’




Removal of deprecated sperrIdAbfrage.xsd

Removal of deprecated functions:

o Create an exclusion list entry <server>/oasisws/rest/oasis/sperre/anlegen

o Modify an exclusion list entry using its ID <serv-

er>/oasisws/rest/oasis/sperriddaten/aendern

o Query own exclusion list <server>/oasisws/rest/oasis/eigenesperrenabfrage

o Query own exclusion list (with parameters) <serv-

er>/oasisws/rest/oasis/eigenesperrenabfrage/mitparametern

o Similarity search in own exclusion list with parameters <serv-

er>/oasisws/rest/oasis/aehnlichkeitssuche/mitparametern

o Query own exclusion list using ID <server>/oasisws/rest/oasis/sperridabfrage

The Content-Type and Content-Length must be specified in the HTTP-Header.


Removal of deprecated Batch 1.0 function

The use of some of the special characters requires xml-notation (Chapter 3.1.3)