OpenImmo Connector

Erstellung von XML-Datenströmen im Open-Immo-Format 1.2.7

Einführung

RELion bietet über eine entsprechende Aareon Connect-API die Möglichkeit, sich insb. Leerstände im bekannten OpenImmo-Format (Version 1.2.7) abrufen.

  • Die Schnittstelle liefert jeweils für eine angefragte Einheit die betreffenden Informationen als XML-Stream (Details siehe unten).
  • Es wird nicht geprüft, ob die betreffende Einheit bspw. zum Tagesdatum leer steht oder vermietet ist. Zur Abfrage aktueller oder zukünftiger Leerstände bietet Aareon Connect eigene APIs, mit denen bspw. Einheitenverträge entsprechend abgefragt werden können. Dies dient u.a. auch dazu, Einheiten zu identifizieren, die zum Tagesdatum noch vermietet, aber bereits gekündigt sind, um sie in den Vermarktungsprozess aufzunehmen.

Weitere Details zur OpenImmo-Definition entnehmen Sie bitte den Informationen unter http://www.openimmo.de/.

Folgende Tabellen werden angewendet:

Tabelle Beschreibung
RelC OpenImmo Setup (5164951) OpenImmo-Einrichtung
RelC Unit Master Data (5052264) Einheitenstamm
RelC Editor (5052347) Bearbeiter am Objekt
Salesperson/Purchaser (13) Verkäufer/Einkäufer
RelC Unit Allocation (5052260) Einheit Verteilungen
RelC Unit Equipment (5052253) Ausstattungen
RelC Allocation (5052256) Verteilungscodes (global)
RelC Equipment And Key (5052254) Ausstattungscodes (global)
RelC Exploitation Method (5052401) Nutzungsarten (global)
RelC Editor Part (5052350) Bearbeiter-Rollen (global)
RelC Budget Debit Pos. Method (5164151) Plansollstellungsarten (mandantenabhängig)

Standard Felder

Nachfolgend erhalten Sie einen Überblick über die Informationen bzw. Kontexte, welche im Zusammenhang mit OpenImmo relevant sind.

Nr. Bereich Details Bemerkung
1 Übertragung Übertragungsinformationen Hier werden einige „technische“ Daten übertragen.
2 Anbieter Anbieterinformationen Können über Einrichtung festgelegt werden.
3 Objektkategorie Nutzungsart Mapping über Nutzungsarten
Vermarktungsart fest MIETE_PACHT=true
Objektart Mapping über Nutzungsarten
4 Geo Straße, PLZ, Ort Adressdaten Einheit
5 Kontaktperson Ansprechpartner für Einheit Ermitteln über Bearbeiter im Objekt, Kennzeichnen eines Rollencodes als OpenImmo-Rollencode
6 Preise Diverse (z. B. Kaltmiete, Nebenkosten, Heizkosten) Mapping über Plansollstellungsarten
7 Flaechen Flächengrößen (z. B. Wohnfläche, Nutzfläche, Ladenfläche) Mapping über Verteilungscodes
8 Ausstattungen Ausstattungsmerkmale Mapping über Ausstattungscodes
9 Zustand_Angaben Zustandsangaben Teilw. über Mapping Ausstattungscodes

Hinweis

Weitere OpenImmo-Bereiche wie z. B. Freitexte, Bieterverfahren oder Infrastrukturmerkmale werden nicht unterstützt.

Einrichtung und Mappings

In der OpenImmo-Einrichtung können Sie zentral alle notwendigen Einstellungen und Mappings vornehmen. Die Mappings (z. B. Nutzungsarten, Ausstattungen etc.) können Sie auch losgelöst von der Einrichtung vornehmen, wenn Sie bspw. zu einem späteren Zeitpunkt weitere Mappings hinterlegen oder vorhandene Mappings anpassen möchten.

Einrichtung

Übertragung

Die folgenden Übertragungsinformationen werden intern belegt:

Nr. OpenIimmo-Feld RELion-Feld Bemerkung
1 version T5164951.F2 (OpenImmo Version) Version aus OpenImmo-Einrichtung
2 sendersoftware RELion
3 senderversion Version der OpenImmo-Extension
4 timestamp Systemzeit des Abrufs

Wichtig

Weitere Übertragungsinformationen (z. B. regi_id) sind aktuell nicht Bestandteil der Schnittstelle.

Anbieter

Für die Übertragung von Anbieterinformationen stehen Ihnen folgende Felder zur Verfügung:

Nr. OpenIimmo-Feld RELion-Feld Bemerkung
1 anbieternr T5164951.F5164961 (Provider No.) Anbieter Nr. aus OpenImmo-Einrichtung
2 openimmo_anid T5164951.F5164962 (Provider ID) Anbieter ID aus OpenImmo-Einrichtung
3 firma T5164951.F5164963 (Company) Firma aus OpenImmo-Einrichtung
4 lizenzkennung T5164951.F5164964 (License ID) Lizenzkennung aus OpenImmo-Einrichtung

Wichtig

Bitte beachten Sie bei der Eingabe der vorgegebenen Formatierungen und Längen. Die Lizenzkennung hat z. B. eine Mindestlänge von 3 und eine Maximallänge von 8 Zeichen. Die Formatierungen und Längen werden nicht durch RELion geprüft. Auszug aus der OpenImmo-XSD-Datei:

Lizenzkennung

Weitere Anbieterinformationen wie bspw. Impressum oder Anhang sind nicht Bestandteil der Schnittstelle.

Kontaktperson

Mit dem Feld RE Bearbeiter Rollencode legen Sie fest, welcher Bearbeiter als Kontaktperson für die betreffende Einheit ermittelt und geliefert werden soll. Die Kontaktperson dient als Ansprechpartner bspw. für Rückfragen von potenziellen Interessenten im Vermarktungsportal.

Regeln zur Ermittlung des passenden Bearbeiters:

  1. Gibt es im Objekt zum relevanten Rollencode keinen Bearbeiter, wird nichts geliefert.
  2. Gibt es im Objekt zum relevanten Rollencode genau einen Bearbeiter, so wird dieser geliefert.
  3. Gibt es im Objekt zum relevanten Rollencode mehr als einen Bearbeiter, wird der als „Hauptbearbeiter“ gekennzeichnete Bearbeiter geliefert.
  4. Gibt es im Objekt zum relevanten Rollencode mehr als einen Bearbeiter von denen keiner als „Hauptbearbeiter“ gekennzeichnet ist, wird der alphabetisch erste Bearbeiter (gemäß Bearbeitercode) geliefert.
Nr. OpenIimmo-Feld RELion-Feld Bemerkung
1 email_zentrale T5714.F102 (E-Mail) E-Mail aus Zuständigkeitseinheit
2 email_direkt T13.F5052 (E-Mail) E-Mail aus Bearbeiter (Verkäufer/Einkäufer)
3 tel_durchw T13.F5053 (Phone No.) Telefon aus Bearbeiter (Verkäufer/Einkäufer)
4 tel_fax T13.F5052252 (RelC Fax No.) aus Bearbeiter (Verkäufer/Einkäufer)
5 tel_handy T13.F5052262 (RelC Mobile Phone No.) aus Bearbeiter (Verkäufer/Einkäufer)
6 name T13.F2 (Name) aus Bearbeiter (Verkäufer/Einkäufer)

Wichtig

Weitere Kontaktinformationen wie strasse, plz und ort sind nicht Bestandteil der Schnittstelle.

Nutzungsarten

Über das Mapping der Nutzungsarten steuern Sie, welche Informationen im Bereich Objektkategorie geliefert werden. Da OpenImmo verschiedene Immobilientypen (z. B. Wohnung oder Büros/Praxen) unterscheidet, können Sie über die Spalte OpenImmo Objektart aus einer Vielzahl möglicher Werte wählen und den von Ihnen verwendeten Nutzungsarten zuordnen.

Objektart

Hinweis

Hier wurden jeweils eigene Nutzungsartencodes angelegt (und darüber eine Ansicht definiert). Sie sollten Ihre bereits existierenden Nutzungsarten mit einem entsprechenden OpenImmo-Mapping versehen. Für OpenImmo benötigen Sie keine eigenen Nutzungsarten, ebenso wenig müssen Sie für jede verfügbare OpenImmo-Objektart eine RELion-Nutzungsart definieren.

Nr. OpenIimmo-Feld RELion-Feld Bemerkung
1 nutzungsart T5052401.F3 (Exploitation Method Class) Nutzungsartenklasse Wohnraum: WOHNEN; Nutzungsartenklasse Gewerbe: GEWERBE; In allen anderen Fällen: leer
2 vermarktungsart MIETE_PACHT
3 objektart T5052401.F5164960 (OpenImmo Exploit. Method) gemäß Mapping

Wichtig

Weitere Objektkategorieinformationen (insb. die user_defined-Felder) sind nicht Bestandteil der Schnittstelle.

Flächen

Über das Mapping von Verteilungen bzw. Verteilungscodes legen Sie fest, welche Größeninformationen in der OpenImmo-Schnittstelle im Bereich Flaechen übertragen werden sollen.

Wohnfläche

Hinweis

Hier wurden für OpenImmo jeweils eigene Verteilungscodes angelegt (und darüber eine Ansicht definiert). Selbstverständlich können Sie Ihre bereits existierenden Verteilungscodes mit einem entsprechenden OpenImmo-Mapping versehen. Für OpenImmo benötigen Sie keine eigenen Verteilungscodes, ebenso wenig müssen Sie für jede verfügbare OpenImmo-Verteilung einen RELion- Verteilungscode definieren.

Wichtig

Zu einer Einheit können mehrere Verteilungen (mit ggf. unterschiedlichen Größen) hinterlegt werden. Sofern für die verwendeten Verteilungscodes ein Mapping eingetragen ist, werden alle Verteilungen/Größen in der Schnittstelle geliefert. Beispiel: einheit

Code

Die Verteilungen liegen auf dem Zeitstrahl. In der Schnittstelle werden die jeweils zum Zeitpunkt des Abrufs gültigen Werte ermittelt und übergeben.

Ausstattungen

Allgemein

Als Ausstattungen werden alle spezifischen Ausstattungsmerkmale der betreffenden Einheit übergeben, sofern sie in RELion erfasst wurden. Einige Ausstattungen kennen nur ein vorhanden Ja/Nein (z. B. Balkon), andere Merkmale kennen Unterausprägungen, bei denen auch Mehrfachnennungen möglich sind (z. B. Bodenbelag, Teppich, PVC). In jedem Fall wird für jedes Merkmal bzw. Untermerkmal ein entsprechendes OpenImmo-Mapping angeboten.

Ausstattung

Hinweis

Im Screenshot wurden jeweils eigene Ausstattungscodes angelegt (und darüber eine Ansicht definiert). Selbstverständlich können Sie Ihre bereits existierenden Ausstattungscodes mit einem entsprechenden OpenImmo-Mapping versehen. Für OpenImmo müssen Sie keine eigenen Ausstattungscodes definieren, ebenso wenig für jede verfügbare OpenImmo-Ausstattung einen RELion-Ausstattungscode hinterlegen.

Wichtig

Zu einer Einheit können mehrere Ausstattungen hinterlegt werden. Sofern für die verwendeten Ausstattungscodes ein Mapping eingetragen ist, werden alle Ausstattungen in der Schnittstelle geliefert. Beispiel:

Zuordnung

Code

Ausstattungen können in RELion auch auf anderen Ebenen (z. B. Objekt, Gebäude, Hauseingang) zugeordnet werden. Diese werden im Rahmen der OpenImmo-Schnittstelle jedoch nicht beachtet (Ausnahme: Energiepass). Relevante Ausstattungen müssen zwingend auf Einheitenebene zugeordnet werden!

Energiepass

Energiepassdaten werden in Form einer speziellen Ausstattung gespeichert. Um diese zu übertragen, muss der entsprechende Ausstattungscode für OpenImmo markiert werden.

Energiepass

Da Energiepassdaten i.d.R. nicht auf Einheitenebene gepflegt werden, erfolgt die Ermittlung hier – abweichend von den übrigen Ausstattungsmerkmalen – nicht fest auf Einheitenebene sondern hierarchisch von oben nach unten:

  1. Objekt
  2. Gebäude
  3. Hauseingang
  4. Einheit D. h., es wird für die betreffende Einheit zunächst geprüft, ob es auf Objektebene eine Ausstattung mit dem als Energiepass markierten Ausstattungscode gibt. Falls ja, wird diese verwenden. Falls nein, wird die Suche auf Ebene des der Einheit zugeordneten Gebäudes wiederholt. Ist kein Gebäude zugeordnet bzw. auf Gebäudeebene keine entsprechende Ausstattung hinterlegt, wird auf Ebene des Hauseingangs und schließlich – falls auch dort nicht gefunden werden kann – auf Ebene der Einheit selbst gesucht.

Wichtig

Es kann maximal ein Ausstattungscode als OpenImmo-Energiepass markiert werden.

Nr. OpenIimmo-Feld RELion-Feld Bemerkung
1 epart T5052253.F1815 (EI Type) BEDARF bzw. VERBRAUCH
2 gueltig_bis T5052253.F1813 (EI valid until) Energieausweis gültig bis
3 energieverbrauchkennwert T5052253.F1823 (CO2 Emissions) CO2 Emissionen
4 mitwarmwasser T5052253.F1824 (Is Water Heating Included) Energieverbrauch für Warmwasser enthalten
5 endenergiebedarf T5052253.F1816 (Energy Demand) Endenergiebedarf
6 primaerenergietraeger T5052253.F1817 (Energy Source) Energieträger (z. B. Kohle).
7 stromwert T5052253.F1821 (Energy Demand Electricity) Energiebedarf/-verbrauch (Strom)
8 waermewert T5052253.F1822 (Energy Demand Heating) Energiebedarf/-verbrauch (Heizung)
9 wertklasse T5052253.F1818 (Efficiency Class) Energie-Effizienzklasse
10 baujahr T5052253.F1819 (Year of Construction Building) Baujahr des Gebäudes (nur bei Wohngebäuden pflegbar)
11 ausstelldatum T5052253.F1812 (EI Issued at) Energieausweis erstellt am
12 jahrgang T5052264.F64 (Finish Date) in Abh. vom Fertigstellungsdatum (Einheitenstamm): 2008 = vor 1.5.2014, 2014= ab dem 1.5.2014
13 gebaeudeart T5052253.F1820 (Is Residential Building) wohn wenn Schalter Wohngebäude = true (T5052253.F1820), sonst nichtwohn

Zustand

OpenImmo kennt eine Reihe sog. Zustandsinformationen. Für die meisten dieser Informationen gibt es in RELion keine adäquate Entsprechung (bspw. Letzte Modernisierung). Allerdings können die beiden Informationen Zustand und Alter analog zu „echten“ Ausstattungen über spezielle Ausstattungscodes geliefert werden.

Nr. OpenIimmo-Feld RELion-Feld Bemerkung
1 baujahr T5052264.F64 (Finish Date) Jahr wird aus Fertigstellungsdatum (Einheitenstamm) extrahiert
2 zustand_art über Ausstattungsmapping Optionen: Zustand
3 alter über Ausstattungsmapping Optionen: Alter

Wichtig

Weitere Zustandsinformationen sind nicht Bestandteil der Schnittstelle.

Preise

Um für OpenImmo Preisinformationen (insb. Miete, Heiz- und Betriebskosten) liefern zu können, besteht die Möglichkeit, vorhandene oder neue Plansollstellungsarten entsprechend auf OpenImmo-Preise zu mappen.

Preise

Hinweis

Hier wurden jeweils eigene Plansollstellungsarten angelegt (und darüber eine Ansicht definiert). Selbstverständlich können Sie Ihre bereits existierenden Plansollstellungsarten mit einem entsprechenden OpenImmo-Mapping versehen. Sie müssen für OpenImmo keine eigenen Plansollstellungsarten definieren, ebenso wenig für jede verfügbare OpenImmo-Preisinformation eine RELion- Plansollstellungsarten hinterlegen.

Nr. OpenIimmo-Feld RELion-Feld Bemerkung
1 nettokaltmiete Mapping über Plansollstellungsart Nettokaltmiete, ohne Betriebskosten
2 kaltmiete Mapping über Plansollstellungsart Kaltmiete (entspricht Nettokaltmiete mit Betriebs-/Nebenkosten, ohne Heizkosten)
3 warmmiete Mapping über Plansollstellungsart Brutto-Warmmiete
4 nebenkosten Mapping über Plansollstellungsart monatliche Betriebskosten/Nebenkosten, ohne Heizkosten!
5 heizkosten Mapping über Plansollstellungsart monatliche Heizkosten abzgl. Vorauszahlungen
6 mietzuschlaege Mapping über Plansollstellungsart weitere Mietzuschläge

Wichtig

Zu einer Einheit können in RELion beliebig viele Plansollstellungen hinterlegt werden. Sofern für die verwendeten Plansollstellungsarten ein Mapping eingetragen ist, werden diese in der Schnittstelle geliefert. Beispiel:

Plansollstellungsart

Preise

  1. Die Plansollstellungen liegen - wie auch die Verteilungen - auf dem Zeitstrahl. Es werden die jeweils zum Zeitpunkt des Abrufs gültigen Werte ermittelt.
  2. OpenImmo kennt weitere Preise (insb. auch Kaufpreise), die sind jedoch nicht Bestandteil.

Geo

Hier wird die Adresse der betreffenden Einheit übermittelt:

Nr. OpenIimmo-Feld RELion-Feld Bemerkung
1 plz T5052264.F29 (PostCode) Postleitzahl
2 ort T5052264.F13 (City) Ort
3 strasse T5052264.F11 (Address) Straße

Wichtig

Weitere Adressinformationen (wie z. B. Koordinaten, Hausnummer oder Flurstück) sind nicht Bestandteil der Schnittstelle.

Zuletzt geändert April 2, 2025: Merged PR 4864: doku-projektentwicklung (a9ad810)