3.6 API – digiMANAGER Hilfe

3.6 API

Aus digiMANAGER Hilfe

Wechseln zu: Navigation, Suche

Inhaltsverzeichnis

- Allgemein

Hierbei handelt es sich um die vordefinierte Schnittstellen, die zur Anbindung an digiMELDE zur Verfügung gestellt wird.
Die Datenübergabe erfolgt dabei im XML Format.
Dadurch können Fremdsysteme wie Hotelverwaltungssysteme, Internetbuchungssysteme (IRS), ... vorhandene Gästedaten an digiMELDE System übergeben.
Momentan besteht nur die Möglichkeit Daten an digiMELDE zu übergeben >> unidirectional (nur schreiben) - nicht lesen
In der aktuellen Version wird außerdem nur "neu anlegen" unterstützt (die API wird aber ständig erweitert).

- Datentransfer

Die Daten müssen mittels der HTTP-Methode POST übertragen werden
Als Übertragungsprotokoll wird HTTP und HTTPS unterstützt
Content-Type: multipart/form-data
Integriertes Authentifizierungsverfahren (Fremdsystemkennung, Benutzername, Passwort)
URL und Zugangsdaten für das Authentifizierungsverfahren erfahren Sie bei der zuständigen Toursitinfo.

Errorcodes

1.1 = Daten wurden nicht über die HTTP-Methode POST übertragen
1.2 = XML nicht valide oder codierung ist nicht UTF-8
2 = Schlüssel des Fremdsystem ungültig oder nicht freigeschaltet
3 = Authentífizierung nicht erfolgreich
4.1 = Datenaufbereitung fehlgeschlagen
4.2.1 = Dateneintrag nicht erflogreich - Fehler unbekannt
4.2.2 = Dateneintrag nicht erflogreich - Datensatz schon vorhanden
4.2.3 = Dateneintrag nicht erflogreich - Daten sind unvollständig
5 = Abmeldung nicht erflogreich

- XML Struktur

Valides XML (wohl geformt)
Version 1.0
encoding UTF-8
Entitäten müssen HTML-codiert werden (z.b. & = &)

<?xml version="1.0" encoding="UTF-8"?>
<digimelde>
	<external></external>
        <auth></auth>
        <meta></meta>
        <hauptreisender>
               <behinderung></behinderung>
        </hauptreisender>
        <mitreisender1>
               <behinderung></behinderung>
        </mitreisender1>
        <mitreisender2>
               <behinderung></behinderung>
        </mitreisender2>
        <mitreisender3>
               <behinderung></behinderung>
        </mitreisender3>
        <mitreisender4>
               <behinderung></behinderung>
        </mitreisender4>
</digimelde>

XML Struktur- Beispiel

<?xml version="1.0" encoding="UTF-8"?>
<digimelde>
	<external>
		<identifier><!-- Kennung --></identifier>
		<base><!-- Betriebsnummer --></base>
		<baseid><!-- ID der Meldung --></baseid>
	</external>
	<auth>
		<benutzername><!-- string --></benutzername>
		<passwort><!-- string --></passwort>
		<objektid><!-- int --></objektid>
		<eintragstyp><!-- string --></eintragstyp>
		<layout><!-- string --></layout>
	</auth>
	<meta>
		<anreise><!-- string --></anreise>
		<abreise><!-- string --></abreise>
		<gastart><!-- int --></gastart>
		<verkehrsmittel><!-- string --></verkehrsmittel>
		<autokennzeichen><!-- string --></autokennzeichen>
	</meta>
	<hauptreisender>
		<anrede><!-- string --></anrede>
		<titel><!-- string --></titel>
		<zusatz><!-- string --></zusatz>
		<gebdatum><!-- string --></gebdatum>
		<email><!-- string --></email>
		<name><!-- string --></name>
		<vorname><!-- string --></vorname>
		<strasse><!-- string --></strasse>
		<plz><!-- int --></plz>
		<ort><!-- string --></ort>
		<land><!-- int --></land>
		<staatsangehoerigkeit><!-- int --></staatsangehoerigkeit>
		<passnummer><!-- string --></passnummer>
		<behinderung>
			<grad><!-- int --></grad>
			<sw_nummer><!-- string --></sw_nummer>
			<sw_gueltig><!-- string --></sw_gueltig>
			<begleitperson><!-- string --></begleitperson>
		</behinderung>
	</hauptreisender>
	<mitreisender1>
		<anrede><!-- string --></anrede>
		<titel><!-- string --></titel>
		<zusatz><!-- string --></zusatz>
		<gebdatum><!-- string --></gebdatum>
		<name><!-- string --></name>
		<vorname><!-- string --></vorname>
		<staatsangehoerigkeit><!-- int --></staatsangehoerigkeit>
		<passnummer><!-- string --></passnummer>
		<behinderung>
			<grad><!-- int --></grad>
			<sw_nummer><!-- string --></sw_nummer>
			<sw_gueltig><!-- string --></sw_gueltig>
			<begleitperson><!-- string --></begleitperson>
		</behinderung>
	</mitreisender1>
	<mitreisender2>
		<anrede><!-- string --></anrede>
		<titel><!-- string --></titel>
		<zusatz><!-- string --></zusatz>
		<gebdatum><!-- string --></gebdatum>
		<name><!-- string --></name>
		<vorname><!-- string --></vorname>
		<staatsangehoerigkeit><!-- int --></staatsangehoerigkeit>
		<passnummer><!-- string --></passnummer>
		<behinderung>
			<grad><!-- int --></grad>
			<sw_nummer><!-- string --></sw_nummer>
			<sw_gueltig><!-- string --></sw_gueltig>
			<begleitperson><!-- string --></begleitperson>
		</behinderung>
	</mitreisender2>
</digimelde>

- TAGS / Values

External

TAG Pflichfeld Typisierung Liste Werte Erklärung
identifier ja int ja ID Fremdsystem
base ja string ja ID Benutzer Fremdsystem
baseid ja string ja ID Datensatz Fremdsystem

Auth

TAG Pflichfeld Typisierung Liste Werte Erklärung
benutzername ja string ja
passwort ja string ja
objektid ja int ja ID der Unterkunft in digiMELDE
eintragstyp ja string ja Standard Standardmeldung
layout ja string ja dl_2


Meta

TAG Pflichfeld Typisierung Liste Werte Erklärung
anreise nein string nein z.B. 01.09.2010
abreise nein string nein z.B. 01.09.2011
gastart ja int ja 1=Urlauber, 2=Geschäftsreisende
verkehrsmittel nein int ja 1=PkW, 2=Bahn, 3=Flugzeug, 4=Bus, 5=Rad, 6=Sonstiges
autokennzeichen nein string nein


Hauptreisender

TAG Pflichfeld Typisierung Liste Werte Erklärung
anrede nein string ja "", Herr, Frau, Firma, Familie
titel nein string nein
zusatz nein string nein
gebdatum nein string nein z.B. 01.09.2010
email nein string nein
name nein string nein
vorname nein string nein
strasse nein string nein
plz nein int nein
ort nein string nein
land nein int nein siehe Länderliste
staatsangehoerigkeit nein int nein siehe Länderliste
passnummer nein string nein


Hauptreisender / Behinderung

TAG Pflichfeld Typisierung Liste Werte Erklärung
grad ja int ja 1=keine Behinderung, 2=unter 80%, 3=ab 80% - ermäßigt, 4=100% - frei
sw_nummer nein string nein Ausweisnummer Schwerbehindertenausweis
sw_gueltig nein string nein Gültigkeit Schwerbehindertenausweis z.B. 01.09.2010
begleitperson nein string ja Ja, Nein


Mitreisender

TAG Pflichfeld Typisierung Liste Werte Erklärung
anrede nein string ja "", Herr, Frau, Firma, Familie
titel nein string nein
zusatz nein string nein
gebdatum nein string nein z.B. 01.09.2010
name nein string nein
vorname nein string nein
staatsangehoerigkeit nein int nein siehe Länderliste
passnummer nein string nein


Mitreisender / Behinderung

TAG Pflichfeld Typisierung Liste Werte Erklärung
grad ja int ja 1=keine Behinderung, 2=unter 80%, 3=ab 80% - ermäßigt, 4=100% - frei
sw_nummer nein string nein Ausweisnummer Schwerbehindertenausweis
sw_gueltig nein string nein Gültigkeit Schwerbehindertenausweis z.B. 01.09.2010
begleitperson nein string ja Ja, Nein
  • Pflichtfelder

- Ländercodes

Land Schlüssel Titel Gruppe
Europa
Deutschland 13 Deutschland Europa
Niederlande 31 Niederlande Europa
Belgien 21 Belgien Europa
Bulgarien 47 Bulgarien Europa
Dänemark 22 Dänemark Europa
Estland 15 Estland Europa
Finnland 23 Finnland Europa
Frankreich 24 Frankreich Europa
Griechenland 25 Griechenland Europa
Großbritanien / Nordirland 26 Großbritanien / Nordirland Europa
Irland, Republik 27 Irland, Republik Europa
Island 28 Island Europa
Italien 29 Italien Europa
Lettland 16 Lettland Europa
Litauen 17 Litauen Europa
Luxemburg 30 Luxemburg Europa
Malta 18 Malta Europa
Norwegen 32 Norwegen Europa
Österreich 33 Österreich Europa
Polen 34 Polen Europa
Portugal 35 Portugal Europa
Rumänien 48 Rumänien Europa
Russland 36 Russland Europa
Schweden 37 Schweden Europa
Schweiz 38 Schweiz[5] Europa
Slowakische Republik 19 Slowakische Republik Europa
Slowenien 46 Slowenien Europa
Spanien 39 Spanien Europa
Tschechische Republik 40 Tschech. Republik Europa
Türkei 41 Türkei Europa
Ukraine 44 Ukraine Europa
Ungarn 42 Ungarn Europa
Zypern 45 Zypern Europa
Sonstiges Europa 43 Sonstiges Europa Europa
Afrika
Rep. Südafrika 50 Rep. Südafrika Afrika
Sonstiges Afrika 55 Sonstiges Afrika Afrika
Amerika
Kanada 70 Kanada Amerika
USA 71 USA Amerika
Mittelamerika / Karibik 72 Mittelamerika / Karibik Amerika
Brasilien 73 Brasilien Amerika
Asien
Arabische Golfstaaten 60 Arabische Golfstaaten[6] Asien
China Volksrepublik / Honkong 61 China Volksrepublik / Honkong Asien
Indien 69 Indien Asien
Israel 62 Israel Asien
Japan 63 Japan Asien
Südkorea 64 Südkorea Asien
Taiwan 65 Taiwan Asien
Sonstiges Asien 66 Sonstiges Asien Asien
Australien, Ozeanien
Australien 75 Australien Australien, Ozeanien
Neuseeland, Ozeanien 79 Neuseeland, Ozeanien Australien, Ozeanien
Von „http://wiki.digimanager.de/index.php/3.6_API“
Persönliche Werkzeuge
4. Downloads