Skip to main content

XML (english)

Character Encoding and XML Structure

The character encoding of the data is - as with the live interface `UTF-8`. The file starts with the XML header: <?xml version="1.0" encoding="UTF-8"?>

 

Then follows the array `<meldescheine />` with at least one registration form <meldeschein /> This contains the data of the main guest (see field definitions) and optionally an array of accompanying persons <begleitperson />`.

 

The sequence of the data can be in any order.

This results in the following structure:

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

Mandatory fields

Folgende Felder werden unabhängig der Gemeindedefinition (s.u.) immer benötigt um eine Mindest-Information für die Kurtaxeberechnung zu besitzen.

Feld Datentyp Erklärung
anreise date

Arrival date of the guest in the format

YYYY-MM-DD
abreise date Departue Date of the guest in the format YYYY-MM-DD
kategorie string The ID of the tariff to be booked (can be viewed via API or via the web interface)

Individual Fields

All other fields are defined individually for each municipality. Whether these are mandatory or optional fields can be found in the definition of the municipalities.

 

Feldzuweisung

An assignment of the fields of the posting system to the import interface can be stored in the system. Thus it is not absolutely necessary to make adjustments to the generation of the XML data set

Mandatory Fields

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

Tariff Assignments

The correct tariff allocation is essential for a correct booking of the guests. If existing XML files are to be taken over from a legacy system, it is imperative that they be adapted.

image-1601979321078.png

The tariffs of the guests are transferred from the field kategorie. The value from the id field (see below) is used for this.
In the example below, a guest with the Erwachsener (Adult)" tariff would have to be transferred as follows:

<kategorie>1</kategorie>

Tariff assignments can be requested from your contact person or - if you have been activated for this - can be seen in the "my profile" area on the web interface.

image-1601978889220.png

Accompanying Persons

ccompanying persons of a registration form can be posted via the tag <begleitperson />. Thus any number of accompanying persons can be booked. All defined fields of the main guest can also be used for accompanying persons.

The field  kategorie must also always be  filled in for accompanying persons  .

If arrival or departure ( anreiseabreise) is not specified for the accompanying persons, these will be taken over by the main guest.

Example accompanying persons

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

Example booking

An example of a booking from a registration form with:

  • 1 registration form
    • Main guest with personal data
    • An accompanying person

 

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