XML

Zeichensatz und XML Struktur

Der Zeichensatz der Daten ist - wie auch bei der Live-Schnittstelle UTF-8. Die Datei beginnt mit dem XML Header: <?xml version="1.0" encoding="UTF-8"?>

Dann folgt das Array <meldescheine /> mit mindestens einem Meldeschein <meldeschein /> Darin enthalten sind die Daten des Hauptgastes (siehe Felddefintionen) und optional einem Array aus Begleitpersonen <begleitperson />.

Hinweis

Die Reihenfolge der Daten können in beliebiger Reihenfolge stehen.

Somit ergibt sich folgende Struktur:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
<?xml version="1.0" encoding="UTF-8"?>
<meldescheine>
    <!-- Meldeschein 2  -->
    <meldeschein>
        <!-- Daten Hauptgast -->
        <begleitperson><!-- Daten Begleiter 1--></begleitperson>
        <begleitperson><!-- Daten Begleiter 2--></begleitperson>
    </meldeschein>
    <!-- Meldeschein 2  -->
    <meldeschein>
        <!-- Daten Hauptgast -->
        <begleitperson><!-- Daten Begleiter 1--></begleitperson>
        <begleitperson><!-- Daten Begleiter 2--></begleitperson>
    </meldeschein>
</meldescheine>

Pflichtfelder

Feld Datentyp Erklärung
anreise date Anreisedatum des Gastes im Format YYYY-MM-DD
abreise date Abreisedatum des Gastes Format YYYY-MM-DD
kategorie string Die ID des zu buchenden Tarifs (kann über API oder über die Web-Oberfläche eingesehen werden)

individuelle Felder

Alle weiteren Felder der sind je Gemeinde individuell definiert. Ob es sich hierbei um Pflichtfelder oder optionale Felder handelt ist der Gemeinden-Definition zu entnehmen.

Feldzuweisung

Eine Zuweisung der Felder der Buchungs-Systems zur Import-Schnittstelle kann im System hinterlegt werden. Somit ist es nicht zwingend notwendig Anpassungen an der Erzeugung des XML-Datensatzes vorzunehmen

Pflichtfelder der Gemeinde

Sind bestimmte Daten einer Gemeinde als Pflichtfeld definiert, so müssen diese ebenfalls in der XML-Datei übergeben werden

Begleitpersonen

Begleitpersonen eines Meldescheins können über das Tag <begleitperson /> gebucht werden. Somit können eine beliebige Anzahl an Begleitern gebucht werden. Alle definierten Felder des Hauptgastes können ebenfalls für Begleiter verwendet werden.

Warning

Die Felder anreise, abreise sowie kategorie müssen bei Begleitpersonen ebenfalls immer befüllt sein.

Beispiel Begleitpersonen

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
    <!-- ... -->
    <meldeschein>
        <!-- Daten des Hauptgastes -->
        <anreise>2019-11-22</anreise>
        <abreise>2019-11-25</anreise>
        <kategorie>1</kategorie>
        <!-- Ende Daten des Hauptgastes -->
        <begleitperson>
            <anreise>2019-11-22</anreise>
            <abreise>2019-11-23</anreise>
            <kategorie>1</kategorie>
            <! -- optionale weitere Daten -->
        </begleitperson>
        <begleitperson>
            <!-- weiterer Begleiter-->
        </begleitperson>
        <begleitperson>
            <!-- weiterer Begleiter-->
        </begleitperson>
   </meldeschein>
<!-- ... -->

Beispieldaten

Ein Beispiel einer Buchung von einem Meldeschein mit:

  • 1 Meldeschein
    • Hauptgast mit Personendaten
    • Einer Begleitperson
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<?xml version="1.0" encoding="UTF-8"?>
<meldescheine>
   <meldeschein>
      <hausnummer>.</hausnummer>
      <anrede>Herr</anrede>
      <name>Mustermann</name>
      <vorname>Max</vorname>
      <plz>123456</plz>
      <ort>Musterstadt</ort>
      <land>Deutschland</land>
      <anreise>2019-10-19</anreise>
      <abreise>2019-10-20</abreise>
      <kategorie>1</kategorie>
      <begleitperson>
         <anrede>Frau</anrede>
         <name>Mustermann</name>
         <vorname>Karin</vorname>
         <kategorie>1</kategorie>
         <anreise>2019-10-19</anreise>
         <abreise>2019-10-20</abreise>
      </begleitperson>
   </meldeschein>
</meldescheine>