OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS...

107
OASIS Beschreibung OASIS-Webservice OASIS Version 4.6 Veröffentlicht am 02.11.2017

Transcript of OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS...

Page 1: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

OASIS

Beschreibung OASIS-Webservice

OASIS Version 4.6

Veröffentlicht am 02.11.2017

Page 2: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

1. Zusammenfassung

OASIS Schnittstellenbeschreibung Seite 2

Inhaltsverzeichnis

Zusammenfassung ............................................................................................................ 7 1

Schnittstellenfunktionen und XML-Schema .................................................................... 8 2

2.1 XML Schemata .............................................................................................................. 8

2.2 Schnittstellenfunktionen .............................................................................................. 10

2.3 HTTP-Header Spezifikation ......................................................................................... 13

Verwendeter Zeichensatz................................................................................................ 13 3

3.1 Erlaubte Zeichen ......................................................................................................... 13

3.1.1 Buchstaben ...................................................................................................................14

3.1.2 Ziffern ...........................................................................................................................15

3.1.3 Sonderzeichen ..............................................................................................................15

OASIS Basistypen ........................................................................................................... 15 4

4.1 Übersicht Basistypen ................................................................................................... 16

4.1.1 Einfache Typen im Schema sperrsystemBasistypen.xsd ............................................16

4.1.2 Komplexe Typen im Schema sperrsystemBasistypen.xsd ..........................................17

Authentisierung und Autorisierung einer Anfrage an den OASIS-Webservice........... 19 5

5.1 Feldgruppe AUTHENTISIERUNG ............................................................................... 19

5.2 Feldgruppe AUTHENTISIERUNG.VERANSTALTER .................................................. 19

5.2.1 Feld AUTHENTISIERUNG.VERANSTALTER.KENNUNG ..........................................20

5.2.2 Feld AUTHENTISIERUNG.VERANSTALTER.PASSWORT........................................20

5.2.3 Feld AUTHENTISIERUNG.BENUTZER.......................................................................21

Übermittlung von Spielerdaten....................................................................................... 21 6

6.1 Übersicht über die Pflichtattribute eines Spielers bei verschiedenen Aktionen ............ 22

6.2 Feldgruppen SPIELER und SPIELER-NEU ................................................................. 22

6.2.1 Feld VORNAME ...........................................................................................................23

6.2.2 Feld NACHNAME .........................................................................................................24

6.2.3 Feld GEBURTSNAME ..................................................................................................25

6.2.4 Feld GEBURTSDATUM ...............................................................................................25

6.2.5 Feld GEBURTSORT.....................................................................................................26

6.2.6 Feldgruppe ANSCHRIFT ..............................................................................................26

Page 3: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

1. Zusammenfassung

Seite 3 OASIS Schnittstellenbeschreibung

Beenden einer Spielersperre .......................................................................................... 29 7

7.1 Beenden einer Sperre anhand der SperrID ................................................................. 29

7.1.1 Feldgruppe AUTHENTISIERUNG ................................................................................30

7.1.2 Feld N-ART ...................................................................................................................30

7.1.3 Feld SPERRGRUND ....................................................................................................31

7.1.4 Feld SPERRID ..............................................................................................................31

Anlegen und Ändern einer Spielersperre 4.0 ................................................................ 32 8

8.1 Anlegen einer Spielersperre 4.0 .................................................................................. 32

8.1.1 Feldgruppe AUTHENTISIERUNG ................................................................................32

8.1.2 Feld SPERRGRUND ....................................................................................................32

8.1.3 Feldgruppe SPIELER ...................................................................................................33

8.1.4 Feldgruppe ANLASS ....................................................................................................34

8.1.5 Antwort auf Anlegen einer Spielersperre 4.0 ...............................................................37

8.2 Ändern einer Spielersperre 4.0 .................................................................................... 37

8.2.1 Feldgruppe AUTHENTISIERUNG ................................................................................38

8.2.2 Feld SPERRID ..............................................................................................................38

8.2.3 Feld SPERRGRUND ....................................................................................................38

8.2.4 Feldgruppe SPIELER ...................................................................................................39

8.2.5 Feldgruppe ANLASS ....................................................................................................40

8.2.6 Antwort auf Ändern einer Spielersperre 4.0 .................................................................43

Abfrage des Spielerstatus in OASIS .............................................................................. 43 9

9.1 Ähnlichkeitsabfrage ..................................................................................................... 44

9.1.1 Übersicht Spielerstatusabfrage ....................................................................................44

9.1.2 Feldgruppe AUTHENTISIERUNG ................................................................................44

9.1.3 Feldgruppe SPIELER ...................................................................................................44

9.1.4 Erlaubte Zeichen für die Abfrage des Spielerstatus .....................................................44

9.1.5 Ergebnis einer Ähnlichkeitsabfrage und Spielerstatusabfrage ....................................45

Eigene Sperren .............................................................................................................. 45 10

10.1 Eigene Sperren abfragen 4.0 ...................................................................................... 46

10.1.1 OASIS 4.0 eigene Sperren abfragen............................................................................46

10.1.2 Antwort auf eigene Sperren abfragen 4.0 ....................................................................48

10.2 Eigene Sperren abfragen mit Parametern 4.0 ............................................................. 49

10.2.1 OASIS 4.0 eigene Sperren abfragen mit Parametern ..................................................49

10.2.2 Antwort auf eigene Sperren abfragen mit Parametern 4.0 ..........................................51

10.3 Eigene Sperren abfragen mit SperrID 4.0 .................................................................... 52

10.3.1 OASIS 4.0 eigene Sperren abfragen mit SperrID ........................................................52

Page 4: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

1. Zusammenfassung

OASIS Schnittstellenbeschreibung Seite 4

10.3.2 Antwort auf eigene Sperren abfragen mit SperrID 4.0 .................................................54

Passwort ändern ........................................................................................................... 55 11

11.1 Übersicht ..................................................................................................................... 55

11.2 Feldgruppe AUTHENTISIERUNG ............................................................................... 55

11.3 Feld PASSWORT-NEU ............................................................................................... 55

11.4 Feld ZIELOBJEKT ....................................................................................................... 56

Erlaubnis prüfen ............................................................................................................ 57 12

Verfügbarkeit prüfen ..................................................................................................... 57 13

Releasenummer abfragen ............................................................................................. 58 14

Länderkatalog laden ...................................................................................................... 58 15

15.1 Länderkatalog ............................................................................................................. 59

15.1.1 Feld KATALOGNAME ..................................................................................................59

15.1.2 Feldgruppe KATALOGITEM .........................................................................................60

Katalog Sperranlässe holen ......................................................................................... 60 16

16.1 Authentisierung ........................................................................................................... 61

16.2 Katalog Sperranlässe .................................................................................................. 61

16.2.1 Feldgruppe ANLASS ....................................................................................................61

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

17.1 Einstellen einer Batch 2.0 Abfrage (Request) .............................................................. 64

17.1.1 Einstellen einer Batch 2.0 Abfrage ...............................................................................64

17.1.2 Antwort auf das Einstellen einer Batch 2.0 Abfrage (Batch-Response) .......................68

17.2 Abholen eines Batch 2.0 Jobs-Ergebnisses ................................................................ 68

17.2.1 Abholen eines Batch 2.0 Ergebnisses..........................................................................68

17.2.2 Antwort auf das Abholen eines Batch 2.0 Ergebnisses ...............................................69

17.3 Statusabfrage eines Batch 2.0 Jobs ............................................................................ 71

17.3.1 Abfrage der Status der Batch-2.0-Jobs ........................................................................72

17.3.2 Antwort auf Abfrage der Status der Batch-2.0-Jobs .....................................................72

Page 5: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

1. Zusammenfassung

Seite 5 OASIS Schnittstellenbeschreibung

Aktuelle Informationen .................................................................................................. 72 18

18.1 Anfrage 73

18.2 Antwort 73

18.2.1 Feldgruppe SPERRSYSTEM-MELDUNG ....................................................................73

18.2.2 Feldgruppe INFORMATION .........................................................................................73

Antworten aus OASIS ................................................................................................... 76 19

19.1 Sperrsystem-Meldung ................................................................................................. 76

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

19.1.2 Feldgruppe SPERRINFO .............................................................................................78

19.1.3 Feldgruppe BESITZER .................................................................................................80

19.1.4 Feldgruppe ANLASS ....................................................................................................81

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

19.2.1 Feldgruppe RESPONSE-STATUS ...............................................................................83

19.3 Eigene-Sperren-Response .......................................................................................... 84

19.3.1 Feldgruppe RESPONSE_STATUS ..............................................................................84

19.3.2 Feldgruppe EIGENE_SPERREN_RESPONSE.SPERRE ...........................................85

19.3.3 Feldgruppe ANLASS ....................................................................................................90

19.4 Batch-Anlegen-Response............................................................................................ 92

19.4.1 Feldgruppe RESPONSE-STATUS ...............................................................................92

19.5 Batch 2.0 Abholen des Batch-Ergebnisses .................................................................. 93

19.5.2 Feldgruppe RESPONSE-STATUS ...............................................................................95

19.5.3 Feldgruppe DS .............................................................................................................95

19.6 Batch 2.0 Informationen über die Batchjobs ................................................................ 96

19.6.1 Feldgruppe RESPONSE-STATUS ...............................................................................97

19.6.2 Feldgruppe BATCHINFO .............................................................................................97

19.7 Wartungs- und Störungsmeldungen ............................................................................ 98

19.7.1 Wartung ........................................................................................................................98

19.7.2 Störung .........................................................................................................................98

19.8 Meldungskatalog ......................................................................................................... 98

Rechte und Rollen in OASIS WS ................................................................................ 100 20

Änderungen gegenüber Version 1.0 .......................................................................... 101 21

Änderungen gegenüber Version 1.1 .......................................................................... 101 22

Page 6: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

1. Zusammenfassung

OASIS Schnittstellenbeschreibung Seite 6

Änderungen gegenüber Version 1.2 .......................................................................... 101 23

Änderungen gegenüber Version 1.8 .......................................................................... 102 24

Änderungen gegenüber Version 2.0 .......................................................................... 102 25

Änderungen gegenüber Version 3.0 .......................................................................... 103 26

Änderungen gegenüber Version 3.2 .......................................................................... 104 27

Änderungen gegenüber Version 3.4 .......................................................................... 105 28

Änderungen gegenüber Version 3.6 .......................................................................... 105 29

Änderungen gegenüber Version 4.0 .......................................................................... 106 30

Änderungen gegenüber Version 4.2 .......................................................................... 107 31

Änderungen gegenüber Version 4.4 .......................................................................... 107 32

Page 7: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

1. Zusammenfassung

Seite 7 OASIS Schnittstellenbeschreibung

Zusammenfassung 1

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

Glücksspielstaatsvertrages (GlüStV),

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

Hessischen Spielhallengesetzes (HSpielhG),

der beim Zugriff auf OASIS zu verwenden ist.

Sofern im Dokument Änderungen gegenüber der Vorgänger-Version vorgenommen werden, werden

sie im Text gelb markiert. Dies soll der einfacheren Lesbarkeit des Dokuments im Abgleich mit der

Vorgänger-Version dienen. Eine Zusammenfassung der aktuellen Änderungen je Version ist im letzten

Kapitel des Dokuments aufgelistet.

Die Versionsnummer des vorliegenden Dokuments richtet sich nach der Releasenummer von OASIS,

in der die Schnittstellenspezifikationen umgesetzt sind.

Page 8: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

2. Schnittstellenfunktionen und XML-Schema

OASIS Schnittstellenbeschreibung Seite 8

Schnittstellenfunktionen und XML-Schema 2

Der OASIS-Webservice ist an REST angelehnt. Anfragen an den Webservice verlaufen via http und

enthalten im Content XML-Dateien. Zur Validierung der XML-Dateien liegen XML-Schemata vor. Ne-

ben der Validierung gegen die XML-Schemata wird an einzelnen Stellen noch weitergehend validiert.

Dies ist in der folgenden Beschreibung jeweils gesondert aufgeführt.

Die Reihenfolge der XML-Tags sind durch die XSD-Dateien definiert.

Der OASIS-Webservice ist zustandslos und arbeitet synchron.

2.1 XML Schemata

Das verwendete XML wird durch folgende XML-Schemata definiert:

Nr. Name der Datei Bemerkung

1 authentisierung.xsd XML-Schema zum Prüfen der Berechtigung des Zugriffs auf

OASIS

2 batchAnlegen.xsd XML-Schema für das Einstelen eines Batch 2.0 Jobs. Inhalt des

XML als gzip.

3 batchAnlegenResponse.xsd Antwort auf das Anlegen eines Batch 2.0 Jobs

4 batchBasistypen.xsd Definition von in batchAbfrage.xsd und bchtAntwort.xsd ver-

wendeten einfachen und zusammengesetzten Datentypen

5 batchJobsInfos.xsd XML-Schema für die Antwort auf eine Batch 2.0 Statusabfrage

(Abfrage des Status der eigenen Batch 2.0 Jobs)

6 batchResponse.xsd XML-Schema für das Ergebnis eines Batch 2.0 Jobs

7 charset.xsd charset für String-Latin aus XÖV

8 eigeneSperrenAbfragen.xsd XML-Schema für die Abfrage aller eigenen Sperren

9 eigeneSperrenAbfragenId.xsd XML-Schema für das Abfragen einer eigenen Sperre mit gege-

bener SperrID

10 eigeneSperrenAbfragenParameter.xsd XML-Schema für das Abfragen einer eigenen Sperre mit gege-

benen Suchparametern

11 eigeneSperrenResponse.xsd XML-Schema für die Abfrage eigener Sperren in 10, 11, 12

12 informationen.xsd XML-Schema für aktielle Informationen aus OASIS

13 katalog.xsd XML-Schema für einen Katalog aus OASIS (aktuell nur Ge-

bietskatalog)

14 latinchars.xsd Zeichensatz „Lateinische Zeichen in Unicode“, der durch KO-

Page 9: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

2. Schnittstellenfunktionen und XML-Schema

Seite 9 OASIS Schnittstellenbeschreibung

SIT als Standard für XÖV definiert wurde (siehe Kapitel 3)

Achtung: Das verwendete XML-Schema wurde dahingehend

modifiziert, dass das Schema-Attribut „elementFormDefault“

jetzt den Wert „unqualified“ hat.

15 passwortAenderung.xsd XML-Schema zum Ändern des Passworts

16 sperranlaesse.xsd XML-Schema der Sperranlässe

17 sperreAendern.xsd XML-Schema zum Ändern einer Sperre seit OASIS 4.0

18 sperreAnlegen.xsd XML-Schema zum Anlegen einer Sperre seit OASIS 4.0

19 sperrenPflege.xsd XML-Schema für das Ändern und Beenden einer Spielersperre

anhand der SperrID

20 sperrsystemBasistypen.xsd Definition von in mehreren anderen XML-Schemata verwende-

ten einfachen und zusammengesetzten Datentypen

21 sperrsystemMeldung.xsd XML-Schema für die Meldungen aus OASIS

22 spielersperrePflege.xsd XML-Schema für das Anlegen, Ändern und Beenden einer

Spielersperre

23 spielerstatusAbfrage.xsd XML-Schema für die Abfrage des Status eines Spielers in

OASIS

Tabelle 1: XML Schemata

Page 10: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

2. Schnittstellenfunktionen und XML-Schema

OASIS Schnittstellenbeschreibung Seite 10

2.2 Schnittstellenfunktionen

Folgende Tabelle zeigt die Schnittstellenfunktionen:

Funktion HTTP-

Verben URL

Nachrichten-

inhalt

(Content)

Rückgabe

(Content)

Kapitel

und

Ab-

schnitt

1.

Beenden

einer Spie-

lersperre

anhand

der Sper-

rID

POST <server>

/oasisws/rest/oasis/sperrid/beenden

Zum Schema

sperrenPflege.xsd

konformes XML

Zum Schema

sperrsystemMel-

dung.xsd konfor-

mes XML 7.1

2.

Abfrage

des Spie-

lerstatus in

OASIS

mittels

„translite-

rierter

Suche“

POST <server>

/oasisws/rest/oasis/aehnlichkeitsabfrage

Zum Schema

spielerstatusAb-

frage.xsd konfor-

mes XML

Zum Schema

sperrsystemMel-

dung.xsd konfor-

mes XML

9.1

3.

Passwort

ändern

POST <server>

/oasisws/rest/oasis/passwort/aendern

Zum Schema

passwortAende-

rung.xsd konfor-

mes XML

Zum Schema

sperrsystemMel-

dung.xsd konfor-

mes XML

11

4.

Erlaubnis

prüfen

POST <server>

/oasisws/rest/oasis/konzession/pruefen

Zum Schema

authentisie-

rung.xsd konfor-

mes XML

Zum Schema

sperrsystemMel-

dung.xsd konfor-

mes XML

12

5.

Verfügbar-

keit von

OASIS WS

abfragen

POST <server>

/oasisws/rest/oasis/verfuegbarkeitsabfra

ge

Zum Schema

authentisie-

rung.xsd konfor-

mes

Zum Schema

sperrsystemMel-

dung.xsd konfor-

mes XML

13

6.

Page 11: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

2. Schnittstellenfunktionen und XML-Schema

Seite 11 OASIS Schnittstellenbeschreibung

Release-

nummer

abfragen

POST <server>

/oasisws/rest/oasis/releasenummerabfr

age

Zum Schema

authentisie-

rung.xsd konfor-

mes XML

Zum Schema

sperrsystemMel-

dung.xsd konfor-

mes XML

14

7.

Länderka-

talog laden

POST <server>

/oasisws/rest/oasis/laenderkatalog/hole

n

Zum Schema

authentisie-

rung.xsd konfor-

mes XML

Zum Schema kata-

log.xsd konformes

XML 15

8.

Aktuelle

Informati-

onen

POST <server>

/oasisws/rest/oasis/abfragen/aktuelleinf

ormationen

Zum Schema

authentisie-

rung.xsd konfor-

mes XML

Zum Schema in-

formationen.xsd

konformes XML 18

9.

Sperre

anlegen

POST <server>

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

Zum neuen Sche-

ma sperreAnle-

gen.xsd konformes

XML

Zum Schema

sperrsystemMel-

dung.xsd konfor-

mes XML

8.1

10.

Sperre

ändern

POST <server>

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

Zum neuen Sche-

ma sperreA-

endern.xsd kon-

formes XML

Zum Schema

sperrsystemMel-

dung.xsd konfor-

mes XML

8.2

11.

Katalog

Sperran-

lässe holen

POST <server>

/oasisws/rest/oasis/abfragen/katalogsper

ranlass/4.0

Zum Schema

authentisie-

rung.xsd konfor-

mes XML

Falls keine Berech-

tigung, zum Sche-

ma sperrsystem-

Meldung.xsd kon-

formes XML, ande-

renfalls zum neuen

Schema sperranla-

esse.xsd konfor-

mes XML

16

12.

Alle eige-

nen Sper-

ren mit

Sperran-

lass abfra-

POST <server>

/oasisws/rest/oasis/abfragen/eigenesperr

en/4.0

Zum neuen

Schema „eigene-

SperrenAbfra-

gen.xsd“ konfor-

mes XML

Zum neuen Sche-

ma „eigeneSper-

renResponse.xsd“

konformes XML

10.1

Page 12: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

2. Schnittstellenfunktionen und XML-Schema

OASIS Schnittstellenbeschreibung Seite 12

gen

13.

Eigene

Sperren

mit Para-

metern

suchen

(translite-

riert)

POST <server>

/oasisws/rest/oasis/abfragen/eigenesperr

en/parameter/4.0

Zum neuen

Schema „eigene-

SperrenAbfra-

genParame-

ter.xsd“ konfor-

mes XML

Zum neuen Sche-

ma „eigeneSper-

renResponse.xsd“

konformes XML

10.2

14.

Eigene

Sperre mit

SperrID

abfragen

POST <server>

/oasisws/rest/oasis/abfragen/eigenesperr

en/id/4.0

Zum neuen

Schema „eigene-

SperrenAbfra-

genId.xsd“ kon-

formes XML

Zum neuen Sche-

ma eigeneSper-

renResponse.xsd

konformes XML

10.3

15.

Einstellen

einer

Batch 2.0

Anfrage

(Request)

POST <server>

/oasisbatchws/rest/oasis/anlegen/auftra

g/batch/4.0

2 neue HTTP-

Header-

Parameter:

OASIS_KENNUN

G, OASIS_PWD

sowie zum Sche-

ma batchAnle-

gen.xsd konformes

XML

Zum Schema

batchAnlegen-

Response.xsd

konformes XML

17.1

16.

Abholen

eines

Batch 2.0

Jobs-

Ergebnis-

ses

POST <server>

/oasisbatchws/rest/oasis/abfragen/auftr

ag/batch/4.0/[Batch-Id]

2 neue HTTP-

Header-

Parameter:

OASIS_KENNUN

G, OASIS_PWD.

Kein XML-Payload

Zum Schema bat-

chResponse.xsd

konformes XML 17.2

17.

Statusab-

frage eines

Batch 2.0

Jobs

POST <server>

/oasisbatchws/rest/oasis/abfragen/statu

s/batch/4.0

2 neue HTTP-

Header-

Parameter:

OASIS_KENNUN

G, OASIS_PWD.

Kein XML-Payload

Zum Schema

batchJobsInfos.xsd

konformes XML 17.3

Page 13: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

3. Verwendeter Zeichensatz

Seite 13 OASIS Schnittstellenbeschreibung

Tabelle 2: Schnittstellenfunktionen

Der Server <server> ist die publizierte Server-Adresse von OASIS.

2.3 HTTP-Header Spezifikation

Content-Type:

Request (Aufruf einer OASIS Schnittstellenfunktion) Content-Type: text/plain

Response (Antwort einer OASIS Schnittstellenfunktion) Content-Type: text/plain

[BATCH 2.0]

Request (Aufruf zum Einstellen eines neuen Batch 2.0 Jobs) Content-Type: application/gzip; charset=UTF-8

Response (Abholen eines Batch 2.0 Jobs-Ergebnisses) Content-Type: application/gzip; charset=UTF-8

Die Angaben zu Content-Type und Content- Length in dem HTTP-Header sind zwingend erfor-derlich.

Verwendeter Zeichensatz 3

Für die XML-Nachrichten ist als Encoding UTF-8 zu verwenden. Für einzelne Felder wird der Zeichen-satz auf den durch KOSIT in XÖV herausgegebenen Standard „Lateinische Zeichen in Unicode“ ein-geschränkt. Dieser Zeichensatz beinhaltet die lateinischen Zeichen aus Unicode einschließlich diakri-tischer Zeichen und Ligaturen.

Der Zeichensatz ist beschrieben im XML-Schema latinchars.xsd, welches in die XML-Schemata sperrsystemBasistypen.xsd, spielersperrePflege.xsd sowie spielerstatusAbfrage.xsd importiert wird.

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

3.1 Erlaubte Zeichen

Die erlaubten Zeichen sind die des Zeichensatzes String.Latin.

Page 14: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

3. Verwendeter Zeichensatz

OASIS Schnittstellenbeschreibung Seite 14

3.1.1 Buchstaben

Erlaubte Buchstaben sind [A-z] sowie:

À Á Â Ã à á â ã Ā ā Ă ă Ą ą Ǎ ǎ Ǟ ǟ Ǻ ǻ Ạ ạ Ẫ ẫ Ậ ª Ả ả Ấ ấ Ầ ầ Ắ ắ Ằ ằ Ẳ ẳ Ẵ ẵ Ặ ặ

Ä Æ ä æ Ǽ ǽ

Å å

Ḃ ḃ

Ç ç Ć ć Ċ ċ Č č

Ð ð Ď ď Đ đ Ḋ ḋ Ḑ ḑ D̂ d̂

È É Ê Ë è é ê ë Ē ē Ĕ ĕ Ė ė Ę ę Ě ě Ə ə ẽ Ễ ễ Ẹ ẹ Ẻ ẻ Ẽ Ề ề Ế ế Ệ ệ

Ḟ ḟ

Ğ ğ Ġ ġ Ģ ģ Ǥ ǥ Ǧ ǧ Ǵ ǵ Ḡ ḡ

Ħ ħ Ȟ ȟ Ḥ ḥ Ḧ ḧ

Ì Í Î Ï ì í î ï Ĩ ĩ Ī ī Ĭ ĭ Į į İ ı Ǐ ǐ Ị ị Ỉ ỉ

Ĵ ĵ ǰ J̌

Ķ ķ ĸ Ǩ ǩ Ḱ ḱ

Ĺ ĺ Ļ ļ Ľ ľ Ŀ ŀ Ł ł L̂ l̂

M̂ m̂ Ṁ ṁ

N̂ n̂ Ñ ñ Ń ń Ņ ņ Ň ň ʼn Ŋ ŋ Ṅ ṅ

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

Ö Ø ö ø Œ œ

Ṗ ṗ

Ŕ ŕ Ŗ ŗ Ř ř

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

ß ẞ

Ţ ţ Ť ť Ŧ ŧ Ț ț Ṫ ṫ

Þ þ

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

Ü ü

Ŵ ŵ Ẁ ẁ Ẃ ẃ Ẅ ẅ

Ẍ ẍ

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

Page 15: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

4. OASIS Basistypen

Seite 15 OASIS Schnittstellenbeschreibung

Ź ź Ż ż Ž ž Ẑ ẑ Ẓ ẓ

Abbildung 1: Diakritika und Ligaturen

3.1.2 Ziffern

0 1 2 3 4 5 6 7 8 9

Abbildung 2: numerische Zeichen

3.1.3 Sonderzeichen

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

Abbildung 3: Sonderzeichen

Hinweis: Einige Zeichen haben in einem XML-Dokument eine besondere Bedeutung und dürfen des-

halb NICHT so als Werte in einem XML Dokument auftauchen. Für dieses Zeichen müssen die XML-

Notation verwendet werden.

Zeichen XML-Notation

< &lt;

> &gt;

& &amp;

" &quot;

' &apos;

OASIS Basistypen 4

Im Folgenden werden die verwendeten Basistypen beschrieben.

Die Basistypen sind enthalten in der Datei sperrsystemBasistypen.xsd, die von den XML-Schemata

passwortAenderung.xsd, spielerstatusAbfrage.xsd sowie spielersperrePflege.xsd referenziert wird.

Page 16: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

4. OASIS Basistypen

OASIS Schnittstellenbeschreibung Seite 16

4.1 Übersicht Basistypen

4.1.1 Einfache Typen im Schema sperrsystemBasistypen.xsd

Typname im XML- Schema Datentyp Verwendung Einschränkungen

t_adresszusatz String.Latin in Spieleranschrift Maximal 256 Zeichen

t_kennung xs:string Benutzername eines

Veranstalters in OASIS.

Dieser wird durch OASIS

vergeben.

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

t_geburtsdatum xs:string Geburtsdatum eines

Spielers

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

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

t_land xs:string 3stelliger numerischer

Schlüssel für das Land

entsprechend dem durch

Destatis veröffentlichten

Länderkatalog. Der Kata-

log wird durch den

OASIS-Webservice als

XML bereitgestellt

([0-9]{3})?

t_nachrichtenart xs:string-

basierte

Enumeration

Spezifiziert für eine

SperrsystemPflege-

Nachricht die Art: Z =

Zugang, V = Änderung, B

= Beenden

[ZVB]

t_name String.Latin Datentyp für Vorname,

Nachname, Geburtsna-

me, Geburtsort und Woh-

nort eines Spielers

Maximal 85 Zeichen

t_passwort xs:string Datentyp für ein Passwort

in OASIS.

Mindestens 8, höchstens

16 Zeichen

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

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

t_plz_hausnummer String.Latin Datentyp für die Postleit-

zahl bzw. die Hausnum-

mer der Anschrift eines

Spielers

Maximal 20 Zeichen

t_sperrgrund xs:string-

basierte

Enumeration

Grund der Sperre; erlaubt

sind nur SELBST und

FREMD

FREMD, SELBST

Page 17: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

4. OASIS Basistypen

Seite 17 OASIS Schnittstellenbeschreibung

t_sperrid xs:integer Datentyp für die SperrID,

die automatisch generiert

wird und jede Sperre

eindeutig referenziert

[Integer]

t_strasse String.Latin Datentyp für die Straße

der Anschrift eines Spie-

lers

Maximal 150 Zeichen

t_anlass_sperre_kennung xs:string Fachlicher Schlüssel für

einen Sperranlass

[0-9]{2}

t_anlass_sperre_bezeichnung String.Latin Bezeichnung des Sper-

ranlasses

Maximal 150 Zeichen

t_benutzer xs:string 3stellige numerische Mit-

arbeiterkennung. 000 ist

Superuser WS, 001 ist

Superuser WEB.

[0-9]{3}

t_meldungsart xs:string-

basierte

Enumeration

Meldet, ob die Anfrage an

OASIS erfolgreich war.

I, W, E

t_meldung_schluessel [0-9]{4} Gibt den eindeutigen

Schlüssel zur Meldung an

4 Ziffern

t_meldung_text xs:string Gibt die Meldung in Text-

form an, die durch

<t_meldung_schluessel>

festgelegt ist

Mindestens 1 Zeichen,

höchstens 4000 Zeichen

Abbildung 4: Einfache Typen im Schema sperrsystemBasistypen.xsd

4.1.2 Komplexe Typen im Schema sperrsystemBasistypen.xsd

Typ im Schema enthaltene Elemente Verwendung

t_anschrift PLZ

ORT

STRASSE

HAUSNR

ADRESSZUSATZ

LAND

Vollständige Wohnanschrift eines Spielers; erforder-

lich beim Eintragen und Ändern einer Spielersperre;

alle Elemente bis auf ADRESSZUSATZ sind Pflicht-

felder (s.u.)

t_anschrift_status PLZ

ORT

Wohnanschrift eines Spielers, die bei einer Abfrage

des Spielerstatus erforderlich ist; kein Element ist

Pflichtfeld bei einer Spielerstatusabfrage (s.u.)

Page 18: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

4. OASIS Basistypen

OASIS Schnittstellenbeschreibung Seite 18

STRASSE

HAUSNR

ADRESSZUSATZ

LAND

t_authentisierung VERANSTALTER

BENUTZER

ein Veranstalter und ein dem Veranstalter zugeord-

neter Benutzer (=Mitarbeiter) des OASIS - Webser-

vice.

t_berechtigter KENNUNG

PASSWORT

Logindaten eines Berechtigten des OASIS-

Webservice

t_spieler VORNAME

NACHNAME

GEBURTSNAME

GEBURTSDATUM

GEBURTSORT

ANSCHRIFT

Daten eines Spielers, die zum Eintragen bzw. Än-

dern einer Sperre in OASIS erforderlich sind; alle

Elemente sind Pflichtfelder bei diesen beiden Aktio-

nen

t_spieler_status VORNAME

NACHNAME

GEBURTSNAME

GEBURTSDATUM

GEBURTSORT

ANSCHRIFT

Daten eines Spielers, die zur Identifizierung einer

Sperre erforderlich sind; nur die Elemente VOR-

NAME, NACHNAME und GEBURTSDATUM sind

Pflichtfelder bei diesen Aktionen

t_anlass_sperre KENNUNG

BEZEICHNUNG

SORTNR

Daten eines Sperranlasses. KENNUNG ist ein

zweistelliger fachlicher Schlüssel. BEZEICHNUNG

ist die Bezeichnung des Sperranlasses. SORTNR

ist eine Sortiernummer, die für eine Anzeige in ei-

nem grafischen Userinterface verwendet werden

kann.

KENNUNG ist ein Pflichtfeld, BEZEICHNUNG und

SORTNR sind optional. Beim Abfragen des Kata-

logs Sperranlässe werden beide Felder gefüllt zu-

rückgegeben.

t_response_status ART

SCHLUESSEL

MELDUNG

Daten eines Responsestatus für die neuen Schnitt-

stellenfunktionen. Inhalte entsprechen den im Mel-

dungskatalog enthaltenen Einträgen.

Page 19: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

5. Authentisierung und Autorisierung einer Anfrage an den OASIS-Webservice

Seite 19 OASIS Schnittstellenbeschreibung

t_logindaten KENNUNG

PASSWORT

BENUTZER

Anmeldedaten OASIS 4.0.

Abbildung 5: Komplexe Typen im Schema sperrsystemBasistypen.xsd

Authentisierung und Autorisierung einer Anfrage 5

an den OASIS-Webservice

Jeder Aufruf der in Kapitel 2 beschriebenen Schnittstellenfunktionen wird durch den OASIS-

Webservice autorisiert. Daher enthalten alle XML-Schemata eine Authentisierungsgruppe. Diese wird

in diesem Kapitel beschrieben.

5.1 Feldgruppe AUTHENTISIERUNG

XML-Tag AUTHENTISIERUNG

XML-Typ t_authentisierung

Eigenschaft Pflichtgruppe für die Schnittstellenfunktionen Eintrag einer

Sperre, Ändern einer Sperre, Beenden einer Sperre, Abfrage

des Spielerstatus, Laden des Länderkatalogs, Passwort än-

dern sowie Erlaubnis prüfen.

Elemente VERANSTALTER

BENUTZER

Tabelle 3: Feldgruppe AUTHENTISIERUNG

5.2 Feldgruppe AUTHENTISIERUNG.VERANSTALTER

XML-Tag VERANSTALTER

XML-Typ t_berechtigter

Eigenschaft Pflichtgruppe

Elemente KENNUNG

PASSWORT

Tabelle 4: Feldgruppe AUTHENTISIERUNG.VERANSTALTER

Page 20: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

5. Authentisierung und Autorisierung einer Anfrage an den OASIS-Webservice

OASIS Schnittstellenbeschreibung Seite 20

Definition:

Veranstalter sind juristische Personen, die eine gültige Erlaubnis zur Verwendung des OASIS-

Webservice haben. Sie erhalten eine generierte Kennung und ein generiertes initiales Passwort, wel-

che zur Authentisierung und Autorisierung verwendet werden. Das initiale Passwort kann mit der

Schnittstellenfunktion „Passwort ändern“ geändert werden. Dies wird seitens OASIS empfohlen.

5.2.1 Feld AUTHENTISIERUNG.VERANSTALTER.KENNUNG

XML-Tag KENNUNG

XML-Typ t_kennung

Feldeigenschaft Pflichtelement

Feldlänge Mindestens 1 Zeichen, höchstens 30 Zeichen

Zulässige Zeichen Großbuchstaben A-Z (ohne Umlaute) und Ziffern 0-9

Tabelle 5: Feld AUTHENTISIERUNG.VERANSTALTER.KENNUNG

Definition:

In diesem Feld wird die durch OASIS an die Veranstalter vergebene Kennung übermittelt.

Anmerkungen:

Anhand der Kennung und des Passworts erfolgt die Authentifizierung und Autorisierung des Veran-

stalters in OASIS.

5.2.2 Feld AUTHENTISIERUNG.VERANSTALTER.PASSWORT

XML-Tag PASSWORT

XML-Typ t_passwort

Feldeigenschaft optional

Feldlänge mindestens 8 Zeichen, höchstens 16 Zeichen

Zulässige Zeichen Buchstaben a-z, A-Z, Umlaute ä,Ä,ö,Ö,ü,Ü,ß,Ziffern 0-9,

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

Tabelle 6: Feld AUTHENTISIERUNG.VERANSTALTER.PASSWORT

Definition:

Page 21: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

6. Übermittlung von Spielerdaten

Seite 21 OASIS Schnittstellenbeschreibung

In diesem Feld wird das Passwort des Veranstalters übermittelt.

Plausibilitäten:

Obwohl das Feld im XML-Schema optional ist, wird es aktuell wie ein Pflichtfeld behandelt, d.h. es

wird durch den OASIS-Webservice geprüft, ob es vorhanden ist.

Anmerkungen:

Anhand der Kennung und des Passworts erfolgt die Authentifizierung und Autorisierung des Veran-

stalters in OASIS.

5.2.3 Feld AUTHENTISIERUNG.BENUTZER

XML-Tag BENUTZER

XML-Typ t_kennung

Feldeigenschaft optional

Feldlänge Mindestens 1 Zeichen, höchstens 30 Zeichen

Zulässige Zeichen Großbuchstaben A-Z (ohne Umlaute) und Ziffern 0-9

Tabelle 7: Feld AUTHENTISIERUNG.BENUTZER

Definition:

In diesem Feld wird die Kennung eines Mitarbeiters übertragen.

Anmerkungen:

Das Feld ist nur für die Anwendung OASIS WEB relevant und wird bei OASIS WS ignoriert.

Übermittlung von Spielerdaten 6

Beim Eintragen, Ändern und Beenden einer Sperre sowie beim Abfragen des Status eines Spielers in

OASIS werden Daten des Spielers zur Identifizierung und zum Erfassen benötigt.

Neu erfasste Spielerdaten müssen vollständig sein. Daten, die der Identifizierung eines Sperreintrags

dienen (z.B. Statusabfrage) müssen nicht vollständig sein. Daher wurden zwei verschiedene XML-

Typen definiert, die in diesem Kapitel beschrieben und in späteren Kapiteln referenziert werden.

Page 22: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

6. Übermittlung von Spielerdaten

OASIS Schnittstellenbeschreibung Seite 22

6.1 Übersicht über die Pflichtattribute eines Spielers bei verschiedenen Aktionen

Im folgenden Abschnitt werden die Daten und XML-Attribute eines Spielers beschrieben. Ob es sich

um Pflicht- oder optionale Felder handelt, kann der nachfolgenden Tabelle entnommen werden:

Attribute eines

Spielers

XML-Name Feldeigenschaft bei

Identifizierung

(Statusabfrage,

Ändern oder

Beenden einer Sper-

re)

Feldeigenschaft bei Erfassung

(Eintragen einer Sperre, neue

Spielerdaten beim Ändern einer

Sperre)

Vorname VORNAME Pflichtfeld Pflichtfeld

Nachname NACHNAME Pflichtfeld Pflichtfeld

Geburtsname GEBURTSNAME optional Pflichtfeld

Geburtsdatum GEBURTSDATUM Pflichtfeld Pflichtfeld

Geburtsort GEBURTSORT optional Pflichtfeld

Postleitzahl PLZ optional Pflichtfeld

Wohnort ORT optional Pflichtfeld

Straße STRASSE optional Pflichtfeld

Hausnummer HAUSNR optional Pflichtfeld

Adresszusatz ADRESSZUSATZ optional optional

Land LAND optional Pflichtfeld

Tabelle 8: Übersicht über die Pflichtattribute eines Spielers bei verschiedenen Aktionen

Die Daten des Spielers, die zur Identifizierung eines Sperreintrags benötigt werden, werden in der

Feldgruppe SPIELER übertragen. Diese hat den XML-Typ t_spieler_status (siehe Abschnitt 4.1.2).

Die Feldgruppe SPIELER.ANSCHRIFT hat den XML-Typ t_anschrift_status.

Die Daten, die beim Eintrag bzw. einer Änderung einer Sperre benötigt werden, werden in der Feld-

gruppe SPIELER-NEU übertragen. Diese hat den XML-Typ t_spieler (siehe Abschnitt 4.1.2) Die

Feldgruppe SPIELER-NEU.ANSCHRIFT hat den XML-Typ t_anschrift.

6.2 Feldgruppen SPIELER und SPIELER-NEU

SPIELER:

XML-Tag SPIELER

XML-Typ t_spieler_status

Page 23: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

6. Übermittlung von Spielerdaten

Seite 23 OASIS Schnittstellenbeschreibung

Elemente VORNAME, NACHNAME, GEBURTSNAME, GEBURTSDA-

TUM, GEBURTSORT, ANSCHRIFT

Tabelle 9: Feldgruppe SPIELER

SPIELER-NEU:

XML-Tag SPIELER-NEU

XML-Typ t_spieler

Elemente VORNAME, NACHNAME, GEBURTSNAME, GEBURTSDA-

TUM, GEBURTSORT, ANSCHRIFT

Tabelle 10: Feldgruppe SPIELER-NEU

Anmerkung:

Beide Feldgruppen unterscheiden sich lediglich hinsichtlich der Feldeigenschaften (Pflicht oder optio-

nal) voneinander. Daher werden die Elemente dieser Feldgruppen im Folgenden gemeinsam be-

schrieben und es wird hinsichtlich der Feldeigenschaften auf den Abschnitt 6.1 verwiesen.

Definition:

In diesen Feldgruppen werden die Daten eines Spielers übermittelt.

Erfassungsregeln:

Grundlage der Erfassung bildet der Identitätsnachweis des Spielers beim Veranstalter. Die in den

amtlichen Dokumenten nicht enthalten Angaben sollen aus anderen Identitätsnachweisen des Spie-

lers ergänzt werden.

Diese Daten müssen wie in den Identitätsnachweisen hinterlegt übermittelt werden. Das betrifft so-

wohl die verwendeten Zeichen als auch die Reihenfolge, siehe Beispiel in Abschnitt 6.2.2.

6.2.1 Feld VORNAME

XML-Tag VORNAME

XML-Typ t_name

Feldeigenschaft Pflichtfeld

Feldlänge höchstens 85 Zeichen

Zulässige Zeichen Lateinische Zeichen in Unicode

Besonderheit Hat ein Spieler keinen Vornamen, so ist dies durch den Ein-

trag eines – (Minus-Zeichens) kenntlich zu machen.

Tabelle 11: Feld VORNAME

Page 24: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

6. Übermittlung von Spielerdaten

OASIS Schnittstellenbeschreibung Seite 24

Definition:

In diesem Feld werden die Vornamen des Spielers übermittelt.

Erfassungsregeln:

Die Vornamen werden so übermittelt, wie sie im Identitätsnachweis zum Zeitpunkt des Anlegens oder

der letzten Änderung der Spielersperre eingetragen sind/waren. Das betrifft sowohl die Reihenfolge

als auch die Zeichen:

die Reihenfolge darf nicht geändert werden, diakritische Zeichen und Ligaturen dürfen nicht translite-

riert werden.

Hat ein Spieler keinen Vornamen, so ist dies durch den Eintrag genau eines – (Minus-Zeichens)

kenntlich zu machen.

6.2.2 Feld NACHNAME

XML-Tag NACHNAME

XML-Typ t_name

Feldeigenschaft Pflichtfeld

Feldlänge höchstens 85 Zeichen

Zulässige Zeichen Lateinische Zeichen in Unicode

Tabelle 12: Feld NACHNAME

Definition:

In diesem Feld werden die Nachnamen des Spielers übermittelt.

Erfassungsregeln:

Die Nachnamen werden so übermittelt, wie sie im Identitätsnachweis zum Zeitpunkt des Anlegens

oder der letzten Änderung der Spielersperre eingetragen sind/waren. Das betrifft sowohl die Reihen-

folge als auch die Zeichen:

die Reihenfolge darf nicht geändert werden, diakritische Zeichen und Ligaturen dürfen nicht translite-

riert werden.

Beispiel:

Nachname, so wie er im Identitätsnachweis steht: Graf von Güldenberg

Dieser Eintrag ist exakt so zu übernehmen.

Beispielsweise sind folgende Schreibweisen nicht erlaubt:

Page 25: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

6. Übermittlung von Spielerdaten

Seite 25 OASIS Schnittstellenbeschreibung

Güldenberg, Graf von Reihenfolge geändert

Graf von Gueldenberg Umlaut oder sonstige diakritische Zeichen bzw. Ligaturen

nicht korrekt übernommen: es dürfen keine Transliterationen

vorgenommen werden.

Von Güldenberg Titel fehlt

Tabelle 13: unerlaubte Schreibweisen im Feld NACHNAME

6.2.3 Feld GEBURTSNAME

XML-Tag GEBURTSNAME

XML-Typ t_name

Feldeigenschaft Siehe Abschnitt 6.1

Feldlänge höchstens 85 Zeichen

Zulässige Zeichen Lateinische Zeichen in Unicode

Tabelle 14: Feld GEBURTSNAME

Definition:

In diesem Feld werden die Geburtsnamen des Spielers übermittelt.

Erfassungsregeln:

Die Geburtsnamen werden so übermittelt, wie sie im Identitätsnachweis eingetragen sind. Das betrifft

sowohl die Reihenfolge als auch die Zeichen:

die Reihenfolge darf nicht geändert werden, diakritische Zeichen und Ligaturen dürfen nicht translite-

riert werden.

6.2.4 Feld GEBURTSDATUM

XML-Tag GEBURTSDATUM

XML-Typ xs:string (Datumsstring im Format JJJJ-MM-TT, für Monat

und Tag ist jeweils auch die Angabe "--" gültig)

Feldeigenschaft Pflichtfeld

Tabelle 15: Feld GEBURTSDATUM

Definition:

In diesem Feld wird das Geburtsdatum des Spielers übermittelt.

Plausibilitäten:

Page 26: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

6. Übermittlung von Spielerdaten

OASIS Schnittstellenbeschreibung Seite 26

Gültigkeitsbereich der Eingabewerte liegt zwischen 0 und 120.

6.2.5 Feld GEBURTSORT

XML-Tag GEBURTSORT

XML-Typ t_name

Feldeigenschaft Siehe Abschnitt 6.1

Feldlänge höchstens 85 Zeichen

Zulässige Zeichen Lateinische Zeichen in Unicode

Tabelle 16: Feld GEBURTSORT

Definition:

In diesem Feld wird der Geburtsort des Spielers übermittelt.

Erfassungsregeln:

Der Geburtsort wird so übermittelt, wie er im Identitätsnachweis eingetragen ist. Diakritische Zeichen

und Ligaturen dürfen nicht transliteriert werden.

6.2.6 Feldgruppe ANSCHRIFT

XML-Tag ANSCHRIFT

XML-Typ t_anschrift_status bzw. t_anschrift

Feldeigenschaft Siehe Abschnitt 6.1

Elemente PLZ, ORT, STRASSE, HAUSNR, ADRESSZUSATZ, LAND

Tabelle 17: Feldgruppe ANSCHRIFT

Definition:

In diesem Element wird die Wohnanschrift des Spielers übermittelt.

Erfassungsregeln:

Die Anschrift ist so zu übermitteln, wie sie im Identitätsnachweis zum Zeitpunkt des Anlegens oder der

letzten Änderung der Spielersperre eingetragen ist/war.

6.2.6.1 Feld ANSCHRIFT.PLZ

XML-Tag PLZ

XML-Typ t_nummer

Page 27: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

6. Übermittlung von Spielerdaten

Seite 27 OASIS Schnittstellenbeschreibung

Feldeigenschaft Siehe Abschnitt 6.1

Feldlänge höchstens 20 Zeichen

Zulässige Zeichen Lateinische Zeichen in Unicode

Tabelle 18: Feld ANSCHRIFT.PLZ

Definition:

In diesem Feld wird die Postleitzahl der Wohnanschrift des Spielers übermittelt.

Erfassungsregeln:

Die Postleitzahl wird so übermittelt, wie sie im Identitätsnachweis zum Zeitpunkt des Anlegens oder

der letzten Änderung der Spielersperre eingetragen ist/war.

6.2.6.2 Feld ANSCHRIFT.ORT

XML-Tag ORT

XML-Typ t_name

Feldeigenschaft Siehe Abschnitt 6.1

Feldlänge höchstens 85 Zeichen

Zulässige Zeichen Lateinische Zeichen in Unicode

Tabelle 19: Feld ANSCHRIFT.ORT

Definition:

In diesem Feld wird der Ort der Wohnanschrift des Spielers übermittelt.

Erfassungsregeln:

Der Ort wird so übermittelt, wie er im Identitätsnachweis zum Zeitpunkt des Anlegens oder der letzten

Änderung der Spielersperre eingetragen ist/war. Diakritische Zeichen und Ligaturen dürfen nicht trans-

literiert werden.

6.2.6.3 Feld ANSCHRIFT.STRASSE

XML-Tag STRASSE

XML-Typ t_strasse

Feldeigenschaft Siehe Abschnitt 6.1

Feldlänge höchstens 150 Zeichen

Zulässige Zeichen Lateinische Zeichen in Unicode

Page 28: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

6. Übermittlung von Spielerdaten

OASIS Schnittstellenbeschreibung Seite 28

Tabelle 20: Feld ANSCHRIFT.STRASSE

Definition:

In diesem Feld wird die Straße der Wohnanschrift des Spielers übermittelt.

Erfassungsregeln:

Die Straße wird so übermittelt, wie sie im Identitätsnachweis zum Zeitpunkt des Anlegens oder der

letzten Änderung der Spielersperre eingetragen ist/war.

6.2.6.4 Feld ANSCHRIFT.HAUSNR

XML-Tag HAUSNR

XML-Typ t_nummer

Feldeigenschaft Siehe Abschnitt 6.1

Feldlänge höchstens 20 Zeichen

Zulässige Zeichen Lateinische Zeichen in Unicode

Tabelle 21: Feld ANSCHRIFT.HAUSNR

Definition:

In diesem Feld wird die Hausnummer der Wohnanschrift des Spielers übermittelt.

Erfassungsregeln:

Die Hausnummer wird so übermittelt, wie sie im Identitätsnachweis zum Zeitpunkt des Anlegens oder

der letzten Änderung der Spielersperre eingetragen ist/war.

6.2.6.5 Feld ANSCHRIFT.ADRESSZUSATZ

XML-Tag ADRESSZUSATZ

XML-Typ t_adresszusatz

Feldeigenschaft optional

Feldlänge höchstens 256 Zeichen

Zulässige Zeichen Lateinische Zeichen in Unicode

Tabelle 22: Feld ANSCHRIFT.ADRESSZUSATZ

Definition:

In diesem Feld wird ein eventuell vorhandener Adresszusatz der Wohnanschrift des Spielers übermit-

telt.

Page 29: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

7. Beenden einer Spielersperre

Seite 29 OASIS Schnittstellenbeschreibung

Erfassungsregeln:

Der Adresszusatz wird so übermittelt, wie er im Identitätsnachweis zum Zeitpunkt des Anlegens oder

der letzten Änderung der Spielersperre eingetragen ist/war. Dies betrifft sowohl die Zeichen als auch

die Reihenfolge. Diakritische Zeichen und Ligaturen dürfen nicht transliteriert werden. Mehrzeilige

Eintragungen werden durch ein Leerzeichen getrennt.

6.2.6.6 Feld ANSCHRIFT.LAND

XML-Tag LAND

XML-Typ t_land

Feldeigenschaft Siehe Abschnitt 6.1

Feldlänge Genau 3 Zeichen

Zulässige Zeichen Ziffern 0-9

Tabelle 23: Feld ANSCHRIFT.LAND

Definition:

In diesem Feld wird das Gebiet der Wohnanschrift des Spielers übermittelt.

Erfassungsregeln:

Grundlage ist der von Destatis veröffentlichte Staatenkatalog. Es wird hierbei der 3 stellige Gebiets-

Destatis-BEV-Code übermittelt.

Plausibilitäten:

Es wird die Gültigkeit des übermittelten Schlüssels gegen den genannten Katalog geprüft. Ungültige

Schlüssel werden abgewiesen.

Beenden einer Spielersperre 7

Jede erzeugte Spielersperre erhält automatisch eine SperrID, die diese Sperre eindeutig identifiziert.

Nach dem Anlegen einer Spielersperre wird im Meldungstext die erzeugte SperrID übermittelt. Mit

Kenntnis dieser SperrID können Sperren beendet werden

7.1 Beenden einer Sperre anhand der SperrID

XML-Schema sperrenPflege.xsd , namespace=

http://www.hzd.de/sperrenPflege

Page 30: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

7. Beenden einer Spielersperre

OASIS Schnittstellenbeschreibung Seite 30

XML-Root-Element SPIELERSPERRE

XML-Typ t_spielersperre

Elemente AUTHENTISIERUNG

N-ART

SPERRGRUND

SPERRGRUND_NEU

SPERRID

SPIELER_NEU

Tabelle 24: Ändern/Beenden einer Sperre anhand der SperrID

Im Folgenden werden die einzelnen Elemente einer Spielersperre-Pflege-Nachricht beschrieben für

das Ändern oder Beenden einer Sperre anhand der SperrID. Die Elemente SPERRGRUND_NEU und

SPIELER_NEU warden nicht beim Beenden einer Sperre benutzt.

7.1.1 Feldgruppe AUTHENTISIERUNG

Zur Beschreibung der Feldgruppe AUTHENTISIERUNG siehe Kapitel 5.

Feldeigenschaft: Pflichtgruppe

7.1.2 Feld N-ART

XML-Tag N-ART

XML-Typ t_nachrichtenart

Feldeigenschaft Pflichtfeld

Feldlänge Genau 1 Zeichen

Zulässige Zeichen B

Tabelle 25: Feld N-ART

Definition:

In diesem Feld wird die Art der Änderung einer Spielersperre übermittelt.

Erfassungsregeln:

Das Beenden einer Spielersperre ist durch den Wert B zu kennzeichnen.

Plausibilitäten:

Bei einer Beendigungsnachricht (N-ART=B) muss das Feld SPERRID gefüllt sein.

Page 31: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

7. Beenden einer Spielersperre

Seite 31 OASIS Schnittstellenbeschreibung

7.1.3 Feld SPERRGRUND

XML-Tag SPERRGRUND

XML-Typ t_sperrgrund

Feldeigenschaft optional

Feldlänge Entsprechend der zulässigen Zeichen

Zulässige Zeichen SELBST, FREMD

Tabelle 26: Feld SPERRGRUND

Definition:

In diesem Feld wird die Art der Spielersperre übermittelt.

Erfassungsregeln:

Wird der Eintrag der Spielersperre durch den Spieler selbst veranlasst, so ist dies durch „SELBST“ zu

kennzeichnen. Wird der Eintrag der Spielersperre durch eine andere Person als den Spieler veran-

lasst, so ist dies durch „FREMD“ zu kennzeichnen.

Plausibilitäten:

Nur die Werte SELBST und FREMD sind erlaubt.

7.1.4 Feld SPERRID

XML-Tag SPERRID

XML-Typ t_sperrid

Feldeigenschaft Pflichtfeld

Feldlänge Min:1 / Max: 38

Zulässige Zeichen Ziffern 0-9

Tabelle 27: Feld SPERRID

Definition:

In diesem Feld wird die eindeutige SperrID des Spielersperreintrages übermittelt.

Erfassungsregeln:

Keine besonderen Erfassungsregeln

Plausibilitäten:

Es muss eine Zahl im angegebenen Gültigkeitsbereich sein.

Page 32: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

8. Anlegen und Ändern einer Spielersperre 4.0

OASIS Schnittstellenbeschreibung Seite 32

Anmerkungen:

Die angegebene SperrID wird ausschließlich innerhalb der dem angemeldeten Veranstalter zugeord-

neten Sperreinträge gesucht.

Das Beenden oder Ändern von Sperren, die nicht dem angemeldeten Veranstalter zugeordnet sind,

kann auch mit Kenntnis der SperrID nicht durchgeführt werden.

Anlegen und Ändern einer Spielersperre 4.0 8

8.1 Anlegen einer Spielersperre 4.0

Eine Spielersperre kann mit dem durch sperreAnlegen.xsd definierten XML angelegt werden.

XML-Schema sperreAnlegen.xsd

XML-Root-Element SPERRE

XML-Typ t_sperre_anlegen

Elemente AUTHENTISIERUNG

SPERRGRUND

SPIELER

ANLASS

Tabelle 28: Übersicht Anlegen einer Spielersperre

Im Folgenden werden die einzelnen Elemente beschrieben.

8.1.1 Feldgruppe AUTHENTISIERUNG

Zur Beschreibung der Feldgruppe AUTENTISIERUNG siehe Abschnitt 5.1

8.1.2 Feld SPERRGRUND

XML-Tag SPERRGRUND

XML-Typ t_sperrgrund

Feldeigenschaft Pflichtfeld beim Anlegen einer Sperre, sonst optional

Feldlänge Entsprechend der zulässigen Zeichen

Zulässige Zeichen SELBST, FREMD

Page 33: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

8. Anlegen und Ändern einer Spielersperre 4.0

Seite 33 OASIS Schnittstellenbeschreibung

Tabelle 29: Feld SPERRGRUND

Definition:

In diesem Feld wird die Art der Spielersperre übermittelt.

Erfassungsregeln:

Wird der Eintrag der Spielersperre durch den Spieler selbst veranlasst, so ist dies durch „SELBST“ zu

kennzeichnen. Wird der Eintrag der Spielersperre durch eine andere Person als den Spieler veran-

lasst, so ist dies durch „FREMD“ zu kennzeichnen.

Plausibilitäten:

Nur die Werte SELBST und FREMD sind erlaubt.

8.1.3 Feldgruppe SPIELER

XML-Tag SPIELER

XML-Typ t_spieler

Feldeigenschaft Pflichtgruppe

Elemente VORNAME

NACHNAME

GEBURTSNAME

GEBURTSDATUM

GEBURTSORT

ANSCHRIFT

Tabelle 30: Feldgruppe SPIELER

Definition:

Mit dieser Feldgruppe werden die vollständigen Daten eines Spielers zum Anlegen übermittelt.

Erfassungsregeln:

Pflicht beim Anlegen einer neuen Spielersperre

Anmerkungen:

Pflichtfelder sind alle bis auf ANSCHRIFT.ADRESSZUSATZ.

Zur detaillierten Beschreibung der Elemente dieser Feldgruppe siehe Abschnitt 6.2

Page 34: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

8. Anlegen und Ändern einer Spielersperre 4.0

OASIS Schnittstellenbeschreibung Seite 34

8.1.3.1 Erlaubte Zeichen für das Anlegen einer neuen Sperre

Beim Anlegen einer neuen Sperre werden die nach String.Latin erlaubten Zeichen weiter einge-

schränkt, um eine zuverlässigere Identifikation von Datensätzen zu ermöglichen.

Für die Elemente der Feldgruppe SPIELER, die den neu anzulegenden Datensatz beschreiben,

gelten zusätzliche Regeln:

Element

erlaubte

Buchstaben

(siehe Kapitel 3.1.1)

erlaubte

Ziffern

(siehe Kapitel 3.1.2)

erlaubte

Sonderzeichen

(siehe Kapitel 3.1.3)

Vorname „alle“ „keine“ .-´`'

Nachname „alle“ „keine“ .-´`'

Geburtsdatum keine 0-9 -

Geburtsname „alle“ „keine“ .-´`'

Geburtsort „alle“ „keine“ .-´`',/()

Anschrift.PLZ „alle“ 0-9 -

Anschrift.Ort „alle“ „keine“ .-´`',/()

Anschrift.Strasse „alle“ 0-9 .-´`',/

Anschrift.Hausnr „alle“ 0-9 -/.,

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

Tabelle 31: Erlaubte Zeichen für das Anlegen einer neuen Sperre

Die Verwendung nicht-erlaubter Zeichen führt zu einer Fehlermeldung.

8.1.4 Feldgruppe ANLASS

XML-Tag ANLASS

XML-Typ t_anlass_sperre

Feldeigenschaft Pflichtgruppe . Kardinalität 1..99. (es muss mindestens einen

Anlass geben. Es darf maximal 99 Anlässe geben)

Elemente KENNUNG – Pflichtfeld. Zweistelliger, fachlicher Schlüssel

aus dem Katalog Sperranlässe.

BEZEICHNUNG – optional. Eintrag wird ignoriert

SORTNR – optional. Eintrag wird ignoriert.

Page 35: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

8. Anlegen und Ändern einer Spielersperre 4.0

Seite 35 OASIS Schnittstellenbeschreibung

Tabelle 32: Feldgruppe ANLASS

Definition:

In jedem ANLASS- Feld wird ein Anlass für die Sperre übermittelt.

Erfassungsregeln:

Zum Anlegen einer Sperre ist mindestens ein Sperranlass erforderlich. Es können mehrere Sperran-

lässe erfasst werden. Die KENNUNG eines Sperranlasses ist Pflichtfeld. Die beiden anderen Elemen-

te der Feldgruppe werden ignoriert.

Plausibilitäten:

Die Kennung muss aus dem Katalog „Sperranlässe“ stammen. Anderenfalls antwortet OASIS mit dem

Schlüssel 0015 – unbekannter Katalogwert Sperranlass [..]

Anmerkungen:

Es findet keine semantische Plausibilisierung der Kombination von mitgelieferten Sperranlässen statt.

(Beispiel: 99 – „kein Grund angegeben“ zusammen mit einem weiteren Anlass führt nicht zur Ableh-

nung durch das System).

Werden mehrmals gleiche KENNUNGen geliefert, so sorgt das System für Eindeutigkeit.

8.1.4.1 Feld ANLASS.KENNUNG

XML-Tag KENNUNG

XML-Typ t_anlass_sperre_kennung

Feldeigenschaft Pflichtelement

Feldlänge genau 2 Ziffern.

Zulässige Zeichen Ziffern 0-9. Es sind nur Werte aus dem Katalog Sperranlässe

zulässig. Der Katalog kann über die neue Schnittstellenfunk-

tion „Katalog Sperranlässe holen“ (Funktion 19 aus Schnittstellen-

funktionen) abgefragt werden.

Tabelle 33: Feld ANLASS.KENNUNG

Definition:

In diesem Feld wird der fachliche Schlüssel für den Anlass einer Sperre übermittelt.

Page 36: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

8. Anlegen und Ändern einer Spielersperre 4.0

OASIS Schnittstellenbeschreibung Seite 36

8.1.4.2 Feld ANLASS.BEZEICHNUNG

XML-Tag BEZEICHNUNG

XML-Typ t_anlass_sperre_bezeichnung

Feldeigenschaft optional

Feldlänge maximal 150 Zeichen

Zulässige Zeichen String.Latin

Tabelle 34: Feld ANLASS.BEZEICHNUNG

Definition:

In diesem Feld wird die fachliche Beschreibung für den Anlass einer Sperre übermittelt.

Anmerkungen:

Das Feld wird beim Anlegen oder Ändern einer Sperre ignoriert, sofern es schemakonform mitgeliefert

wurde. Sicherer ist es, beim Anlegen / Ändern von Sperren kein ANLASS.BEZEICHNUNG mitzulie-

fern.

8.1.4.3 Feld ANLASS.SORTNR

XML-Tag SORTNR

XML-Typ xs:integer

Feldeigenschaft optional

Tabelle 35: Feld ANLASS.SORTNR

Definition:

In diesem Feld wird eine Reihenfolge für die Sperranlässe mitgeliefert, die z.B. in Webanwendungen

verwendet werden kann.

Anmerkungen:

Das Feld wird beim Anlegen oder Ändern einer Sperre ignoriert, sofern es schemakonform mitgeliefert

wurde. Sicherer ist es, beim Anlegen / Ändern von Sperren kein ANLASS.SORTNR mitzuliefern.

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

Page 37: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

8. Anlegen und Ändern einer Spielersperre 4.0

Seite 37 OASIS Schnittstellenbeschreibung

<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 Antwort auf Anlegen einer Spielersperre 4.0

Zum Schema sperrsystemMeldung.xsd konformes XML.

Beschreibung des Schemas siehe Sperrsystem-Meldung.

8.2 Ändern einer Spielersperre 4.0

Jede erzeugte Spielersperre erhält automatisch eine SperrID, die diese Sperre eindeutig identifiziert.

Nach dem Anlegen einer Spielersperre wird im Meldungstext die erzeugte SperrID übermittelt. Mit

Kenntnis dieser SperrID können Sperren geändert oder beendet werden

Eine Spielersperre kann mit dem durch sperreAendern.xsd definierten XML geändert werden.

XML-Schema sperreAendern.xsd

XML-Root-Element SPERRE

XML-Typ t_sperre_aendern

Elemente AUTHENTISIERUNG

SPERRID

SPERRGRUND

SPIELER

ANLASS

Tabelle 36: Ändern einer Sperre 4.0

Im Folgenden werden die einzelnen Elemente einer Sperre-Ändern-Nachricht beschrieben.

Page 38: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

8. Anlegen und Ändern einer Spielersperre 4.0

OASIS Schnittstellenbeschreibung Seite 38

8.2.1 Feldgruppe AUTHENTISIERUNG

Zur Beschreibung der Feldgruppe AUTHENTISIERUNG siehe Kapitel 5.

Feldeigenschaft: Pflichtgruppe

8.2.2 Feld SPERRID

XML-Tag SPERRID

XML-Typ t_sperrid

Feldeigenschaft Pflichtfeld

Feldlänge Min:1 / Max: 38

Zulässige Zeichen Ziffern 0-9

Tabelle 37: Feld SPERRID

Definition:

In diesem Feld wird die eindeutige SperrID des Spielersperreintrages übermittelt.

Erfassungsregeln:

Keine besonderen Erfassungsregeln

Plausibilitäten:

Es muss eine Zahl im angegebenen Gültigkeitsbereich sein.

Anmerkungen:

Die angegebene SperrID wird ausschließlich innerhalb der der angemeldeten Betriebsstätte zugeord-

neten Sperreinträge gesucht.

Das Ändern von Sperren, die nicht der angemeldeten Betriebsstätte zugeordnet sind, kann auch mit

Kenntnis der SperrID nicht durchgeführt werden.

8.2.3 Feld SPERRGRUND

XML-Tag SPERRGRUND

XML-Typ t_sperrgrund

Feldeigenschaft optional

Feldlänge Entsprechend der zulässigen Zeichen

Zulässige Zeichen SELBST, FREMD

Page 39: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

8. Anlegen und Ändern einer Spielersperre 4.0

Seite 39 OASIS Schnittstellenbeschreibung

Tabelle 38: Feld SPERRGRUND

Definition:

In diesem Feld wird der neue Grund der Sperre übermittelt, wenn er geändert werden soll.

Erfassungsregeln:

Wird der Eintrag der Spielersperre durch den Spieler selbst veranlasst, so ist dies durch „SELBST“ zu

kennzeichnen. Wird der Eintrag der Spielersperre durch eine andere Person als den Spieler veran-

lasst, so ist dies durch „FREMD“ zu kennzeichnen. Der Sperrgrund überschreibt den aktuellen Grund

der Sperre.

Plausibilitäten:

Nur die Werte SELBST und FREMD sind erlaubt.

8.2.4 Feldgruppe SPIELER

XML-Tag SPIELER

XML-Typ t_spieler

Feldeigenschaft Pflichtgruppe

Elemente VORNAME

NACHNAME

GEBURTSNAME

GEBURTSDATUM

GEBURTSORT

ANSCHRIFT

Tabelle 39: Feldgruppe SPIELER

Definition:

Mit dieser Feldgruppe werden die neuen Daten eines Spielers zum Ändern übermittelt.

Erfassungsregeln:

Die Daten müssen vollständig sein. Es dürfen nicht nur die geänderten Felder des Spielers mitgelie-

fert werden.

Anmerkungen:

Page 40: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

8. Anlegen und Ändern einer Spielersperre 4.0

OASIS Schnittstellenbeschreibung Seite 40

Pflichtfelder sind alle bis auf ANSCHRIFT.ADRESSZUSATZ.

Zur detaillierten Beschreibung der Elemente dieser Feldgruppe siehe Abschnitt 6.2

8.2.4.1 Erlaubte Zeichen für das Ändern einer Spielersperre

(siehe auch Abschnitt Fehler! Verweisquelle konnte nicht gefunden werden.)

Beim Anlegen einer neuen Sperre werden die nach String.Latin erlaubten Zeichen weiter einge-

schränkt, um eine zuverlässigere Identifikation von Datensätzen zu ermöglichen.

Für die Elemente der Feldgruppe SPIELER-NEU, die den zu ändernden Datensatz beschreibt,

gelten zusätzliche Regeln:

Element

erlaubte

Buchstaben

(siehe Kapitel 3.1.1)

erlaubte

Ziffern

(siehe Kapitel 3.1.2)

erlaubte

Sonderzeichen

(siehe Kapitel 3.1.3)

Vorname „alle“ „keine“ .-´`'

Nachname „alle“ „keine“ .-´`'

Geburtsdatum keine 0-9 -

Geburtsname „alle“ „keine“ .-´`'

Geburtsort „alle“ „keine“ .-´`',/()

Anschrift.PLZ „alle“ 0-9 -

Anschrift.Ort „alle“ „keine“ .-´`',/()

Anschrift.Strasse „alle“ 0-9 .-´`',/

Anschrift.Hausnr „alle“ 0-9 -/.,

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

Tabelle 40: Erlaubte Zeichen für das Ändern einer Spielersperre

Die Verwendung nicht erlaubter Zeichen führt zu einer Fehlermeldung.

8.2.5 Feldgruppe ANLASS

XML-Tag ANLASS

XML-Typ t_anlass_sperre

Feldeigenschaft optional . Kardinalität 0..99. Es darf höchstens 99 Anlässe

Page 41: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

8. Anlegen und Ändern einer Spielersperre 4.0

Seite 41 OASIS Schnittstellenbeschreibung

geben.

Elemente KENNUNG – Pflichtfeld. Zweistelliger fachlicher Schlüssel

aus dem Katalog Sperranlässe.

BEZEICHNUNG – optional. Eintrag wird ignoriert

SORTNR – optional. Eintrag wird ignoriert.

Tabelle 41: Feldgruppe ANLASS

Definition:

In jedem ANLASS- Feld wird ein Anlass für die Sperre übermittelt.

Erfassungsregeln:

Werden beim Ändern einer Sperre Sperranlässe mitgeliefert, so müssen diese vollständig sein. Das

System ersetzt die der Sperre zugeordneten Sperranlässe vollständig durch die mit der Änderungs-

nachricht mitgelieferten Sperranlässe. Es erfolgt kein Differenzabgleich alt/neu.

Plausibilitäten:

Die Kennung muss aus dem Katalog „Sperranlässe“ stammen. Anderenfalls antwortet OASIS mit dem

Schlüssel 0015 – unbekannter Katalogwert Sperranlass [..]

Anmerkungen:

Es findet keine semantische Plausibilisierung der Kombination von mitgelieferten Sperranlässen statt.

(Beispiel: 99 – „kein Grund angegeben“ zusammen mit einem weiteren Anlass führt nicht zur Ableh-

nung durch das System).

Werden mehrmals gleiche KENNUNGen geliefert, so sorgt das System für Eindeutigkeit.

8.2.5.1 Feld ANLASS.KENNUNG

XML-Tag KENNUNG

XML-Typ t_anlass_sperre_kennung

Feldeigenschaft Pflichtelement

Feldlänge genau 2 Ziffern.

Zulässige Zeichen Ziffern 0-9. Es sind nur Werte aus dem Katalog Sperranlässe

zulässig. Der Katalog kann über die neue Schnittstellenfunk-

tion „Katalog Sperranlässe holen“ (Funktion 19 aus Schnittstellen-

funktionen) abgefragt werden.

Page 42: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

8. Anlegen und Ändern einer Spielersperre 4.0

OASIS Schnittstellenbeschreibung Seite 42

Tabelle 42: Feld ANLASS.KENNUNG

Definition:

In diesem Feld wird der fachliche Schlüssel für den Anlass einer Sperre übermittelt.

8.2.5.2 Feld ANLASS.BEZEICHNUNG

XML-Tag BEZEICHNUNG

XML-Typ t_anlass_sperre_bezeichnung

Feldeigenschaft optional

Feldlänge maximal 150 Zeichen

Zulässige Zeichen String.Latin

Tabelle 43: Feld ANLASS.BEZEICHNUNG

Definition:

In diesem Feld wird die fachliche Beschreibung für den Anlass einer Sperre übermittelt.

Anmerkungen:

Das Feld wird beim Anlegen oder Ändern einer Sperre ignoriert, sofern es schemakonform mitgeliefert

wurde. Sicherer ist es, beim Anlegen / Ändern von Sperren kein ANLASS.BEZEICHNUNG mitzulie-

fern.

8.2.5.3 Feld ANLASS.SORTNR

XML-Tag SORTNR

XML-Typ xs:integer

Feldeigenschaft optional

Tabelle 44: Feld ANLASS.SORTNR

Definition:

In diesem Feld wird eine Reihenfolge für die Sperranlässe mitgeliefert, die z.B. in Webanwendungen

verwendet werden kann.

Anmerkungen:

Page 43: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

9. Abfrage des Spielerstatus in OASIS

Seite 43 OASIS Schnittstellenbeschreibung

Das Feld wird beim Anlegen oder Ändern einer Sperre ignoriert, sofern es schemakonform mitgeliefert

wurde. Sicherer ist es, beim Anlegen / Ändern von Sperren kein ANLASS.SORTNR mitzuliefern.

Beispiel 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/sperreAendern">

<AUTHENTISIERUNG>

<VERANSTALTER>

<KENNUNG>Z1234567</KENNUNG>

<PASSWORT>Qwertz!2</PASSWORT>

</VERANSTALTER>

<BENUTZER>000</BENUTZER>

</AUTHENTISIERUNG>

<SPERRID>42</SPERRID>

<SPERRGRUND>FREMD</SPERRGRUND>

<SPIELER>

<VORNAME>Gabi</VORNAME>

<NACHNAME>Karpfen</NACHNAME>

<GEBURTSNAME>Goldfisch</GEBURTSNAME>

<GEBURTSDATUM>1980-01-01</GEBURTSDATUM>

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

<KENNUNG>02</KENNUNG>

</ANLASS>

</tns:SPERRE>

8.2.6 Antwort auf Ändern einer Spielersperre 4.0

Zum Schema sperrsystemMeldung.xsd konformes XML.

Beschreibung des Schemas siehe Sperrsystem-Meldung.

Abfrage des Spielerstatus in OASIS 9

Fachlich und technisch können zwei Arten von Spielerstatusabfragen unterschieden werden:

Spielerstatusabfragen, die sich auf alle relevanten, im System befindlichen Sperren beziehen

(siehe dieses Kapitel);

Die zeichengenaue Spielerstatusabfrage wurde entfernt.

Die Abfragen des Spielerstatus können anhand von Spielerdaten (Spielerstatusabfrage) durchgeführt

werden.

Abfragen erfolgen mit den durch spielerstatusAbfrage.xsd definierten XML.

Page 44: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

9. Abfrage des Spielerstatus in OASIS

OASIS Schnittstellenbeschreibung Seite 44

Die Antwort erfolgt als XML konform zum Schema sperrsystemMeldung.xsd.

9.1 Ähnlichkeitsabfrage

Die Ähnlichkeitsabfrage in OASIS hat das Ziel, zu ermitteln, ob für einen Spieler ein Sperreintrag vor-

handen ist.

Bei der Ähnlichkeitssuche wird nach „ähnlichen“ Einträgen – im Rahmen von OASIS auch als transli-

terierte Suche bezeichnet, da für die Suche Zeichen transliteriert abgelegt und gesucht werden.

Die Benutzung dieser Schnittstellenfunktion unterscheidet sich nicht von der der Spielerstatusabfrage.

9.1.1 Übersicht Spielerstatusabfrage

XML-Root-Element STATUSABFRAGE

XML-Typ t_statusabfrage

Elemente AUTHENTISIERUNG

SPIELER

Tabelle 45: Übersicht Spielerstatusabfrage

9.1.2 Feldgruppe AUTHENTISIERUNG

Zur Beschreibung der Feldgruppe AUTHENTISIERUNG siehe Kapitel 5.

Feldeigenschaft: Pflichtgruppe

9.1.3 Feldgruppe SPIELER

Siehe Abschnitt 6.2

9.1.4 Erlaubte Zeichen für die Abfrage des Spielerstatus

Bei einer Statusabfrage werden alle nach String.Latin erlaubten Zeichen zugelassen. Dies wurde nö-

tig, um auch Datensätze finden zu können, die Zeichen enthalten, die nicht den OASIS Restriktionen

genügen, aber dennoch aus Vorsystemen übernommen werden mussten.

Element

Erlaubte

Buchstaben

(siehe Abschnitt

3.1.1)

Erlaubte

Ziffern

(siehe Abschnitt

3.1.2)

Erlaubte

Sonderzeichen

(siehe Abschnitt 3.1.3)

Page 45: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

10. Eigene Sperren

Seite 45 OASIS Schnittstellenbeschreibung

Vorname „alle“ 0-9 „alle“

Nachname „alle“ 0-9 „alle“

Geburtsdatum keine 0-9 -

Geburtsname „alle“ 0-9 „alle“

Geburtsort „alle“ 0-9 „alle“

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

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

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

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

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

Tabelle 46: Erlaubte Zeichen für die Abfrage des Spielerstatus

9.1.5 Ergebnis einer Ähnlichkeitsabfrage und Spielerstatusabfrage

Die Antworten erfolgen als Sperrsystem-Meldung (siehe Abschnitt 19.8).

Gibt es keinen zur Abfrage passenden Eintrag in OASIS, so gilt der Spieler als nicht gesperrt. Die

Sperrsystem-Meldung hat den Schlüssel 0019, Typ I und einen entsprechenden Meldungstext.

Konnte ein Sperreintrag anhand der Abfrage eindeutig identifiziert werden, so ist der Spieler gesperrt.

Die Sperrsystem-Meldung hat den Schlüssel 0018, den Typ W und einen entsprechenden Mel-

dungstext. Sie enthält einen Verweis auf den Veranstalter, der für die Sperre änderungsberechtigt ist.

Gibt es mehr als einen Sperreintrag zur Abfrage und wurde die Abfrage mit wenigen Attributen ge-

führt, so kann die Abfrage mit mehr Attributen wiederholt werden, um Eindeutigkeit zu erreichen. Die

Sperrsystem-Meldung hat den Schlüssel 0023, den Typ W und einen entsprechenden Meldungstext.

Gibt es mehr als einen Sperreintrag zur Abfrage, aber die Abfrage kann nicht erweitert werden, so gilt

der Spieler als gesperrt. Die Sperrsystem-Meldung hat den Schlüssel 0024, den Typ W und einen

entsprechenden Meldungstext.

Eigene Sperren 10

Antwort auf Ändern einer Spielersperre 4.0

Zum Schema sperrsystemMeldung.xsd konformes XML.

Beschreibung des Schemas siehe Sperrsystem-Meldung.

Abfrage des Spielerstatus in OASIS

Page 46: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

10. Eigene Sperren

OASIS Schnittstellenbeschreibung Seite 46

Spielerstatusabfragen, die sich nur auf die Sperren des abfragenden Veranstalters beziehen

(siehe dieses Kapitel)

Antwort auf Ändern einer Spielersperre 4.0

Zum Schema sperrsystemMeldung.xsd konformes XML.

10.1 Eigene Sperren abfragen 4.0

Da mit OASIS 4.0 Sperranlässe neu hinzugekommen sind, gibt es neue Funktionen (Funktion 20 sie-

he Schnittstellenfunktionen) zum Abfragen der eigenen Sperren, die zusätzlich Sperranlässe zurück-

liefert.

Alle eigenen Sperren können mit einem zum neuen Schema eigeneSperrenAbfragen.xsd konformen

XML abgefragt werden.

10.1.1 OASIS 4.0 eigene Sperren abfragen

XML-Root-Element ABFRAGE

XML-Typ t_eigenesperrenabfrage

Elemente LOGINDATEN

Tabelle 47: Übersicht eigene Sperren abfagen 4.0

10.1.1.1 Feldgruppe LOGINDATEN

XML-Tag LOGINDATEN

XML-Typ t_logindaten

Eigenschaft Anmeldedaten einer Betriebsstätte

Elemente KENNUNG

PASSWORT

BENUTZER

Tabelle 48: Feldgruppe ABFRAGE.LOGINDATEN

Page 47: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

10. Eigene Sperren

Seite 47 OASIS Schnittstellenbeschreibung

10.1.1.2 Feld ABFRAGE.LOGINDATEN.KENNUNG

XML-Tag KENNUNG

XML-Typ t_kennung

Feldeigenschaft Pflichtelement

Feldlänge Mindestens 1 Zeichen, höchstens 30 Zeichen

Zulässige Zeichen Großbuchstaben A-Z (ohne Umlaute) und Ziffern 0-9

Tabelle 49: Feld ABFRAGE.LOGINDATEN.KENNUNG

Definition:

In diesem Feld wird die durch OASIS an die Betriebsstätte vergebene Kennung übermittelt.

Anmerkungen:

Anhand der Kennung und des Passworts erfolgt die Authentifizierung und Autorisierung der Betriebs-

stätte in OASIS.

10.1.1.3 Feld ABFRAGE.LOGINDATEN.PASSWORT

XML-Tag PASSWORT

XML-Typ t_passwort

Feldeigenschaft Pflichtfeld

Feldlänge mindestens 8 Zeichen, höchstens 16 Zeichen

Zulässige Zeichen Buchstaben a-z, A-Z, Umlaute ä,Ä,ö,Ö,ü,Ü,ß,Ziffern 0-9,

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

Tabelle 50: Feld ABFRAGE.LOGINDATEN.PASSWORT

Definition:

In diesem Feld wird das Passwort der Betriebsstätte übermittelt.

Plausibilitäten:

keine

Anmerkungen:

Page 48: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

10. Eigene Sperren

OASIS Schnittstellenbeschreibung Seite 48

Anhand der Kennung und des Passworts erfolgt die Authentifizierung und Autorisierung der Betriebs-

stätte in OASIS.

10.1.1.4 Feld ABFRAGE.LOGINDATEN.BENUTZER

XML-Tag BENUTZER

XML-Typ t_kennung

Feldeigenschaft optional

Feldlänge Mindestens 1 Zeichen, höchstens 30 Zeichen

Zulässige Zeichen Großbuchstaben A-Z (ohne Umlaute) und Ziffern 0-9

Tabelle 51: Feld ABFRAGE.LOGINDATEN.BENUTZER

Definition:

In diesem Feld wird die Kennung eines Superusers WS übertragen.

Anmerkungen:

Das Feld ist nur für die Anwendung OASIS WEB relevant und wird bei OASIS WS ignoriert. Falls das

Feld mitgeliefert wird, muss es schemakonform sein. Inhaltlich wird es nicht geprüft.

Beispiel XML (EigeneSperrenRequest)

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

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

<LOGINDATEN>

<KENNUNG>Z1234567</KENNUNG>

<PASSWORT>Qwertz!2</PASSWORT>

<BENUTZER>000</BENUTZER>

</LOGINDATEN>

</tns:ABFRAGE>

10.1.2 Antwort auf eigene Sperren abfragen 4.0

Zum Schema eigeneSperrenResponse.xsd konformes XML.

Beschreibung des Schemas siehe Eigene-Sperren-Response.

Page 49: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

10. Eigene Sperren

Seite 49 OASIS Schnittstellenbeschreibung

10.2 Eigene Sperren abfragen mit Parametern 4.0

Da mit OASIS 4.0 Sperranlässe neu hinzugekommen sind, gibt es neue Funktionen (Funktion 21 sie-

he Schnittstellenfunktionen) zum Abfragen der eigenen Sperren mit Parametern, die zusätzlich die

Sperranlässe zurückliefert.

Nach eigenen Sperren kann mit einem zum neuen Schema eigeneSperrenAbfragenParameter.xsd

konformen XML gesucht werden. Die Suche findet analog zur Ähnlichkeitssuche transliteriert statt.

10.2.1 OASIS 4.0 eigene Sperren abfragen mit Parametern

XML-Root-Element ABFRAGE

XML-Typ t_eigenesperrensuche

Elemente LOGINDATEN

VORNAME

NACHNAME

GEBURTSNAME

GEBURTSDATUM

GEBURTSORT

ANSCHRIFT

Tabelle 52: Übersicht eigene Sperren abfagen mit Parametern 4.0

10.2.1.1 Feldgruppe LOGINDATEN

XML-Tag LOGINDATEN

XML-Typ t_logindaten

Eigenschaft Anmeldedaten einer Betriebsstätte

Elemente KENNUNG

PASSWORT

BENUTZER

Tabelle 53: Feldgruppe ABFRAGE.LOGINDATEN

10.2.1.2 Feld ABFRAGE.LOGINDATEN.KENNUNG

XML-Tag KENNUNG

XML-Typ t_kennung

Page 50: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

10. Eigene Sperren

OASIS Schnittstellenbeschreibung Seite 50

Feldeigenschaft Pflichtelement

Feldlänge Mindestens 1 Zeichen, höchstens 30 Zeichen

Zulässige Zeichen Großbuchstaben A-Z (ohne Umlaute) und Ziffern 0-9

Tabelle 54: Feld ABFRAGE.LOGINDATEN.KENNUNG

Definition:

In diesem Feld wird die durch OASIS an die Betriebsstätte vergebene Kennung übermittelt.

Anmerkungen:

Anhand der Kennung und des Passworts erfolgt die Authentifizierung und Autorisierung der Betriebs-

stätte in OASIS.

10.2.1.3 Feld ABFRAGE.LOGINDATEN.PASSWORT

XML-Tag PASSWORT

XML-Typ t_passwort

Feldeigenschaft Pflichtfeld

Feldlänge mindestens 8 Zeichen, höchstens 16 Zeichen

Zulässige Zeichen Buchstaben a-z, A-Z, Umlaute ä,Ä,ö,Ö,ü,Ü,ß,Ziffern 0-9,

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

Tabelle 55: Feld ABFRAGE.LOGINDATEN.PASSWORT

Definition:

In diesem Feld wird das Passwort der Betriebsstätte übermittelt.

Plausibilitäten:

keine

Anmerkungen:

Anhand der Kennung und des Passworts erfolgt die Authentifizierung und Autorisierung der Betriebs-

stätte in OASIS.

Page 51: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

10. Eigene Sperren

Seite 51 OASIS Schnittstellenbeschreibung

10.2.1.4 Feld ABFRAGE.LOGINDATEN.BENUTZER

XML-Tag BENUTZER

XML-Typ t_kennung

Feldeigenschaft optional

Feldlänge Mindestens 1 Zeichen, höchstens 30 Zeichen

Zulässige Zeichen Großbuchstaben A-Z (ohne Umlaute) und Ziffern 0-9

Tabelle 56: Feld ABFRAGE.LOGINDATEN.BENUTZER

Definition:

In diesem Feld wird die Kennung eines Superusers WS übertragen.

Anmerkungen:

Das Feld ist nur für die Anwendung OASIS WEB relevant und wird bei OASIS WS ignoriert. Falls das

Feld mitgeliefert wird, muss es schemakonform sein. Inhaltlich wird es nicht geprüft.

10.2.1.5 Felder zum Spieler

Die Felder VORNAME, NACHNAME, GEBURTSNAME, GEBURTSDATUM, GEBURTSORT und die

Feldgruppe ANSCHRIFT und deren Erfassungsregeln und Plausibilitäten sind die unter 6.1 beschrie-

benen.

Beispiel XML

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

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

<LOGINDATEN>

<KENNUNG>F6832171</KENNUNG>

<PASSWORT>Qwertz!2</PASSWORT>

<BENUTZER>000</BENUTZER>

</LOGINDATEN>

<VORNAME>Gabi</VORNAME>

<NACHNAME>Goldfisch</NACHNAME>

<GEBURTSDATUM>1980-01-01</GEBURTSDATUM>

<GEBURTSORT></GEBURTSORT>

<ANSCHRIFT>

<ADRESSZUSATZ>Hinterhaus 1.OG</ADRESSZUSATZ>

</ANSCHRIFT>

</tns:ABFRAGE>

10.2.2 Antwort auf eigene Sperren abfragen mit Parametern 4.0

Zum Schema eigeneSperrenResponse.xsd konformes XML.

Beschreibung des Schemas siehe Eigene-Sperren-Response.

Page 52: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

10. Eigene Sperren

OASIS Schnittstellenbeschreibung Seite 52

10.3 Eigene Sperren abfragen mit SperrID 4.0

Da mit OASIS 4.0 Sperranlässe neu hinzugekommen sind, gibt es neue Funktionen (Funktion 22 sie-

he Schnittstellenfunktionen) zum Abfragen der eigenen Sperren mit Parametern, die zusätzlich die

Sperranlässe zurückliefert.

Nach eigenen Sperren kann mit einer Sperr-ID mit einem zum neuen Schema eigeneSperrenAbfra-

genId.xsd konformen XML gesucht werden.

10.3.1 OASIS 4.0 eigene Sperren abfragen mit SperrID

XML-Root-Element ABFRAGE

XML-Typ t_eigenesperrensuche

Elemente LOGINDATEN

SPERRID

Tabelle 57: Übersicht eigene Sperren abfagen mit SperrID 4.0

10.3.1.1 Feldgruppe LOGINDATEN

XML-Tag LOGINDATEN

XML-Typ t_logindaten

Eigenschaft Anmeldedaten einer Betriebsstätte

Elemente KENNUNG

PASSWORT

BENUTZER

Tabelle 58: Feldgruppe ABFRAGE.LOGINDATEN

10.3.1.2 Feld ABFRAGE.LOGINDATEN.KENNUNG

XML-Tag KENNUNG

XML-Typ t_kennung

Feldeigenschaft Pflichtelement

Feldlänge Mindestens 1 Zeichen, höchstens 30 Zeichen

Zulässige Zeichen Großbuchstaben A-Z (ohne Umlaute) und Ziffern 0-9

Page 53: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

10. Eigene Sperren

Seite 53 OASIS Schnittstellenbeschreibung

Tabelle 59: Feld ABFRAGE.LOGINDATEN.KENNUNG

Definition:

In diesem Feld wird die durch OASIS an die Betriebsstätte vergebene Kennung übermittelt.

Anmerkungen:

Anhand der Kennung und des Passworts erfolgt die Authentifizierung und Autorisierung der Betriebs-

stätte in OASIS.

10.3.1.3 Feld ABFRAGE.LOGINDATEN.PASSWORT

XML-Tag PASSWORT

XML-Typ t_passwort

Feldeigenschaft Pflichtfeld

Feldlänge mindestens 8 Zeichen, höchstens 16 Zeichen

Zulässige Zeichen Buchstaben a-z, A-Z, Umlaute ä,Ä,ö,Ö,ü,Ü,ß,Ziffern 0-9,

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

Tabelle 60: Feld ABFRAGE.LOGINDATEN.PASSWORT

Definition:

In diesem Feld wird das Passwort der Betriebsstätte übermittelt.

Plausibilitäten:

keine

Anmerkungen:

Anhand der Kennung und des Passworts erfolgt die Authentifizierung und Autorisierung der Betriebs-

stätte in OASIS.

10.3.1.4 Feld ABFRAGE.LOGINDATEN.BENUTZER

XML-Tag BENUTZER

XML-Typ t_kennung

Feldeigenschaft optional

Page 54: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

11. Passwort ändern

OASIS Schnittstellenbeschreibung Seite 54

Feldlänge Mindestens 1 Zeichen, höchstens 30 Zeichen

Zulässige Zeichen Großbuchstaben A-Z (ohne Umlaute) und Ziffern 0-9

Tabelle 61: Feld ABFRAGE.LOGINDATEN.BENUTZER

Definition:

In diesem Feld wird die Kennung eines Superusers WS übertragen.

Anmerkungen:

Das Feld ist nur für die Anwendung OASIS WEB relevant und wird bei OASIS WS ignoriert. Falls das

Feld mitgeliefert wird, muss es schemakonform sein. Inhaltlich wird es nicht geprüft.

10.3.1.5 FELD ABFRAGE.SPERRID

XML-Tag SPERRID

XML-Typ t_sperrid

Feldeigenschaft Pflichtfeld, genau ein Element

Zulässige Zeichen Ziffern 0-9

Tabelle 62: Feld ABFRAGE.SPERRID

Definition: Mit der SperrID wird ein Sperreintrag eindeutig im System identifiziert. Der Typ wird in

sperrsystemBasistypen spezifiziert.

Beispiel XML

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

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

<LOGINDATEN>

<KENNUNG>Z1234567</KENNUNG>

<PASSWORT>Qwertz!2</PASSWORT>

<BENUTZER>000</BENUTZER>

</LOGINDATEN>

<SPERRID>3935</SPERRID>

</tns:ABFRAGE>

10.3.2 Antwort auf eigene Sperren abfragen mit SperrID 4.0

Zum Schema eigeneSperrenResponse.xsd konformes XML.

Beschreibung des Schemas siehe Eigene-Sperren-Response.

Page 55: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

11. Passwort ändern

Seite 55 OASIS Schnittstellenbeschreibung

Passwort ändern 11

Da die Authentisierung anhand von Kennung und Passwort erfolgt, gibt es im OASIS-Webservice die

Funktion „Passwort ändern“.

Die Änderung des Passworts erfolgt mit dem durch passwortAenderung.xsd definierten XML.

Die Antwort erfolgt als XML konform zum Schema sperrsystemMeldung.xsd.

11.1 Übersicht

XML-Root-Element PASSWORTAENDERUNG

XML-Typ t_pwd_aenderung

Elemente AUTHENTISIERUNG

PASSWORT-NEU

ZIELOBJEKT

Tabelle 63: Übersicht

Im Folgenden werden die einzelnen Elemente einer Passwortänderung beschrieben. Der XML-Typ

verweist dabei auf die unter 4 beschriebenen Basistypen.

11.2 Feldgruppe AUTHENTISIERUNG

Definition:

Anhand dieser Feldgruppe wird der Veranstalter authentisiert.

Feldeigenschaft: Pflichtgruppe

Zur Beschreibung der Feldgruppe AUTENTISIERUNG siehe Kapitel 5.

11.3 Feld PASSWORT-NEU

XML-Tag PASSWORT-NEU

XML-Typ t_passwort

Feldeigenschaft Pflichtfeld

Feldlänge mindestens 8 Zeichen, höchstens 20 Zeichen

Zulässige Zeichen Buchstaben a-z, A-Z, Umlaute ä,Ä,ö,Ö,ü,Ü,ß,Ziffern 0-9,

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

Page 56: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

11. Passwort ändern

OASIS Schnittstellenbeschreibung Seite 56

Tabelle 64: Feld PASSWORT-NEU

Definition:

Mit diesem Feld wird das neue Passwort übertragen. Es ersetzt nach erfolgreicher Änderung das bis-

herige Passwort.

Anmerkung:

Neben der Prüfung auf Schemakonformität wird eine Eingabeplausibilisierung auf zulässige Zeichen

durchgeführt.

11.4 Feld ZIELOBJEKT

XML-Tag ZIELOBJEKT

XML-Typ t_zielobjekt

Feldeigenschaft optional

Feldlänge Entsprechend der zulässigen Zeichen

Zulässige Zeichen B, V

Tabelle 65: Feld ZIELOBJEKT

Definition:

Da die Authentisierung zwei Berechtigte umfasst (Veranstalter und Benutzer), wird mit diesem Feld

angegeben, für welchen der beiden Berechtigten die Änderung erfolgen soll.

Erfassungsregeln:

Die Feldgruppe AUTHENTISIERUNG.BENUTZER hat hier keine Relevanz. Es wird ausschließlich

anhand der Feldgruppe AUTHENTISIERUNG.VERANSTALTER authentisiert. Daher bezieht sich bis

auf weiteres jede Passwortänderung auf das des Veranstalters.

XML-Typ t_zielobjekt:

Die Definition dieses XML-Typs befindet sich in passwortAenderung.xsd. Es handelt sich um eine xs-

string-basierte Enumeration mit den Werten V und B. V bedeutet, das Passwort des Veranstalters soll

geändert werden, B bedeutet, dass Passwort des Benutzers soll geändert werden

Plausibilitäten:

Der Wert B ist vorerst nicht erlaubt und wird bis auf weiteres abgewiesen.

Page 57: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

12. Erlaubnis prüfen

Seite 57 OASIS Schnittstellenbeschreibung

Erlaubnis prüfen 12

Die Gültigkeit einer Erlaubnis kann mit der Funktion „Erlaubnis auf Gültigkeit prüfen“ des OASIS-

Webservice geprüft werden. Es erfolgt die Authentisierung des Veranstalters anhand der Kennung

und des Passworts.

Eine Prüfung der Erlaubnis erfolgt mit dem durch authentisierung.xsd definierten XML.

Die Antwort erfolgt als XML konform zum Schema sperrsystemMeldung.xsd.

XML-Root-Element AUTHENTISIERUNG

XML-Typ t_authentisierung

Elemente VERANSTALTER

BENUTZER

Tabelle 66: Authentisierung

Feldgruppe AUTHENTISIERUNG

Definition:

Anhand dieser Feldgruppe wird der Veranstalter authentisiert.

Feldeigenschaft: Pflichtgruppe

Zur Beschreibung der Feldgruppe AUTENTISIERUNG siehe Kapitel 5.

Verfügbarkeit prüfen 13

Die Verfügbarkeit des Services OASIS WS kann mit der Funktion „Verfügbarkeitsabfrage“ des OASIS-

Webservice geprüft werden. Es erfolgt die Authentisierung des Veranstalters anhand der Kennung

und des Passworts.

Eine Prüfung der Verfügbarkeit erfolgt mit dem durch authentisierung.xsd definierten XML.

Die Antwort erfolgt als XML konform zum Schema sperrsystemMeldung.xsd mit Meldungsschlüssel

049 bei Verfügbarkeit.

XML-Root-Element AUTHENTISIERUNG

XML-Typ t_authentisierung

Elemente VERANSTALTER

BENUTZER

Tabelle 67: Authentisierung

Page 58: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

14. Releasenummer abfragen

OASIS Schnittstellenbeschreibung Seite 58

Feldgruppe AUTHENTISIERUNG

Definition:

Anhand dieser Feldgruppe wird der Veranstalter authentisiert.

Feldeigenschaft: Pflichtgruppe

Zur Beschreibung der Feldgruppe AUTENTISIERUNG siehe Kapitel 5.

Releasenummer abfragen 14

Die aktuelle Releasenummer von OASIS kann mit der Funktion „Releasenummerabfrage“ des OASIS-

Webservice ermittelt werden. Es erfolgt die Authentisierung des Veranstalters anhand der Kennung

und des Passworts.

Eine Abfrage der Releasenummer erfolgt mit dem durch authentisierung.xsd definierten XML.

Die Antwort erfolgt als XML konform zum Schema sperrsystemMeldung.xsd mit Meldungsschlüssel

050.

XML-Root-Element AUTHENTISIERUNG

XML-Typ t_authentisierung

Elemente VERANSTALTER

BENUTZER

Tabelle 68: Authentisierung

Feldgruppe AUTHENTISIERUNG

Definition:

Anhand dieser Feldgruppe wird der Veranstalter authentisiert.

Feldeigenschaft: Pflichtgruppe

Zur Beschreibung der Feldgruppe AUTENTISIERUNG siehe Kapitel 5.

Länderkatalog laden 15

OASIS stellt den verwendeten Länderkatalog auf Anfrage zur Verfügung. Mit der Funktion „Länderka-

talog holen“ kann der gültige Länderkatalog geladen werden.

Page 59: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

15. Länderkatalog laden

Seite 59 OASIS Schnittstellenbeschreibung

Grundlage bietet der aktuelle durch Destatis veröffentlichte Katalog vom 01.01.2016, auf den in

OASIS Bezug genommen wird.

Jeder Eintrag im Katalog besteht aus der amtlichen Kurzform des Gebiets, dem 3stelligen numeri-

schen Gebietsschlüssel (Gebiet: Destatis-BEV-Code ) und dem 2stelligen alphanumerischen Länder-

kürzel (ISO-3166 Alpha 2).

Die Abfrage des Länderkatalogs erfolgt mit dem durch authentisierung.xsd definierten XML.

Die Antwort erfolgt als XML konform zum Schema katalog.xsd.

XML-Root-Element AUTHENTISIERUNG

XML-Typ t_authentisierung

Elemente VERANSTALTER

BENUTZER

Tabelle 69: Länderkatalog laden

Feldgruppe AUTHENTISIERUNG

Definition:

Anhand dieser Feldgruppe wird der Veranstalter authentisiert.

Zur Beschreibung der Feldgruppe AUTENTISIERUNG siehe Kapitel 5.

15.1 Länderkatalog

Der Länderkatalog wird als zum Schema katalog.xsd konformes XML zurückgegeben.

XML-Root-Element KATALOG

Elemente KATALOGNAME

KATALOGITEM

Tabelle 70: Katalog

15.1.1 Feld KATALOGNAME

XML-Tag KATALOGNAME

XML-Typ t_name

Feldeigenschaft Pflichtfeld

Feldlänge Höchstens 85 Zeichen

Page 60: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

16. Katalog Sperranlässe holen

OASIS Schnittstellenbeschreibung Seite 60

Zulässige Zeichen xs:string

Tabelle 71: Feld KATALOGNAME

Definition:

Mit diesem Feld wird der Name des Katalogs übertragen.

15.1.2 Feldgruppe KATALOGITEM

XML-Tag KATALOGITEM

XML-Typ t_katalog_item

Feldeigenschaft beliebig viele Elemente

Elemente KBEZ1

KBEZ2

LBEZ

Tabelle 72: Feldgruppe KATALOGITEM

Definition:

Mit jedem Katalogitem wird ein Eintrag in den Katalog übertragen.

XML-Tagname XML-Typ Eigenschaft Länge Bedeutung

KBEZ1 t_name Pflichtfeld maximal 85

Zeichen

3stelliger numerischer

Schlüssel (Destatis-BEV-

Code)

KBEZ2 t_name Pflichtfeld maximal 85

Zeichen

2stelliges Länderkürzel (ISO-

3166 Alpha 2)

LBEZ t_name Pflichtfeld maximal 85

Zeichen

Amtliche Kurzform des

Staatsnamen

Tabelle 73: Definition KATALOGITEM

OASIS nimmt in Spielerdaten nur den 3stelligen numerischen Schlüssel (Destatis-BEV-Code) entge-

gen.

Katalog Sperranlässe holen 16

OASIS stellt den Katalog „Sperranlässe“ auf Anfrage zur Verfügung. Mit der Funktion „Katalog Sperran-

lässe holen“ (Funktion 18 – siehe Abschnitt 2.2) kann der gültige Katalog der Sperranlässe geladen

werden.

Page 61: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

16. Katalog Sperranlässe holen

Seite 61 OASIS Schnittstellenbeschreibung

16.1 Authentisierung

Die Abfrage des Katalogs erfolgt mit dem durch authentisierung.xsd definierten XML, siehe Kapitel 5.

16.2 Katalog Sperranlässe

Der Katalog Sperranlässe wird als zum XML-Schema sperranlässe.xsd konformes XML zurückgege-

ben.

XML-Root-Element KAT_SPERRANLAESSE

XML-Typ t_kat_sperranlaesse

Elemente ANLASS

Tabelle 74: Katalog Sperranlässe

16.2.1 Feldgruppe ANLASS

XML-Tag ANLASS

XML-Typ t_anlass_sperre

Feldeigenschaft beliebig viele Elemente (praktisch maximal 99)

Elemente KENNUNG – Pflichtfeld. Zweistelliger fachlicher Schlüssel

aus dem Katalog Sperranlässe.

BEZEICHNUNG – Pflichtfeld

SORTNR – Pflichtfeld

Tabelle 75: Feldgruppe ANLASS

Definition:

Mit jedem ANLASS wird ein Element des Katalogs übertragen.

XML-

Tagname

XML-Typ Eigenschaft Länge Bedeutung

KENNUNG t_anlass_sperre_

kennung

Pflichtfeld genau 2 Zif-

fern

2stelliger fachlicher Schlüssel,

der beim Anlegen und Ändern

von Sperren benötigt wird

BEZEICH-

NUNG

StringLatin Pflichtfeld maximal 150

Zeichen

Bezeichnung des Sperranlas-

ses z.B. zur Anzeige in einem

grafischen User Interface

SORTNR int Pflichtfeld Nummer zum Sortieren der

Katalogelemente beim Anzei-

Page 62: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

17. Batch 2.0

OASIS Schnittstellenbeschreibung Seite 62

gen in einem grafischen User

Interface. Die Sortierreihenfol-

ge entspricht den Anforderun-

gen von OASIS und kann von

den Verwendern des Katalogs

ignoriert werden.

Tabelle 76: Definition ANLASS

OASIS verwendet beim Anlegen und Ändern einer Sperre lediglich den 2stelligen fachlichen Schlüssel

(KENNUNG).

Batch 2.0 17

Im Unterschied zur bestehenden Batch-Funktionalität werden Batch-Anfragen in Batch 2.0 asynchron

verarbeitet. Die Batch 2.0 Schnittstelle erwartet die Batchanfrage in gepackter Form (gzip). Das er-

möglicht ein schnelleres Hochladen großer Batch-Anfragen.

OASIS Batch 2.0 unterliegt technischen Vorgaben, die unter folgender Adresse eingesehen werden

können:

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

Der Status der eigenen offenen Batch-Anfragen kann abgefragt werden. Ist die Abarbeitung eines

Batches beendet, kann das Batchergebnis in Form eines gzip-Files abgeholt werden.

Im folgenden werden Betriebsstätten und deren Mitarbeiter und/oder Dienstleister als Webservice-

Nutzer bezeichnet.

1. Voraussetzunge für die Nutzung der Batch 2.0 Funktionalität

Voraussetzung für die Nutzung von Batch 2.0 ist eine Berechtigung dazu.

2. Welche Punkte müssen vor der Nutzung noch beachtet werden

a. Jeder berechtigten Betriebsstätte wurde ein Zeitraum zugeordnet, an dem sie Batchabfragen

durchführen kann. Dieser könnte zum Beispiel lauten: Dienstags, zwischen 12:00 und 14:00 Uhr.

b. Für jeden Zeitraum gibt es eine maximale Anzahl von Batchabfragen, die nach OASIS hochgela-

den werden dürfen.

c. Für jede Batchabfrage gibt es eine maximale Anzahl von einzelnen Personen, die abgefragt wer-

den dürfen.

3. Ablauf

Page 63: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

17. Batch 2.0

Seite 63 OASIS Schnittstellenbeschreibung

Bevor eine Batchabfrage durchgeführt werden kann muss jeder Webservice-Nutzer sicherstellen,

dass die Punkte unter (2) eingehalten wurden!

a. Um eine Batchabfrage durchzuführen, muss zunächst auf Seiten des Webservice-Nutzers (Kapitel

17.1)

Eine Batch-XML Datei erzeugt werden,

Die Batch-XML Datei mit gzip gepackt werden

b. Batchabfrage über die OASIS Schnittstellenfunktion „Einstellen einer Batch 2.0 Abfrage“ durchfüh-

ren (Kapitel 17.1)

Request: Die erstellte XML-Datei nach OASIS hochladen (siehe Kapitel 17.1.1)

Response: die von OASIS erhaltene Bestätigung der Anfrage auswerten (siehe Kapitel 17.1.2)

c. Optionaler Schritt: Prüfen der Status von allen Batchabfragen einer Betriebsstätte (Kapitel 17.3)

Request: XML-Datei nach OASIS hochladen (siehe Kapitel 17.3.1)

Response: die von OASIS erhaltene Bestätigung der Anfrage auswerten (siehe Kapitel17.3.2)

Dieser Schritt ist optional und kann weggelassen werden. Es kann direkt versucht werden ein Bat-

chergebniss abzufragen - siehe d). Falls das Ergebnis noch nicht vorliegt ist dies an der Response

der Abfrage unter d) zu erkennen.

d. Abholen des Ergebnisses der unter a) hochgeladenen Batchabfrage (Kapitel 17.2)

Request: XML-Datei nach OASIS hochladen (siehe Kapitel 17.2.1)

Response: die von OASIS erhaltene Bestätigung der Anfrage auswerten (siehe Kapitel 17.2.2)

Es gibt folgende Status, in denen sich ein Batchabfrage befinden kann:

Status Bedeutung

WAITING

Dieser Status bedeutet, dass eine Batch-Anfrage auf ihre Abarbeitung wartet.

In diesem Status befindet sich eine Batch-Anfrage direkt nachdem sie OASIS übergeben – und in der Datenbank eingetragen wurde.

RUNNING

Dieser Status zeigt an, dass ein Batch gerade ausgeführt wird.

Nachdem der Batch im Status WAITING gewartet hat, wird er vom Scheduler in den Status RUNNING versetzt und ausgeführt. Aus einem Batch werden nun mehrere Statusabfragen an die Datenbank verschickt

CANCELLED Eine Batch-Anfrage in diesem Status wurde manuell abgebrochen. In diesem Fall ist die Abarbeitung eines Batches beendet und die Mitteilung bezüglich des Abbruchs kann als Ergebnis abgeholt werden.

FINISHED Dieser Status bedeutet, dass die Abarbeitung eines Batches beendet ist und das Batch-Ergebnis von der Betriebsstätte abgeholt werden kann.

COMPLETED In diesem Status befindet sich eine Batch-Abfrage, wenn die Betriebsstätte das Ergebnis der Batch-Abfrage abgeholt hat.

Page 64: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

17. Batch 2.0

OASIS Schnittstellenbeschreibung Seite 64

ARCHIVED Der letzte Status, in den eine Batch-Abfrage versetzt wird zeigt an, dass der komplette Zyklus beendet ist, indem die XML-Request Daten (Spielerdaten) sowie das Ergebnis aus Datenschutzgründen aus der Tabelle entfernt wurden.

17.1 Einstellen einer Batch 2.0 Abfrage (Request)

17.1.1 Einstellen einer Batch 2.0 Abfrage

Das Übertragen der XML-Struktur erfolgt in gepackter Form mittels gzip.

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

XML-Schema: batchAnlegen.xsd

Die Authentisierungscredetials (Betriebsstättenkennung und Passwort) werden mit 2 neuen HTTP-

Header-Parametern übermittelt.

Identische BatchAnfragen innerhalb des selben Timeslots werden auf Grundlage ihres MD5-Hashes

ermittelt und abgelehnt.

Eine Validierung des Bodys erfolgt noch nicht beim Hochladen eines Batchauftrags, sondern erst beim

Abarbeiten des Batchauftrags.

Der Batchauftrag wird bei der Bearbeitung abgelehnt, wenn das gelieferte XML nicht schemakonform

ist, gegen weitergehende Plausibilisierungen verstößt oder keine Datensätze (also keine Feldgruppen

DS) enthält.

HTTP-Header-Parameter

OASIS_KENNUNG Kennung der Betriebsstätte. Pattern [0-9A-Z]{1,30}

OASIS_PWD Passwort des Superusers WS der Betriebsstätte. Mindestens 8, höchstens 16 Buchstaben a-z, A-Z, Umlaute ä,Ä,ö,Ö,ü,Ü,ß,Ziffern 0-9, Sonderzeichen: ! # $ % ' ( ) * _ + , - . / : ; = ? | ~ §

Tabelle 77: HTTP Header Parameter

Page 65: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

17. Batch 2.0

Seite 65 OASIS Schnittstellenbeschreibung

Batch Anlegen Request XML:

Die Tagnamen wurden so kurz wie möglich gewählt, damit der Payload möglichst klein wird, auch

wenn das die Lesbarkeit des XML etwas beeinträchtigt.

XML-Schema batchAnlegen.xsd

XML-Root-Element BATCH_ANLEGEN_REQUEST

XML-Typ t_batch_anlegen_request

Elemente DS

17.1.1.1 Feldgruppe BATCH_ANLEGEN_REQUEST.DS

XML-Tag DS

XML-Typ t_batchanlegen_datensatz

Eigenschaft Datensatz einer Statusabfrage

Elemente I

F

SP

Tabelle 78: Feldgruppe BATCH_ANLEGEN_REQUEST.DS

17.1.1.2 Feld BATCH_ANLEGEN_REQUEST.DS.I

XML-Tag I

XML-Typ t_ds_id

Feldeigenschaft Pflichtelement

Feldlänge mindestens eine, maximal 7 Ziffern

Zulässige Zeichen Ziffern 0-9

Tabelle 79: Feld BATCH_ANLEGEN_REQUEST.DS.I

Definition:

Innerhalb des XML eindeutige ID dieses Datensatzes. Die ID wird aus der Batch-Abfrage zu diesem

Datensatz übernommen. Von OASIS wird nicht überprüft, ob diese ID wirklich eindeutig ist. Dies si-

cherzustellen bleibt dem Aufrufer überlassen.

Page 66: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

17. Batch 2.0

OASIS Schnittstellenbeschreibung Seite 66

17.1.1.3 Feld BATCH_ANLEGEN_REQUEST.DS.F

XML-Tag F

XML-Typ t_freitext

Feldeigenschaft optional

Feldlänge höchstens 16 Zeichen

Zulässige Zeichen Buchstaben a-z, A-Z, Umlaute ä,Ä,ö,Ö,ü,Ü,ß, Ziffern 0-9,

Sonderzeichen: Leerzeichen, - / ()

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

Tabelle 80: BATCH_ANLEGEN_REQUEST.DS.F

Definition:

Mit diesem Feld kann jeder Datensatz zusätzlich mit einem Freitext (Kundennummer, etc.) versehen

werden. Der Feldinhalt wird in die Antwort übernommen.

17.1.1.4 Feldgruppe BATCH_ANLEGEN_REQUEST.DS.SP

XML-Tag SP

XML-Typ t_spielerdaten

Eigenschaft Spielerdaten für die Statusabfrage

Elemente V (= Vorname)

N (= Nachname)

G (= Geburtsname)

D (= Geburtsdatum)

O (= Geburtsort)

A (= Feldgruppe Anschrift)

Tabelle 81: Feldgruppe BATCH_ANLEGEN_REQUEST.DS.SP

Definition:

Mit dieser Feldgruppe werden die Daten des Spielers für die Statusabfrage übertragen.

Plausibilitäten:

Es gelten die Aussagen aus Kapitel Abfrage des Spielerstatus in OASIS.

Page 67: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

17. Batch 2.0

Seite 67 OASIS Schnittstellenbeschreibung

17.1.1.5 Feldgruppe BATCH_ANLEGEN_REQUEST.DS.SP.A

XML-Tag A

XML-Typ t_anschriftdaten

Eigenschaft Anschriftdaten für die Statusabfrage

Elemente P (= Postleitzahl)

W (= Wohnort)

S (= Straße)

H (= Hausnummer)

Z (= Adresszusatz)

L (= Land)

Tabelle 82: Feldgruppe BATCH_ANLEGEN_REQUEST.DS.SP.A

Definition:

Mit dieser Feldgruppe werden die Daten der Wohnanschrift des Spielers für die Statusabfrage über-

tragen.

Plausibilitäten:

Es gelten die Aussagen aus Kapitel Abfrage des Spielerstatus in OASIS.

Beispiel XML (Request)

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

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

<!-- 1. Datensatz -->

<DS> <!--Typ t_batchanlegen_datensatz -->

<I>1</I>

<F>Meine Anmerkung</F>

<SP> <!--Typ t_spielerdaten -->

<V>Peter</V>

<N>Müller</N>

<G>Schmidt</G>

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

<O>Hamburg</O>

<A>

<P>12345</P>

<W>Hamburg</W>

<S>Parkstraße</S>

<H>3</H>

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

<L>000</L>

</A>

</SP>

</DS>

<!-- 2. Datensatz -->

<DS> <!--Typ t_batchanlegen_datensatz -->

<I>2</I>

<F>Meine Anmerkung</F>

<SP> <!--Typ t_spielerdaten -->

<V>Gabi</V>

<N>Goldfisch</N>

Page 68: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

17. Batch 2.0

OASIS Schnittstellenbeschreibung Seite 68

<G>Schmidt</G>

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

<O>Berlin</O>

<A>

<P>12345</P>

<W>Dresden</W>

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

<H>12 a</H>

<L>000</L>

</A>

</SP>

</DS>

<!-- n. Datensatz -->

<!-- … usw. -->

</tns:BATCH_ANLEGEN_REQUEST>

17.1.2 Antwort auf das Einstellen einer Batch 2.0 Abfrage (Batch-Response)

Zum Schema batchAnlegenResponse.xsd konformes XML.

XML-Schema: batchAnlegenResponse.xsd

Beschreibung des Schemas siehe Batch-Anlegen-Response

Beispiel 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 Abholen eines Batch 2.0 Jobs-Ergebnisses

Der Webservice ermöglicht den Download des Ergebnisses eines Batchjobs im Status FINISHED.

Durch das Herunterladen des Ergebnisses werden die Batchabfrage und die Batchantwort in der Da-

tenbank gelöscht und stehen nicht mehr zur Verfügung.

17.2.1 Abholen eines Batch 2.0 Ergebnisses

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

Page 69: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

17. Batch 2.0

Seite 69 OASIS Schnittstellenbeschreibung

Die Authentisierungscredetials (Betriebsstättenkennung und Passwort) werden mit 2 HTTP-Header-

Parametern übermittelt, die BATCH-ID als PATH-Parameter. Daher ist kein XML zum Abholen des

Batchergebnisses erforderlich.

HTTP-Header-Parameter

OASIS_KENNUNG Kennung der Betriebsstätte. Pattern [0-9A-Z]{1,30}

OASIS_PWD Passwort des Superusers WS der Betriebsstätte. Mindestens 8, höchstens 16 Buchstaben a-z, A-Z, Umlaute ä,Ä,ö,Ö,ü,Ü,ß,Ziffern 0-9, Sonderzeichen: ! # $ % ' ( ) * _ + , - . / : ; = ? | ~ §

PATH Parameter

BATCH-ID

Die mit dem BatchAnlegenResponse durch OASIS übermittelte BATCH-ID. Beispiel

URL-Aufruf für das Abholen eines Batches mit der Batch ID <111>:

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

17.2.2 Antwort auf das Abholen eines Batch 2.0 Ergebnisses

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

XML-Schema: batchResponse.xsd

Hat der abgefragte Batchauftrag den Status FINISHED, d.h. liegt ein Ergebnis vor und ist mindestens

ein Spieler gesperrt, so enthält das zurückgelieferte XML mindestens eine Feldgruppe DS (siehe

Feldgruppe DS). Die Felder ANZAHL-ERFOLGREICH-VERARBEITET, ANZAHL-NICHT-GESPERRT,

ANZAHL-GESPERRT und ANZAHL-NICHT-EINDEUTIG enthalten die korrekten Zahlen.

Hat der abgefragte Batchauftrag einen anderen Status als FINISHED, dann fehlt die Feldgruppe

<DS>, da keine Datensätze zurückgegeben werden. Die Felder <ANZAHL_...> enthalten den Wert 0,

<SPERRSYSTEM-MELDUNG> ist entsprechend des aktuellen Status gefüllt.

Die Feldgruppe SPERRSYSTEM-MELDUNG enthält Informationen, entsprechend dem Meldungskata-

log.

Beschreibung des XML BatchResponse siehe Batch 2.0 Abholen des Batch-Ergebnisses

Beispiel XML (Response)

Page 70: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

17. Batch 2.0

OASIS Schnittstellenbeschreibung Seite 70

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

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

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

<BATCH-ID>1</BATCH-ID>

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

<SCHLUESSEL>0078</SCHLUESSEL>

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

</RESPONSE-STATUS>

<DS>

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

<FREITEXT>123-00001</FREITEXT>

<SPERRSYSTEM-MELDUNG>

<ART>W</ART>

<SCHLUESSEL>0018</SCHLUESSEL>

<MELDUNG>Der Spieler ist gesperrt</MELDUNG>

<SPERRINFO>

<SPERRID>61524</SPERRID>

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

<FREITEXT>123-00331</FREITEXT>

<SPERRSYSTEM-MELDUNG>

<ART>W</ART>

<SCHLUESSEL>0018</SCHLUESSEL>

<MELDUNG>Der Spieler ist gesperrt</MELDUNG>

<SPERRINFO>

<SPERRID>524</SPERRID>

<BESITZER>

<NAME>Lotto Sachsen-Anhalt</NAME>

<ANSPRECHPARTNER>Flotte Lotte</ANSPRECHPARTNER>

<TELEFON>01234-56789</TELEFON>

<EMAIL>[email protected]</EMAIL>

</BESITZER>

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

<SPERRGRUND>SELBST</SPERRGRUND>

</SPERRINFO>

</SPERRSYSTEM-MELDUNG>

</DS>

<DS>

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

<FREITEXT>123-12100</FREITEXT>

<SPERRSYSTEM-MELDUNG>

<ART>W</ART>

<SCHLUESSEL>0023</SCHLUESSEL>

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

Sie die Suche ein.</MELDUNG>

<SPERRINFO>

<SPERRID>61524</SPERRID>

<BESITZER>

<NAME>Hurtigspielhölle</NAME>

<ANSPRECHPARTNER>Hugo Hurtig</ANSPRECHPARTNER>

<TELEFON>1234-56789</TELEFON>

<EMAIL>[email protected]</EMAIL>

</BESITZER>

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

Page 71: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

17. Batch 2.0

Seite 71 OASIS Schnittstellenbeschreibung

<SPERRGRUND>SELBST</SPERRGRUND>

</SPERRINFO>

<SPERRINFO>

<SPERRID>524</SPERRID>

<BESITZER>

<NAME>Spielhalle Kleinkuckucksheim</NAME>

<ANSPRECHPARTNER>Clara Fall</ANSPRECHPARTNER>

<TELEFON>62534-56789</TELEFON>

<EMAIL>[email protected]</EMAIL>

</BESITZER>

<SPERRDATUM>2014-04-15</SPERRDATUM>

<SPERRGRUND>SELBST</SPERRGRUND>

</SPERRINFO>

</SPERRSYSTEM-MELDUNG>

</DS>

</tns:BATCHRESPONSE>

Response codes sind z.B.:

Nr Bedeutung

0076 Diese Fehlermeldung wird erzeugt, wenn versucht wird das Ergebnis einer Batch-Abfrage abzuholen, die noch nicht begonnen wurde.

0075 Diese Fehlermeldung wird erzeugt, wenn versucht wird das Ergebnis einer Batch-Abfrage abzuholen, die noch in Bearbeitung ist.

0078 Der Batchlauf wurde ohne Warnung oder Fehler beendet.

<RESPONSE-TEXT>: „kein Fehler aufgetreten“

0079

Bei mindestens einer Spielerstatusabfrage sind Fehler aufgetreten.Die Batchverarbei-tung konnte aber mit dem nächsten zu verarbeitenden Datensatz fortfahren.

Welche(r) Datensätze fehler verursacht haben ist im Element <SPERRSYSTEM-MELDUNG> des Datensatzes einzusehen.

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

0080

Die Batchabfrage als Ganzes konnte nicht ausgeführt werden, z.B. nicht valides XML, oder die Datenbank steht nicht zur Verfügung, etc.

Da es hierführ mehrere Fehlermöglichkeiten gibt, steht in <RESPONSE-TEXT> die entsprechende Fehlermedung und kein fester Text.

17.3 Statusabfrage eines Batch 2.0 Jobs

Der Service ermöglicht das Abfragen der Status von eigenen Batch 2.0 Abfragen. Es werden nur Batch 2.0 Ab-

fragen berücksichtigt, die noch nicht archiviert (Status=ARCHIVED) sind.

Page 72: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

18. Aktuelle Informationen

OASIS Schnittstellenbeschreibung Seite 72

17.3.1 Abfrage der Status der Batch-2.0-Jobs

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

Die Authentisierungscredetials (Betriebsstättenkennung und Passwort) werden mit 2 neuen HTTP-

Header-Parametern übermittelt. Daher ist kein XML zum Abholen des Batchergebnisses erforderlich.

HTTP-Header-Parameter

OASIS_KENNUNG Kennung der Betriebsstätte. Pattern [0-9A-Z]{1,30}

OASIS_PWD Passwort des Superusers WS der Betriebsstätte. Mindestens 8, höchstens 16 Buchstaben a-z, A-Z, Umlaute ä,Ä,ö,Ö,ü,Ü,ß,Ziffern 0-9, Sonderzeichen: ! # $ % ' ( ) * _ + , - . / : ; = ? | ~ §

17.3.2 Antwort auf Abfrage der Status der Batch-2.0-Jobs

Eine erfolgreich eingestellte Batch 2.0 Abfrage durchläuf in OASIS WS verschiedene Zustände:

17.3.2.1 Status einer Batch 2.0 Abfrage

Status Bedeutung

WAITING Die Batch 2.0 Abfrage wartet auf ihre Verarbeitung.

RUNNING Die Batch 2.0 Abfrage wird aktuell abgearbeitet.

FINISHED Die Batch 2.0 Abfrage ist abgearbeitet und das Ergebnis liegt

zum Download vor. Das gesendete XML der Batchabfrage

liegt in OASIS nicht mehr vor.

COMPLETED Das Ergebnis der Batch 2.0 Abfrage wurde durch den Anfra-

ger abgeholt. Das XML des Ergebnisses der Batchabfrage

liegt in OASIS nicht mehr vor

CANCELLED Die Batch 2.0 Abfrage wurde manuell abgebrochen. Es liegt

kein Ergebnis vor

Beschreibung des XML-Schemas siehe Batch 2.0 Informationen über die Batchjobs

Aktuelle Informationen 18

Page 73: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

18. Aktuelle Informationen

Seite 73 OASIS Schnittstellenbeschreibung

Unter „aktuellen Informationen“ sollen Meldungen verstanden werden, die „sehr dringend“ oder zu-

mindest „wichtig“ sind, z.B. Teilausfall eines Systems, Ankündigung von Wartungsarbeiten, anstehen-

de Releasewechsel, etc.

Solche Informationen können den OASIS Nutzern über eine Schnittstellenfunktion zur Verfügung ge-

stellt werden.

18.1 Anfrage

Die Anfrage erfolgt mit dem durch authentisierung.xsd definierten XML (Kapitel 5).

18.2 Antwort

In einer strukturierten Antwort werden die Meldungen zurückgegeben.

XML-Schema: informationen.xsd

XML-Root-Element INFORMATIONEN

XML-Typ t_informationen

Elemente SPERRSYSTEM-MELDUNG

INFORMATION

Tabelle 83: Aufbau Informationen

18.2.1 Feldgruppe SPERRSYSTEM-MELDUNG

Definition:

Diese Feldgruppe entspricht einer Sperrsystem-meldung.

Feldeigenschaft: Pflichtgruppe

Zur Beschreibung der Feldgruppe Sperrsystem-meldung siehe Kapitel 18.

18.2.2 Feldgruppe INFORMATION

Definition:

Diese Feldgruppe enthält die Meldung, den Gültigkeitszeitraum und das Datum der letzten Bearbei-

tung.

XML-Tag INFORMATION

Page 74: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

18. Aktuelle Informationen

OASIS Schnittstellenbeschreibung Seite 74

XML-Typ t_information

Feldeigenschaft optional, beliebig viele Elemente

Elemente ID

TEXT

VON

BIS

MODIFIED

Tabelle 84: Feldgruppe Information

18.2.2.1 Feld INFORMATION.ID

XML-Tag ID

XML-Typ t_info_id

Feldeigenschaft Pflichtfeld

Pattern [\d]{1,9}

Zulässige Zeichen xs:string

Tabelle 85: Meldungs-ID

Definition:

In diesem Feld wird die ID einer aktuellen Information übermittelt.

18.2.2.2 Feld INFORMATION.TEXT

XML-Tag TEXT

XML-Typ t_text

Feldeigenschaft Pflichtfeld

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

Zulässige Zeichen xs:string

Tabelle 86: Meldungstext einer aktuellen Information

Definition:

In diesem Feld wird der Meldungstext einer aktuellen Information übermittelt.

Page 75: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

18. Aktuelle Informationen

Seite 75 OASIS Schnittstellenbeschreibung

18.2.2.3 Feld INFORMATION.VON

XML-Tag VON

XML-Typ xs:date

Feldeigenschaften Pflichtfeld

Zulässige Zeichen xs:date

Tabelle 87: aktuelle Information gültig von...

Definition:

In diesem Feld wird der Anfang des Gültigkeitszeitraumes der aktuellen Information übermittelt.

18.2.2.4 Feld INFORMATION.BIS

XML-Tag BIS

XML-Typ xs:date

Feldeigenschaften Pflichtfeld

Zulässige Zeichen xs:date

Tabelle 88: aktuelle Information gültig bis...

Definition:

In diesem Feld wird das Ende des Gültigkeitszeitraumes der aktuellen Information übermittelt.

18.2.2.5 Feld INFORMATION.MODIFIED

XML-Tag MODIFIED

XML-Typ xs:dateTime

Feldeigenschaften Pflichtfeld

Zulässige Zeichen xs:dateTime

Tabelle 89: Zeitpunkt der letzten Aktualisierung der Meldung

Definition:

In diesem Feld wird der Zeitpunkt der letzten Aktualisierung der aktuellen Information übermittelt.

Beispiel einer Antwort:

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

Page 76: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

19. Antworten aus OASIS

OASIS Schnittstellenbeschreibung Seite 76

<SPERRSYSTEM-MELDUNG>

<ART>I</ART>

<SCHLUESSEL>0049</SCHLUESSEL>

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

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

Es können zwischen 0 und unbegrenzt viele Informationselemente zurückgegeben werden. Die Ele-

mente innerhlab des Informationselementes sind Pflichtfelder, die nur einemal vorkommen.

Antworten aus OASIS 19

19.1 Sperrsystem-Meldung

Eine Sperrsystem-Meldung entspricht dem durch sperrsystemMeldung.xsd definierten XML.

Übersicht:

XML-Root-Element SPERRSYSTEM-MELDUNG

XML-Typ t_meldung

Datenfelder ART

SCHLUESSEL

MELDUNG

SPERRINFO

Tabelle 90: SPERRSYSTEM-MELDUNG

Page 77: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

19. Antworten aus OASIS

Seite 77 OASIS Schnittstellenbeschreibung

19.1.1 SPERRSYSTEM-MELDUNG

19.1.1.1 Feld ART

XML-Tag ART

XML-Typ t_meldungsart aus sperrsystemBasistypen.xsd

xs:string-basierte Enumeration

Feldeigenschaft Pflichtfeld

Zulässige Werte I, W, E

Tabelle 91: Feld ART

Definition:

In diesem Feld wird übermittelt, ob die Anfrage an OASIS erfolgreich war.

Bedeutung:

I bedeutet Information. Es ist kein Fehler aufgetreten. Beispiel: die Meldung, dass ein Spieler

nicht gesperrt ist, hat die Art I. Die Meldung, dass eine Erlaubnis gültig ist, hat ebenfalls die

Art I

W bedeutet Warnung. Es ist kein Fehler aufgetreten. Beispiel: die Meldung, dass ein Spieler

gesperrt ist, hat die Art W

E bedeutet „Error“. Es ist ein Fehler aufgetreten. Dies kann ein Fehler sein, der durch fehler-

haftes XML oder Fehler bei der Plausibilisierung der Daten oder einen Programmfehler oder

einen Ausfall des OASIS-Services verursacht wurde

19.1.1.2 Feld SCHLUESSEL

XML-Tag SCHLUESSEL

XML-Typ t_meldung_schluessel aus sperrsystemBasistypen.xsd

Feldeigenschaft optional

Feldlänge Genau 4 Ziffern

Zulässige Zeichen [0-9]{4}

Tabelle 92: Feld SCHLUESSEL

Definition:

Dieses Feld übermittelt den Schlüssel eines Meldungskatalogs. Der Meldungskatalog liegt im Anhang

bei. Es kann dabei noch redaktionelle Änderungen geben.

Page 78: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

19. Antworten aus OASIS

OASIS Schnittstellenbeschreibung Seite 78

19.1.1.3 Feld MELDUNG

XML-Tag MELDUNG

XML-Typ t_meldung_text aus sperrsystemBasistypen.xsd

Feldeigenschaft optional

Feldlänge Mindestens 1 Zeichen, höchstens 4000 Zeichen

Zulässige Zeichen xs:string

Tabelle 93: Feld MELDUNG

Definition:

Mit dieser Meldung werden ausführliche Informationen zu Fehlersituationen und andere Informatio-

nen, die für die Bewertung der Antwort nützlich sind, übermittelt.

19.1.2 Feldgruppe SPERRINFO

XML-Tag SPERRINFO

XML-Typ t_sperrinformation

Feldeigenschaft optional, beliebig viele Elemente

Elemente SPERRID

BESITZER

SPERRDATUM

SPERRGRUND

SPIELER

ANLASS

Tabelle 94: Feldgruppe SPERRINFO

Definition:

Mit Sperrinfo werden Daten eines Sperreintrags übermittelt. Der Detailierungsgrad hängt von der ein-

gehenden Anfrage ab.

19.1.2.1 Feld SPERRID

XML-Tag SPERRID

XML-Typ t_sperrid

Feldeigenschaft Pflichtfeld, genau ein Element

Page 79: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

19. Antworten aus OASIS

Seite 79 OASIS Schnittstellenbeschreibung

Zulässige Zeichen sb:t_sperrid

Tabelle 95: Feld SPERRID

Definition:

Mit der SperrID wird ein Sperreintrag eindeutig im System identifiziert. Der Typ wird in sperrsystemBa-

sistypen spezifiziert.

19.1.2.2 Feld SPERRDATUM

XML-Tag SPERRDATUM

XML-Typ t_sperrid

Feldeigenschaft optional, maximal ein Element

Zulässige Zeichen xs:date

Tabelle 96: Feld SPERRDATUM

Definition:

Mit diesem Feld wird das Sperrdatum übermittelt.

HINWEIS:

Es wird empfohlen, beim Aufheben einer Sperre anhand des Sperrdatums zu überprüfen, ob eine

Sperre unterjährig aufgehoben wird.

19.1.2.3 Feld SPERRGRUND

XML-Tag SPERRGRUND

XML-Typ t_sperrgrund

Feldeigenschaft optional, maximal ein Element

Zulässige Zeichen sb:t_sperrgrund

Tabelle 97: Feld SPERRGRUND

Definition:

Der Typ wird in sperrsystemBasistypen spezifiziert.

19.1.2.4 Feld SPIELER

XML-Tag SPIELER

XML-Typ t_spieler

Page 80: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

19. Antworten aus OASIS

OASIS Schnittstellenbeschreibung Seite 80

Feldeigenschaft optional, maximal ein Element

Zulässige Zeichen sb:t_spieler

Tabelle 98: Feld SPIELER

Definition:

Der Typ wird in sperrsystemBasistypen spezifiziert.

19.1.3 Feldgruppe BESITZER

XML-Tag BESITZER

XML-Typ t_sperrenbesitzer

Feldeigenschaft optional, maximal ein Element

Elemente NAME

ANSPRECHPARTNER

TELEFON

EMAIL

Tabelle 99: Feldgruppe BESITZER

Definition:

Mit Besitzer werden Daten des Veranstalters übertragen, der eine bestimmte Sperre ändern darf.

Anmerkungen:

Diese Feldgruppe wird nur im Fall von Statusabfragen übertragen, sofern ein Spieler als gesperrt

identifiziert wurde.

19.1.3.1 Feld BESITZER.NAME

XML-Tag NAME

XML-Typ xs:string

Feldeigenschaft Pflichtfeld

Feldlänge Höchstens 200 Zeichen

Tabelle 100: Feld BESITZER.NAME

Definition:

Mit diesem Feld wird der Name des Veranstalters übertragen.

Page 81: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

19. Antworten aus OASIS

Seite 81 OASIS Schnittstellenbeschreibung

19.1.3.2 Feld BESITZER.ANSPRECHPARTNER

XML-Tag NAME

XML-Typ xs:string

Feldeigenschaft optional

Feldlänge Höchstens 200 Zeichen

Tabelle 101: Feld BESITZER.ANSPRECHPARTNER

Definition:

Mit diesem Feld wird der Name eines Ansprechpartners des Veranstalters übertragen.

19.1.3.3 Feld BESITZER.TELEFON

XML-Tag NAME

XML-Typ xs:string

Feldeigenschaft optional

Feldlänge Höchstens 50 Zeichen

Tabelle 102: Feld BESITZER.TELEFON

Definition:

Mit diesem Feld wird eine Telefonnummer des Veranstalters übertragen.

19.1.3.4 Feld BESITZER.EMAIL

XML-Tag NAME

XML-Typ xs:string

Feldeigenschaft optional

Feldlänge Höchstens 100 Zeichen

Tabelle 103: Feld BESITZER.EMAIL

Definition:

Mit diesem Feld wird eine Mailadresse des Veranstalters übertragen.

19.1.4 Feldgruppe ANLASS

XML-Tag ANLASS

XML-Typ t_anlass_sperre

Page 82: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

19. Antworten aus OASIS

OASIS Schnittstellenbeschreibung Seite 82

Feldeigenschaft beliebig viele Elemente (praktisch maximal 99)

Elemente KENNUNG – Pflichtfeld. Zweistelliger fachlicher Schlüssel

aus dem Katalog Sperranlässe.

BEZEICHNUNG – Pflichtfeld

SORTNR – Pflichtfeld

Tabelle 104: Feldgruppe ANLASS

Definition:

Mit jedem Element wird ein der Sperre zugeordneter Sperranlass übertragen

XML-

Tagname

XML-Typ Eigenschaft Länge Bedeutung

KENNUNG t_anlass_sperre_

kennung

Pflichtfeld genau 2 Zif-

fern

2stelliger fachlicher Schlüssel,

der beim Anlegen und Ändern

von Sperren benötigt wird

BEZEICH-

NUNG

StringLatin Pflichtfeld maximal 150

Zeichen

Bezeichnung des Sperranlas-

ses z.B. zur Anzeige in einem

grafischen User Interface

SORTNR int Pflichtfeld Nummer zum Sortieren der

Katalogelemente beim Anzei-

gen in einem grafischen User

Interface. Die Sortierreihenfol-

ge entspricht den Anforderun-

gen von OASIS und kann von

den Verwendern des Katalogs

ignoriert werden.

Tabelle 105: Definition ANLASS

OASIS verwendet beim Anlegen und Ändern einer Sperre lediglich den 2stelligen fachlichen Schlüssel

(KENNUNG).

19.2 Response-Status

Ab OASIS 4.0 wird bei den neu hinzugekommenen Funktionen statt mit einer Sperrsystemmeldung

mit einem Response-Status geantwortet. Dieser beinhaltet keine weiteren Informationen außer der

ART, dem SCHLUESSEL und der MELDUNG.

Dem Response-Status liegen die unter Meldungskatalog aufgeführten Systemmeldungen zugrunde.

Page 83: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

19. Antworten aus OASIS

Seite 83 OASIS Schnittstellenbeschreibung

19.2.1 Feldgruppe RESPONSE-STATUS

XML-Tag RESPONSE-STATUS

XML-Typ t_response_status

Feldeigenschaft optional, beliebig viele Elemente

Elemente ART

SCHLUESSEL

MELDUNG

Tabelle 106: Feldgruppe RESPONSE-STATUS

19.2.1.1 Feld RESPONSE-STATUS.ART

XML-Tag ART

XML-Typ xs:string-basierte Enumeration

Feldeigenschaft Pflichtfeld

Zulässige Werte I, W, E

Tabelle 107: Feld RESPONSE-STATUS.ART

Definition:

In diesem Feld wird übermittelt, ob die Anfrage an OASIS erfolgreich war.

Bedeutung:

I bedeutet Information. Es ist kein Fehler aufgetreten. Beispiel: die Meldung, dass ein Spieler

nicht gesperrt ist, hat die Art I. Die Meldung, dass eine Erlaubnis gültig ist, hat ebenfalls die

Art I

W bedeutet Warnung. Es ist kein Fehler aufgetreten. Beispiel: die Meldung, dass ein Spieler

gesperrt ist, hat die Art W

E bedeutet „Error“. Es ist ein Fehler aufgetreten. Dies kann ein Fehler sein, der durch fehler-

haftes XML oder Fehler bei der Plausibilisierung der Daten oder einen Programmfehler oder

einen Ausfall des OASIS-Services verursacht wurde

19.2.1.2 Feld RESPONSE-STATUS.SCHLUESSEL

XML-Tag SCHLUESSEL

XML-Typ t_meldung_schluessel

Feldeigenschaft optional

Page 84: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

19. Antworten aus OASIS

OASIS Schnittstellenbeschreibung Seite 84

Feldlänge Genau 4 Ziffern

Zulässige Zeichen [0-9]{4}

Tabelle 108: Feld RESPONSE-STATUS.SCHLUESSEL

Definition:

Dieses Feld übermittelt den Schlüssel eines Meldungskatalogs. Der Meldungskatalog liegt im Anhang

bei. Es kann dabei noch redaktionelle Änderungen geben.

19.2.1.3 Feld RESPONSE-STATUS.MELDUNG

XML-Tag MELDUNG

XML-Typ t_meldung_text

Feldeigenschaft optional

Feldlänge Mindestens 1 Zeichen, höchstens 4000 Zeichen

Zulässige Zeichen xs:string

Tabelle 109: Feld RESPONSE-STATUS.MELDUNG

Definition:

Mit dieser Meldung werden ausführliche Informationen zu Fehlersituationen und andere Informatio-

nen, die für die Bewertung der Antwort nützlich sind, übermittelt.

19.3 Eigene-Sperren-Response

Auf die Funktion „Eigene Sperren abfragen 4.0“ antwortet OASIS mit einem durch eigeneSperrenResponse.xsd

definierten XML

Übersicht:

XML-Root-Element EIGENE_SPERREN_RESPONSE

XML-Typ t_eigene_sperren_response

Datenfelder RESPONSE_STATUS

SPERRE

Tabelle 110: Eigene-Sperren-Response

19.3.1 Feldgruppe RESPONSE_STATUS

XML-Tag RESPONSE_STATUS

Page 85: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

19. Antworten aus OASIS

Seite 85 OASIS Schnittstellenbeschreibung

XML-Typ t_response_status

Feldeigenschaft optional, beliebig viele Elemente

Elemente ART

SCHLUESSEL

MELDUNG

Tabelle 111: Feldgruppe RESPONSE_STATUS

19.3.2 Feldgruppe EIGENE_SPERREN_RESPONSE.SPERRE

XML-Tag SPERRE

XML-Typ t_sperre

Feldeigenschaft optional, beliebig viele Elemente

Elemente SPERRID

SPERRDATUM

SPERRGRUND

VORNAME

NACHNAME

GEBURTSNAME

GEBURTSDATUM

GEBURTSORT

ANSCHRIFT

ANLASS

Tabelle 112: Feldgruppe EIGENE_SPERREN_RESPONSE.SPERRE

19.3.2.1 Feld SPERRID

XML-Tag SPERRID

XML-Typ t_sperrid

Feldeigenschaft Pflichtfeld, genau ein Element

Zulässige Zeichen sb:t_sperrid

Tabelle 113: Feld EIGENE_SPERREN_RESPONSE.SPERRE.SPERRID

Definition:

Page 86: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

19. Antworten aus OASIS

OASIS Schnittstellenbeschreibung Seite 86

Mit der SperrID wird ein Sperreintrag eindeutig im System identifiziert. Der Typ wird in sperrsystemBa-

sistypen spezifiziert.

19.3.2.2 Feld SPERRDATUM

XML-Tag SPERRDATUM

XML-Typ t_sperrid

Feldeigenschaft optional, maximal ein Element

Zulässige Zeichen xs:date

Tabelle 114: Feld EIGENE_SPERREN_RESPONSE.SPERRE.SPERRDATUM

Definition:

Mit diesem Feld wird das Sperrdatum übermittelt.

HINWEIS:

Es wird empfohlen, beim Aufheben einer Sperre anhand des Sperrdatums zu überprüfen, ob eine

Sperre unterjährig aufgehoben wird.

19.3.2.3 Feld SPERRGRUND

XML-Tag SPERRGRUND

XML-Typ t_sperrgrund

Feldeigenschaft optional, maximal ein Element

Zulässige Zeichen sb:t_sperrgrund

Tabelle 115: Feld EIGENE_SPERREN_RESPONSE.SPERRE.SPERRGRUND

Definition:

Der Typ wird in sperrsystemBasistypen spezifiziert.

19.3.2.4 Feld VORNAME

XML-Tag VORNAME

XML-Typ t_name

Feldeigenschaft Pflichtfeld

Feldlänge höchstens 85 Zeichen

Zulässige Zeichen Lateinische Zeichen in Unicode

Tabelle 116: Feld VORNAME

Page 87: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

19. Antworten aus OASIS

Seite 87 OASIS Schnittstellenbeschreibung

Definition:

In diesem Feld werden die Vornamen des Spielers übermittelt.

19.3.2.5 Feld NACHNAME

XML-Tag NACHNAME

XML-Typ t_name

Feldeigenschaft Pflichtfeld

Feldlänge höchstens 85 Zeichen

Zulässige Zeichen Lateinische Zeichen in Unicode

Tabelle 117: Feld NACHNAME

Definition:

In diesem Feld werden die Nachnamen des Spielers übermittelt.

19.3.2.6 Feld GEBURTSNAME

XML-Tag GEBURTSNAME

XML-Typ t_name

Feldeigenschaft optional

Feldlänge höchstens 85 Zeichen

Zulässige Zeichen Lateinische Zeichen in Unicode

Tabelle 118: Feld GEBURTSNAME

Definition:

In diesem Feld werden die Geburtsnamen des Spielers übermittelt.

19.3.2.7 Feld GEBURTSDATUM

XML-Tag GEBURTSDATUM

XML-Typ xs:string (Datumsstring im Format JJJJ-MM-TT, für Monat

und Tag ist jeweils auch die Angabe "--" gültig)

Feldeigenschaft Pflichtfeld

Tabelle 119: Feld GEBURTSDATUM

Definition:

Page 88: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

19. Antworten aus OASIS

OASIS Schnittstellenbeschreibung Seite 88

In diesem Feld wird das Geburtsdatum des Spielers übermittelt.

19.3.2.8 Feld GEBURTSORT

XML-Tag GEBURTSORT

XML-Typ t_name

Feldeigenschaft optional

Feldlänge höchstens 85 Zeichen

Zulässige Zeichen Lateinische Zeichen in Unicode

Tabelle 120: Feld GEBURTSORT

Definition:

In diesem Feld wird der Geburtsort des Spielers übermittelt.

19.3.2.9 Feldgruppe ANSCHRIFT

XML-Tag ANSCHRIFT

XML-Typ t_anschrift_status bzw. t_anschrift

Feldeigenschaft Siehe Abschnitt 6.1

Elemente PLZ, ORT, STRASSE, HAUSNR, ADRESSZUSATZ,

LAND

Tabelle 121: Feldgruppe ANSCHRIFT

Definition:

In diesem Element wird die Wohnanschrift des Spielers übermittelt.

19.3.2.9.1 Feld ANSCHRIFT.PLZ

XML-Tag PLZ

XML-Typ t_nummer

Feldeigenschaft Siehe Abschnitt 6.1

Feldlänge höchstens 20 Zeichen

Zulässige Zeichen Lateinische Zeichen in Unicode

Tabelle 122: Feld ANSCHRIFT.PLZ

Definition:

In diesem Feld wird die Postleitzahl der Wohnanschrift des Spielers übermittelt.

Page 89: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

19. Antworten aus OASIS

Seite 89 OASIS Schnittstellenbeschreibung

19.3.2.9.2 Feld ANSCHRIFT.ORT

XML-Tag ORT

XML-Typ t_name

Feldeigenschaft Siehe Abschnitt 6.1

Feldlänge höchstens 85 Zeichen

Zulässige Zeichen Lateinische Zeichen in Unicode

Tabelle 123: Feld ANSCHRIFT.ORT

Definition:

In diesem Feld wird der Ort der Wohnanschrift des Spielers übermittelt.

19.3.2.9.3 Feld ANSCHRIFT.STRASSE

XML-Tag STRASSE

XML-Typ t_strasse

Feldeigenschaft Siehe Abschnitt 6.1

Feldlänge höchstens 150 Zeichen

Zulässige Zeichen Lateinische Zeichen in Unicode

Tabelle 124: Feld ANSCHRIFT.STRASSE

Definition:

In diesem Feld wird die Straße der Wohnanschrift des Spielers übermittelt.

19.3.2.9.4 Feld ANSCHRIFT.HAUSNR

XML-Tag HAUSNR

XML-Typ t_nummer

Feldeigenschaft Siehe Abschnitt 6.1

Feldlänge höchstens 20 Zeichen

Zulässige Zeichen Lateinische Zeichen in Unicode

Tabelle 125: Feld ANSCHRIFT.HAUSNR

Definition:

In diesem Feld wird die Hausnummer der Wohnanschrift des Spielers übermittelt.

19.3.2.9.5 Feld ANSCHRIFT.ADRESSZUSATZ

Page 90: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

19. Antworten aus OASIS

OASIS Schnittstellenbeschreibung Seite 90

XML-Tag ADRESSZUSATZ

XML-Typ t_adresszusatz

Feldeigenschaft optional

Feldlänge höchstens 256 Zeichen

Zulässige Zeichen Lateinische Zeichen in Unicode

Tabelle 126: Feld ANSCHRIFT.ADRESSZUSATZ

Definition:

In diesem Feld wird ein eventuell vorhandener Adresszusatz der Wohnanschrift des Spielers übermit-

telt.

19.3.2.9.6 Feld ANSCHRIFT.LAND

XML-Tag LAND

XML-Typ t_land

Feldeigenschaft Siehe Abschnitt 6.1

Feldlänge Genau 3 Zeichen

Zulässige Zeichen Ziffern 0-9

Tabelle 127: Feld ANSCHRIFT.LAND

Definition:

In diesem Feld wird das Land der Wohnanschrift des Spielers übermittelt.

Grundlage ist der von Destatis veröffentlichte Staatenkatalog. Es wird hierbei der 3 stellige Destatis-

BEV-Code übermittelt (siehe Anlage Staatsangehoerigkeitsgebietsschluessel.pdf)

19.3.3 Feldgruppe ANLASS

XML-Tag ANLASS

XML-Typ t_anlass_sperre

Feldeigenschaft beliebig viele Elemente (praktisch maximal 99)

Elemente KENNUNG – Pflichtfeld. Zweistelliger fachlicher Schlüssel

aus dem Katalog Sperranlässe.

BEZEICHNUNG – Pflichtfeld

SORTNR – Pflichtfeld

Tabelle 128: Feldgruppe ANLASS

Page 91: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

19. Antworten aus OASIS

Seite 91 OASIS Schnittstellenbeschreibung

Definition:

Mit jedem ANLASS wird ein Element des Katalogs übertragen.

XML-

Tagname

XML-Typ Eigenschaft Länge Bedeutung

KENNUNG t_anlass_sperre_

kennung

Pflichtfeld genau 2 Zif-

fern

2stelliger fachlicher Schlüssel,

der beim Anlegen und Ändern

von Sperren benötigt wird

BEZEICH-

NUNG

StringLatin Pflichtfeld maximal 150

Zeichen

Bezeichnung des Sperranlas-

ses z.B. zur Anzeige in einem

grafischen User Interface

SORTNR int Pflichtfeld Nummer zum Sortieren der

Katalogelemente beim Anzei-

gen in einem grafischen User

Interface. Die Sortierreihenfol-

ge entspricht den Anforderun-

gen von OASIS und kann von

den Verwendern des Katalogs

ignoriert werden.

Tabelle 129: Definition ANLASS

OASIS verwendet beim Anlegen und Ändern einer Sperre lediglich den 2stelligen fachlichen Schlüssel

(KENNUNG).

Beispiel XML (EigeneSperrenResponse)

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

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

<RESPONSE_STATUS>

<ART>I</ART>

<SCHLUESSEL>0049</SCHLUESSEL>

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

</RESPONSE_STATUS>

<SPERRE>

<SPERRID>3245</SPERRID>

<SPERRDATUM>2000-12-31</SPERRDATUM>

<SPERRGRUND>SELBST</SPERRGRUND>

<VORNAME>Klara</VORNAME>

<NACHNAME>Papp</NACHNAME>

<GEBURTSNAME>Hütchen</GEBURTSNAME>

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

<GEBURTSORT>Merseburg</GEBURTSORT>

<ANSCHRIFT>

<PLZ>12345</PLZ>

<ORT>Tilleda</ORT>

<STRASSE>Hauptstraße</STRASSE>

<HAUSNR>10</HAUSNR>

<LAND>000</LAND>

</ANSCHRIFT>

<ANLASS>

<KENNUNG>01</KENNUNG>

Page 92: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

19. Antworten aus OASIS

OASIS Schnittstellenbeschreibung Seite 92

<BEZEICHNUNG>Suchtgefährdung</BEZEICHNUNG>

<SORTNR>1</SORTNR>

</ANLASS>

<ANLASS>

<KENNUNG>02</KENNUNG>

<BEZEICHNUNG>Finanzen</BEZEICHNUNG>

<SORTNR>2</SORTNR>

</ANLASS>

</SPERRE>

<SPERRE>

. . .

</SPERRE>

</tns:EIGENE_SPERREN_RESPONSE>

19.4 Batch-Anlegen-Response

Auf die Funktion „Einstellen einer Batch 2.0 Anfrage“ antwortet OASIS mit einem durch batchAnlegenRespon-

se.xsd definierten XML

Übersicht:

XML-Root-Element BATCH_ANLEGEN_RESPONSE

XML-Typ t_batch_anlegen_response

Datenfelder RESPONSE-STATUS

BATCH-ID

Tabelle 130: Batch-Anlegen-Response

19.4.1 Feldgruppe RESPONSE-STATUS

Siehe Response-Status.

19.4.1.1 Feld BATCH_ANLEGEN_RESPONSE.BATCH-ID

XML-Tag ART

XML-Typ t_batch_id

Feldeigenschaft optional

Zulässige Werte numerisch

Zulässige Zeichen Ziffern 0-9 (Pattern [\d]{1,9})

Bemerkung Diese ID wird von OASIS generiert

Tabelle 131: Feld BATCH_ANLEGEN_RESPONSE.BATCH-ID

Page 93: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

19. Antworten aus OASIS

Seite 93 OASIS Schnittstellenbeschreibung

19.5 Batch 2.0 Abholen des Batch-Ergebnisses

Das Ergebnis der Batch-2.0 Abfrage wird als komprimiertes (gzip) zum Schema batchResponse.xsd

konformes XML bereitgestellt.

Übersicht:

XML-Root-Element BATCHRESPONSE

XML-Typ t_batchresponse

Datenfelder BATCH-ID

TIMESTAMP

ANZAHL-ERFOLGREICH-VERARBEITET

ANZAHL-NICHT-GESPERRT

ANZAHL-GESPERRT

ANZAHL-NICHT-EINDEUTIG

RESPONSE-STATUS

DS

Tabelle 132: Batch-2.0-Response

19.5.1.1 Feld BATCHRESPONSE.BATCH-ID

XML-Tag ART

XML-Typ t_batch_id

Feldeigenschaft optional

Zulässige Werte numerisch

Zulässige Zeichen Ziffern 0-9 (Pattern [\d]{1,9})

Bemerkung Diese ID wird von OASIS generiert

Tabelle 133: Feld BATCHRESPONSE.BATCH-ID

19.5.1.2 Feld BATCHRESPONSE.TIMESTAMP

XML-Tag TIMESTAMP

XML-Typ xs:dateTime

Feldeigenschaft Pflichtfeld

Bemerkung Der Zeitpunkt, an dem das Ergebnis der Batchanfrage ermit-

telt, d.h. der Batchjob in den Status FINISHED gesetzt wur-

Page 94: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

19. Antworten aus OASIS

OASIS Schnittstellenbeschreibung Seite 94

de.

Tabelle 134: Feld BATCHRESPONSE.TIMESTAMP

19.5.1.3 Feld BATCHRESPONSE.ANZAHL-NICHT-GESPERRT

XML-Tag ANZAHL-NICHT-GESPERRT

XML-Typ xs:integer

Feldeigenschaft Pflichtfeld

Bemerkung Die Gesamtzahl der nicht gesperrten Personen

Tabelle 135: Feld BATCHRESPONSE. ANZAHL-NICHT-GESPERRT

19.5.1.4 Feld BATCHRESPONSE.ANZAHL-GESPERRT

XML-Tag ANZAHL-GESPERRT

XML-Typ xs:integer

Feldeigenschaft Pflichtfeld

Bemerkung Die Gesamtzahl der gesperrten Persone bei denen es ge-

nau einen Treffer gab.

Tabelle 136: Feld BATCHRESPONSE.ANZAHL-GESPERRT

19.5.1.5 Feld BATCHRESPONSE.ANZAHL-NICHT-EINDEUTIG

XML-Tag ANZAHL-NICHT-EINDEUTIG

XML-Typ xs:integer

Feldeigenschaft Pflichtfeld

Bemerkung Die Gesamtzahl der Personen, bei denen es mehr als einen

Treffer gab.

Tabelle 137: Feld BATCHRESPONSE. ANZAHL-NICHT-EINDEUTIG

19.5.1.6 Feld BATCHRESPONSE. ANZAHL-ERFOLGREICH-VERARBEITET

XML-Tag ANZAHL-ERFOLGREICH-VERARBEITET

Page 95: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

19. Antworten aus OASIS

Seite 95 OASIS Schnittstellenbeschreibung

XML-Typ xs:integer

Feldeigenschaft Pflichtfeld

Bemerkung Die Gesamtzahl der verarbeiteten Datensätze

Tabelle 138: Feld BATCHRESPONSE. ANZAHL-ERFOLGREICH-VERARBEITET

19.5.2 Feldgruppe RESPONSE-STATUS

Siehe Response-Status.

19.5.3 Feldgruppe DS

Die Feldgruppe DS fehlt bei der Antwort auf das Einstellen einer Batch 2.0 Abfrage.

XML-Tag DS

XML-Typ t_ds

Feldeigenschaft optional

Elemente DS-ID

FREITEXT

SPERRSYSTEM-MELDUNG

19.5.3.1 Feld DS.DS-ID

XML-Tag DS-ID

XML-Typ t_ds_id

Feldeigenschaft Pflichtfeld

Feldlänge

Zulässige Zeichen

Bemerkung Dies ist die vom Abfrager gelieferte DS-ID.

Bei der Rückgabe (z.B. auch bei einer Fehlermeldung!) wird

die „DS-ID“ so angegeben wie übermittelt, damit der Sender

den falschen Datensatz auch identifizieren kann. Auch eine

DS-ID, die nicht den Schemavorgaben entspricht, wird in der

Antwort zurückgegeben. Deshalb gibt es für die OASIS Ant-

wort keine Einschränkungen bzgl „Feldlänge“ und „zuläs-

sige Zeichen“.

Page 96: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

19. Antworten aus OASIS

OASIS Schnittstellenbeschreibung Seite 96

19.5.3.2 Feld DS.FREITEXT

XML-Tag FREITEXT

XML-Typ t_freitext

Feldeigenschaft optional

Feldlänge

Zulässige Zeichen

Bemerkung Dies ist der vom Abfrager gelieferte FREITEXT

Bei der Rückgabe (z.B. auch bei einer Fehlermeldung!) wird

der „Freitext“ so angegeben wie übermittelt, damit der Sen-

der den falschen Datensatz auch identifizieren kann. Auch

ein Freitext, der nicht den Schemavorgaben entspricht, wird

in der Antwort zurückgegeben. Deshalb gibt es für die

OASIS Antwort keine Einschränkungen bzgl „Feldlänge“

und „zulässige Zeichen“.

19.5.3.3 Feldgruppe SPERRSYSTEM-MELDUNG

Beschreibung siehe Feldgruppe SPERRSYSTEM-MELDUNG

Diese enthält die Antwort auf die Statusabfrage zu einem einzelnen Spieler entsprechend dem Mel-

dungskatalog.

19.6 Batch 2.0 Informationen über die Batchjobs

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

XML-Schema: batchJobsInfos.xsd

XML-Schema batchJobsInfos.xsd

XML-Root-Element BATCHJOBSINFOS

XML-Typ t_batchjobsinfos

Elemente RESPONSE-STATUS

BATCHINFO

Beispiel XML (Response)

Page 97: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

19. Antworten aus OASIS

Seite 97 OASIS Schnittstellenbeschreibung

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

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

<RESPONSE-STATUS>

<ART>I</ART>

<SCHLUESSEL>0049</SCHLUESSEL>

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

<BATCHINFO>

<BATCH-ID>1</BATCH-ID>

<STATUS>COMPLETED</STATUS>

</BATCHINFO>

<BATCHINFO>

<BATCH-ID>2</BATCH-ID>

<STATUS>FINISHED</STATUS>

</BATCHINFO>

</tns:BATCHJOBSINFOS>

19.6.1 Feldgruppe RESPONSE-STATUS

Siehe Response-Status.

19.6.2 Feldgruppe BATCHINFO

XML-Tag BATCHINFO

XML-Typ t_batchinfo

Feldeigenschaft optional

Elemente BATCH-ID

STATUS

19.6.2.1 Feld BATCH-ID

Siehe Feld BATCH-ID

19.6.2.2 Feld STATUS

XML-Tag STATUS

XML-Typ xs:string

Feldeigenschaft Pflichtfeld

Feldtyp xs:string mit xs:enumeration

Zulässige Werte WAITING, RUNNING, FINISHED, COMPLETED, CAN-

CELLED

Page 98: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

19. Antworten aus OASIS

OASIS Schnittstellenbeschreibung Seite 98

19.7 Wartungs- und Störungsmeldungen

Ist das System wegen betrieblichen Störungungen oder Wartungsarbeiten nicht erreichbar, wer-

den alle WS-Anfragen mit einer Sperrsystemmeldung beantwortet.

19.7.1 Wartung

Im Falle von Wartungsarbeiten wird jede Anfrage mit einer Sperrsystemeldung der Art I und dem

Schlüssel 0052 beantwortet.

19.7.2 Störung

Im Falle einer Störung wird jede Anfrage wird mit einer Sperrsystemeldung der Art E und dem Schlüs-

sel 0053 beantwortet.

19.8 Meldungskatalog

Der Meldungskatalog hat folgende Einträge:

Schlüssel Art Meldung

0001 E „Sie haben keine Berechtigung“ oder „Sie haben keine Berechtigung (kein gülti-ges Zertifikat)“

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)

0003 E Es ist ein Serverfehler aufgetreten. Bitte wenden Sie sich an die Hotline (Tel 06652/1872212).

0004 E Änderung oder Beenden der Sperre ist nicht möglich: es wurde kein Sperrein-trag zum Spieler gefunden.

0007 I Die Person wurde mit Datum <TT.MM.JJJJ> erfolgreich gesperrt.

0008 E Sie haben keine Berechtigung diese Sperre zu ändern.

0009 I Die Spielerdaten wurden am <TT.MM.JJJJ> erfolgreich geändert.

0010 E Sie haben keine Berechtigung diese Sperre zu beenden.

0011 I Die Spielersperre wurde am <TT.MM.JJJJ> erfolgreich aufgehoben.

0014 E Das XML ist nicht schemakonform.

0015 E Es ist ein Plausibilisierungsfehler aufgetreten. <Kontext zum Fehler, z.B. Nach-name zu lang>

0016 E „Sie haben keine gültige Konzession/Erlaubnis.“ oder „Sie haben keinen Zugang zum System, da Ihre Konzession/Erlaubnis ruht.“

0017 I Die Konzession/Erlaubnis ist gültig.

0018 W Der Spieler ist gesperrt.

0019 I Der Spieler ist nicht gesperrt.

Page 99: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

19. Antworten aus OASIS

Seite 99 OASIS Schnittstellenbeschreibung

0020 I Das Passwort wurde erfolgreich geändert.

0021 E Sie dürfen den OASIS-Webservice nicht verwenden.

0022 E Sie dürfen den OASIS-Webclient nicht verwenden.

0023 W Der Spieler ist gesperrt. Es gab mehr als einen Treffer für Ihre Abfrage.

0024 W Der Spieler ist gesperrt. Es gab mehr als einen Treffer für Ihre Abfrage.

0040 E Die Daten werden gerade von einem anderen Benutzer geändert.

0041 W Sie müssen Ihr Initialpasswort ändern.

0042 I Der Benutzer wurde erfolgreich angelegt.

0043 E Passwortänderung fehlgeschlagen, da der angegebene Benutzer nicht bekannt ist.

0044 E Für den angegebenen Benutzer dürfen Sie das Passwort nicht ändern.

0045 E Das neue Passwort muss sich von dem bisherigen unterscheiden.

0046 E Für den angegebenen Benutzer dürfen Sie die Angaben nicht ändern.

0047 I Die Angaben zum Benutzer wurden erfolgreich geändert.

0048 E Änderung der Angaben zum Benutzer fehlgeschlagen, da der angegebene Be-nutzer nicht bekannt ist.

0049 I Die Abfrage wurde erfolgreich durchgeführt.

0050 I <Nummer der einheitlichen Programmversion>

0051 E Ihre Zugangsberechtigung wurde deaktiviert-bitte wenden Sie sich an die Hotline (Tel 06652/1872212)

0052 I Derzeit werden geplante Wartungsarbeiten am OASIS-Service durchgeführt.

0053 E Derzeit liegt eine Störung von OASIS vor. An der Entstörung wird derzeit gear-beitet.

0054 W Die maximale Anzahl gleichzeitig laufender Batchabfragen ist erreicht. Bitte ver-suchen Sie es später nochmal.

0060 E Einstellen von Batchanfragen: Übertragener Inhalt kann nicht in eine Batchan-frage konvertiert werden

0061 E Einstellen von Batchanfragen: Batch beinhaltet zu viele Datensätze

0062 E Einstellen von Batchanfragen: Identischer Batch wurde bereits beauftragt

0063 E Einstellen von Batchanfragen: Batch wurde nicht im korrekten Zeitfenster beauf-tragt

0064 E Einstellen von Batchanfragen: Betriebsstätte ist nicht berechtigt einen Batch zu beauftragen

0065 E Einstellen von Batchanfragen: Maximale Anzahl von Batches pro Zeitfenster überschritten

0066 E Einstellen von Batchanfragen: Batchverarbeitung wurde aus betrieblichen Grün-den temporär gesperrt

0070 E Ergebnisse von Batchanfragen: Fehler bei der Verarbeitung eines Batch aufge-treten

0071 E Ergebnisse von Batchanfragen: Batchverarbeitung wurde manuell abgebrochen

0072 E Ergebnisse von Batchanfragen: Berechtigung zur Batchverarbeitung wurde ent-zogen

Page 100: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

20. Rechte und Rollen in OASIS WS

OASIS Schnittstellenbeschreibung Seite 100

0073 E Ergebnisse von Batchanfragen: Der Batch existiert nicht oder nicht mehr

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

0075 E Ergebnisse von Batchanfragen: Der Batch befindet sich noch in Bearbeitung. Das Ergebnis liegt noch nicht vor

0076 E Ergebnisse von Batchanfragen: Der Batch wurde noch nicht begonnen

0077 I Einstellen von Batchanfragen: Die Batchabfrage wurde erfolgreich hochgeladen

0078 I Ergebnisse von Batchanfragen: kein Fehler aufgetreten

0079 W Ergebnisse von Batchanfragen: Batchabfrage mit Warnungen beendet

0080 E Ergebnisse von Batchanfragen: Batchabfrage mit Fehlern beendet

0081 E Einstellen von Batchanfragen: Hochgeladene Datei konnte nicht als gzip ent-packt werden

Tabelle 139: Meldungskatalog

Anmerkungen:

Der Katalog kann noch geringfügigen Änderungen unterliegen. Die hier aufgeführten Schlüssel mit Art

und Bedeutung werden sich aber nicht ändern. Änderungen kann es am Meldungstext geben. Es

können weitere Meldungen hinzukommen.

Rechte und Rollen in OASIS WS 20

Rollen

Rechte auf OASIS WS Funktionalitäten

Stat

us

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

Kat

alo

ge h

ole

(Lä

nd

er,…

)

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

Schreibender Zugriff

x x x x x x x x x x x x x Optional x

Lesender Zugriff

x - - - - - - - x x x x x Optional x

Page 101: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

0.

Seite 101 OASIS Schnittstellenbeschreibung

Änderungen gegenüber Version 1.0 21

Im Vergleich zur Version 1.0 gab es folgende wesentlichen Änderungen:

Die XML-Schemata haben eine Versionsnummer (1.1) und im Attribut elementFormDefault

den Wert "unqualified", was die Verarbeitung einfacher gestaltet. Aus diesem Grund wird auch

ein eigenes XML-Schema für „String.Latin“ verwendet.

Der OASIS-Webservice wurde um die Funktionalitäten „Länderkatalog laden“, „Passwort än-

dern“ und „Konzession prüfen“ erweitert

Die Menge der Pflichtattribute der Spielerdaten ist vom Kontext abhängig (Identifizierung ei-

nes Spielers versus Eintragen einer Sperre). Zur Abfrage des Status werden weniger Attribute

gefordert als in Version 1.0

Die Feldgruppen SPIELER und SPIELER-NEU haben ihre Bedeutungen geändert.

Die Sperrsystemmeldung wurde um eine Meldungsart und optionale Daten von Veranstaltern

erweitert.

Änderungen gegenüber Version 1.1 22

Das Spieler-Geburtsdatum hat sich in Typ und Wertebereich geändert.

Geburtsname (Spieler/Spieler-Neu) ist ein Pflichtfeld

Sperrgrund ist nur bei Anlegen einer Sperre Pflichtfeld

Länderkatalog (beiliegend) aktualisiert

Tabelle Meldungskatalog aktualisiert

Änderungen gegenüber Version 1.2 23

Der Name des Dokumentes ist dem aktuellen OASIS Release angeglichen

Kap.2 neue XML Schemata

Kap.2 neue Schnittstellenfunktionen

Kap.4 sperrsystemBasistypen.xsd erweitert

Page 102: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

24. Änderungen gegenüber Version 1.8

OASIS Schnittstellenbeschreibung Seite 102

Kap.7 aufgeteilt in Kapitel 7 und 8. Einführung der SperrID

Kap.9 ergänzt um Beschreibung der SperrIdAbfrage

Kap.10 Beschreibung Eigene Sperren Abfragen

Kap.11 Beschreibung Eigene Sperren Abfragen mit Parametern

Kap.15 Antworten aus OASIS, Beschreibung der aktualisierten Sperrsystem-Meldung

Kopf- und Fußzeilen angepasst

„Konzession“ in „Erlaubnis“ geändert

Schreibfehler behoben

Änderungen gegenüber Version 1.8 24

Kap.02 Tabelle " Schnittstellenfunktionen" erweitert

Kap.5.1.2 entfernt

Kap.10/11 zusammengefasst

Kap.9.2 nach Kap.10 verschoben

Kap.14 " Verfügbarkeit prüfen " eingefügt

Kap.15 " Releasenummer abfragen " eingefügt

Kap.17 Meldungskatalog aktualisiert

Änderungen gegenüber Version 2.0 25

Kapitel 2 - Schnittstellenfunktionen und XML Schema:

o Funktionen „Ändern einer Spielersperre anhand der Spielerdaten“ und „Beenden einer

Spielersperre anhand der Spielerdaten“ entfernt

o Tabelle 2: Sortierung nach Kapitel

o Neue Funktionen "Ähnlichkeitssuche mit Parametern", "Ähnlichkeitsabfrage" hinzuge-

fügt

Kapitel 0 - Verwendeter Zeichensatz:

Page 103: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

26. Änderungen gegenüber Version 3.0

Seite 103 OASIS Schnittstellenbeschreibung

o Neues Kapitel: 3.1.1 Buchstaben

o Neues Kapitel: 3.1.2 Ziffern

o Neues Kapitel: 3.1.3 Sonderzeichen

Kapitel 7- Anlegen einer Spielersperre:

o Neues Kapitel: Erlaubte Zeichen für das Anlegen einer neuen Sperre

Kapitel 8 - Ändern und Beenden einer Spielersperre:

o Als DEPRECATED markierte Funktion (Ehemals Kapitel 8.1: "Ändern/Beenden einer

Sperre anhand der Spielerdaten") entfernt

o Neues Kapitel: Erlaubte Zeichzen für das Ändern einer Spielersperre

Kapitel 9- Abfrage des Spielerstatus in OASIS

o Neues Kapitel: 9.1.1.2.1 Erlaubte Zeichen für die Abfrage des Spielerstatus

Kapitel 10 – Abfrage des Spielerstatus in OASIS

o Neues Kapitel 10.3 Ähnlichkeitssuche mit Parametern

Kapitel 19.8 - Meldungskatalog

o Meldungskatalog aktualisiert.

Meldung 001 kann mit zusätzlichem Parameter "kein gültiges Zertifikat" ausgegeben

werden.

Änderungen gegenüber Version 3.0 26

Kapitel 7.1 Beenden einer Sperre anhand der SperrID

o Neues XML Element: SPERRGRUND_NEU

Kapitel 16 Batchabfrage

o Neue Schnittstellenfunktion

Kapitel 17.5.6 Meldungskatalog

o ID 12 und ID 13 entfernt

Page 104: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

27. Änderungen gegenüber Version 3.2

OASIS Schnittstellenbeschreibung Seite 104

Änderungen gegenüber Version 3.2 27

Kapitel 7.1

o genaue Abfrage des Spielerstatus in OASIS als DEPRECATED markiert

o Verschieben von Inhalten nach Kapitel 9.2

Kapitel 7.1.2

o Textänderung, da Mehrfachsperren jetzt möglich sind

Kapitel 7.1

o Erweiterung des Kapitels mit Inhalten aus Kapitel 9.1

Kapitel 10.2

o Eigene Sperren abfragen mit Parameter als DEPRECATED markiert

Kapitel 16.2

o Erweiterung des Patterns in der Batch-Antwort.

Kapitel 17

o Neues Kapitel „Aktuelle Informationen“ hinzugefügt

Kapitel 18

o Neues Kapitel Wartungs- und Störungsmeldungen

o Änderung im Meldungskatalog: Meldung zu Schlüssel 23 geändert

o Meldung 51 hinzugefügt

o Meldung 52 hinzugefügt

o Meldung 53 hinzugefügt

o Meldung 54 hinzugefügt

Kapitel 19

o Komplett neu

Page 105: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

28. Änderungen gegenüber Version 3.4

Seite 105 OASIS Schnittstellenbeschreibung

Änderungen gegenüber Version 3.4 28

Abschnitt 2.2: Hinweis zum Content-Type hinzugefügt

Abschnitt 4.1.1: Passwort mindestens 8 Zeichen, höchstens 16 Zeichen

Abschnitt 5.2.2: Passwort mindestens 8 Zeichen, höchstens 16 Zeichen

Kapitel 8.2.6: Die Spielerstatusabfrage (Funktion 4 – siehe Abschnitt 2.2) wird systemintern

durch eine Ähnlichkeitssuche abgebildet. Die Schnittstellenmethode Spielerstatusabfrage

(Funktion 4 – siehe Abschnitt 2.2) wird in einer nächsten OASIS Version entfallen und ist da-

her als DEPRECATED ausgezeichnet.

Abschnitt 9.1: Spielerstatusabfrage (Funktion 4 – siehe Abschnitt 2.2) [DEPRECATED]

Abschnitt 19.6 - Wartung- und Störungsmeldungen: neu erstellt

Abschnitt19.7.1: neu erstellt

Abschnitt 19.7.2: neu erstellt

Kapitel 18.6 – Meldungskatalog: ergänzt

o Neue Meldung 0051 hinzugefügt

o Neue Meldung 0052 hinzugefügt

o Neue Meldung 0053 hinzugefügt

o Neue Meldung 0054 hinzugefügt

Kapitel 19 - Rechte und Rollen in OASIS WS: neu erstellt

Änderungen gegenüber Version 3.6 29

Abschnitt 2.2: 4 neue Schnittstellenfunktionen hinzugefügt. 3 Schnittstellenfunktionen als de-

precated markiert.

Zeichengenaue Suche entfernt (Spielerstatusabfrage)

Abschnitt 4.1.1: neue einfache Basistypen t_anlass_sperre_kennung und

t_anlass_sperre_bezeichnung

Abschnitt 4.1.2: neuer Basistyp t_anlass_sperre

Page 106: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

30. Änderungen gegenüber Version 4.0

OASIS Schnittstellenbeschreibung Seite 106

Abschnitt 7.1: bisherige Schnittstellenfunktion als deprecated gekennzeichnet. Änderung des

Systemverhaltens in Bezug auf den Anlass der Sperre bei Verwendung der alten Schnittstel-

lenfunktion

Abschnitt 8.1: bisherige Schnittstellenfunktion als deprecated gekennzeichnet.

Kapitel 9: Beschreibung der neuen Schnittstellenfunktionen zum Anlegen, Ändern und Aufhe-

ben einer Sperre

Kapitel 16: Für das Land des Wohnorts einer Person wird ab 4.0 der dreistellige Gebiets-

schlüssel verwendet

Kapitel 17: Beschreibung der Schnittstellenfunktion zum Holen des Katalogs „Sperranlässe“

Kapitel 19: Batch 2.0, neues Kapitel erstellt

Abschnitt 21.4: Feldgruppe SPERRSYSTEM-MELDUNG erbt die einfachen Datentypen

t_meldungsart, t_meldung_schluessel und t_meldung_text aus den Sperrsystem-Basistypen

Neue Feldgruppe ANLASS in der Feldgruppe SPERRINFO

Abchnitt 21.6: Meldungskatalog für Batch 2.0 erweitert

Kapitel 23: Referenz auf die XML-Schemata sperreAnlegen.xsd, sperreAendern.xsd, sperre-

Aufheben.xsd sowie sperranlaesse.xsd

Kapitel 23: Referenz auf die XML-Schemata batchResponse.xsd, batchJobsInfos.xsd

Kapitel 21: Platzhalter im Meldungskatalog ersetzt

Kapitel 12.1: Anmerkung zu Passwort-Neu angepasst

Änderungen gegenüber Version 4.0 30

Kapitel 2.2: neue URLs für Batch 2.0: OASISBATCHWS

Kapitel 21.2, 21.5 und Kapitel 21.6: in batchAnlegenResponse.xsd, batchResponse.xsd und

batchJobsInfos.xsd wurde das XML Element <RESPONSE_STATUS> nach <RESPONSE-

STATUS> geändert

Kapitel 19.2.2 und Kapitel 21.5: In der „Antwort auf das Abholen eines Batch 2.0 Ergebnisses“

(batchAnlegenResponse.xsd, batchResponse.xsd, batchJobsInfos.xsd) wurde das XML Ele-

ment <BATCH_ID> nach <BATCH-ID> geändert

Kapiel 19.2.2 und Kapitel 21.5: Der Content-Type für „Antwort auf das Abholen eines Batch

2.0 Ergebnisses“ wurde von application/zip auf application/gzip geändert

Page 107: OASIS Version 4.6 Veröffentlicht am 02.11 · 2. Schnittstellenfunktionen und XML-Schema OASIS Schnittstellenbeschreibung Seite 8 2 Schnittstellenfunktionen und XML-Schema Der OASIS-Webservice

31. Änderungen gegenüber Version 4.2

Seite 107 OASIS Schnittstellenbeschreibung

Kapitel 19.1.1.2: Einschränkung der Überprüfung der Datensatz-ID

Kapitel 19.2.2: Response-Codes hinzugeführt

Kapitel 21.5.3.1: Bemerkung für XML-Element <DS-ID> für „Batch 2.0 Abholen eines Batch-

Ergebnisses“ hinzugefügt

Kapitel 21.5.3.2: Bemerkung für XML-Element <Freitext> für „Batch 2.0 Abholen eines Batch-

Ergebnisses“ hinzugefügt

Änderungen gegenüber Version 4.2 31

Enfternung deprecated sperrIdAbfrage.xsd

Entfernung deprecated Funktionen:

o Anlegen einer Spielersperre <server>/oasisws/rest/oasis/sperre/anlegen

o Ändern einer Spielersperre anhand der SperrID <ser-

ver>/oasisws/rest/oasis/sperriddaten/aendern

o Eigene Sperren abfragen <server>/oasisws/rest/oasis/eigenesperrenabfrage

o Eigene Sperren abfragen mit Parameter <ser-

ver>/oasisws/rest/oasis/eigenesperrenabfrage/mitparametern

o Abfrage des Eigene Sperren „transliteriert“ mit Parameter abfragen <ser-

ver>/oasisws/rest/oasis/aehnlichkeitssuche/mitparametern

o Eigene Sperre abfragen mit Parameter SperrID <ser-

ver>/oasisws/rest/oasis/sperridabfrage

Die Angaben zu Content-Type und Content- Length in dem HTTP-Header sind zwingend er-

forderlich.

Änderungen gegenüber Version 4.4 32

Entfernung deprecated Batch 1.0 Funktion

Einfügung Hinweis zu der Verwendung von Sonderzeichen (Kapitel 3.1.3)