# API

# Allgemein

Die Anwendung verfügt über eine Programmierbare Schnittstelle, kurz API (Application Programming Interface) genannt. Mithilfe dieser ist es möglich Informationen zwischen der Anwendung und Drittanbietern auszutauschen.

## Protokoll

Die Kommunikation erfolgt ausschließlich über das `<span class="n">http</span>`-Protkoll und Port `<span class="mi">443</span>`

## Sicherheit und Freigaben

Sämtliche Kommunikation erfolgt über HTTPS mit einem SHA-256 RSA verschlüsselten SSL Zertifikat Sollte Ihr System hinter einer Firewall installiert sein, werden folgende Freigaben benötigt.

- Protokoll: `<span class="n">http</span>`
- Port: `<span class="mi">443</span>`
- DNS Namen / A-Record: `<span class="n">kunden</span><span class="o">-</span><span class="n">systeme</span><span class="o">-</span><span class="mi">384614943</span><span class="p">.</span><span class="n">eu</span><span class="o">-</span><span class="n">central</span><span class="o">-</span><span class="mi">1</span><span class="p">.</span><span class="n">elb</span><span class="p">.</span><span class="n">amazonaws</span><span class="p">.</span><span class="n">com</span>`

## Test / Produktiv System

Für die Entwicklung und Testumsetzung ist ein Test-System verfügbar. Die Funktionalität beider Systeme ist diesselbe - im Testsystem können jedoch bereits Features enthalten sein, welche noch nicht im Produktivsystem vorhanden sind.

##### Testsystem:

API-Backend: [https://dev-api.meldescheine.de/api/](https://dev-api.meldescheine.de/api/)   
Web-Frontend: [https://dev.meldescheine.de/](https://dev.meldescheine.de/)

##### Produktiv-System:

API-Backend: [https://api.meldescheine.de/api/ ](https://api.meldescheine.de/api/)  
Web-Frontend: [https://v2.meldescheine.de/](https://v2.meldescheine.de/)

<p class="callout warning">Zugangsdaten für das Test sowie Produktivsystem weichen voneinander ab.</p>

## Umstellung von Test auf Produktivsystem

Da beide Systeme dieselben Funktionalitäten bieten, sind bei der Umstellung nach erfolgreichen Tests i.d.R. nur folgende Parameter anzupassen:

- API URL
- Zugangsdaten (Benutzername,Passwort)
- Tarifzuweisungen

## HTTP-Header

Für die korrekte Übergabe im System sind folgende Http-Header zwingend notwendig

<table border="1" id="bkmrk-name-wert-beschreibu" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 25%;">**Name**</td><td style="width: 25%;">**Wert**</td><td style="width: 25%;">**Beschreibung**</td></tr><tr><td style="width: 25%;">Content-Type</td><td style="width: 25%;">application/json oder application/xml </td><td style="width: 25%;">Inhalt der Anfrage, entsprechend JSON oder XML</td></tr><tr><td style="width: 25%;">User-Agent</td><td style="width: 25%;">beliebige Zeichenkette</td><td style="width: 25%;">Eine beliebige Zeichenkette - im Idealfall übergeben Sie hier einen eindeutigen Bezeichner Ihres Systems z.B "mustermann-booking-1.0.4-x86"</td></tr></tbody></table>

<p class="callout info">Wenn die o.g. Header nicht übergeben werden, so werden Ihre Anfragen mit einem HTTP Error Code `403 "forbidden"` abgelehnt.</p>

## URL Endung

Alle Aufrufe einer URL sollten mit einem abschliessenden Slash (`<span class="o">/</span>`) erfolgen.

Nicht korrekt:

<table class="codehilitetable" id="bkmrk-token-erzeugen-post-"><tbody><tr><td class="code"><div>```
 <span class="n">Token</span> <span class="n">erzeugen</span>
 <span class="n">POST</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">api</span><span class="p">.</span><span class="n">meldescheine</span><span class="p">.</span><span class="n">de</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="n">token</span>
```

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

Korrekt:

```
 Token erzeugen
 POST https://api.meldescheine.de/api/token/
```

# Formate

## Zeichensatz / Kodierung

Unabhängig vom Format erfolgt die Übergabe und Rückgabe der Daten immer `<span class="n">UTF8</span>` kodiert. Nutzt Ihre Anwendung eine andere Zeichen-Kodierung (z.B. ISO-8859-1), so müssen die Buchungs-Daten vor der Übergabe in das entsprechende Format konvertiert werden.

## Validierung der Anfragen

Alle schreibenden Anfragen (z.b. das Buchen eines Meldescheins) mithilfe eines JSON-Schemas validiert, um gültigen Datenaufbau zu gewährleisten. Entsprechende Schemata sind unter den jeweiligen Punkten der Dokumentation vermerkt.

Offizielle Dokumentation und Syntax-Erklärung unter [json-schema.org](https://json-schema.org/)

Info

Anfragen in einem anderen Format (z.B.) werden **ebenfalls** über die Schemata geprüft, werden zurvor jedoch intern in JSON umgewandelt.

## Unterstützte Formate

Die Schnittstelle kann mit verschiedenen Formaten verwendet werden. Diese werden in den folgenden Punkten erläutert und es werden Besonderheiten hervorgehoben.

Folgende Formate werden unterstützt:

<div id="bkmrk-format-code-verwende"><div><table><thead><tr><th>Format</th><th>Code</th><th>Verwendet</th><th>URL-Parameter</th></tr></thead><tbody><tr><td>JSON</td><td>`<span class="n">json</span>`</td><td>**Standard**</td><td>`<span class="o">?</span><span class="n">format</span><span class="o">=</span><span class="n">json</span>` (nicht notwendig,da Standard)</td></tr><tr><td>XML</td><td>`<span class="n">xml</span>`</td><td>explizite Angabe</td><td>`<span class="o">?</span><span class="n">format</span><span class="o">=</span><span class="n">xml</span>`</td></tr></tbody></table>

</div></div>JSON Endpunkt aufrufen

<div id="bkmrk-"></div><table class="codehilitetable" id="bkmrk-post-%2Fendpunkt-url-%23"><tbody><tr><td class="code"><div>```
POST /endpunkt-url
<span class="c1"># oder explizit</span>
POST /endpunkt-url?format<span class="o">=</span>json
```

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

XML Endpunkt aufrufen

<div id="bkmrk--0"></div><table class="codehilitetable" id="bkmrk-post-%2Fendpunk-url%3Ffo"><tbody><tr><td class="code"><div>```
POST /endpunk-url?format=xml
```

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

Achtung

Der `<span class="n">format</span>` Parameter muss sowohl bei lesenden (`<span class="k">GET</span>`), als bei schreibenden (`<span class="n">POST</span>`,`<span class="n">PUT</span>`) in als URL-Parameter übergeben werden, wenn ein anderes Format, als der Standard verwendet werden soll.

---

## JSON

Es kann nur gültiger JSON Syntax nach der Spezifikation angenommen werden werden. Leerstellen und/oder Zeilenumbrüche sind hierbei nicht relevant.

<div id="bkmrk--2"></div><table class="codehilitetable" id="bkmrk-%7B%22a%22%3A%22b%22%2C%22c%22%3A%22d%22%7D"><tbody><tr><td class="code"><div>```
    <span class="p">{</span><span class="nt">"a"</span><span class="p">:</span><span class="s2">"b"</span><span class="p">,</span><span class="nt">"c"</span><span class="p">:</span><span class="s2">"d"</span><span class="p">}</span>  
```

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

ist äquivalent zu:

<div id="bkmrk--3"></div><table class="codehilitetable" id="bkmrk-%7B-%22a%22%3A-%22b%22%2C-%22c%22%3A-%22d%22"><tbody><tr><td class="code"><div>```
    <span class="p">{</span>
        <span class="nt">"a"</span><span class="p">:</span> <span class="s2">"b"</span><span class="p">,</span>
        <span class="nt">"c"</span><span class="p">:</span> <span class="s2">"d"</span>
    <span class="p">}</span>  
```

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

Bibliotheken, die zur Erstellung des JSON Formats verwendet werden können, finden sich in allen gängigen Programmiersprachen sowie umgebungen, was die Implementierung vereinfacht. Eine Auflistung gängiger Bibliotheken sind unter json.org aufgelistet.

Offizielle Spezifikation und Beispiele: [json.org](https://json.org/)

---

## XML

Die API lässt sich ebenfalls über das XML-Format ansprechen. Alle URL-Endpunkte der API bleiben bestehen müssen jedoch mit dem `<span class="n">format</span>` Parameter übergeben werden (siehe unten)

Info

Sowohl Übergabe, als auch Rückgabe der API werden in XML übermittelt.

### URL Parameter

Um das XML Format zu verwenden ist es notwendig hinter allen aufrufenden URLs den GET Parameter `<span class="n">format</span>`mit dem Wert `<span class="n">xml</span>` zu verwenden.

Um eine Authentizierung im XML-Format aufzurufen lautet die URL somit:

`<span class="err">POST /api/token/?format=xml</span>`

### Besonderheiten XML-Format

#### Root-Element

XML-Dokumente werden **immer** mit dem Element `<span class="o"><</span><span class="n">root</span><span class="o">></span>` beginnen und entsprechend mit `<span class="o"></</span><span class="n">root</span><span class="o">></span>` enden

Beispiel:

<div id="bkmrk-xml-0"><label for="__tab_1_0">XML</label><div></div></div><div id="bkmrk--5"></div><div id="bkmrk-%3Croot%3E-%3C%21---es-folgt"><div><table class="codehilitetable"><tbody><tr><td class="code"><div>```
 <span class="nt"><root></span>
    <span class="c"><!-- Es folgt das eigentliche Dokument zur Übergabe --></span>
 <span class="nt"></root></span>
```

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

</div></div>#### Listen / Arrays

Array Elemente werden **immer** mit dem Tag `<span class="o"><</span><span class="n">list</span><span class="o">-</span><span class="n">item</span><span class="o">></span>` versehen

Beispiel: Übergabe einer Liste von 3 Meldescheinen

<div id="bkmrk-xml-1"><label for="__tab_2_0">XML</label><div></div></div><div id="bkmrk--6"></div>```
 <root>
    <meldescheine>
        <list-item><!-- weitere Daten --></list-item>
        <list-item><!-- weitere Daten --></list-item>
        <list-item><!-- weitere Daten --></list-item>
    </meldescheine>
    <!-- weitere Daten -->
 </root>
```

# Authentifzierung

Bevor gesicherte Anfragen durchgeführt werden können, ist ein gültiges Authentifizierungs-Merkmal- künftig `<span class="n">Token</span>` genannt - erforderlich. Die Authentifizierung erfolgt über API Aufruf mit Benutzername sowie Passwort-Schlüssel und gibt im Erfolgsfall ein JWT Token zurück.

<p class="callout info">Das Token muss bei allen Anfragen außer der Anmeldung übergeben werden.</p>

Für die Authentifzierung sind folgende Informationen notwendig:

- Server-URL
- Benutzername / Email
- Passwort

Weiterhin werden folgende Informationen für weitere Aufrufe benötigt.

- Gemeinde-ID(s)
- Objekt-ID(s)

Diese Informationen lassen sich nach der Authentifizierung direkt über den [get\_config](https://api.meldescheine.de/static/docs/de/live-api/methods/get_config.html) Aufrufen.

---

## Token erzeugen

<div id="bkmrk--0"></div><table class="codehilitetable" id="bkmrk-post-api-%2Ftoken%2F"><tbody><tr><td class="code"><div>```
<span class="n">POST</span> <span class="n">api</span> <span class="o">/</span><span class="n">token</span><span class="o">/</span>
```

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

<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>username</td><td>string</td><td>Benutzername oder Email-Adresse</td></tr><tr><td>password</td><td>string</td><td>das zugehörige Passwort</td></tr></tbody></table>

</div></div>Besonderheit

Die Authentifzierung kann zusätzlich zur Übergabe als JSON oder XML ebenfalls als `<span class="n">application</span><span class="o">/</span><span class="n">x</span><span class="o">-</span><span class="n">www</span><span class="o">-</span><span class="n">form</span><span class="o">-</span><span class="n">urlencoded</span>` übergeben. werden - eher bekannt als Formular-Daten.

Somit ist eine interaktive Anmeldung im System über z.B. ein HTML Formular oder eine Dritt-Anwendung möglich.

#### Beispiele

##### Request

<div id="bkmrk-json"><label for="__tab_1_0">JSON</label><div></div></div><div id="bkmrk-%7B-%22username%22%3A-%22m.mus"><table class="codehilitetable"><tbody><tr><td class="code"><div>```
<span class="p">{</span>
  <span class="nt">"username"</span><span class="p">:</span> <span class="s2">"m.mustermann"</span><span class="p">,</span>
  <span class="nt">"password"</span><span class="p">:</span> <span class="s2">"5bed8a17a5f780aa3b541e41c62416a64"</span>
<span class="p">}</span>
```

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

</div>##### <label for="__tab_1_1"></label>Response

<div id="bkmrk-json-0">JSON</div><div id="bkmrk-%7B-%22token%22%3A-%22ej0exaio"><table class="codehilitetable"><tbody><tr><td class="code"><div>```
<span class="p">{</span>
  <span class="nt">"token"</span><span class="p">:</span> <span class="s2">"eJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ...<abgeschnitten>"</span>
<span class="p">}</span>
```

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

</div>## <label for="__tab_2_1"></label>Token verwenden

Das Token wird bei jeder Abfrage im HTTP Header "`Authorization`" übergeben. Vor das im ersten Schritt erzeugte Token

HTTP Header `<span class="k">Authorization</span>`  
Prefix: `<span class="n">JWT</span>`

Beispiel:

<div id="bkmrk-text"><label for="__tab_3_0">Text</label><div></div></div><div id="bkmrk-authorization%3A-jwt-e"><div><table class="codehilitetable"><tbody><tr><td class="code"><div>```
Authorization: JWT eyJhbGciOiJIUzI1NiIeyJ4554dscvd499dfcc....
```

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

</div></div><p class="callout info">Bitte auf das Präfix `<span class="n">JWT</span>` sowie die Leerstelle zwischen dem Präfix und dem eigentlich Token achten. `<span class="p">[</span><span class="n">PRÄFIX</span><span class="o">|</span><span class="n">LEERSTELLE</span><span class="o">|</span><span class="n">TOKEN</span><span class="p">]</span>`</p>

<p class="callout info">Alternativ kann das JWT Token auch als GET-Parameter "`jwt`" übergeben werden: `https://.../?jwt=<token>`</p>

## Code-Beispiele

### Token abfragen

<div id="bkmrk-python-3"><label for="__tab_4_0">Python 3</label></div><div id="bkmrk-%23-pip3-install-reque"><div><table class="codehilitetable"><tbody><tr><td class="code"><div>```
<span class="c1"># pip3 install requests </span>
<span class="kn">import</span> <span class="nn">requests</span>
<span class="n">payload</span> <span class="o">=</span> <span class="p">{</span>
    <span class="s1">'username'</span><span class="p">:</span><span class="s1">'demo'</span><span class="p">,</span>
    <span class="s1">'password'</span><span class="p">:</span><span class="s1">'demo'</span><span class="p">,</span>
<span class="p">}</span>

<span class="n">r</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="s1">'https://<API_URL>/api/token/'</span><span class="p">,</span><span class="n">data</span><span class="o">=</span><span class="n">payload</span><span class="p">)</span>
<span class="n">server_response_json</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>

<span class="hll"><span class="n">jwt_token</span> <span class="o">=</span> <span class="n">server_response_json</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'token'</span><span class="p">)</span> <span class="c1"># Aus dem server_response objekt den String-Wert aus "token" extrahieren</span>
</span><span class="nb">print</span><span class="p">(</span><span class="n">jwt_token</span><span class="p">)</span>
<span class="c1"># <str>: eJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...</span>
```

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

</div></div>### Token in Header übergeben

<div id="bkmrk-python-3-0"><label for="__tab_5_0">Python 3</label><div></div></div><div id="bkmrk-%23-pip3-install-reque-0"><div><table class="codehilitetable"><tbody><tr><td class="code"><div>```
<span class="c1"># pip3 install requests</span>
<span class="kn">import</span> <span class="nn">requests</span>
<span class="n">payload</span> <span class="o">=</span> <span class="p">{</span>
    <span class="c1"># Beliebige Daten</span>
<span class="p">}</span>

<span class="c1"># variable jwt_token aus vorherigem Beispiel</span>
<span class="n">headers</span> <span class="o">=</span> <span class="p">{</span>
<span class="hll">  <span class="s1">'authorization'</span><span class="p">:</span> <span class="s1">'JWT </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">jwt_token</span> <span class="c1"># Ergibt "JWT eJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..."</span>
</span><span class="p">}</span>

<span class="c1">#Hier wird der Header mit übergeben</span>
<span class="hll"><span class="n">r</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="s1">'https://<API_URL>/<anfrage>/'</span><span class="p">,</span><span class="n">data</span><span class="o">=</span><span class="n">payload</span><span class="p">,</span><span class="n">headers</span><span class="o">=</span><span class="n">headers</span><span class="p">)</span> 
</span><span class="n">server_response_json</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
<span class="c1"># ...</span>
```

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

</div></div>---

<div id="bkmrk--1"></div><div id="bkmrk--2"></div>

# Meta Objekt

Zusätzlich zu einem passenden Auth-Token wird eine `<span class="n">meta</span>` Objekt für alle authentifzierten Anfragen benötigt. Dieses Objekt identifiziert die Abfrage und übergibt einen Kontext für den Aufruf.

So geben `<span class="n">gemeinde</span>`, und `<span class="n">objekt</span>` an, für welche Gemeinde sowie welchen Vermieter und Objekt der Gemeinde der Aufruf verwendet wird.

<p class="callout info">Das Meta Objekt kann nicht alleine übergeben werden. Es gehört immer zu einem weiteren Aufruf (siehe entspr. Kapitel)</p>

### Parameter

<div id="bkmrk-feld-datentyp-ben%C3%B6ti"><table style="height: 145px; width: 834px;"><thead><tr style="height: 29px;"><th style="height: 29px; width: 98.25px;">Feld</th><th style="height: 29px; width: 75.1833px;">Datentyp</th><th style="height: 29px; width: 142.35px;">benötigt</th><th style="height: 29px; width: 218.533px;">Beschreibung</th><th style="width: 274.683px; height: 29px;"> </th></tr></thead><tbody><tr style="height: 29px;"><td style="height: 29px; width: 98.25px;">gemeinde</td><td style="height: 29px; width: 75.1833px;">int</td><td style="height: 29px; width: 142.35px;">true</td><td style="height: 29px; width: 218.533px;">Die ID der zu buchenden Gemeinde</td><td style="width: 274.683px; height: 29px;"> </td></tr><tr style="height: 29px;"><td style="height: 29px; width: 98.25px;">objekt</td><td style="height: 29px; width: 75.1833px;">int</td><td style="height: 29px; width: 142.35px;">true</td><td style="height: 29px; width: 218.533px;">Die ID des zu buchenden Vermieters</td><td style="width: 274.683px; height: 29px;"> </td></tr><tr style="height: 29px;"><td style="height: 29px; width: 98.25px;">requestId</td><td style="height: 29px; width: 75.1833px;">string</td><td style="height: 29px; width: 142.35px;">(nur wenn `idempotent`= true)</td><td style="height: 29px; width: 218.533px;">Eine optionale Referenz zur Buchung</td><td style="width: 274.683px; height: 29px;">Rückgabe: die übergebene Zeichekette, oder falls nicht übergeben, eine zufällig generierte Zeichenkette</td></tr><tr style="height: 29px;"><td style="width: 98.25px; height: 29px;">idempotent</td><td style="width: 75.1833px; height: 29px;">bool</td><td style="width: 142.35px; height: 29px;">false</td><td style="width: 218.533px; height: 29px;">Anfrage auf Eindeutigkeit prüfen</td><td style="width: 274.683px; height: 29px;"> </td></tr></tbody></table>

</div>### Eindeutige Anfragen (Idempotenz)

Um Mehrfachbuchungen bei Verbindungsabbrüchen oder anderen Fehlern zu unterbinden bietet die Schnittstelle die Möglichkeit, das feld `idempotent` im Meta-Objekt zu übergeben.

In Verbindung mit der `requestId` ist es somit möglich, sicherzustellen, dass das System keine Mehrfachanfragen zulässt.

Der erste Aufruf eines idempotenten Requests wird normal angenommen - jede weitere Anfrage mit der gleichen Request-ID wird abgelehnt, solange das System diese Request-ID speichert.

<p class="callout info">Gespeicherte Request-IDs verfallen nach 5 Minuten (300 Sekunden). Nach Ablauf kann die gleiche Request-ID wieder verwendet werden. Es ist jedoch immer ratsam eine neue, zufällig generierte Request-ID zu erzeugen.</p>

<p class="callout info">Die Request-IDs sind immer auf den Benutzer der Anfrage bezogen eindeutig. Somit könnten `user1` und `user2` die Request-ID `123-456-789` verwenden, ohne Fehler zu erhalten.</p>

<p class="callout info">Alle Anfragen die das Meta-Objekt enthalten, unterstützten dieses Merkmal.</p>

<p class="callout warning">Die Request-ID wird erst nach einem erfolgreich durchgeführten Vorgang auf dem Server gespeichert. Bei parallelen Anfragen besteht keine Garantie für Eindeutigkeit.</p>

**Vorgehensweise:**

- Generieren Sie eine eindeutige Request-ID z.B. über eine uuid-Funktion z.B ([https://docs.python.org/3/library/uuid.html](https://docs.python.org/3/library/uuid.html))
- Übergeben Sie die Request-ID im Feld `requestId`
- Setzen Sie das Merkmal `idempotent` auf `true`

```JSON
{
	"meta": {
		"gemeinde":1,
     	"objekt": 2049,
		"requestId": "123-456-789",
		"idempotent":true
	}
}
```

<p class="callout warning">Wenn Sie das `idempotent` Merkmal verwenden, ist die Übergabe des Feldes `requestId` zwingend notwendig.</p>

#####  

### Beispiele

##### Request

<div id="bkmrk-"></div><div id="bkmrk-json-%7B-%22meta%22%3A-%7B-%22ob"><div><label for="__tab_6_0">JSON</label></div>```json
{<br></br>   "meta": {<br></br>     "objekt": 806,<br></br>     "gemeinde": 1,<br></br>     "requestId":"abcdefg"  // In der Antwort wird der gleiche Wert wieder in "requestId" enthalten sein<br></br>   },<br></br>   //weitere Daten<br></br>}
```

<div>XML</div></div>```xml
<?xml version="1.0" encoding="utf-8"?>
<meta>
    <vermieter>1</vermieter>
    <gemeinde>1</gemeinde><!-- in diesem Fall wird als requestId eine zufällige Zeichenkette zurückgegeben -->
</meta>
<!-- weitere Daten -->
```

##### Response

JSON

```json
{
  "meta": {
     "requestId": "66f81f62-0942-11eb-bd68-c04a00212a69",
     "timestamp": "2020-10-08T10:43:56.496102",
     "user": {
            "id": 38,
            "username": "DemoV",
            "alias": "Lisa Mustermann"
        },
        "gemeinde": 1
    }
}
```

# Methoden

Im folgenden sind alle implementierten Methoden definiert.

Sollten Sie Daten aus dem System benötigen, welche nicht über die Schnittstelle freigegeben werden, kontaktieren Sie bitte Ihren Ansprechpartner.

# Meldescheine buchen

<div id="bkmrk-"></div><table class="codehilitetable" id="bkmrk-post-meldeschein%2Fbuc"><tbody><tr><td class="code">```
POST  import/meldeschein/buchen/
```

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

Dieser Aufruf erzeugt einen oder mehrere elektronischen Meldeschein im System.

## Allgemein

Es ist möglich mehrere Meldescheine auf einmal zu buchen, indem weitere Objekte dem `<span class="n">meldescheine</span>` Array hinzugefügt werden.

## Parameter

<div id="bkmrk-name-datentyp-verwen"><div><table><thead><tr><th>Name</th><th>Datentyp</th><th>Verwendung</th></tr></thead><tbody><tr><td>meta</td><td>object</td><td>[Meta-Objekt](https://wiki.meldescheine.de/books/api/page/meta-objekt "Meta Objekt")</td></tr><tr><td>params</td><td>object</td><td>Optionale Parameter</td></tr><tr><td>meldescheine</td><td>array</td><td>Array mit Meldescheindaten</td></tr><tr><td>meldescheine\[\]</td><td>object</td><td>Die zu buchenden Daten des Meldescheins</td></tr><tr><td>meldescheine\[\].personen</td><td>array</td><td>Auflistung aller Gäste</td></tr><tr><td>meldescheine\[\].ms\_type</td><td>string</td><td>Immer mit dem Wert "ems" zu befüllen</td></tr></tbody></table>

</div></div>### Pro Person

<div id="bkmrk-name-datentyp-verwen-0"><div><table><thead><tr><th>Name</th><th>Datentyp</th><th>Verwendung</th></tr></thead><tbody><tr><td>meldescheine\[\].personen\[\].tarif\_id</td><td>int</td><td>Die Tarif-ID des Gasts</td></tr><tr><td>meldescheine\[\].personen\[\].gast\_type</td><td>string</td><td>Gast-Art (`<span class="n">person</span>`, `<span class="n">gruppe</span>` )</td></tr><tr><td>meldescheine\[\].personen\[\].arrival\_date</td><td>date</td><td>Anreisedatum des Gasts</td></tr><tr><td>meldescheine\[\].personen\[\].departure\_date</td><td>date</td><td>Abreisedatum des Gasts</td></tr></tbody></table>

</div></div>#### Einzel-Person

<div id="bkmrk-name-datentyp-verwen-1"><div><table><thead><tr><th>Name</th><th>Datentyp</th><th>Verwendung</th></tr></thead><tbody><tr><td>meldescheine\[\].personen\[\].\*</td><td>string</td><td>Weitere definierte Felder. (nach Definition)</td></tr></tbody></table>

</div></div><p class="callout info">Die Definition der Felder hängt von der Gemeinde ab und können über den Aufruf [`<span class="o">/</span><span class="n">get_current_user</span>`](https://wiki.meldescheine.de/books/api/page/konfiguration-abrufen "Konfiguration abrufen") abgefragt werden.</p>

#### Reisegruppe

<div id="bkmrk-name-datentyp-verwen-2"><div>  
</div><div><table><thead><tr><th>Name</th><th>Datentyp</th><th>Verwendung</th></tr></thead><tbody><tr><td>meldescheine\[\].personen\[\].anzahl</td><td>int</td><td>Anzahl der Gäste</td></tr></tbody></table>

</div></div><div id="bkmrk--0"></div><p class="callout warning">Wenn das Feld meldescheine\[\].personen\[\].anzahl größer 1 ist ,wird der Meldeschein als Gruppenmeldeschein verbucht. Eventuell übergebene Einzelinformationen für den Gast (Vorname,Nachname etc.) werden nicht gespeichert.</p>

### Optionale Parameter (`params`)

<table border="1" id="bkmrk-name-datentyp-beschr" style="border-collapse: collapse; width: 100%; height: 47px;"><tbody><tr style="height: 18px;"><td style="width: 33.3333%; height: 18px;">Name</td><td style="width: 33.3333%; height: 18px;">Datentyp</td><td style="width: 33.3333%; height: 18px;">Beschreibung</td></tr><tr style="height: 29px;"><td style="width: 33.3333%; height: 29px;">append\_pdf</td><td style="width: 33.3333%; height: 29px;">bool</td><td style="width: 33.3333%; height: 29px;">Für bei der Response jedem Meldeschein-Objekt den Parameter "pdf" .</td></tr></tbody></table>

##### `params.append_pdf`

Dieser Schalter ermöglicht es, jedem Meldeschein-Objekt direkt das PDF anzufügen.   
In der Server-Antwort wird das Feld `pdf` angefügt, welches den Base64-kodierten Meldescheine enthält.

<p class="callout danger">Das aktivieren dieses Schalters gilt als Druckvorgang und wird entsprechend protokolliert - siehe Erklärung [hier](https://wiki.meldescheine.de/books/api/page/meldeschein-kurkarte-abrufen-%28pdf%29 "Meldeschein-Kurkarte abrufen (PDF)").</p>

##### Beispiel

```JSON
{
	"meta": {
		"gemeinde": 1,
		"requestId": "123-456-789",
		"idempotent": true,
		"objekt": 2049
	},
	"params": {
		"append_pdf": true
	},
    ....
 }
```

```JSON
{
    "meta": {
        "gemeinde": 1,
        "requestId": "123-456-789",
        "idempotent": true,
        "objekt": 2049,
        "timestamp": "2020-12-18T11:51:41.154820",
        "user": {
            "id": 38,
            "username": "DemoV",
            "alias": "Lisa Mustermann"
        }
    },
    "status": "success",
    "meldescheine": [
        {
            "meldeschein": {
                "id": 28,
             	//....
            },
            "id": 28,
            "pdf": "JVBERi0xLjMKMSAwIG9iago8PAov....." 
        }
    ]
}
```

## Server Antwort

Die Serverantwort gibt im Erfolgsfall ein Array aus `<span class="n">meldeschein</span>` Objekten mit der dem gesamten Meldeschein-Objekt zurück.

<p class="callout warning">Der Anwort-Aufbau entspricht dem aus dem Meldeschein aktuaklisieren [/get](https://wiki.meldescheine.de/books/api/page/meldescheindaten-abrufen "Meldescheindaten abrufen") Aufruf</p>

<p class="callout info">Die Reihenfolge der Personen ist zwischen Anfrage und Antwort immer gleichbleibend. Somit können Sie die die ID's der Personen in Ihrem System für spätere Aktualisierungen mitführen</p>

Response:

<div id="bkmrk-json"><div><label for="__tab_1_0">JSON</label></div></div>```JSON
{
  "meta": {
    "requestId": "5ca0b885-11e3-4abd-9e60-cb8265ea9899",
    "timestamp": "2019-10-24T14:06:10.673840",
    "user": {
      "id": 14,
      "username": "api_demo",
      "first_name": "API",
      "last_name": "Demo",
      "email": "api_demo@apidemo.de",
      "is_active": true,
      "user_type": "beherberger",
      "alias": "API Demo",
      "last_login": "2019-10-24T11:35:18.015947+02:00"
    },
    "gemeinde": 1
  },
  "status": "success",
  "meldescheine": [
    {
      "id": 396,
      //.....
      "personen": [
        {
          "id":3334,
          "tarif_id": 1,

          "Gast_Vorname": "Max",
          "Gast_Name": "Mustermann",
          "arrival_date": "2019-01-01",
          "departure_date": "2019-01-15"
        }
      ]
    }
  ]
}
```

<div id="bkmrk-json-%7B-%22meta%22%3A-%7B-%22re"></div><div id="bkmrk--1"></div><div id="bkmrk--2"></div>## Beispiel-Buchungen

Beispiele für verschiedene Szenarien

### Personen-Meldeschein

Folgende Beispiele zeigen jeweils die Buchung eines Scheins. Da die Rückantwort des Servers ist unabhängig des Typs immer gleich.

Request:

<div id="bkmrk-json-1"><label for="__tab_2_0">JSON</label><div>  
</div></div><div id="bkmrk--3"></div><div id="bkmrk-%7B-%22meta%22%3A-%7B-%22vermiet"><div><table class="codehilitetable"><tbody><tr><td class="code">```json
{
  "meta": {
    "vermieter": 1,
    "gemeinde": 1,
    "objekt": 1
  },
  "meldescheine": [
    {
      "input_id": "test-1",
      "personen": [
        {
          "gast_type": "person",
          "tarif_id": 1,
          "Gast_Vorname": "TEST_BF",
          "arrival_date": "2019-07-14",
          "departure_date": "2019-07-17"
        }
      ]
    }
  ]
}

```

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

</div><label for="__tab_2_1">XML</label></div>### Gruppen-Meldeschein

Request:

<div id="bkmrk-json-0"><label for="__tab_3_0">JSON</label><div>  
</div></div><div id="bkmrk--4"></div><div id="bkmrk-%7B-%22meta%22%3A-%7B-%22vermiet-0"><div><table class="codehilitetable"><tbody><tr><td class="code">```json
{
  "meta": {
    "vermieter": 1,
    "gemeinde": 1,
    "objekt": 1
  },
  "meldescheine": [
    {
      "input_id": "test-1",
      "personen": [
        {
          "gast_type": "gruppe",
          "anzahl": 5,
          "tarif_id": 1,
          "arrival_date": "2019-07-14",
          "departure_date": "2019-07-17"
        }
      ]
    }
  ]
}

```

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

</div><label for="__tab_3_1">XML</label></div>## Code-Beispiele

Folgendes Beispiel authentifiziert die Anfrage und bucht einen Meldeschein

<div id="bkmrk-python-3"><label for="__tab_4_0">Python 3</label><div>  
</div></div><div id="bkmrk--5"></div>```python
# This example uses the "requests" library for HTTP requests (https://requests.readthedocs.io/en/latest/)
# You can install it via 
# $ pip3 install requests
import requests
payload = {
    'username':'api_demo',
    'password':'demodemo',
}

r = requests.post('https://apiv2.meldescheine.de/api/token/',data=payload)
server_response_json = r.json()


jwt_token = server_response_json.get('token') # Aus dem server_response objekt den String-Wert aus "token" extrahieren

# Jetzt buchen
meldeschein_data = {} # Leer für Test
headers = {
 'Authorization':  "JWT %s" % jwt_token
}
r = requests.post("https://apiv2.meldescheine.de/api/import/meldeschein/buchen/",data=meldeschein_data,headers=headers)

```

# Meldescheine aktualisieren

<p class="callout danger">Dokumentation unvollständig. </p>

<span style="color: #222222; font-size: 2.8275em; font-weight: 400;">Allgemein</span>

Dieser Aufruf aktualisiert einen existierenden elektronischen Meldeschein im System.

<p class="callout warning">Es kann pro Aufruf immer nur ein (1) Meldeschein aktualisiert werden.  
Wenn im unten erläuterten Array mehrere Meldescheine aufgeführt sind, wird der erste Meldeschein (Index:0) aktualisiert.</p>

<p class="callout info">Existierende Meldescheine müssen immer mindestens einen Gast besitzen. Es ist nicht möglich einen Meldeschein zu "leeren", indem alle Gäste gelöscht werden.</p>

## Beschränkungen

Ein Meldeschein kann nur verändert werden, solange sich sein Status in "Entwurf" oder "gedruckt" befindet. Ist ein Meldeschein abgereist, sind keine weiteren Änderungen möglich.

"abgereist" ist wie folgt definiert: Alle Gäste des Meldescheins sind abgereist. Ein automatischer Prozess auf System-Ebene prüft alle aktuellen Meldescheine und Gäste anhand ihres Abreisedatums. Sind alle Gäste abgereist, so erhält der Meldeschein den Status "abgereist". Der Meldeschein gilt somit für die Gemeinde als "bereit zur Abrechnung."

Änderungen an diesen Meldescheinen können nur über die Gemeinde angefordert werden.

## Parameter

```
POST import/meldeschein/aktualisieren/
```

<div id="bkmrk-name-datentyp-verwen"><div><table><thead><tr><th>Name</th><th>Datentyp</th><th>Verwendung</th></tr></thead><tbody><tr><td>meta</td><td>object</td><td>[Meta-Objekt](https://wiki.meldescheine.de/books/api/page/meta-objekt "Meta Objekt")</td></tr><tr><td>meldescheine</td><td>array</td><td>Array mit Meldescheindaten</td></tr><tr><td>meldescheine\[\]</td><td>object</td><td>Die zu buchenden Daten des Meldescheins</td></tr><tr><td>meldescheine\[\].personen</td><td>array</td><td>Auflistung aller Gäste</td></tr></tbody></table>

</div></div><p class="callout info">Der Aufbau der Anfrage entspricht exakt des Aufrufs "[buchen](https://wiki.meldescheine.de/books/api/page/meldescheine-buchen "Meldescheine buchen")" mit dem Unterschied, dass im Meldeschein-Objekt die ID aus dem Aufruf "buchen" mit übergeben werden muss, um den zu aktualisierenden Meldeschein eindeutig zu identifizieren.</p>

<p class="callout info">Zum aktualisieren von Gästen muss das Feld "id" mit übergeben werden</p>

## Server Antwort

Die "aktualisieren" Antwort enthält den aktualisieren Meldeschein als vollständiges Objekt. Die Antwort ist unabhängig der ausgeführten Aktion immer im gleichen Format und spiegelt den aktuellen Status des Meldescheins im System wider.

<p class="callout info">Da nur derzeit ein Meldeschein aktualisiert werden kann, befindet sich der aktualisierten Meldeschein im Objekt `response.meldescheine[0]`</p>

<p class="callout warning">Die Antwort gibt den aktuellen Status des Meldescheins im System zurück - hier können Sie ggfls. prüfen, ob Änderungen erfolgreich übernommen wurden.</p>

```json
{
    "meta": {
        "requestId": "afc8673a-2a4c-11eb-b5a3-c04a00212a69",
        "timestamp": "2020-11-19T10:50:41.996029",
        "user": {
            "id": 38,
            "username": "DemoV",
            "alias": "Lisa Mustermann"
        },
        "gemeinde": 1
    },
    "status": "success",
    "response": {
        "meldescheine": [
            {
                "id": 688,
                "personen": [
                    {
                        "id": 2015,
                        "tarif_id": 1,
                        "meldeschein_id": 688,
                        "gast_type": "person",
                        "created": "2020-11-19T10:48:47.228504+01:00",
                        "modified": "2020-11-19T10:50:42.311202+01:00",
                        "anzahl": 1,
                        "arrival_date": "2019-07-14",
                        "departure_date": "2019-07-17",
                        "CSID": "6b59af3c-2a4c-11eb-aa07-c04a00212a69-WLclSDowcn",
                        "kurtaxe_calc": 6.0,
                        "Gast_Vorname": "aktualisiert?",
                        "Gast_Name": null,
                        "Gast_Geburtsdatum": null,
                        "Gast_Strasse": null,
                        "Gast_Postleitzahl": null,
                        "Gast_Wohnort": null,
                        "Gast_Land": null,
                        "Gast_Email": null,
                        "Gast_Ausweisnummer": null,
                        "Gast_Staatsangehoerigkeit": null,
                        "address_id": null,
                        "address_lat": null,
                        "address_lng": null,
                        "address_label": null
                    },
                    {
                        "id": 2016,
                        "tarif_id": 1,
                        "meldeschein_id": 688,
                        "gast_type": "person",
                        "created": "2020-11-19T10:48:47.571441+01:00",
                        "modified": null,
                        "anzahl": 1,
                        "arrival_date": "2019-07-14",
                        "departure_date": "2019-07-17",
                        "CSID": "6b59af3c-2a4c-11eb-aa07-c04a00212a69-WLclSDowcn",
                        "kurtaxe_calc": 6.0,
                        "Gast_Vorname": "TEST_BF_2",
                        "Gast_Name": null,
                        "Gast_Geburtsdatum": null,
                        "Gast_Strasse": null,
                        "Gast_Postleitzahl": null,
                        "Gast_Wohnort": null,
                        "Gast_Land": null,
                        "Gast_Email": null,
                        "Gast_Ausweisnummer": null,
                        "Gast_Staatsangehoerigkeit": null,
                        "address_id": null,
                        "address_lat": null,
                        "address_lng": null,
                        "address_label": null
                    },
                    {
                        "id": 2017,
                        "tarif_id": 1,
                        "meldeschein_id": 688,
                        "gast_type": "person",
                        "created": "2020-11-19T10:48:47.611475+01:00",
                        "modified": null,
                        "anzahl": 1,
                        "arrival_date": "2019-07-14",
                        "departure_date": "2019-07-17",
                        "CSID": "6b59af3c-2a4c-11eb-aa07-c04a00212a69-WLclSDowcn",
                        "kurtaxe_calc": 6.0,
                        "Gast_Vorname": "TEST_BF_3",
                        "Gast_Name": null,
                        "Gast_Geburtsdatum": null,
                        "Gast_Strasse": null,
                        "Gast_Postleitzahl": null,
                        "Gast_Wohnort": null,
                        "Gast_Land": null,
                        "Gast_Email": null,
                        "Gast_Ausweisnummer": null,
                        "Gast_Staatsangehoerigkeit": null,
                        "address_id": null,
                        "address_lat": null,
                        "address_lng": null,
                        "address_label": null
                    },
                    {
                        "id": 2018,
                        "tarif_id": 1,
                        "meldeschein_id": 688,
                        "gast_type": "person",
                        "created": "2020-11-19T10:48:47.655957+01:00",
                        "modified": null,
                        "anzahl": 1,
                        "arrival_date": "2019-07-14",
                        "departure_date": "2019-07-17",
                        "CSID": "6b59af3c-2a4c-11eb-aa07-c04a00212a69-WLclSDowcn",
                        "kurtaxe_calc": 6.0,
                        "Gast_Vorname": "TEST_BF_4",
                        "Gast_Name": null,
                        "Gast_Geburtsdatum": null,
                        "Gast_Strasse": null,
                        "Gast_Postleitzahl": null,
                        "Gast_Wohnort": null,
                        "Gast_Land": null,
                        "Gast_Email": null,
                        "Gast_Ausweisnummer": null,
                        "Gast_Staatsangehoerigkeit": null,
                        "address_id": null,
                        "address_lat": null,
                        "address_lng": null,
                        "address_label": null
                    }
                ],
                "travel_span": {
                    "arrival_date": "2019-07-14T00:00:00",
                    "departure_date": "2019-07-17T00:00:00",
                    "travel_days": 3,
                    "uebernachtungen_sum": 12
                },
                "objekt": {
                    "id": 2049,
                    "beherberger_id": 13455,
                    "beherberger": {
                        "firma": "Ferienhof Müller",
                        "vorname": "Melissa",
                        "nachname": "Müller",
                        "comment": "<br>",
                        "debitor_nr": "08154711",
                        "alias": "Ferienhof Müller (08154711)",
                        "id": 13455,
                        "ansprechpartner": 37,
                        "gemeinde_id": 1
                    },
                    "beherberger_alias": "Ferienhof Müller (08154711)",
                    "ortsteil": {
                        "id": 1,
                        "alias": "Standard",
                        "gemeinde": 1
                    },
                    "created": "2020-03-30T08:34:03.052153+02:00",
                    "modified": "2020-07-21T13:16:53.520759+02:00",
                    "anzahl_betten": 4,
                    "alias": "Haus Sonne",
                    "strasse": "Edgar-Anstett-Straße 4",
                    "plz": "66978",
                    "ort": "Merzalben",
                    "tarifzone": 1,
                    "unterkunftsart": 1
                },
                "meldescheinnummer": "688",
                "objekt_id": 2049,
                "beherberger_id": 13455,
                "verwendete_kurtaxe": 24.0,
                "creation_user": {
                    "id": 38,
                    "username": "DemoV",
                    "alias": "Lisa Mustermann"
                },
                "precheck_errors": [],
                "state_display": "Entwurf",
                "faktura_date": null,
                "CSID": "6b59af3c-2a4c-11eb-aa07-c04a00212a69-WLclSDowcn",
                "Form_Id": null,
                "BatchNo": null,
                "BatchRDate": "2020-11-19",
                "BatchPgDta": null,
                "BatchTrack": null,
                "ms_type": "ems",
                "state": "draft",
                "created": "2020-11-19T00:00:00+01:00",
                "modified": null,
                "user_note": null,
                "is_storniert": false,
                "source": null,
                "storno_bestaetigt": false,
                "kurtaxe_ist": null,
                "manueller_betrag": 0.0,
                "kz_manueller_betrag": false,
                "kurtaxe_calc": 24.0,
                "stat_alter_kind_1": null,
                "stat_alter_kind_2": null,
                "stat_alter_kind_3": null,
                "stat_alter_kind_4": null,
                "invoice": null
            }
        ]
    }
}
```

### Anlegen von zusätzlichen Gästen

Um dem Meldeschein weitere Gäste hinzuzufügen, können diese ohne Angabe des Feldes "id" in das "personen" Array mit übergeben werden.

<p class="callout info">Für das anlegen von zusätzlichen Gästen gelten die Regeln wie beim anlegen eines Meldescheins. Die Felder "tarif\_id" , "arrival\_date" sowie "departure\_date" sind zwingend notwendig. Zusätzliche Felder analog zum buchen Aufruf und der eingerichteten Gemeinde.</p>

Beispiel-Request: Anlegen eines zusätzlichen Gastes:

"Max Mustermann"  
Tarif-ID "1" (Erwachsener)  
Reisezeitraum: 15.10.2020 - 16.10.2020   
in Meldeschein 650

```json
{
  "meta":  {
    "objekt":2080,
    "gemeinde":1,
		"requestId":"TEST"
  },
  "meldescheine": [
    {
			"id": 650,
			"personen":[
				{
					"arrival_date": "2020-10-15",
					"departure_date":"2020-10-16",
					"tarif_id":1,
					"Gast_Vorname":"Max",
					"Gast_Name":"Mustermann"
				}
			]
		}
  ]
}
```

### Aktualisieren von vorhandenen Gästen 

Um Gäste zu aktualisieren, da sich z.B. Reisedaten geändert haben ist es notwendig, die "id" des Gastes mit zu übergeben.  
Diese kann z.B. über den "[get-data](https://wiki.meldescheine.de/books/api/page/meldescheindaten-abrufen "Meldescheindaten abrufen")" Aufruf abgerufen werden oder kann beim buchen der Meldescheine sofort gespeichert werden.

Beispiel: Ändern des im vorherigen Beispiel "Anlegen von zusätzlichen Gästen" erzeugten Gastes "Max Mustermann":.

In diesem Fall wird der Reisezeitraum geändert: 16.10.2020 bis 19.10.2020 sowie der Nachname des Gastes.

<p class="callout warning">Es werden nur Felder aktualisiert, die übergeben werden und im System vorhanden sind. Achten Sie daher bitte darauf, nur die notwendigen Felder zu übergeben und achten Sie auf korrekte Feldbezeichnungen </p>

<p class="callout info">**Zu beachten die ID "1945" des Gastes im unteren Beispiel.**  
- Wird die ID angegeben: Gast aktualisieren  
- Keine Angabe der ID: Gast anlegen</p>

```json
{
  "meta":  {
    "objekt":2080,
    "gemeinde":1,
		"requestId":"TEST"
  },
  "meldescheine": [
    {
			"id": 650,
			"personen":[
				{
					"id":1945, //<------------------- ID des Gastes (z.B. über /get-data abgerufen
					"arrival_date": "2020-10-16",
					"departure_date":"2020-10-18",
					"tarif_id":1,
					"Gast_Vorname":"Max",
					"Gast_Name":"Mustermann (verändert)"
				}
			]
		}
  ]
}
```

### Löschen von vorhandenen Gästen

<p class="callout danger">**Hinweis zum aktualisieren von Gästen:**  
Bitte verwenden Sie immer den Ablauf "aktualisieren" um Gäste zu verändern. Bitte löschen Sie nicht alle Gäste und legen diese neu an.   
Dies ist technisch in einem kombinierten Aufruf (s.u.) zwar möglich - jedoch erschwert dies die Nachvollziehbarkeit auf System-Ebene, da zu jedem Gast eine Historie angelegt wird.</p>

Gäste können gelöscht werden, in dem diese mit ihrer ID sowie dem Feld "delete:true" übergeben werden.

Beispiel-Request: Löschen des Gastes mit id `1937` aus Meldeschein mit ID `651`

```json
{
  "meta":  {
    "objekt":2080,
    "gemeinde":1,
		"requestId":"TEST"
  },
  "meldescheine": [
    {
			"id": 651,
			"personen":[
				{
					"id": 1937,
					"delete":true  //<------ Gibt an, dass der Gast beim Aufruf gelöscht werden soll
				}
			]
		}
  ]
}
```

<p class="callout warning">Wenn Sie versuchen einen Gast zu löschen, der nicht dem Schein zugeordnet ist, erhalten Sie eine entsprechende Fehlermeldung</p>

### Verschiedene Gast-Aktionen in einem Aufruf

Es ist möglich die oben beschriebenen Aktionen in einem Aufruf zu kombinieren:

Beispiel:

Eine Kombination aus den og. Beispielen

- Gast `1945` aktualisieren
- Gast `1937` löschen
- Einen neuen Gast anlegen

```json
{
  "meta":  {
    "objekt":2080,
    "gemeinde":1,
		"requestId":"TEST"
  },
  "meldescheine": [
    {
			"id": 650,
			"personen":[
				{
					"id":1945,
					"arrival_date": "2020-10-16",
					"departure_date":"2020-10-18",
					"tarif_id":1,
					"Gast_Vorname":"Max",
					"Gast_Name":"Mustermann (verändert)"
				},
					{
					"id": 1937,
					"delete":true 
				},
				{
					"arrival_date": "2020-10-15",
					"departure_date":"2020-10-16",
					"tarif_id":1,
					"Gast_Vorname":"Max",
					"Gast_Name":"Mustermann"
				}
				
			]
		}
  ]
}
```

# Meldescheindaten abrufen

Dieser Aufruf frägt alle hinterlegten Daten eines oder mehrerer Meldescheine ab.

<div id="bkmrk-"></div><table class="codehilitetable" id="bkmrk-get-meldeschein%2Fget%2F" style="width: 887px;"><tbody><tr><td class="code" style="width: 887px;"><div>```
 POST  import/meldeschein/get/
```

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

## Parameter

<div id="bkmrk-name-datentyp-verwen"><div><table><thead><tr><th>Name</th><th>Datentyp</th><th>Verwendung</th></tr></thead><tbody><tr><td>meta</td><td>Objekt</td><td>[Meta-Objekt](https://wiki.meldescheine.de/books/api/page/meta-objekt "Meta Objekt")</td></tr><tr><td>meldescheine</td><td>Array</td><td>Array mit Meldeschein-IDs</td></tr></tbody></table>

</div></div>## Beispiele

Folgendes Beispiel ruft die Daten von zwei Meldescheinen ab.

##### Request

<div id="bkmrk-json-%7B-%22meta%22%3A-%7B-%2F%2F."><label for="__tab_1_0">JSON</label>```json
{<br></br>  "meta": {<br></br>  	//....<br></br>  },<br></br>  "meldescheine": [<br></br>    123,<br></br>    456<br></br>  ]<br></br>}
```

</div><div id="bkmrk--0">  
  
</div>##### Response

<div id="bkmrk-json"><label for="__tab_2_0">JSON</label><div></div></div><div id="bkmrk--1"></div><div id="bkmrk-%7B-%22meta%22%3A-%7B-%22request"><table class="codehilitetable"><tbody><tr><td class="code"><div>```
<span class="p">{</span>
  <span class="nt">"meta"</span><span class="p">:</span> <span class="p">{</span>
    <span class="nt">"requestId"</span><span class="p">:</span> <span class="s2">"0324b440-c0ec-4828-a13c-5b1b81797d78"</span><span class="p">,</span>
    <span class="nt">"timestamp"</span><span class="p">:</span> <span class="s2">"2019-06-13T11:55:26.039028"</span><span class="p">,</span>
    <span class="nt">"user"</span><span class="p">:</span> <span class="p">{</span>
      <span class="nt">"id"</span><span class="p">:</span> <span class="mi">6</span><span class="p">,</span>
      <span class="nt">"username"</span><span class="p">:</span> <span class="s2">"demo_hotel"</span>
    <span class="p">},</span>
    <span class="nt">"gemeinde"</span><span class="p">:</span> <span class="mi">1</span>
  <span class="p">},</span>
  <span class="nt">"response"</span><span class="p">:</span> <span class="p">[</span>
    <span class="p">{<br></br></span>      "id":123,
      <span class="nt">"personen"</span><span class="p">:</span> <span class="p">[</span>
        <span class="p">{</span>
          <span class="nt">"tarif_id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
          <span class="nt">"Gast_Vorname"</span><span class="p">:</span> <span class="s2">"Max"</span><span class="p">,</span>
          <span class="nt">"Gast_Name"</span><span class="p">:</span> <span class="s2">"Mustermann"</span><span class="p">,</span>
          <span class="nt">"arrival_date"</span><span class="p">:</span> <span class="s2">"2019-01-01"</span><span class="p">,</span>
          <span class="nt">"departure_date"</span><span class="p">:</span> <span class="s2">"2019-01-15"</span>
        <span class="p">}</span>
      <span class="p">]</span>
    <span class="p">},</span>
    <span class="p">{</span>
      <span class="nt">"id"</span><span class="p">:</span> <span class="s2">"456"</span><span class="p">,</span>
      <span class="nt">"personen"</span><span class="p">:</span> <span class="p">[</span>
        <span class="p">{</span>
          <span class="nt">"tarif_id"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
          <span class="nt">"anzahl"</span><span class="p">:</span> <span class="mi">12</span>
        <span class="p">}</span>
       //...<br></br><span class="p">]</span>
    <span class="p">}</span>
  <span class="p">]</span>
<span class="p">}</span>
```

</div></td></tr><tr><td><div><span class="p"> </span></div></td></tr></tbody></table>

</div><label for="__tab_2_1"></label>

# Meldeschein-Kurkarte abrufen (PDF)

Gibt die Kurkarten der angefragten Meldescheine als base64 kodiertes PDF zurück. Die Kurkarte ist druckfertig und muss i.d.R. nur noch als PDF-Datei ausgegeben und gedruckt werden.

<p class="callout warning">**Vermeiden Sie mehrfache Aufrufe der Schnittstelle**:  
Jede Anfrage "get-pdf" wird als Druckvorgang gewertet und entsprechend protokolliert.   
  
Sie gilt somit als physikalischer Druck einer Kurkarte. Achten Sie daher bitte darauf, die Anfrage nur auszuführen, wenn ein Druck der Gästekarte umgehend folgt.   
  
Sollte die PDF-Kurkarte mehrfach benötigt werden, speichern Sie bitte das PDF auf Ihrem System für eventuelle Verwendung ab.</p>

## Parameter

<table class="codehilitetable" id="bkmrk-get-import%2Fmeldesche"><tbody><tr><td class="code"><div>```
POST import/meldeschein/get-pdf/
```

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

<div id="bkmrk-name-datentyp-verwen"><div><div><table><thead><tr><th>Name</th><th>Datentyp</th><th>Verwendung</th></tr></thead><tbody><tr><td>meta</td><td>object</td><td>[Meta-Objekt](https://wiki.meldescheine.de/books/api/page/meta-objekt "Meta Objekt")</td></tr><tr><td>meldescheine</td><td>array</td><td>Array mit Meldeschein-IDs</td></tr></tbody></table>

</div></div></div>## Request

Folgendes Beispiel ruft die Daten von zwei Meldescheinen ab.

Request:

<div id="bkmrk-json-%7B-%22meta%22%3A-%7B-%22ob"><label for="__tab_3_0">JSON</label>```json
{<br></br>  "meta":  {<br></br>    "objekt": 2049,<br></br>    "gemeinde": 1<br></br>  },<br></br>  "meldescheine": [<br></br>    553<br></br>  ]<br></br>}
```

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

<div id="bkmrk-json"><label for="__tab_4_0">JSON</label></div><div id="bkmrk-%7B-%22meta%22%3A-%7B-%22request">```json
{
    "meta": {
        "requestId": "66f81f62-0942-11eb-bd68-c04a00212a69",
        "timestamp": "2020-10-08T10:43:56.496102",
        "user": {
            "id": 38,
            "username": "DemoV",
            "alias": "Lisa Mustermann"
        },
        "gemeinde": 1
    },
    "response": [
        {
            "id": 553,
            "encoding": "base64",
            "pdf": "JVBERi0xLjMKMSAwIG9iaHMgWyAzIDAg....<abgeschnitten>"
        }
    ]
}
```

</div>## PDF dekodieren und speichern

Die Rückgabe des Servers enthält die PDF-Daten als `<span class="n">base64</span>` kodierte `<span class="n">string</span>`-Werte in der Response. Der'Wert ist jeweil ins `<span class="n">response</span><span class="p">[].</span><span class="n">pdf</span>` zu finden.

<div id="bkmrk-die-%C3%BCbliche-vorgehen">Die übliche Vorgehensweise ist es, den base64 kodierten Wert als PDF-Datei zu speichern und diese dann zur weiteren Verwendung zu geben (z.B. Ausdruck Kurkarte).</div><div id="bkmrk--0"></div><div id="bkmrk-m%C3%B6glichkeiten-base64">Möglichkeiten Base64 Zeicheketten als Binärdateien zu speichern bieten sich in vielen Programmiersprachen.</div>### Code-Beispiele

<div id="bkmrk-python-3"><label for="__tab_2_0">Python 3</label><div></div></div>```python
import base64

# ....
# Die variable Antwort des Servers ist hier in der variable "r" zu finden

for ms in r['response']:

  base64_string = ms.get('pdf')
  filename =  './Beispiel-Meldeschein-%s.pdf' % ms.get('id') # Datei als "Beispiel-Meldeschein-<id>.pdf" speichern
  fh = open(filename,'wb')   #lokale Datei im binären Modus zum schreiben öffnen / erstellen.

  decoded = base64.decodebytes(base64_string) # Base64 String binär dekodieren
  fh.write(decoded) #  dekodierte Daten in Datei schreiben
  fh.close() # Datei schliessen
  # Die Datei <filename> kann nun gedruckt werden
```

<div id="bkmrk--1"></div>

# Konfiguration abrufen

<table class="codehilitetable" id="bkmrk-get-get-config%2F" style="width: 726px;"><tbody><tr><td class="code" style="width: 726px;"><div>```
<span class="k">GET</span>  users<span class="o">/get_current_user</span>
```

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

Dieser Aufruf frägt alle Informationen zum aktuellen Benutzer und damit verknüpften Gemeinden sowie Beherbergern.

Dies ermöglicht es, in der Drittsoftware definierte Tarife, Meldeschein-Felder sowie weitere Informationen abzurufen und bereitzustellen.

## Parameter

Keine Parameter notwendig

## Aufbau Antwort

### Allgemein

<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>user.\*</td><td>object</td><td>Informationen zum aktuell angemeldeten Benutzer (über Token)</td></tr><tr><td>beherberger</td><td>array</td><td>Dem Account zugeordnete Vermieter</td></tr><tr><td>beherberger\[\].\*</td><td>object</td><td>Sämtliche Informationen zum Vermieter</td></tr><tr><td>beherberger\[\].objekte</td><td>object</td><td>Alle Objekte des Vermieters, welche dem Account zugeordnet sind</td></tr><tr><td>gemeinden</td><td>array</td><td>Alle dem Account zugeordneten Gemeinden (i.d.R. eine)</td></tr><tr><td>gemeinden\[\].ortsteile</td><td>array</td><td>Alle definierten Ortsteile der Gemeinde</td></tr><tr><td>gemeinden\[\].tarifzonen</td><td>array</td><td>Alle definierten Tarifzonen der Gemeinde</td></tr><tr><td>gemeinden\[\].saisonzeiten</td><td>array</td><td>Alle definierten Saisonzeiten der Gemeinde</td></tr><tr><td>gemeinden\[\].meldeschein\_fields</td><td>array</td><td>Alle definierten Felder des Elektronischen Meldescheins</td></tr></tbody></table>

</div></div>### Meldeschein-Felder

Die definierten Gast/Meldescheinfelder sind unter folgendem Pfad zu finden:

`<span class="n">gemeinden</span><span class="o">[</span><span class="n">GEMEINDE_ID</span><span class="o">]</span><span class="p">.</span><span class="n">meldeschein_fields</span>`, wobei `<span class="n">GEMEINDE_ID</span>` der jeweiligen Gemeinde entspricht

Relevante Felder:

<div id="bkmrk-feld-datentyp-erkl%C3%A4r-0"><div><table><thead><tr><th>Feld</th><th>Datentyp</th><th>Erklärung</th></tr></thead><tbody><tr><td>alias</td><td>string</td><td>Klartextbezeichnung</td></tr><tr><td>column\_name</td><td>string</td><td>Der Wert der Datenbankspalte, dieser Wert wird bei der Übergabe in `<span class="o">/</span><span class="n">buchen</span>` benötigt</td></tr><tr><td>data\_type</td><td>string</td><td>Datentyp des Felds</td></tr><tr><td>required</td><td>boolean</td><td>Wird der Wert bei der Buchung eines Meldescheins benötigt?</td></tr></tbody></table>

</div></div>Hinweis

Alle Felder mit `<span class="n">required</span> <span class="o">=</span> <span class="k">true</span>` müssen bei der Buchung eines Meldescheins übergeben werden

### Definierte Tarife, Saisonzeiten, Tarifzonen

Die definierten Tarife, Saisonzeiten und Tarifzonen folgen dem gleichen Aufbau

Tarife: `<span class="n">gemeinden</span><span class="o">[</span><span class="n">GEMEINDE_ID</span><span class="o">]</span><span class="p">.</span><span class="n">tarife</span>`, wobei `<span class="n">GEMEINDE_ID</span>` der jeweiligen Gemeinde entspricht Saisonzeiten: `<span class="n">gemeinden</span><span class="o">[</span><span class="n">GEMEINDE_ID</span><span class="o">]</span><span class="p">.</span><span class="n">saisonzeiten</span>`, wobei `<span class="n">GEMEINDE_ID</span>` der jeweiligen Gemeinde entspricht Tarifzonen: `<span class="n">gemeinden</span><span class="o">[</span><span class="n">GEMEINDE_ID</span><span class="o">]</span><span class="p">.</span><span class="n">tarifzonen</span>`, wobei `<span class="n">GEMEINDE_ID</span>` der jeweiligen Gemeinde entspricht

## Beispiele

Folgendes Beispiel ruft die gesamte Konfiguration für einen Demo-Mandanten ab.

Response:

<div id="bkmrk-json"><label for="__tab_1_0">JSON</label><div></div></div><div id="bkmrk-"></div>```json
{
  "user": {
    "id": 14,
    "username": "api_demo",
    "first_name": "API",
    "last_name": "Demo",
    "email": "api_demo@apidemo.de",
    "is_active": true,
    "user_type": "beherberger",
    "alias": "API Demo",
    "last_login": "2019-10-24T11:35:18.015947+02:00"
  },
  "beherberger": [
    {
      "id": 9,
      "objekte": [
        {
          "id": 9,
          "tarifzone_id": 1,
          "ortsteil_id": 1,
          "beherberger_id": 9,
          "tarifzone": {
            "id": 1,
            "created": "2019-08-21T15:41:56.239951+02:00",
            "modified": "2019-08-21T15:41:56.240018+02:00",
            "alias": "Hauptzone",
            "gemeinde": 1
          },
          "ortsteil": {
            "id": 1,
            "created": "2019-08-21T15:42:02.596680+02:00",
            "modified": "2019-08-21T15:42:02.596757+02:00",
            "alias": "Fehmarn",
            "gemeinde": 1
          },
          "beherberger": {
            "firma": "DEMO",
            "vorname": "Max",
            "nachname": "Mustermann",
            "comment": "",
            "debitor_nr": null,
            "alias": "DEMO"
          },
          "created": "2019-09-04T09:51:53.201523+02:00",
          "modified": "2019-09-04T09:51:53.201585+02:00",
          "anzahl_betten": 1,
          "alias": "API-Objekt",
          "strasse": "API-Strasse",
          "plz": "86707",
          "ort": "Westendorf"
        }
      ],
      "alias": "DEMO",
      "created": "2019-09-04T09:49:52.052348+02:00",
      "modified": "2019-09-04T09:56:22.192552+02:00",
      "is_active": true,
      "firma": "DEMO",
      "anrede": "Herr",
      "vorname": "DEMO",
      "nachname": "DEMO",
      "strasse": "DEMO",
      "plz": "123456",
      "ort": "DEMO",
      "telefon": "12345",
      "email": "demo@demo.de",
      "allow_logins": true,
      "create_invoices": true,
      "custom_1": null,
      "custom_2": null,
      "custom_3": null,
      "custom_4": null,
      "debitor_nr": null,
      "vermieter_nr": "API-TEST",
      "comment": "",
      "gemeinde": 1
    }
  ],
  "gemeinden": [
    {
      "id": 1,
      "ortsteile": [
        {
          "id": 1,
          "created": "2019-08-21T15:42:02.596680+02:00",
          "modified": "2019-08-21T15:42:02.596757+02:00",
          "alias": "Hauptbereich",
          "gemeinde": 1
        }
      ],
      "tarifzonen": [
        {
          "id": 1,
          "created": "2019-08-21T15:41:56.239951+02:00",
          "modified": "2019-08-21T15:41:56.240018+02:00",
          "alias": "Hauptzone",
          "gemeinde": 1
        }
      ],
      "saisonzeiten": [
        {
          "id": 1,
          "created": "2019-08-21T15:44:42.087596+02:00",
          "modified": "2019-08-21T15:44:42.087663+02:00",
          "alias": "Hauptsaison 2019",
          "valid_from": "2019-05-15",
          "valid_until": "2019-09-14",
          "gemeinde": 1
        },
        {
          "id": 2,
          "created": "2019-08-22T10:11:18.114641+02:00",
          "modified": "2019-08-22T10:11:18.114702+02:00",
          "alias": "Nebensaison 1",
          "valid_from": "2019-01-01",
          "valid_until": "2019-05-14",
          "gemeinde": 1
        },
        {
          "id": 3,
          "created": "2019-08-22T10:12:05.322441+02:00",
          "modified": "2019-08-22T10:12:05.322534+02:00",
          "alias": "Nebensaison 2",
          "valid_from": "2019-09-15",
          "valid_until": "2019-12-31",
          "gemeinde": 1
        }
      ],
      "tarife": [
        {
          "id": 2,
          "full_alias": "Behinderung 80% (SB 80 %)",
          "created": "2019-08-22T10:16:22.572120+02:00",
          "modified": "2019-08-22T10:16:22.572201+02:00",
          "is_active": true,
          "tarif_code": "SB 80 %",
          "alias": "Behinderung 80%",
          "allow_beherberger": true,
          "print_kurkarte": true,
          "default_selected": false,
          "gemeinde": 1
        },
        {
          "id": 3,
          "full_alias": "Behinderung Begleitung (SBB 80 %)",
          "created": "2019-08-22T10:16:58.052509+02:00",
          "modified": "2019-08-22T10:16:58.052578+02:00",
          "is_active": true,
          "tarif_code": "SBB 80 %",
          "alias": "Behinderung Begleitung",
          "allow_beherberger": true,
          "print_kurkarte": true,
          "default_selected": false,
          "gemeinde": 1
        },
        {
          "id": 7,
          "full_alias": "Beruflich Anwesende (BA)",
          "created": "2019-08-22T10:21:39.062066+02:00",
          "modified": "2019-08-22T10:21:39.062138+02:00",
          "is_active": true,
          "tarif_code": "BA",
          "alias": "Beruflich Anwesende",
          "allow_beherberger": true,
          "print_kurkarte": true,
          "default_selected": false,
          "gemeinde": 1
        },
        {
          "id": 1,
          "full_alias": "Erwachsener (EW)",
          "created": "2019-08-21T15:43:26.469087+02:00",
          "modified": "2019-09-05T14:54:45.644304+02:00",
          "is_active": true,
          "tarif_code": "EW",
          "alias": "Erwachsener",
          "allow_beherberger": true,
          "print_kurkarte": true,
          "default_selected": true,
          "gemeinde": 1
        },
        {
          "id": 5,
          "full_alias": "Gruppen ab 25 Personen (GG)",
          "created": "2019-08-22T10:17:47.179287+02:00",
          "modified": "2019-08-22T10:17:47.179348+02:00",
          "is_active": true,
          "tarif_code": "GG",
          "alias": "Gruppen ab 25 Personen",
          "allow_beherberger": true,
          "print_kurkarte": true,
          "default_selected": false,
          "gemeinde": 1
        },
        {
          "id": 4,
          "full_alias": "Gruppen unter 25 Personen (GK)",
          "created": "2019-08-22T10:17:30.252887+02:00",
          "modified": "2019-08-22T10:17:30.252952+02:00",
          "is_active": true,
          "tarif_code": "GK",
          "alias": "Gruppen unter 25 Personen",
          "allow_beherberger": true,
          "print_kurkarte": true,
          "default_selected": false,
          "gemeinde": 1
        },
        {
          "id": 8,
          "full_alias": "keine Kategorie (kK)",
          "created": "2019-08-22T10:22:02.186252+02:00",
          "modified": "2019-08-22T10:22:02.186552+02:00",
          "is_active": true,
          "tarif_code": "kK",
          "alias": "keine Kategorie",
          "allow_beherberger": true,
          "print_kurkarte": true,
          "default_selected": false,
          "gemeinde": 1
        },
        {
          "id": 6,
          "full_alias": "Kinder (Kind)",
          "created": "2019-08-22T10:20:33.649448+02:00",
          "modified": "2019-08-22T10:20:33.649504+02:00",
          "is_active": true,
          "tarif_code": "Kind",
          "alias": "Kinder",
          "allow_beherberger": true,
          "print_kurkarte": true,
          "default_selected": false,
          "gemeinde": 1
        }
      ],
      "meldeschein_fields": [
        {
          "id": 2,
          "created": "2019-08-21T15:46:11.393579+02:00",
          "modified": "2019-09-05T14:56:24.456160+02:00",
          "alias": "Nachname",
          "column_name": "Gast_Name",
          "data_type": "text",
          "size": 6,
          "transferable": false,
          "list_visible": true,
          "required": true,
          "priority": "high",
          "view_order": 1,
          "gemeinde": 1
        },
        {
          "id": 1,
          "created": "2019-08-21T15:45:57.452169+02:00",
          "modified": "2019-09-05T14:56:20.478747+02:00",
          "alias": "Vorname",
          "column_name": "Gast_Vorname",
          "data_type": "text",
          "size": 6,
          "transferable": false,
          "list_visible": true,
          "required": false,
          "priority": "high",
          "view_order": 2,
          "gemeinde": 1
        },
        {
          "id": 3,
          "created": "2019-08-22T10:26:05.736723+02:00",
          "modified": "2019-08-22T10:26:05.736825+02:00",
          "alias": "Strasse",
          "column_name": "Gast_Strasse",
          "data_type": "text",
          "size": 12,
          "transferable": false,
          "list_visible": false,
          "required": false,
          "priority": "low",
          "view_order": 3,
          "gemeinde": 1
        },
        {
          "id": 4,
          "created": "2019-08-22T10:26:29.499058+02:00",
          "modified": "2019-08-22T10:26:29.499139+02:00",
          "alias": "PLZ",
          "column_name": "Gast_Postleitzahl",
          "data_type": "text",
          "size": 4,
          "transferable": false,
          "list_visible": false,
          "required": false,
          "priority": "low",
          "view_order": 4,
          "gemeinde": 1
        },
        {
          "id": 5,
          "created": "2019-08-22T10:26:42.577394+02:00",
          "modified": "2019-08-22T10:27:14.479290+02:00",
          "alias": "Ort",
          "column_name": "Gast_Wohnort",
          "data_type": "text",
          "size": 8,
          "transferable": false,
          "list_visible": true,
          "required": false,
          "priority": "low",
          "view_order": 5,
          "gemeinde": 1
        },
        {
          "id": 6,
          "created": "2019-08-26T13:50:23.435905+02:00",
          "modified": "2019-09-05T15:02:12.258999+02:00",
          "alias": "Geburtsdatum",
          "column_name": "Gast_Geburtstag",
          "data_type": "date",
          "size": 4,
          "transferable": false,
          "list_visible": false,
          "required": false,
          "priority": "low",
          "view_order": 6,
          "gemeinde": 1
        }
      ],
      "created": "2019-08-21T15:00:59.512049+02:00",
      "modified": "2019-08-21T15:36:50.593090+02:00",
      "alias": "Fehmarn",
      "using_paper": true,
      "using_ems": true,
      "datatable_name": "dat_99999"
    }
  ],
  "created": "2019-09-04T09:52:03.825645+02:00",
  "modified": "2019-09-04T09:52:03.825762+02:00",
  "permissions": [
    "authentication.add_vermieteraccount",
    "authentication.change_vermieteraccount",
    "authentication.delete_vermieteraccount",
    "authentication.view_vermieteraccount",
    "common.view_beherberger",
    "common.view_objekt"
  ]
}

```

# Meldescheine stornieren

Dieser Aufruf setzt den Status der übergebenen Meldescheine auf "storniert".

<p class="callout info">Stornierte Meldescheine sind nicht länger veränderbar.</p>

<div id="bkmrk-"></div><table class="codehilitetable" id="bkmrk-get-meldeschein%2Fget%2F" style="width: 887px;"><tbody><tr><td class="code" style="width: 887px;"><div>```
 POST  import/meldeschein/stornieren/
```

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

## Parameter

<div id="bkmrk-name-datentyp-verwen"><div><table><thead><tr><th>Name</th><th>Datentyp</th><th>Verwendung</th></tr></thead><tbody><tr><td>meta</td><td>Objekt</td><td>[Meta-Objekt](https://wiki.meldescheine.de/books/api/page/meta-objekt "Meta Objekt")</td></tr><tr><td>meldescheine</td><td>Array</td><td>Array mit Meldeschein-IDs</td></tr></tbody></table>

</div></div>## Beispiele

Folgendes Beispiel storniert zwei Meldescheine

##### Request

<div id="bkmrk--0"></div>```json
{
	"meta": {
		"gemeinde": 1,
		"objekt": 2049
	},
	"meldescheine": [
		347,348
	]
}
```

<div id="bkmrk--1"></div>##### Response

<div id="bkmrk-json"><label for="__tab_2_0">JSON</label><div></div></div>```JSON
{
    "meta": {
        "gemeinde": 1,
        "objekt": 2049,
        "requestId": "5546961c-8d5a-11eb-b450-c04a00212a69",
        "timestamp": "2021-03-25T12:07:48.219553",
        "user": {
            "id": 2,
            "username": "admin",
            "alias": "Administrator"
        }
    },
    "status": "success",
    "meldescheine": [
        347,348
    ]
}
```

<div id="bkmrk--2"></div><div id="bkmrk--3"></div><div id="bkmrk-%C2%A0">  
<label for="__tab_2_1"></label></div>