Advanced Search
Search Results
15 total results found
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 aus...
Formate
Zeichensatz / Kodierung Unabhängig vom Format erfolgt die Übergabe und Rückgabe der Daten immer UTF8 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 konve...
Authentifzierung
Bevor gesicherte Anfragen durchgeführt werden können, ist ein gültiges Authentifizierungs-Merkmal- künftig Token genannt - erforderlich. Die Authentifizierung erfolgt über API Aufruf mit Benutzername sowie Passwort-Schlüssel und gibt im Erfolgsfall ein JWT Tok...
Meldescheine buchen
POST import/meldeschein/buchen/ 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 meldescheine Array hinzugefügt werden. Par...
Meldescheindaten abrufen
Dieser Aufruf frägt alle hinterlegten Daten eines oder mehrerer Meldescheine ab. POST import/meldeschein/get/ Parameter Name Datentyp Verwendung meta Objekt Meta-Objekt meldescheine Array Array mit Meldeschein-IDs Beispiele ...
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. Vermeiden Sie mehrfache Aufrufe der Schnittstelle:Jede Anfrage "get-pdf" wird ...
Konfiguration abrufen
GET users/get_current_user 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...
asdasd
asdasd#
Meldescheine aktualisieren
Dokumentation unvollständig. Allgemein Dieser Aufruf aktualisiert einen existierenden elektronischen Meldeschein im System. Es kann pro Aufruf immer nur ein (1) Meldeschein aktualisiert werden.Wenn im unten erläuterten Array mehrere Meldescheine aufgeführt...
Allgemein
Zusätzlich zur Web-API, besteht die Möglichkeit, Meldescheindaten per Datei zu importieren. Dieser Import erfolgt in der Regel auf seiten eines Vermieters, welcher hierzu einen direkten Zugang zur Weboberfläche besitzt und auch dort die Dateien selbstständig h...
XML
Zeichensatz und XML Struktur Der Zeichensatz der Daten ist - wie auch bei der Live-Schnittstelle UTF-8. Die Datei beginnt mit dem XML Header: <?xml version="1.0" encoding="UTF-8"?> Dann folgt das Array <meldescheine /> mit mindestens einem Meldes...
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, und objekt an, für welche Gemeinde sowie welchen ...
Meldescheine stornieren
Dieser Aufruf setzt den Status der übergebenen Meldescheine auf "storniert". Stornierte Meldescheine sind nicht länger veränderbar. POST import/meldeschein/stornieren/ Parameter Name Datentyp Verwendung meta Objekt Meta-Objekt melde...
XML (english)
Character Encoding and XML Structure The character encoding of the data is - as with the live interface `UTF-8`. The file starts with the XML header: <?xml version="1.0" encoding="UTF-8"?> Then follows the array `<meldescheine />` with at least one regist...
Authentifizierung Via Buchungscode
Diese Funktion ist für die "Karte hinzufügen" Funktionalität gedacht. Allgemein Jeder Gast hat einen eindeutigen Auth-Code, da dieser sich aus der Meldeschein-ID sowie der Gast-ID zusammensetzt Der Auth-Code muss zur Gemeinde ID passen, somit ist es möglich,...