# Formate

Folgende Formate sind im System implementiert und können verwendet werden:

# XML

## Zeichensatz und XML Struktur

Der Zeichensatz der Daten ist - wie auch bei der Live-Schnittstelle `<span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>`. Die Datei beginnt mit dem XML Header: `<span class="cp"><?xml version="1.0" encoding="UTF-8"?></span>`

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

<p class="callout info">Die Daten können in beliebiger Reihenfolge stehen, solange die Struktur korrekt ist.</p>

Somit ergibt sich folgende Struktur:<label for="__tab_1_0"></label>

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

<div id="bkmrk-"></div>## Pflichtfelder

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

<div id="bkmrk-feld-datentyp-erkl%C3%A4r"><div><table><thead><tr><th>Feld</th><th>Datentyp</th><th>Erklärung</th></tr></thead><tbody><tr><td>`<span class="n">anreise</span>`</td><td>date</td><td>Anreisedatum des Gastes im Format `<span class="n">YYYY</span><span class="o">-</span><span class="n">MM</span><span class="o">-</span><span class="n">DD</span>`</td></tr><tr><td>`<span class="n">abreise</span>`</td><td>date</td><td>Abreisedatum des Gastes Format `<span class="n">YYYY</span><span class="o">-</span><span class="n">MM</span><span class="o">-</span><span class="n">DD</span>`</td></tr><tr><td>`<span class="n">kategorie</span>`</td><td>string</td><td>Die ID des zu buchenden Tarifs (kann über API oder über die Web-Oberfläche eingesehen werden)</td></tr></tbody></table>

</div></div>## 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

<p class="callout info">Eine Zuweisung der Felder der Buchungs-Systems zur Import-Schnittstelle wird im System je Gemeinde hinterlegt werden. Somit ist i.d.R. keine Anpassung der XML-Datei notwendig (Ausnahme - Tarife (siehe Kapitel "Tarifzuweisung")</p>

<p class="callout info">Je nach Definition der Gemeinde können Felder in der XML-Datei existieren welche beim Import nicht in das System eingespielt werden.</p>

#### Pflichtfelder der Gemeinde

<p class="callout warning">Sind bestimmte Daten einer Gemeinde als Pflichtfeld definiert, so müssen diese ebenfalls in der XML-Datei übergeben werden.</p>

## Tarifzuweisung

<p class="callout danger">Die korrekte Tarifzuweisung ist unabdingbar für eine korrekte Buchung der Gäste. Sollten existierende XML-Dateien aus einem Altsystem übernommen werden, so müssen diese **zwingend** angepasst werden.</p>

[![image-1601979321078.png](https://s3-eu-central-1.amazonaws.com/wiki.meldescheine.de/uploads/images/gallery/2020-10/scaled-1680-/image-1601979321078.png)](https://s3-eu-central-1.amazonaws.com/wiki.meldescheine.de/uploads/images/gallery/2020-10/image-1601979321078.png)

Die Tarife der Gäste werden aus dem Feld `kategorie` übertragen. Dazu wird der Wert aus dem Feld "id" (s.u.) verwendet.  
Im u.g. Beispiel wäre also ein Gast mit Tarif "Erwachsener" wie folgt zu übergeben:

`<span class="nt"><kategorie></span>1<span class="nt"></kategorie></span>`

<p class="callout info">Tarifzuweisungen können über Ihren Ansprechpartner angefordert werden oder sind - sofern Sie dafür freigeschaltet sind im Bereich "mein Profil" über die Web-Oberfläche ersichtlich.</p>

[![image-1601978889220.png](https://s3-eu-central-1.amazonaws.com/wiki.meldescheine.de/uploads/images/gallery/2020-10/scaled-1680-/image-1601978889220.png)](https://s3-eu-central-1.amazonaws.com/wiki.meldescheine.de/uploads/images/gallery/2020-10/image-1601978889220.png)

## Begleitpersonen

Begleitpersonen eines Meldescheins können über das Tag `<span class="o"><</span><span class="n">begleitperson</span> <span class="o">/></span>` 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.

<p class="callout warning">Das Feld `<span class="n">kategorie</span>` müssen bei Begleitpersonen ebenfalls **immer** befüllt sein.</p>

<p class="callout warning">Sollten An- oder Abreise (`anreise`, `abreise`) bei den Begleitpersonen nicht angegeben sein, so werden diese vom Hauptgast übernommen.</p>

### Beispiel Begleitpersonen

<div id="bkmrk-xml-%3C%21---...---%3E-%3Cme"><label for="__tab_2_0">XML</label><div><table class="codehilitetable" style="width: 376px;"><tbody><tr><td class="code" style="width: 376px;"><div><button class="md-clipboard" data-clipboard-target="#__code_1 pre, #__code_1 code" title="In Zwischenablage kopieren"></button>```
    <span class="c"><!-- ... --></span>
    <span class="nt"><meldeschein></span>
        <span class="c"><!-- Daten des Hauptgastes --></span>
        <span class="nt"><anreise></span>2019-11-22<span class="nt"></anreise></span>
        <span class="nt"><abreise></span>2019-11-25<span class="nt"></anreise></span>
        <span class="nt"><kategorie></span>1<span class="nt"></kategorie></span>
        <span class="c"><!-- Ende Daten des Hauptgastes --></span>
        <span class="nt"><begleitperson></span>
            <span class="nt"><anreise></span>2019-11-22<span class="nt"></anreise></span>
            <span class="nt"><abreise></span>2019-11-23<span class="nt"></anreise></span>
            <span class="nt"><kategorie></span>1<span class="nt"></kategorie></span>
            <span class="cp"><! -- optionale weitere Daten --></span>
        <span class="nt"></begleitperson></span>
        <span class="nt"><begleitperson></span>
            <span class="c"><!-- weiterer Begleiter--></span>
        <span class="nt"></begleitperson></span>
        <span class="nt"><begleitperson></span>
            <span class="c"><!-- weiterer Begleiter--></span>
        <span class="nt"></begleitperson></span>
   <span class="nt"></meldeschein></span>
<span class="c"><!-- ... --></span>
```

</div></td></tr></tbody></table>

</div></div>## Beispiel-Buchung

Ein Beispiel einer Buchung von einem Meldeschein mit:

- 1 Meldeschein 
    - Hauptgast mit Personendaten
    - Einer Begleitperson

<div id="bkmrk-xml"><label for="__tab_3_0">XML</label></div><div id="bkmrk-%3C%3Fxml-version%3D%221.0%22--0">```xml
<?xml version="1.0" encoding="UTF-8"?><br></br><meldescheine><br></br>   <meldeschein><br></br>      <hausnummer>.</hausnummer><br></br>      <anrede>Herr</anrede><br></br>      <name>Mustermann</name><br></br>      <vorname>Max</vorname><br></br>      <plz>123456</plz><br></br>      <ort>Musterstadt</ort><br></br>      <land>Deutschland</land><br></br>      <anreise>2019-10-19</anreise><br></br>      <abreise>2019-10-20</abreise><br></br>      <kategorie>1</kategorie><br></br>      <begleitperson><br></br>         <anrede>Frau</anrede><br></br>         <name>Mustermann</name><br></br>         <vorname>Karin</vorname><br></br>         <kategorie>1</kategorie><br></br>         <anreise>2019-10-19</anreise><br></br>         <abreise>2019-10-20</abreise><br></br>      </begleitperson><br></br>   </meldeschein><br></br></meldescheine>
```

</div>

# 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 `&lt;meldescheine /&gt;` 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 />``.

<p class="callout info">The sequence of the data can be in any order.</p>

This results in the following structure:  
<label for="__tab_1_0"></label>

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

<div id="bkmrk-"></div>## Mandatory fields

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

<div id="bkmrk-feld-datentyp-erkl%C3%A4r"><div><table style="height: 147px;" width="810"><thead><tr style="height: 29px;"><th style="height: 29px; width: 89.5333px;">Feld</th><th style="height: 29px; width: 78.55px;">Datentyp</th><th style="height: 29px; width: 640.917px;">Erklärung</th></tr></thead><tbody><tr style="height: 52px;"><td style="height: 52px; width: 89.5333px;">`<span class="n">anreise</span>`</td><td style="height: 52px; width: 78.55px;">date</td><td style="height: 52px; width: 640.917px;">Arrival date of the guest in the format

`<span class="n">YYYY</span><span class="o">-</span><span class="n">MM</span><span class="o">-</span><span class="n">DD</span>`</td></tr><tr style="height: 29px;"><td style="height: 29px; width: 89.5333px;">`<span class="n">abreise</span>`</td><td style="height: 29px; width: 78.55px;">date</td><td style="height: 29px; width: 640.917px;">Departue Date of the guest in the format `<span class="n">YYYY</span><span class="o">-</span><span class="n">MM</span><span class="o">-</span><span class="n">DD</span>`</td></tr><tr style="height: 29px;"><td style="height: 29px; width: 89.5333px;">`<span class="n">kategorie</span>`</td><td style="height: 29px; width: 78.55px;">string</td><td style="height: 29px; width: 640.917px;">The ID of the tariff to be booked (can be viewed via API or via the web interface)</td></tr></tbody></table>

</div></div>## 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

<p class="callout info">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</p>

#### Mandatory Fields

<p class="callout warning">Sind bestimmte Daten einer Gemeinde als Pflichtfeld definiert, so müssen diese ebenfalls in der XML-Datei übergeben werden.</p>

## Tariff Assignments

<p class="callout danger">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.</p>

[![image-1601979321078.png](https://s3-eu-central-1.amazonaws.com/wiki.meldescheine.de/uploads/images/gallery/2020-10/scaled-1680-/image-1601979321078.png)](https://s3-eu-central-1.amazonaws.com/wiki.meldescheine.de/uploads/images/gallery/2020-10/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:

`<span class="nt"><kategorie></span>1<span class="nt"></kategorie></span>`

<p class="callout info">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.</p>

[![image-1601978889220.png](https://s3-eu-central-1.amazonaws.com/wiki.meldescheine.de/uploads/images/gallery/2020-10/scaled-1680-/image-1601978889220.png)](https://s3-eu-central-1.amazonaws.com/wiki.meldescheine.de/uploads/images/gallery/2020-10/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.

<p class="callout warning"><span style="box-sizing: border-box; outline-color: var(--color-primary); outline-width: 1px; color: #6a2802; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Oxygen, Ubuntu, Roboto, Cantarell, 'Fira Sans', 'Droid Sans', 'Helvetica Neue', sans-serif; font-size: 14px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial; vertical-align: inherit;"><span style="box-sizing: border-box; outline-color: var(--color-primary); outline-width: 1px; vertical-align: inherit;">The field </span></span>`<span class="n" style="box-sizing: border-box; outline-color: var(--color-primary); outline-width: 1px; margin: 0px; padding: 0px; border: 0px; font: inherit; vertical-align: baseline;">kategorie</span>`<span style="box-sizing: border-box; outline-color: var(--color-primary); outline-width: 1px; color: #6a2802; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Oxygen, Ubuntu, Roboto, Cantarell, 'Fira Sans', 'Droid Sans', 'Helvetica Neue', sans-serif; font-size: 14px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial; vertical-align: inherit;"><span style="box-sizing: border-box; outline-color: var(--color-primary); outline-width: 1px; vertical-align: inherit;"> must also </span></span>**<span style="box-sizing: border-box; outline-color: var(--color-primary); outline-width: 1px; vertical-align: inherit;">always be</span>**<span style="box-sizing: border-box; outline-color: var(--color-primary); outline-width: 1px; color: #6a2802; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Oxygen, Ubuntu, Roboto, Cantarell, 'Fira Sans', 'Droid Sans', 'Helvetica Neue', sans-serif; font-size: 14px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial; vertical-align: inherit;"><span style="box-sizing: border-box; outline-color: var(--color-primary); outline-width: 1px; vertical-align: inherit;"> filled </span><span style="box-sizing: border-box; outline-color: var(--color-primary); outline-width: 1px; vertical-align: inherit;">in for accompanying persons </span><span style="box-sizing: border-box; outline-color: var(--color-primary); outline-width: 1px; vertical-align: inherit;">.</span></span></p>

<p class="callout warning"><span style="box-sizing: border-box; outline-color: var(--color-primary); outline-width: 1px; color: #6a2802; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Oxygen, Ubuntu, Roboto, Cantarell, 'Fira Sans', 'Droid Sans', 'Helvetica Neue', sans-serif; font-size: 14px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial; vertical-align: inherit;"><span style="box-sizing: border-box; outline-color: var(--color-primary); outline-width: 1px; vertical-align: inherit;">If arrival or departure ( </span></span>`anreise`<span style="box-sizing: border-box; outline-color: var(--color-primary); outline-width: 1px; color: #6a2802; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Oxygen, Ubuntu, Roboto, Cantarell, 'Fira Sans', 'Droid Sans', 'Helvetica Neue', sans-serif; font-size: 14px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial; vertical-align: inherit;"><span style="box-sizing: border-box; outline-color: var(--color-primary); outline-width: 1px; vertical-align: inherit;">, </span></span>`abreise`<span style="box-sizing: border-box; outline-color: var(--color-primary); outline-width: 1px; color: #6a2802; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Oxygen, Ubuntu, Roboto, Cantarell, 'Fira Sans', 'Droid Sans', 'Helvetica Neue', sans-serif; font-size: 14px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial; vertical-align: inherit;"><span style="box-sizing: border-box; outline-color: var(--color-primary); outline-width: 1px; vertical-align: inherit;">) is not specified for the accompanying persons, these will be taken over by the main guest.</span></span></p>

### <span style="box-sizing: border-box; outline-color: var(--color-primary); outline-width: 1px; vertical-align: inherit;">Example accompanying persons</span>

<div id="bkmrk-xml-%3C%21---...---%3E-%3Cme"><label for="__tab_2_0">XML</label><div><table class="codehilitetable" style="width: 376px;"><tbody><tr><td class="code" style="width: 376px;"><div><button class="md-clipboard" data-clipboard-target="#__code_1 pre, #__code_1 code" title="In Zwischenablage kopieren"></button>```
    <span class="c"><!-- ... --></span>
    <span class="nt"><meldeschein></span>
        <span class="c"><!-- Daten des Hauptgastes --></span>
        <span class="nt"><anreise></span>2019-11-22<span class="nt"></anreise></span>
        <span class="nt"><abreise></span>2019-11-25<span class="nt"></anreise></span>
        <span class="nt"><kategorie></span>1<span class="nt"></kategorie></span>
        <span class="c"><!-- Ende Daten des Hauptgastes --></span>
        <span class="nt"><begleitperson></span>
            <span class="nt"><anreise></span>2019-11-22<span class="nt"></anreise></span>
            <span class="nt"><abreise></span>2019-11-23<span class="nt"></anreise></span>
            <span class="nt"><kategorie></span>1<span class="nt"></kategorie></span>
            <span class="cp"><! -- optionale weitere Daten --></span>
        <span class="nt"></begleitperson></span>
        <span class="nt"><begleitperson></span>
            <span class="c"><!-- weiterer Begleiter--></span>
        <span class="nt"></begleitperson></span>
        <span class="nt"><begleitperson></span>
            <span class="c"><!-- weiterer Begleiter--></span>
        <span class="nt"></begleitperson></span>
   <span class="nt"></meldeschein></span>
<span class="c"><!-- ... --></span>
```

</div></td></tr></tbody></table>

</div></div>## <span style="box-sizing: border-box; outline-color: var(--color-primary); outline-width: 1px; vertical-align: inherit;">Example booking</span>

<span style="box-sizing: border-box; outline-color: var(--color-primary); outline-width: 1px; vertical-align: inherit;">An example of a booking from a registration form with:</span>

- <span style="box-sizing: border-box; outline-color: var(--color-primary); outline-width: 1px; vertical-align: inherit;">1 registration form</span>
    - <span style="box-sizing: border-box; outline-color: var(--color-primary); outline-width: 1px; vertical-align: inherit;">Main guest with personal data</span>
    - <span style="box-sizing: border-box; outline-color: var(--color-primary); outline-width: 1px; vertical-align: inherit;">An accompanying person</span>

<div id="bkmrk-xml"><label for="__tab_3_0">XML</label></div><div id="bkmrk-%3C%3Fxml-version%3D%221.0%22--0">```xml
<?xml version="1.0" encoding="UTF-8"?><br></br><meldescheine><br></br>   <meldeschein><br></br>      <hausnummer>.</hausnummer><br></br>      <anrede>Herr</anrede><br></br>      <name>Mustermann</name><br></br>      <vorname>Max</vorname><br></br>      <plz>123456</plz><br></br>      <ort>Musterstadt</ort><br></br>      <land>Deutschland</land><br></br>      <anreise>2019-10-19</anreise><br></br>      <abreise>2019-10-20</abreise><br></br>      <kategorie>1</kategorie><br></br>      <begleitperson><br></br>         <anrede>Frau</anrede><br></br>         <name>Mustermann</name><br></br>         <vorname>Karin</vorname><br></br>         <kategorie>1</kategorie><br></br>         <anreise>2019-10-19</anreise><br></br>         <abreise>2019-10-20</abreise><br></br>      </begleitperson><br></br>   </meldeschein><br></br></meldescheine>
```

</div>