Meta Objekt

Zusätzlich zu einem passenden Auth-Token wird eine meta Objekt für alle authentifzierten Anfragen benötigt. Dieses Objekt identifiziert die Abfrage und übergibt einen Kontext für den Aufruf.

So geben gemeinde, vermieter und objekt an, für welche Gemeinde sowie welchen Vermieter und Objekt der Gemeinde der Aufruf verwendet wird.

~~JSON-Schema:~~ /api/meldeschein/schema/meta/

Das Meta Objekt kann nicht alleine übergeben werden. Es gehört immer zu einem weiteren Aufruf (siehe entspr. Kapitel)

Parameter

Feld	Datentyp	benötigt	Beschreibung
gemeinde	int	true	Die ID der zu buchenden Gemeinde
objekt	int	true	Die ID des zu buchenden Vermieters
requestId	string	false	Eine optionale Referenz zur Buchung	Rückgabe: die übergebene Zeichekette, oder falls nicht übergeben, eine zufällig generierte Zeichenkette

Beispiele

Request

JSON

{
   "meta": {
     "objekt": 806,
     "gemeinde": 1,
     "requestId":"abcdefg"  // In der Antwort wird der gleiche Wert wieder in "requestId" enthalten sein
   },
   //weitere Daten
}

XML

<?xml version="1.0" encoding="utf-8"?>
<meta>
    <vermieter>1</vermieter>
    <gemeinde>1</gemeinde>
</meta>
<!-- weitere Daten -->