Webservices für Immonet Immonet-APIapi.immonet.de/doc/Immonet-API_Handbuch.pdf · 3 Kapitel 2....

Immonet-API -Webservices für Immonet

Immowelt Hamburg GmbH

Immonet-API - Webservices für ImmonetImmowelt Hamburg GmbH

Version 3.129.1 (c) Immowelt Hamburg GmbH

iii

InhaltsverzeichnisI. Immonet-API ........................................................................................................... 1

1. Immonet-API .................................................................................................. 2Immonet-API .............................................................................................. 2Zugang zur Immonet-API ............................................................................ 2Rechtesystem ............................................................................................ 2

2. API-Grundlagen .............................................................................................. 3API-Grundlagen .......................................................................................... 3Service-URLs ............................................................................................. 3Aufrufparameter ......................................................................................... 3Formate ..................................................................................................... 4Sessions .................................................................................................... 6Exposé-Anzeige ......................................................................................... 7

3. Authentifizierung ............................................................................................. 8Allgemeines ............................................................................................... 8Funktionweise der Verschlüsselung ............................................................. 8API-Aufruf Beispiel PHP ............................................................................. 8

4. Anhänge ...................................................................................................... 10Fehlercodes ............................................................................................. 10Datentypen ............................................................................................... 18Grundformate für Anfragen und Antworten ................................................. 18Dokumentation der verwendeten Standards ............................................... 20

II. API-Funktionen ..................................................................................................... 225. agent.* - Suchagenten .................................................................................. 23

agent.{name|nameAuth} ............................................................................ 24agent.{saveURL|saveURLAuth} ................................................................. 25

6. broker.* - Anbieter ........................................................................................ 26broker.data ............................................................................................... 27broker.disclaim ......................................................................................... 28broker.impress .......................................................................................... 29

7. contact.* - Kontakt ........................................................................................ 30contact.brokerform .................................................................................... 33contact.brokerformSend ............................................................................ 34contact.brokershortform ............................................................................. 35contact.brokershortformSend ..................................................................... 36contact.brokershortformValidate ................................................................. 37contact.data ............................................................................................. 38contact.friend ............................................................................................ 39

8. expose.* - Exposés ...................................................................................... 40expose.complete ...................................................................................... 41expose.data ............................................................................................. 43expose.disclaim ........................................................................................ 45

9. {geo|location}.* - Geo-Informationen .............................................................. 46location.autocomplete ............................................................................... 47location.choicelist ...................................................................................... 48{geo|location}.cities ................................................................................... 49location.cityAliases .................................................................................... 51location.cityZips ........................................................................................ 52{geo|location}.continents ........................................................................... 53{geo|location}.counties .............................................................................. 54{geo|location}.departments ........................................................................ 55location.districtAliases ............................................................................... 56{geo|location}.districts ............................................................................... 57location.districtZips ................................................................................... 58{geo|location}.federalstates ........................................................................ 59{geo|location}.find ..................................................................................... 60

Immonet-API

iv

{geo|location}.importantCities ..................................................................... 62{geo|location}.islands ................................................................................ 63{geo|location}.regionareas ......................................................................... 64{geo|location}.regions ................................................................................ 65{geo|location}.states .................................................................................. 66location.streetMultiZip ............................................................................... 67location.streetZip ...................................................................................... 68{geo|location}.zip ...................................................................................... 69

10. memo.* - Merkzettel ................................................................................... 70memo.{addObject|addOjectAuth} ............................................................... 71memo.{clone|cloneAuth} ............................................................................ 72memo.complete ........................................................................................ 73memo.create ............................................................................................ 74memo.{delete|deleteAuth} ......................................................................... 75memo.{deleteObject|deleteObjectAuth} ...................................................... 76memo.{friend|friendAuth} ........................................................................... 77memo.{objects|objectsAuth} ....................................................................... 78memo.memoMemoByPersonIdOrEmail ...................................................... 79

11. option.* - Kategorien/Typen ......................................................................... 80option.features .......................................................................................... 81option.marketingtypes ............................................................................... 82option.objectcats ....................................................................................... 83option.objectstates .................................................................................... 84option.objecttypeParentcats ....................................................................... 85option.objecttypes ..................................................................................... 86option.parentcats ...................................................................................... 87option.prices ............................................................................................. 88option.searchfeatureFeatures .................................................................... 89option.searchfeatures ................................................................................ 90

12. search.* - Suche ........................................................................................ 91search.fieldinfos ........................................................................................ 92search.fields ............................................................................................. 93search.oow ............................................................................................... 97

13. session.* - Sessions ................................................................................... 98session.close ............................................................................................ 99session.open .......................................................................................... 100session.ping ........................................................................................... 101

14. system.* - Meta-Funktionen ....................................................................... 102system.limits ........................................................................................... 103system.listMethods ................................................................................. 104system.version ........................................................................................ 105

15. statistics.* - Expose Statistiken .................................................................. 106statistics.write ......................................................................................... 107

16. user.* - Benutzer ...................................................................................... 108user.salt ................................................................................................. 110

v

Tabellenverzeichnis2.1. Service-URLs ...................................................................................................... 32.2. Aufrufparameter ................................................................................................... 312.1. Suchfelder der Feldersuche .............................................................................. 93

vi

Beispiele2.1. Beispiel für einen XML-RPC-Aufruf ....................................................................... 32.2. Ein Beispiel für den Aufruf der Immonet-API mit XML-RPC in PHP ......................... 6

Teil I. Immonet-API

2

Kapitel 1. Immonet-APIImmonet-API

Die Immonet-API stellt eine standardisierte Schnittstelle zum Immobilien-Datenbestandvon Immonet zur Verfügung. Entwickler und Dienstleiter können über die Immonet-APIImmobilien suchen, Exposes und Kontaktdaten abfragen und den Datenbestand vonImmonet aktualisieren.

Die Immonet-API basiert auf bekannten Internet- und Branchen-Standards. Für dieKommunikation werden HTTP und JSON-RPC oder XML-RPC benutzt. Als Datenformatekommen XML, OpenImmo und JSON zum Einsatz.

Zugang zur Immonet-APIEntwickler und Dienstleister, die die Immonet-API benutzen wollen, müssen sich dafür beiImmonet registrieren (http://www.immonet.de/de/register_user/). Sie erhalten durch dieRegistrierung eine Anwender-ID, die Sie zusammen mit Ihrem Kennwort angeben müssen,wenn Sie eine Funktion der Immonet-API aufrufen. Bevor Sie die Immonet-API mit IhrerAnwender-ID benutzen können, muss die ID dafür freigeschaltet werden. Die Freischaltunggeschieht durch die technische Kundenbetreuung bei Immonet.

RechtesystemEin internes Rechtesystem legt fest, welche Funktionen der Immonet-API mit einerAnwender-ID aufgerufen werden dürfen. Die Immonet-API stellt eine Meta-Funktion zurVerfügung, die es Ihnen ermöglicht, eine Liste aller Funktionen abzurufen, die Sie mit ihrerAnwender-ID benutzen dürfen. Siehe dazu Abschnitt „system.listMethods“

http://www.immonet.de/de/register_user/

3

Kapitel 2. API-Grundlagen

API-GrundlagenDie Funktionen der Immonet-API können über verschiedene Serviceprotokolle aufgerufenwerden und liefern ihre Ergebnisse in mehreren Datenformaten zurück. Damit kann dieVerwendung der Immonet-API sehr flexibel dem jeweiligen Anwendungsfall angepasstwerden.

Service-URLsAls Serviceprotokolle stehen JSON-RPC und XML-RPC zur Verfügung. Für jedesServiceprotokoll gibt es einen festen Einstiegspunkt, der durch die Service-URL festgelegtwird.

Tabelle 2.1. Service-URLs

Serviceprotokoll Service-URL

JSON-RPC http://api.immonet.de/api/jsonrpc

XML-RPC http://api.immonet.de/api/xmlrpc

Serviceanfragen geschehen grundsätzlich über HTTP und die POST-Methode von HTTP.Der eigentliche Funktionsaufruf wird der API im jeweiligen Format als Datenpaket im Bodydes HTTP-Requests übergeben.

AufrufparameterSie müssen sich dem System gegenüber identifizieren, damit überprüft werden kann, obSie die gewünschte Funktion aufrufen dürfen. Dazu wird die Service-URL bei jedem Aufrufdurch einige Parameter ergänzt:

Tabelle 2.2. Aufrufparameter

Parameter Typ Pflicht-Parameter? Bedeutung

jsessionid string nein Session-ID (sieheAbschnitt „Sessions“)

uid integer ja Ihre Anwender-ID

sig string ja Aufruf-Signatur(siehe Text)

zanid string nein Ihre Zanox-ID

Beispiel 2.1. Beispiel für einen XML-RPC-Aufruf

http://api.immonet.de/api/xmlrpc;jsessionid=DA32242SSGE2?\ uid=12345&sig=11ba3f9a81cd4a7ed21fd19ed0f203e6

Bei den Parameternamen werden Groß- und Kleinschreibung unterschieden.

Die Aufruf-Signatur dient der Zugangs- und Konsistenzprüfung und berechnet sich aus denanderen übergebenen Parametern:

API-Grundlagen

4

Prozedur 2.1. Algorithmus zur Signatur-Berechnung

1. Die Parameter werden alphabetisch nach Name sortiert.

;jsessionid=DA32242SSGE2?uid=12345

2. ";", "?", "&" und "=" werden entfernt. Namen und Werte der Aufrufparameter werden ineiner Zeichenkette direkt aneinander gehängt.

jsessionidDA32242SSGE2uid12345

3. Das Kennwort des Anwenders wird vor die entstandene Zeichenkette gehängt.

KENNWORTjsessionidDA32242SSGE2uid12345

4. Aus der Zeichenkette wird ihr MD5-Hashwert berechnet.

11ba3f9a81cd4a7ed21fd19ed0f203e6

5. Der MD5-Hashwert wird als Wert für den sig-Parameter übergeben.

;jsessionid=DA32242SSGE2\ ?uid=12345\ &sig=11ba3f9a81cd4a7ed21fd19ed0f203e6

Extra-Parameter in der Service-URLEs steht Ihnen frei, über die oben genannten Parameter hinaus, weitere Parameter in derService-URL anzugeben.

Die Immonet-API verarbeitet nur die Anwender-ID, die Session-ID und die Signatur. Alleanderen Aufruf-Parameter werden bei der Verarbeitung der Anfrage ignoriert. Sie werdenaber in der Tracking-URL (Siehe Abschnitt ???) wieder ausgegeben und können so vonIhnen verwendet werden, um zum Beispiel eigene Statistiken zu führen.

Wenn Sie die Immonet-API zusammen mit Zanox nutzen, sollten Sie Ihre Zanox-ID alsParameter zanid angeben und die Tracking-IFrames einbinden, damit Ihre API-Aufrufekorrekt gezählt werden können.

Verwenden Sie keine Parameter, deren Name mit den drei Buchstaben „api“ beginnt.Dieses Präfix wird von der Immonet-API selbst verwendet.

Achtung

Beachten Sie, dass sich die Aufruf-Signatur ändert und neu berechnet werdenmuss, wenn Sie zusätzliche Parameter in der Service-URL angeben.

FormateIm Anhang „Grundformate für Anfragen und Antworten“ werden die grundsätzlichenFormate für Funktionsaufrufe der verschiedenen Service-Protokolle und ihre Antwortenbeschrieben. Die Formate entsprechen den jeweiligen Protokoll-Spezifikationen (sieheAnhang „Dokumentation der verwendeten Standards“) und sind in ihrer Struktur ähnlich:

AnfragenIn Service-Anfragen wird jeweils der Name der gewünschten Funktion und die Liste derFunktionsparameter mit ihren Werten übergeben.

API-Grundlagen

5

Achtung

Grundsätzlich gilt: Alle Funktionsaufrufe benutzen den Zeichensatz UTF-8

Die Spezifikation für JSON-RPC sieht optional eine Aufruf-ID (id) vor, die in der Service-Antwort einfach wieder ausgegeben wird. Die Aufruf-ID dient der Verknüpfung von Anfrageund Antwort bei asynchroner Verarbeitung und kann beliebige Werte annehmen, die vomAnwender frei gewählt werden können.

Antworten

Service-Antworten enthalten jeweils das Ergebnis des Funktionsaufrufes (result-payload),eingepackt in einen Protokoll-Mantel.

Ist das Ergebnis des Funktionsaufrufes ein XML-Objekt (zum Beispiel ein OpenImmo-Objekt), so wird dieses „encoded“ zurückgeliefert. Das heißt, die Zeichen der XML-Syntax(Spitze Klammern, Anführungsstriche, Ampersand) wurden durch Entities ersetzt:

& &

< <

> >

" "

Fehlermeldungen

Trat beim Bearbeiten einer Anfrage ein Fehler auf, so wird anstelle der normalen Service-Antwort eine Fehlermeldung zurückgeliefert. Die Fehlermeldung enthält jeweils einenFehlercode und eine textuelle Fehlerbeschreibung.

Achtung

Die Fehlermeldung bezieht sich immer auf den Funktionsaufruf selbst. Auchim Fehlerfall liefert das zugrunde liegende HTTP-Protokoll den Statuscode 200zurück. Ein anderer Statuscode deutet auf ein Netzwerk-Problem hin, nichtunbedingt auf Fehler im Funktionsaufruf.

Anhang „Fehlercodes“ enthält eine Liste der Fehlermeldungen.

API-Grundlagen

6

Aufruf-Beispiele

Beispiel 2.2. Ein Beispiel für den Aufruf der Immonet-API mit XML-RPCin PHP

<?php

require_once 'Zend/XmlRpc/Client.php';$user_id = "123456";$password = "ein kennwort";$session_id = "";

## aufruf zunächst ohne session-id#$client = new Zend_XmlRpc_Client( 'http://api.immonet.de/api/xmlrpc?uid='.$user_id. '&sig='.calculateSignature($password,$user_id));## session-id holen#$session_id = $client->call('session.open');## aufruf mit session-id#$client = new Zend_XmlRpc_Client( 'http://api.immonet.de/api/xmlrpc;jsessionid='.$session_id. '?uid='.$user_id. '&sig='.calculateSignature($password,$user_id,$session_id));## expose abrufen#echo $client->call( 'expose.complete', (object)array('immonetid' => '1234567') );## session beenden#$client->call('session.close');

function calculateSignature($password,$uid,$sessionid='') { $s = $password; if ($sessionid != '') { $s .= 'jsessionid'.$sessionid; } $s .= 'uid'.$uid; return(md5($s));} # calculateSignature()

?>

SessionsEinige API-Funktionen können auf dem Server nur dann korrekt ausgeführt werden, wenndieser die Möglichkeit hat, Zwischenergebnisse abzulegen. Um diese Funktionen benutzenzu können, ist es notwendig, vor dem ersten Aufruf eine Session zu öffnen. Die API stelltdafür einige spezielle Funktionen zur Verfügung. Beim Öffnen einer Session liefert die API

API-Grundlagen

7

eine Session-ID zurück, die bei nachfolgenden API-Aufrufen als Parameter in der Service-URL übergeben werden muß.

Achtung

Session-IDs haben eine Lebensdauer von 15 Minuten. Erfolgt innerhalb derLebensdauer kein API-Aufruf, wird die Session-ID ungültig und es muss eine neueSession geöffnet werden. Jeder Aufruf einer API-Funktion startet die Zeitmessungneu und verlängert damit die Lebensdauer der Session-ID.

Exposé-AnzeigeWerden die Daten eines Exposés auf einer Webseite angezeigt, muß der HTML-Code derSeite folgendes Tag enthalten:

<meta name="robots" content="noindex, follow"/>

Damit wird verhindert, dass Suchmaschinen die Exposé-Seite indizieren und DuplicateContent entsteht.

8

Kapitel 3. AuthentifizierungAllgemeines

Für die API-Funktionen der Merkzettel und Suchaufträge (Suchagenten) wurde eineMenge von Funktionen geschaffen, die zusätzlich zur normalen Aufgabe noch eineAuthentifizierung des Nutzers erlauben. Diese Funktionen können optional genutzt werdenund sind alle mit dem Kürzel "Auth" im Funktionsnamen versehen. (siehe auch Kapitel 5,agent.* - Suchagenten und Kapitel 10, memo.* - Merkzettel) Einige Api-Nutzer durfen ausSicherheitsgründen nur die Funktionen mit Authentifizierung verwenden.

Die Authentifizierung erfolgt über die E-Mail-Adresse, den Benutzernamen oderdie Identifikationsnummer des Benutzers (Parameter useridentification) und einenverschlüsselten Hash-Wert (Parameter authenticationhash). Mit dieser Art derAuthentifizierung wird vermieden, dass der API-Nutzer das Passwort als Klartextmitschicken muss. Um die Authentifizierung zu verwenden muss der API-Client dieseVerschlüsselung selbst durchführen. (Im Detail wird dies in den folgenden Absätzenerklärt) Anschließend wird der Hash-Wert über die API übertragen. Die Immonet-Applikation holt sich anhand der Nutzeridentifikation die benötigten Daten und führtebenfalls die gleiche Verschlüsselung durch. Stimmen die Hash-Werte überein ist derNutzer authentifiziert.

Funktionweise der VerschlüsselungAls Verschlüssungs-Algorithmus wird zur Zeit der SHA-256 (Secure Hash Algorithm)verwendet. Sollten sich in der Zukunft andere Verschlüsselungsstandards etablieren,wird der Hash-Algorithmus ggf. ausgetauscht. Hash-Algorithmen realisieren eine„Einwegverschlüsselung“ um, welche gewährleistet, dass der ursprüngliche Wert nichtwiederhergestellt werden kann.

Voraussetzung für die Nutzung der Authentifikations-Funktionen ist die Verwendung einerSession. Die Erzeugung des Hash-Werts für die Authentifizierung erfolgt in mehrerenSchritten. Zunächst muss über Funktion der Salt geholt werden. (Funktion user.salt) Dieserwird mit dem eingegebenen Passwort konkateniert und gehasht. Der entstandene Wertwird anschließend noch mal mit der sessionid (wird durch die Funktion „session.open“gegeben) konkatiniert und wiederum gehasht. Dieser finale Hashwert kann dann für dieAuthentifizierung verwendet werden. Das folgende Pseudocode-Beispiel verdeutlicht dienotwendigen Schritte für eine Authentifizierung:

sessionid = session.open(); emailaddress = [email protected]; plainpass = test12; salt = user.salt(emailaddress ); hash1 = hash(concat(plainpass,salt)); authenticationhash = hash(concat(sessionid,hash1));

Siehe auch API-Funktion "user.salt".

API-Aufruf Beispiel PHP

... $client = new jsonRPCClient('http://api.immonet.de/api/jsonrpc?

Authentifizierung

9

uid='.$user_id.'&sig='.calculateSignature($password,$user_id),true); # SesssionId holen $sessionid = $client->__call('session.open',null); $client = new jsonRPCClient('http://api.immonet.de/api/jsonrpc; jsessionid='.$sessionid.'?uid='.$user_id.'& sig='.calculateSignature($password,$user_id,$sessionid),true);

# Salt holen $salt = $client->__call('user.salt', (object)array('useridentification' => '[email protected]'));

# Passwort 'test12' und Salt hashen $pwhash = hash('sha256', 'test12'.$salt);

# pwhash mit der SessionId hashen $authhash = hash('sha256',$sessionid.$pwhash);

print_r( $client->__call( 'memo.memoByPersonIdOrEmail', (object)array('useridentification' => '[email protected]', 'authenticationhash' => $authhash) ) ); ...

10

Kapitel 4. AnhängeFehlercodes

Trat beim Bearbeiten einer Anfrage ein Fehler auf, so wird anstelle der normalen Service-Antwort eine Fehlermeldung zurückgeliefert. Die Fehlermeldung enthält jeweils einenFehlercode und eine textuelle Fehlerbeschreibung. JSON-RPC und XML-RPC gebeneinen numerischen Fehlercode aus.

Code Code-Symbol Text Beschreibung

1001 ParamFormat FehlerhaftesParameterformat

Die Parameterwurden nicht korrektübergeben. DasFormat sollteüberprüft werden.

1002 ParamIDMiss Immonet-ID oderObjekt-ID mussangegeben werden

Die gewünschteAPI-Funktion kannohne die Angabeeiner Immonet-IDoder Objekt-ID nichtausgeführt werden.

1003 ParamInvld Parameter ungültig Einer oder mehrereParameterüberschreiten dievorgegebenenWertebereiche.

1004 ParamPrsnIDMiss Person-ID oderImmonet-ID oderObjekt-ID mussangegeben werden

Die gewünschte API-Funktion kann ohnedie Angabe einerImmonet-ID, Objekt-ID oder Person-IDnicht ausgeführtwerden.

1005 ParamEMailInvld E-Mail-Adresseungueltig

Die angegebeneE-Mail-Adresseentspricht nicht derRFC 822

1006 ParamSendEMailInvld E-Mail-Adresse desAbsenders ungueltig

Die angegebene E-Mail-Adresse desAbsenders entsprichtnicht der RFC 822

1007 ParamMiss Parameter fehlt Es fehlt einParameter

2001 CntctBrkr Fehler beimVerschicken derKontaktanfrage

Die Kontaktanfragekonnte nichtabgeschickt werden.Evtl. lag ein internerFehler vor. DieAnfrage solltewiederholt werden.

2002 CntctData Fehler beim Abrufder Kontaktdaten

Die gewünschtenKontaktdatenkonnten nicht

Anhänge

11

Code Code-Symbol Text Beschreibungabgerufen werden.Evtl. lag ein internerFehler vor. DieAnfrage solltewiederholt werden.

2003 CntctFrnd Fehler beimVerschicken desExposes

Die Exposé-Empfehlung konntenicht abgeschicktwerden. Evtl. lag eininterner Fehler vor.Die Anfrage solltewiederholt werden.

2004 CntctForm Fehler beim Abrufder Formulardaten

Die Formulardatenkonnten nicht aus derDatenbank abgerufenwerden. Evtl. lag eininterner Fehler vor.Die Anfrage solltewiederholt werden.

2005 CntctValid Fehler beimValidieren derFormulardaten

Die Formulardatenkonnten nichtvalidiert werden.Evtl. lag ein internerFehler vor. DieAnfrage solltewiederholt werden.

2006 CntctVldNoRslt Validierung derFormulardaten ohneErgebnis

Die Validierungder Formulardatenhat kein Ergebnisgeliefert. Evtl. lag eininterner Fehler vor.Die Anfrage solltewiederholt werden.

2007 CntctNoShort Kurz-Anfrage nichtmoeglich

Der Anbieter desObjektes möchtekeine Kurz-Anfragenbekommen.

3001 ExpsCmplt Fehler beim Abrufdes Exposes

Die gewünschtenExposé-Datenkonnten nichtabgerufen werden.Evtl. lag ein internerFehler vor. DieAnfrage solltewiederholt werden.

4001 ObjNotFnd Kein Objekt mitangegebenerImmonet-ID oderObjekt-ID gefunden

Es wurde kein Objektmit der angebenenImmonet-ID oderAnbieter-Objekt-IDgefunden.

4002 ObjNotVsbl Das Objekt ist nichtsichtbar

Das Objekt mit derangebenen Immonet-ID oder Anbieter-

Anhänge

12

Code Code-Symbol Text BeschreibungObjekt-ID ist nichtsichtbar.

5002 SrchNoRslt KeineSuchergebnissevorhanden

Die ausgeführteSuche hat keineErgebnisse geliefert.Evtl. lag ein internerFehler vor. DieAnfrage solltewiederholt werden.

5003 SrchOOW Fehler beim Abrufder Objekte derWoche

Die Objekte derWoche konntennicht abgerufenwerden. Evtl. lag eininterner Fehler vor.Die Anfrage solltewiederholt werden.

5004 SrchFields Fehler beim Aufrufder Feldersuche

Die gewünschteSuche konntenicht ausgeführtwerden. Evtl. lag eininterner Fehler vor.Die Anfrage solltewiederholt werden.

5005 SrchSimilar Fehler beimAufruf derÄhnlichkeitssuche

DieÄhnlichkeitssuchekonnte nichtausgeführt werden.Evtl. lag ein internerFehler vor. DieAnfrage solltewiederholt werden.

5006 SrchROOW Fehler beim Abrufder regionalenObjekte

Fehler beim Abrufder regionalenObjekte

5007 SrchParaPolyInvalid Die Summe derPolygonenflächenüberschreitetdie maximaleFlächenbegrenzung\nMindestens einesder Polygone ist zuklein\n

Die Summe derPolygonenflächenüberschreitetdie maximaleFlächenbegrenzung.Mindestens eines derPolygone ist zu klein.Beispielrückgabe:[1,4,7]

5008 SrchParaPolyInvalidTooSmallMindestens eines derPolygone ist zu klein

Mindestens eines derPolygone ist zu klein.Beispielrückgabe:[1,4,7]

5009 SrchParaPolyInvalidTooBigDie Summe derPolygonenflächenüberschreitetdie maximaleFlächenbegrenzung

Die Summe derPolygonenflächenüberschreitetdie maximaleFlächenbegrenzung.

Anhänge

13


6001 RqstWrngSig Aufruf-Signatur nichtkorrekt

Die Aufruf-Signatur(URL-Parametersig) passt nicht zuden übergebenenParametern. Evtl.wurde ein falschesKennwort für dieBerechnung benutzt.

6002 RqstNotAllwd Aufruf der Methodenicht erlaubt

Die gewünschte API-Funktion darf nichtaufgerufen werden.

6003 RqstUnkMthd Methode nichtvorhanden

Die gewünschte API-Funktion existiertnicht. Das Aufruf-Paket sollte aufTippfehler überprüftwerden.

6004 RqstExcMthd Methode konnte nichtausgefuehrt werden

Die gewünschte API-Funktion konntenicht aufgerufenwerden. Evtl. lag eininterner Fehler vor.Die Anfrage solltewiederholt werden.

6005 RqstFormat Ergebnisse konntennicht in Zielformatkonvertiert werden

Die Ergebnisses desFunktionsaufrufeskonnten nichtin das Formatder Schnittstelle(JSON,XML)konvertiert werden.

6006 RqstLimit Aufruflimit erreicht Ihr Tageslimit fürAPI-Aufrufe isterreicht. WeitereAufrufe sind erstnach 0:00 Uhr amfolgenden Tagmöglich.

7001 SessNotVld Session ungültig Die Session mit derangegebenen ID(URL-Parametersessionid) existiertnicht oder istabgelaufen, weilder letzten Aufrufmehr als 15 Minutenzurückliegt.

7002 SessNeeded Aufruf der Methodeohne Session nichterlaubt

Die gewünschteAPI-Funktion darfnur in einer gültigenSession (URL-Parameter sessionid)aufgerufen werden.

Anhänge

14


8001 SystemCall Fehler beim Aufrufder Systemfunktion


8002 SystemRslt Keine Systemdatenabrufbar

Die ausgeführteAPI-Funktion hatkeine Ergebnissegeliefert. Evtl. lag eininterner Fehler vor.Die Anfrage solltewiederholt werden.

9001 GeoCall Fehler beim Aufrufder Geo-Funktion


9002 GeoRslt Keine Geo-Datenabrufbar


10001 OptionCall Fehler beim Aufrufder Option-Funktion


10002 OptionRslt Keine Option-Datenabrufbar


11001 AgntSavUrlCall Fehler beim Aufrufder Agent-URL-Funktion


11002 AgntSavUrlRslt Keine URL erzeugt Die ausgeführteAPI-Funktion hatkeine Ergebnissegeliefert. Evtl. lag ein

Anhänge

15

Code Code-Symbol Text Beschreibunginterner Fehler vor.Die Anfrage solltewiederholt werden.

11003 AgntIDMiss Suchagent-ID mussangegeben werden

Die gewünschte API-Funktion kann ohnedie Angabe einerSuchagent-ID nichtausgeführt werden.

11004 AgntActMiss Aktion mussangegeben werden

Die gewünschteAPI-Funktion kannohne die Angabeeiner Aktion nichtausgeführt werden.

11005 AgntCall Fehler beim Aufrufder Suchagent-Funktion


11006 AgntNotFnd Kein Suchagent mitangegebener IDgefunden

In der Datenbankwurde keinSuchagent mitder angegebenenSuchagent-IDgefunden.

11007 AgntEMailMiss E-Mail-Adresse mussangegeben werden

Die gewünschte API-Funktion kann ohnedie Angabe einer E-Mail-Adresse nichtausgeführt werden.

11008 AgntLstRslt Keine Suchagentenfuer angegebeneE-Mail-Adressegefunden

In der Datenbankwurde keinSuchagent zurangegebenen E-Mail-Adresse gefunden.

11009 AgntSavRslt Suchagent konntenicht gespeichertwerden

Die Daten desSuchagentenkonnten nicht inder Datenbankgespeichert werden.

12001 MemoCall Fehler beim Aufrufder Memo-Funktion


12002 MemoNotFnd Merkzettel nichtgefunden

Der gewünschteMerkzettel wurde inder Datenbank nichtgefunden.

Anhänge

16


12003 MemoNoLsts Keine Merkzettel-Listen gefunden

Der angegebeneMerkzettel enthältkeine Listen.

12004 MemoNoObjs Keine Objektdatengefunden

Die angegebeneMerkzettel-Listeenthält keineObjekte.

12005 MemoIDMiss Merkzettel-ID mussangegeben werden

Die gewünschte API-Funktion kann ohnedie Angabe einerMerkzettel-ID nichtausgeführt werden.

12006 MemoLstTtlMiss Titel der Liste mussangegeben werden

Die gewünschte API-Funktion kann ohnedie Angabe einesListen-Titels nichtausgeführt werden.

12007 ObjectAlreadyInMemo Objekt wurde schondem Merkzettelhinzugefügt

Das Objektwurde bereitsdem Merkzettelhinzugefügt undkonnte deswegennicht erneuthinzugefügt werden.

12008 HasNoMemo Der Benutzer hatkeinen Merkzettel

Die Funktion konntenicht ausgeführtwerden, weil derBenutzer keinenMerkzettel besitzt.

13001 LoctnCall Fehler beim Aufrufder Location-Funktion


13002 LoctnRslt Keine Location-Datenabrufbar


14001 BrkrCall Fehler beim Aufrufder Broker-Funktion


14002 BkrNotFnd Keine Brokerdatengefunden

Die ausgeführteAPI-Funktion hatkeine Ergebnisse

Anhänge

17

Code Code-Symbol Text Beschreibunggeliefert. Evtl. lag eininterner Fehler vor.Die Anfrage solltewiederholt werden.

14003 BrkrNoLsts Keine Broker-Listegefunden


15001 InternMapCall Fehler beim Aufrufder RDM-Mapping-Funktion


15002 InternMapNotFnd Kein RDM-Mappinggefunden

Für die angebenenParameter wurdekein Mappinggefunden

16001 FiPaCall Fehler beim Aufrufder FiPa-Funktion


17001 UserCall Fehler beim Aufrufder User-Funktion


17002 UsrNotFnd Keine Userdatengefunden

Zu den angegebenParametern konntenkeine Benutzerdatengefunden werden.

17003 UsrAuthFail User konnte nichtauthentifiziert werden

Der User konntenicht überuseridentification undauthenticationhashauthentifiziertwerden.

21001 PrjNotFound Projekt konnte nichtgefunden werden

Projekt konnte nichtgefunden werden

21002 ProjectLinkedExposesCallFehler beimAufruf vonproject.linkedExposes

Fehler beimAufruf vonproject.linkedExposes

Anhänge

18


22001 MyNewHomeExceptionEs ist einunerwarteter Fehleraufgetreten

Es ist einunerwarteter Fehleraufgetreten

DatentypenDie Definitionen grundlegender Datentypen der Immonet-API können unter der URL

http://api.immonet.de/api/xsd/immonet.xsd

abgerufen werden.

Die Datentypen die von einem Modul der Immonet-API benutzt werden, sind jeweils ineiner eigenen XSD-Datei zusammengefasst:

Modul URL

agent.* http://api.immonet.de/api/xsd/AgentService.xsd

broker.* http://api.immonet.de/api/xsd/BrokerService.xsd

contact.* http://api.immonet.de/api/xsd/ContactService.xsd

expose.* http://api.immonet.de/api/xsd/ExposeService.xsd

geo.* http://api.immonet.de/api/xsd/GeoService.xsd

location.* http://api.immonet.de/api/xsd/LocationService.xsd

memo.* http://api.immonet.de/api/xsd/MemoService.xsd

option.* http://api.immonet.de/api/xsd/OptionService.xsd

search.* http://api.immonet.de/api/xsd/SearchService.xsd

session.* http://api.immonet.de/api/xsd/SessionService.xsd

system.* http://api.immonet.de/api/xsd/SystemService.xsd

Grundformate für Anfragen und Antworten

JSON-RPC

Anfrage

{"id": "call-id","method": "any.function","params": { "name": "value",


http://api.immonet.de/api/xsd/AgentService.xsd

http://api.immonet.de/api/xsd/AgentService.xsd

http://api.immonet.de/api/xsd/BrokerService.xsd


http://api.immonet.de/api/xsd/ContactService.xsd


http://api.immonet.de/api/xsd/ExposeService.xsd


http://api.immonet.de/api/xsd/GeoService.xsd


http://api.immonet.de/api/xsd/LocationService.xsd


http://api.immonet.de/api/xsd/MemoService.xsd


http://api.immonet.de/api/xsd/OptionService.xsd


http://api.immonet.de/api/xsd/SearchService.xsd


http://api.immonet.de/api/xsd/SessionService.xsd

http://api.immonet.de/api/xsd/SessionService.xsd

http://api.immonet.de/api/xsd/SystemService.xsd

http://api.immonet.de/api/xsd/SystemService.xsd

Anhänge

19

"name2": "value2" },"version": "1.1"}

Antwort mit Payload

{"id": "call-id","result": result-payload (JSON),"version": "1.1"}

Leere Antwort

{"id": "call-id","result": null,"version": "1.1"}

Fehlermeldung

{"id": "call-id","error": { "name": "JSONRPCError", "code": 999, "message": "an example for an error message" },"version": "1.1"}

XML-RPC

Anfrage

<?xml version="1.0" encoding="UTF-8" ?><methodCall> <methodName>any.function</methodName> <params> <param> <value> <struct> <member> <name>name</name> <value><string>value</string></value> </member> <member> <name>name2</name> <value><int>value2</int></value> </member> </struct> </value> </param>

Anhänge

20

</params></methodCall>

Antwort mit Payload

<?xml version="1.0" encoding="UTF-8" ?><methodResponse> <params> <param> <value> result-payload (XML) </value> </param> </params></methodResponse>

Leere Antwort

<?xml version="1.0" encoding="UTF-8" ?><methodResponse> <params> <param> <value/> </param> </params></methodResponse>

Fehlermeldung

<?xml version="1.0" encoding="UTF-8" ?><methodResponse> <fault> <value> <struct> <member> <name>faultCode</name> <value><int>4</int></value> </member> <member> <name>faultString</name> <value><string>Too many parameters.</string></value> </member> </struct> </value> </fault></methodResponse>

Dokumentation der verwendeten StandardsHTTP http://www.w3.org/Protocols/

http://json.org/JSON

http://www.ietf.org/rfc/rfc4627.txt

http://json-rpc.org/JSON-RPC

http://json-rpc.org/wd/JSON-RPC-1-1-WD-20060807.html

Anhänge

21

OpenImmo http://www.openimmo.de/

XML http://www.w3.org/XML/

XML-RPC http://www.xmlrpc.com/spec

Teil II. API-Funktionen

23

Kapitel 5. agent.* - SuchagentenFunktionen für die Erstellung und Verwaltung von Immonet-Suchagenten.

agent.* - Suchagenten

24

agent.{name|nameAuth}Einen Namen für einen Suchagenten berechnen

JSON-RPC XML-RPC

agent.name agent.name

agent.nameAuth agent.nameAuth

Session nötig? Tracking erforderlich?

nein, Verwendung der Authentifizierung: ja nein

Parameter

Name Typ Pflicht? Beschreibung

query string ja Such-Parameter fürden Suchagenten

useridentification string nein Benötigt fürnameAuth.(siehe Kapitel 3,Authentifizierung)

authenticationhash string nein Benötigt fürnameAuth.(siehe Kapitel 3,Authentifizierung)

Bemerkungenkeine

AusgabeEs wird eine Zeichenkette mit dem berechneten Namen zurückgegeben.

agent.* - Suchagenten

25

agent.{saveURL|saveURLAuth}Zu einer Felder-Suche die passende URL der Portal-Seite „Suchagent speichern“ abfragen

JSON-RPC XML-RPC

agent.saveURL agent.saveURL

agent.saveURLAuth agent.saveURLAuth



Parameter


useridentification string nein Benötigt fürsaveURLAuth.(siehe Kapitel 3,Authentifizierung)

authenticationhash string nein Benötigt fürsaveURLAuth.(siehe Kapitel 3,Authentifizierung)

Weitere Parameter siehe Funktion „search.fields“

BemerkungenBenutzer des Immonet-Portals können eine von ihnen definierte Suchanfrage alsSuchagent speichern. Diese Funktion liefert zu einer Felder-Suche die URL der passenden„Suchagent speichern“-Seite. Die Parameter sind identisch mit denen der Felder-Suche.

AusgabeEs wird eine URL zurückgegeben.

26

Kapitel 6. broker.* - AnbieterFunktionen für die Suche nach Immobilien-Anbietern und die Ausgabe von Anbieterdaten.

broker.* - Anbieter

27

broker.dataLiefert die Daten eines Immobilien-Anbieters

JSON-RPC XML-RPC

broker.data broker.data


nein nein

Parameter


immonetid IdType nein Immonet-ID einesImmobilien-Objektesdes Anbieters

objectid string nein Anbieter-Objekt-IDeines Immobilien-Objektes desAnbieters

personid integer nein ID des Anbieters

BemerkungenEs wird nach nur einer ID gesucht. Werden mehrere IDs als Parameter übergeben, werdendie Parameter nach folgender Reihenfolge verwendet:

1. personid

2. immonetid

3. objectid

AusgabeEs werden die Daten des Anbieters ausgegeben.

Formatbeschreibung: BrokerDataType (http://api.immonet.de/api/xsd/BrokerService.xsd)



broker.* - Anbieter

28

broker.disclaimLiefert die Widerrufsbelehrung eines Immobilien-Anbieters

JSON-RPC XML-RPC

broker.disclaim broker.disclaim


nein nein

Parameter


pgPersonId integer ja ID des Anbieters

textOnly bool nein Wenn "true", wirdeine Text Version derWiderrufsbelehrungzurückgeliefert, sonstHtml.

AusgabeEs wird die Widerrufsbelehrung eines Anbieters ausgegeben.

Formatbeschreibung: BrokerDisclaimerDto (http://api.immonet.de/api/xsd/BrokerService.xsd)



broker.* - Anbieter

29

broker.impressLiefert die Impressum-Daten eines Immobilien-Anbieters

JSON-RPC XML-RPC

broker.impress broker.impress


nein nein

Parameter


immonetid IdType nein Immonet-ID einesImmobilien-Objektesdes Anbieters

objectid string nein Anbieter-Objekt-IDeines Immobilien-Objektes desAnbieters

personid integer nein ID des Anbieters


1. personid

2. immonetid

3. objectid

AusgabeEs werden die Impressum-Daten des Anbieters ausgegeben.

Formatbeschreibung: BrokerImpressResponseType (http://api.immonet.de/api/xsd/BrokerService.xsd)



30

Kapitel 7. contact.* - KontaktFunktionen für die Kontaktaufnahme mit einem Broker oder zum Verschicken vonExposés.

contact.* - Kontakt

31

contact.* - Kontakt

32

contact.* - Kontakt

33

contact.brokerformEine Beschreibung des Kontaktformulars zu einem Expose abrufen.

JSON-RPC XML-RPC

contact.brokerform contact.brokerform


nein nein

Parameter


immonetid IdType nein Immonet-ID desgewünschtenObjektes

objectid string nein Anbieter-Objekt-IDdes gewünschtenObjektes

BemerkungenEs wird entweder nach der Immonet-ID oder nach der Anbieter-Objekt-ID gesucht. Werdenbeide IDs als Parameter übergeben, wird nach der Immonet-ID gesucht.

AusgabeEs wird eine Beschreibung des Kontaktformulars für das gewünschte Exposé ausgegeben.

Formatbeschreibung: ContactBrokerFormResponseType (http://api.immonet.de/api/xsd/ContactService.xsd)

Hinweis

Achtung

Für Hausbau-Objekte (objecttype == 6) wird ein spezielles Kontaktformularbenutzt, dessen Definition mit der Methode hsb.brokerform abgerufen werdenkann. Siehe ???.



contact.* - Kontakt

34

contact.brokerformSendEine formularbasierte Kontaktanfrage zu einem Expose verschicken.

JSON-RPC XML-RPC

contact.brokerformSend contact.brokerformSend


nein ja

Parameter




values array ofContactFormFieldValueType

ja Eingabe-Wertefür das Formular(jeweils Feldnameund Feldwert)

senderPersonId string nein PersonId dereingeloggten Person


Formatbeschreibung: ContactFormFieldValueType (http://api.immonet.de/api/xsd/ContactService.xsd)

AusgabeEs wird eine Tracking-URL zurückgegeben.

Hinweis

Achtung

Für Hausbau-Objekte (objecttype == 6) wird ein spezielles Kontaktformularbenutzt, dessen Daten mit der Methode hsb.brokerformSend übertragen werdenkann. Siehe ???.



contact.* - Kontakt

35

contact.brokershortformEine Beschreibung des Kurzkontakt-Formulars zu einem Expose abrufen.

JSON-RPC XML-RPC

contact.brokershortform contact.brokershortform


nein nein

ParameterSiehe „contact.brokerform“

BemerkungenSiehe „contact.brokerform“

AusgabeEs wird eine Beschreibung des Kurzkontakt-Formulars für das gewünschte Exposéausgegeben.

Formatbeschreibung: ContactBrokerFormResponseType (http://api.immonet.de/api/xsd/ContactService.xsd)



contact.* - Kontakt

36

contact.brokershortformSendEine formularbasierte Kurzkontakt-Anfrage zu einem Expose verschicken.

JSON-RPC XML-RPC

contact.brokershortformSend contact.brokershortformSend


nein ja

ParameterSiehe „contact.brokerformSend“

BemerkungenSiehe „contact.brokerformSend“

AusgabeEs wird eine Tracking-URL zurückgegeben.

contact.* - Kontakt

37

contact.brokershortformValidateEine formularbasierte Kurzkontakt-Anfrage zu einem Expose validieren.

JSON-RPC XML-RPC

contact.brokershortformValidate contact.brokershortformValidate


nein nein

ParameterSiehe „contact.brokerformSend“

BemerkungenSiehe „contact.brokerformSend“

AusgabeDas Antwortpaket enthält ein Feld, das beschreibt, ob die übergebenen Daten füreine Kurz-Anfrage ausreichend sind. Ist das nicht der Fall, wird eine Liste der Felderausgegeben, die nicht gültig sind.

Formatbeschreibung: ContactBrokerFormValidResponseType (http://api.immonet.de/api/xsd/ContactService.xsd)



contact.* - Kontakt

38

contact.dataAnbieterdaten zu einem Expose abrufen

JSON-RPC XML-RPC

contact.data contact.data


nein nein

Parameter





AusgabeEs werden die Kontaktdaten für das gewünschte Exposé ausgegeben.

Formatbeschreibung: ContactDataResponseType (http://api.immonet.de/api/xsd/ContactService.xsd)



contact.* - Kontakt

39

contact.friendEin Expose an einen Freund schicken

JSON-RPC XML-RPC

contact.friend contact.friend


nein nein

Parameter




senderemail EmailAddressType ja E-Mail-Adresse desAbsenders

email EmailAddressType ja E-Mail-Adresse desEmpfängers

comment string nein Kommentar desAbsenders


AusgabeEs wird ein leeres Antwort-Paket zurückgegeben.

40

Kapitel 8. expose.* - ExposésFunktionen zur Ausgabe von Exposés

expose.* - Exposés

41

expose.completeLiefert das komplette Exposé eines Objektes im OpenImmo-Format zurück.

JSON-RPC XML-RPC

expose.complete expose.complete


nein ja

Parameter




openimmoversion string nein Openimmo-Exportversion,mögliche Werte 1.1und 1.2.3 (default:1.1)


AusgabeDie Ausgabe enthält das komplette Exposé im OpenImmo-Format und die Tracking-URL. Daten, die vom Objekt-Anbieter als nicht öffentlich markiert wurden, werden nichtausgegeben (das betrifft z.B. die Objekt-Adresse oder Preisinformationen).

Formatbeschreibung: ExposeCompleteResponseType (http://api.immonet.de/api/xsd/ExposeService.xsd)

Achtung

Die JSON-RPC-Schnittstelle liefert keinen XML-String zurück,sondern ein JSON-Objekt, das aus dem OpenImmo-XML erzeugtwurde. Der Umwandlungsalgorithmus ist hier beschrieben: http://onwebdevelopment.blogspot.com/2008/05/converting-xml-to-json.html.

HinweiseWerden die Daten eines Exposés auf einer Webseite angezeigt, muß der HTML-Code derSeite folgendes Tag enthalten:




expose.* - Exposés

42


Aus technischen Gründen werden von dieser Funktion auch Exposés ausgeliefert, die inder Datenbank als „nicht mehr verfügbar“ markiert sind. Im OpenImmo-XML sind dieseExposés mit

<aktion aktionart="DELETE"/>

gekennzeichnet. Die Daten von so markierten Exposén müssen gelöscht werden. Siedürfen nicht mehr angezeigt werden.

expose.* - Exposés

43

expose.dataLiefert das komplette Exposé eines Objektes als Datenstruktur zurück.

JSON-RPC XML-RPC

expose.data expose.data


nein ja

Parameter




uuid string nein Global-Object-Key (UUID) desgewünschtenObjektes(Experimental)


AusgabeDie Ausgabe enthält das komplette Exposé als Datenstruktur und die Tracking-URL.Daten, die vom Objekt-Anbieter als nicht öffentlich markiert wurden, werden nichtausgegeben (das betrifft z.B. die Objekt-Adresse oder Preisinformationen).

Formatbeschreibung: ExposeDataResponseType (http://api.immonet.de/api/xsd/ExposeService.xsd) ExposeDataResponseType (http://api.immonet.de/api/xsd/ExposeService-2.4.xsd)

HinweiseWerden die Daten eines Exposés auf einer Webseite angezeigt, muß der HTML-Code derSeite folgendes Tag enthalten:



Aus technischen Gründen werden von dieser Funktion auch Exposés ausgeliefert, die inder Datenbank als „nicht mehr verfügbar“ markiert sind. In der Daten sind diese Exposésmit



http://api.immonet.de/api/xsd/ExposeService-2.4.xsd

http://api.immonet.de/api/xsd/ExposeService-2.4.xsd

expose.* - Exposés

44

rights.status="archived"

oder

rights.status="deleted"

oder

rights.status="notvisible"

gekennzeichnet. Die Daten von so markierten Exposén müssen gelöscht werden. Siedürfen nicht mehr angezeigt werden.

expose.* - Exposés

45

expose.disclaimLiefert die Widerrufsbelehrung des Immobilien-Anbieters zu einem Exposé.

JSON-RPC XML-RPC

expose.disclaim expose.disclaim


nein nein

Parameter


immonetid integer ja Immonet ID desgewünschtenObjektes

textOnly bool nein Wenn "true", wirdeine Text Version derWiderrufsbelehrungzurückgeliefert, sonstHtml.

AusgabeEs wird die Widerrufsbelehrung eines Anbieters ausgegeben. Bei Objekten, die denKriterien des Bestellerprinzips entsprechen, wird keine Widerrufsbelehrung ausgegeben.

Formatbeschreibung: BrokerDisclaimerDto (http://api.immonet.de/api/xsd/BrokerService.xsd)



46

Kapitel 9. {geo|location}.* - Geo-Informationen

Funktionen zur Ausgabe der (vereinfachten) Geo-Hierarchie, nach der die Immobilien-Objekte in der Immonet-Datenbank strukturiert sind:

Kont inent Staat

Bundesland

RegionKreis Regierungsbezirk

Ort /Stadt

Bezirk Orts-/Stadt teil

Insel

Geo-Hierarchie

Diese Funktionen überstützen die Generierung von Auswahllisten in Suchformularen.

Die Funktionen der Module geo.* und location.* benutzen jeweils die selben Aufruf-Parameter und liefern die selben Ergebnismengen. Unterschiede gibt es in der in derStruktur der gelieferten Datensätze:

geo.*: Zu jedem Geo-Objekt wird seine Id und sein Name ausgegeben.

location.*: Zu jedem Geo-Objekt werden auch die in der Geo-Hierarchieübergeordneten Geo-Objekte ausgegeben. Zum Beispiel zu einem Bezirk der Kontinent,der Staat, das Bundesland und der Ort. Hierarchie-Ebenen, die nicht gefüllt sind, werden inder Ausgabe weggelassen.

{geo|location}.* -Geo-Informationen

47

location.autocompleteStellt eine Methode zur Autovervollständingung von Geo-Daten bereit.

JSON-RPC XML-RPC

location.autocomplete location.autocomplete


nein nein

Parameter


prefix String ja Präfix für das Geo-Daten geliefertwerden sollen*.

topdistricts boolean nein Gibt an, ob dieAntwort um Top-Districts erweitertwerden soll, auchwenn diese nicht mitdem Präfix beginnen.

Bemerkungen* Für den Parameter Präfix gelten folgende Einschränkungen

1. Es sind Zahlen und Buchstaben erlaubt.

2. Die Groß- und Kleinschreibung ist nicht relevant.

3. Das Präfix muss mindestens 2 Zeichen lang sein.

4. Die Vorbezeichnugen Sankt, St. und St werden synonym behandelt. Eine Suche nachSt. liefert so auch Orte die sich mit Sankt schreiben. Die Orte werden aber in Ihrerrichtigen Schreibweise ausgeliefert. Eine Suche nach "St. A" liefert unter anderem"Sankt Afra, Mering"

AusgabeEs wird eine Auswahlliste für Geo-Objekte ausgegeben.

Formatbeschreibung location.autocomplete: LocationChoicelistType (http://api.immonet.de/api/xsd/LocationService.xsd)




48

location.choicelistLiefert eine Auswahlliste für Geo-Objekte.

JSON-RPC XML-RPC

location.choicelist location.choicelist


nein nein

Parameterkeine

Bemerkungenkeine

AusgabeEs wird eine Auswahlliste für Geo-Objekte ausgegeben.

Formatbeschreibung location.choicelist: LocationChoicelistType (http://api.immonet.de/api/xsd/LocationService.xsd)




49

{geo|location}.citiesLiefert eine Liste der Orte/Städte eines Staates, eines Bundeslandes, einesRegierungsbezirkes, einer Region oder eines (Land-)Kreises.

JSON-RPC XML-RPC

geo.cities geo.cities

location.cities location.cities


nein nein

Parameter


cityid String nein ID einer Stadt/Ortes,der gesucht wird

countyid integer nein ID des(Land-)Kreises, indem die Orte liegensollen

federalstateid integer nein ID desBundeslandes, indem die Orte liegensollen

regionareaid integer nein ID desRegierungsbezirkes,in dem die Orteliegen sollen

regionid integer nein ID der Region, indem die Orte liegensollen

stateid integer nein ID der Staates, indem die Orte liegensollen

zip string nein Postleitzahl-Gebiet,in dem die Orteliegen sollen


1. countyid

2. federalstateid

3. regionid

4. regionareaid

5. stateid


50

6. zip

AusgabeEs wird eine Liste der Orte ausgegeben.

Formatbeschreibung geo.cities: GeoListResponseType (http://api.immonet.de/api/xsd/GeoService.xsd)

Formatbeschreibung location.cities: LocationHierarchieListResponseType (http://api.immonet.de/api/xsd/LocationService.xsd)






51

location.cityAliasesLiefert eine Liste der Alias-Namen für einige Städte.

JSON-RPC XML-RPC

location.cityAliases location.cityAliases


nein nein

Parameterkeine

Bemerkungenkeine

AusgabeEs wird eine Liste der Alias-Namen für einige Städte ausgegeben.

Formatbeschreibung location.cityAliases: LocationHierarchieListResponseType(http://api.immonet.de/api/xsd/LocationService.xsd)



52

location.cityZipsLiefert eine Liste der Orte/Städte und deren Postleitzahlen eines Staates, einesBundeslandes, eines Regierungsbezirkes, einer Region oder eines (Land-)Kreises.

JSON-RPC XML-RPC

location.cityZips location.cityZips


nein nein

ParameterSiehe location.cities

BemerkungenSiehe location.cities. Diese Funktion liefert die Ergebnismenge von location.cities, ergänztum eine Liste der Postleitzahlen für jeden Ort

AusgabeEs wird eine Liste der Orte und ihrer Postleitzahlen ausgegeben.

Formatbeschreibung: LocationHierarchieListResponseType (http://api.immonet.de/api/xsd/LocationService.xsd)




53

{geo|location}.continentsLiefert eine Liste der Kontinente.

JSON-RPC XML-RPC

geo.continents geo.continents

location.continents location.continents


nein nein

Parameterkeine

Bemerkungenkeine

AusgabeEs wird eine Liste der Kontinente ausgegeben.

Formatbeschreibung geo.continents: GeoListResponseType (http://api.immonet.de/api/xsd/GeoService.xsd)

Formatbeschreibung location.continents: LocationHierarchieListResponseType(http://api.immonet.de/api/xsd/LocationService.xsd)





54

{geo|location}.countiesLiefert eine Liste der (Land-)Kreise eines Bundeslandes, eines Regierungsbezirkes oderStaates.

JSON-RPC XML-RPC

geo.counties geo.counties

location.counties location.counties


nein nein

Parameter


federalstateid integer ja ID desBundeslandes,in dem die(Land-)Kreise liegensollen

regionareaid integer nein ID desRegierungsbezirkes,in dem die(Land-)Kreise liegensollen

stateid integer nein ID der Staates,in dem die(Land-)Kreise liegensollen


1. federalstateid

2. regionareaid

3. stateid

AusgabeEs wird eine Liste der (Land-)Kreise ausgegeben.

Formatbeschreibung geo.counties: GeoListResponseType (http://api.immonet.de/api/xsd/GeoService.xsd)

Formatbeschreibung location.counties: LocationHierarchieListResponseType (http://api.immonet.de/api/xsd/LocationService.xsd)






55

{geo|location}.departmentsLiefert eine Liste der Bezirke/Stadtgebiete eines Ortes oder einer Stadt oder eines Staates.

JSON-RPC XML-RPC

geo.departments geo.departments

location.departments location.departments


nein nein

Parameter


cityid integer ja ID des Ortes, dessenBezirke/Stadtgebieteausgegeben werdensollen

stateid integer ja ID des Staates,dessen Bezirke/Stadtgebieteausgegeben werdensollen


1. cityid

2. stateid

AusgabeEs wird eine Liste der Bezirke/Stadtgebiete ausgegeben.

Formatbeschreibung geo.departments: GeoListResponseType (http://api.immonet.de/api/xsd/GeoService.xsd)

Formatbeschreibung location.departments: LocationHierarchieListResponseType(http://api.immonet.de/api/xsd/LocationService.xsd)





56

location.districtAliasesLiefert eine Liste der Alias-Namen für einige Ortsteile.

JSON-RPC XML-RPC

location.districtAliases location.districtAliases


nein nein

Parameterkeine

Bemerkungenkeine

AusgabeEs wird eine Liste der Alias-Namen für einige Ortsteile ausgegeben.

Formatbeschreibung location.districtAliases: LocationHierarchieListResponseType(http://api.immonet.de/api/xsd/LocationService.xsd)



57

{geo|location}.districtsLiefert eine Liste der Orts-/Stadtteile eines Bezirks/Stadtgebiets, eines Ortes oder einerStadt oder eines Staates.

JSON-RPC XML-RPC

geo.districts geo.districts

location.districts location.districts


nein nein

Parameter


cityid integer nein ID des Ortes, dessenOrtsteile/Stadtteileausgegeben werdensollen

departmentid integer nein ID des Bezirks,dessen Ortsteile/Stadtteileausgegeben werdensollen

stateid integer ja ID des Staates,dessen Ortsteile/Stadtteileausgegeben werdensollen


1. cityid

2. departmentid

3. stateid

AusgabeEs wird eine Liste der Orts-/Stadtteile ausgegeben.

Formatbeschreibung geo.districts: GeoListResponseType (http://api.immonet.de/api/xsd/GeoService.xsd)

Formatbeschreibung location.districts: LocationHierarchieListResponseType (http://api.immonet.de/api/xsd/LocationService.xsd)






58

location.districtZipsLiefert eine Liste der Orts-/Stadtteile und deren Postleitzahlen eines Bezirks/Stadtgebiets,eines Ortes oder einer Stadt oder eines Staates.

JSON-RPC XML-RPC

location.districtZips location.districtZips


nein nein

ParameterSiehe location.districts

BemerkungenSiehe location.districts. Diese Funktion liefert die Ergebnismenge von location.districts,ergänzt um eine Liste der Postleitzahlen für jeden Orts-/Stadtteil

AusgabeEs wird eine Liste der Orts-/Stadtteile und ihrer Postleitzahlen ausgegeben.

Formatbeschreibung: LocationHierarchieListResponseType (http://api.immonet.de/api/xsd/LocationService.xsd)




59

{geo|location}.federalstatesLiefert eine Liste der Bundesländer eines Staates.

JSON-RPC XML-RPC

geo.federalstates geo.federalstates

location.federalstates location.federalstates


nein nein

Parameter


stateid integer nein ID des Staates,dessenBundesländerausgegeben werdensollen

BemerkungenKeine

AusgabeEs wird eine Liste der Bundesländer ausgegeben.

Formatbeschreibung geo.federalstates: GeoListResponseType (http://api.immonet.de/api/xsd/GeoService.xsd)

Formatbeschreibung location.federalstates: LocationHierarchieListResponseType(http://api.immonet.de/api/xsd/LocationService.xsd)





60

{geo|location}.findDurchsucht die Geo-Hierarchie nach Namen.

JSON-RPC XML-RPC

geo.find geo.find

location.find location.find


nein nein

Parameter


any String nein Name einesbeliebigen Geo-Objektes

city String nein Name eines Ortes

county String nein Name eines(Land-)Kreises

department String nein Name eines Bezirks

district String nein Name eines Orts-/Stadtteils

federalstate String nein Name einesBundeslandes

region String nein Name einer Region

regionarea String nein Name einesRegierungsbezirkes

state String nein Name eines Staates

BemerkungenEs wird nach nur einem Namen gesucht. Werden mehrere Namen als Parameterübergeben, werden die Parameter nach folgender Reihenfolge verwendet:

1. any

2. city

3. county

4. department

5. district

6. federalstate

7. region

8. regionarea

9. state


61

AusgabeEs wird eine Liste aller Geo-Objekte (je nach Parameter: Ort, Bundesland, Bezirk, etc.)ausgegeben, deren Name die übergebene Zeichenkette enthält. Ist der Name eindeutig,enthält die Liste nur ein Geo-Objekt.

Zu jedem Geo-Objekt werden auch die in der Geo-Hierarchie übergeordneten Geo-Objekteausgegeben. Zum Beispiel zu einem Bezirk der Staat, das Bundesland und der Ort.Hierarchie-Ebenen, die nicht gefüllt sind, werden in der Ausgabe weggelassen.

Formatbeschreibung geo.find: GeoHierarchieListResponseType (http://api.immonet.de/api/xsd/GeoService.xsd)

Formatbeschreibung location.find: LocationHierarchieListResponseType (http://api.immonet.de/api/xsd/LocationService.xsd)






62

{geo|location}.importantCitiesLiefert eine Liste wichtigen Orte/Städte eines Staates, eines Regierungsbezirks oder einesBundeslandes.

JSON-RPC XML-RPC

geo.importantCities geo.importantCities

location.importantCities location.importantCities


nein nein

Parameter


federalstateid integer nein ID desBundeslandes, indem die Orte liegensollen

regionareaid integer nein ID desRegierungsbezirkes,in dem die Orteliegen sollen

stateid integer nein ID des Staates, indem die Orte liegensollen


1. federalstateid

2. regionareaid

3. stateid

AusgabeEs wird eine Liste der Orte ausgegeben.

Formatbeschreibung geo.importantCities: GeoListResponseType (http://api.immonet.de/api/xsd/GeoService.xsd)

Formatbeschreibung location.importantCities: LocationHierarchieListResponseType(http://api.immonet.de/api/xsd/LocationService.xsd)





63

{geo|location}.islandsLiefert eine Liste der Inseln eines Staates.

JSON-RPC XML-RPC

geo.islands geo.islands

location.islands location.islands


nein nein

Parameter


stateid integer nein ID des Staates,dessen Inselnausgegeben werdensollen

BemerkungenKeine

AusgabeEs wird eine Liste der Inseln ausgegeben.

Formatbeschreibung geo.federalstates: GeoListResponseType (http://api.immonet.de/api/xsd/GeoService.xsd)

Formatbeschreibung location.federalstates: LocationHierarchieListResponseType(http://api.immonet.de/api/xsd/LocationService.xsd)





64

{geo|location}.regionareasLiefert eine Liste der Regierungsbezirke eines Bundeslandes oder Staates.

JSON-RPC XML-RPC

geo.regionareas geo.Regionareas

location.regionareas location.Regionareas


nein nein

Parameter


federalstateid integer ja ID desBundeslandes,dessenRegierungsbezirkeausgegeben werdensollen

stateid integer ja ID des Staates,dessenRegierungsbezirkeausgegeben werdensollen


1. federalstateid

2. stateid

AusgabeEs wird eine Liste der Regierungsbezirke ausgegeben.

Formatbeschreibung geo.regionareas: GeoListResponseType (http://api.immonet.de/api/xsd/GeoService.xsd)

Formatbeschreibung location.regionareas: LocationHierarchieListResponseType(http://api.immonet.de/api/xsd/LocationService.xsd)





65

{geo|location}.regionsLiefert eine Liste der Regionen eines Staates oder Bundeslandes.

JSON-RPC XML-RPC

geo.regions geo.Regions

location.regions location.Regions


nein nein

Parameter


federalstateid integer nein ID desBundeslandes,dessen Regionenausgegeben werdensollen

stateid integer nein ID des Staates,dessen Regionenausgegeben werdensollen

BemerkungenEs wird entweder nach der federalstateid oder nach der stateid gesucht. Werden mehrereIDs als Parameter übergeben, wird die federalstateid verwendet.

AusgabeEs wird eine Liste der Regionen ausgegeben.

Formatbeschreibung geo.regions: GeoListResponseType (http://api.immonet.de/api/xsd/GeoService.xsd)

Formatbeschreibung location.regions: LocationHierarchieListResponseType (http://api.immonet.de/api/xsd/LocationService.xsd)






66

{geo|location}.statesLiefert eine Liste der Staaten eines Kontinents.

JSON-RPC XML-RPC

geo.states geo.states

location.states location.states


nein nein

Parameter


continentid integer nein ID des Kontinents,dessen Staatenausgegeben werdensollen

Bemerkungenkeine

AusgabeEs wird eine Liste der Staaten ausgegeben.

Formatbeschreibung geo.states: GeoListResponseType (http://api.immonet.de/api/xsd/GeoService.xsd)

Formatbeschreibung location.states: LocationHierarchieListResponseType (http://api.immonet.de/api/xsd/LocationService.xsd)






67

location.streetMultiZipLiefert alle Postleitzahlen zu einer Stadt und Strasse.

JSON-RPC XML-RPC

location.streetMultiZip location.streetMultiZip


nein nein

Parameter


street string ja Strasse (undHausnummer)

cityid integer ja Id eines Ortes

Bemerkungenkeine

AusgabeEs wird eine Liste der Postleitzahlen ausgegeben.

Formatbeschreibung location.streetMultiZip: LocationStreetMultiZipResponseType(http://api.immonet.de/api/xsd/LocationService.xsd)



68

location.streetZipLiefert die Postleitzahl einer Strasse.

JSON-RPC XML-RPC

location.streetZip location.streetZip


nein nein

Parameter


street string ja Strasse (undHausnummer)

ziporcity string ja Postleitzahl oder Ort

Bemerkungenkeine

AusgabeEs wird eine Postleitzahl ausgegeben.


69

{geo|location}.zipLiefert eine Liste der Postleitzahlen zu einem Ort oder Orts-/Stadtteil.

JSON-RPC XML-RPC

geo.zip geo.zip

location.zip location.zip


nein nein

Parameter


cityid integer nein ID des Ortes

districtid integer nein ID des Orts-/Stadtteils


1. cityid

2. districtid

AusgabeEs wird eine Liste der Postleitzahlen ausgegeben.

70

Kapitel 10. memo.* - MerkzettelFunktionen zur Verwaltung von Merkzetteln.

Jeder Merkzettel kann mehrere Listen enthalten, in denen Immobilienobjekte und Notizengespeichert werden können:

Objekt object id= 21234Not iz: "Das erste Objekt "

Objekt object id= 25678Not iz: "Das zweite Objekt "

Objekt object id= 29012Not iz: "Das drit te Objekt "

Liste list t it le= "Zweite Liste"

Objekt object id= 11234Not iz: "Das erste Objekt "

Objekt object id= 15678Not iz: "Das zweite Objekt "

Objekt object id= 19012Not iz: "Das drit te Objekt "

Liste list t it le= "Erste Liste"

Merkzet tel m em oid= 1234

Aufbau Merkzettel/-listen

Die Merkzettel werden in der Immonet-Datenbank gespeichert und können jederzeit überihre Id abgerufen, manipuliert und gelöscht werden.

Warnung

Jeder Merkzettel wird künftig nur noch aus einer Objekt-Liste bestehen. Die Listen-Funktionen werden in einer der nächsten Versionen entfernt. Sie sollten nicht mehrbenutzt werden

memo.* - Merkzettel

71

memo.{addObject|addOjectAuth}Objekt zu einer Liste in einem Merkzettel hinzufügen.

JSON-RPC XML-RPC

memo.addObject memo.addObject

memo.addObjectAuth memo.addObjectAuth



Parameter


listtitle String nein Name der Merkzettel-Liste, zu der dasObjekt hinzugefügtwerden soll

memoid Integer ja, beiVerwendung derAuthentifizierung:nein

Id des Merkzettels

note String nein Notiz zum Objekt

address MemoAddressType nein Adresse zum Objekt

contacted String nein Wurde dasMerkzettel-Objekt kontaktiert("yes"|"no")

objectid Integer ja Immonet-Id desObjektes, das derListe hinzugefügtwerden soll

useridentification string nein Benötigt füraddOjectAuth.(siehe Kapitel 3,Authentifizierung)

authenticationhash string nein Benötigt füraddOjectAuth.(siehe Kapitel 3,Authentifizierung)

BemerkungenWird der Parameter "listtitle" weggelassen, wird die Standard-Liste im Merkzettel benutzt.Eine Liste wird angelegt, wenn ein "listtitle" übergeben wird und die Liste noch nichtvorhanden ist.


memo.* - Merkzettel

72

memo.{clone|cloneAuth}Kopie eines Merkzettels anlegen.

JSON-RPC XML-RPC

memo.clone memo.clone

memo.cloneAuth memo.cloneAuth



Parameter


memoid Integer ja Id des Merkzettels,der kopiert werdensoll

useridentification string nein Benötigt fürcloneAuth.(siehe Kapitel 3,Authentifizierung)

authenticationhash string nein Benötigt fürcloneAuth.(siehe Kapitel 3,Authentifizierung)

Bemerkungenkeine

AusgabeEs wird die Id der Merkzettel-Kopie ausgeben.

memo.* - Merkzettel

73

memo.completeKompletten Merkzettel abfragen.

JSON-RPC XML-RPC

memo.complete memo.complete


nein nein

Parameter


memoid Integer ja Id des Merkzettels

Bemerkungenkeine

AusgabeEs wird der komplette Merkzettel mit allen Listen und den darin gespeicherten Objekt-Notizen ausgegeben.Unix-Timestamps geben an, wann der Merkzettel erzeugt (tscreate)bzw. zuletzt geändert wurde (tsupdate).

Formatbeschreibung: MemoCompleteResponseType (http://api.immonet.de/api/xsd/MemoService.xsd)



memo.* - Merkzettel

74

memo.createNeuen Merkzettel anlegen.

JSON-RPC XML-RPC

memo.create memo.create


nein nein

Parameterkeine

Bemerkungenkeine

AusgabeEs wird die Id des neuen Merkzettels ausgeben.

memo.* - Merkzettel

75

memo.{delete|deleteAuth}Merkzettel löschen.

JSON-RPC XML-RPC

memo.delete memo.delete

memo.deleteAuth memo.deleteAuth



Parameter



Id des Merkzettels

useridentification string nein Benötigt fürdeleteAuth.(siehe Kapitel 3,Authentifizierung)

authenticationhash string nein Benötigt fürdeleteAuth.(siehe Kapitel 3,Authentifizierung)

Bemerkungenkeine


memo.* - Merkzettel

76

memo.{deleteObject|deleteObjectAuth}Objekt aus Liste in Merkzettel löschen.

JSON-RPC XML-RPC

memo.deleteObject memo.deleteObject

memo.deleteObjectAuth memo.deleteObjectAuth



Parameter


listtitle String nein Name der Merkzettel-Liste, aus der dasObjekt gelöschtwerden soll


Id des Merkzettels

objectid Integer ja Immonet-Id desObjektes, das ausder Liste gelöschtwerden soll

useridentification string nein Benötigt fürdeleteObjectAuth.(siehe Kapitel 3,Authentifizierung)

authenticationhash string nein Benötigt fürdeleteObjectAuth.(siehe Kapitel 3,Authentifizierung)

BemerkungenWird der Parameter "listtitle" weggelassen, wird die Standard-Liste im Merkzettel benutzt


memo.* - Merkzettel

77

memo.{friend|friendAuth}Merkzettel-Liste an einen Freund schicken.

JSON-RPC XML-RPC

memo.friend memo.friend

memo.friendAuth memo.friendAuth



Parameter


listtitle String nein Name der Merkzettel-Liste, die verschicktwerden soll


Id des Merkzettels

senderemail EmailAddressType ja E-Mail-Adresse desAbsenders

email EmailAddressType ja E-Mail-Adresse desEmpfängers

comment string nein Kommentar desAbsenders

useridentification string nein Benötigt fürfriendAuth.(siehe Kapitel 3,Authentifizierung)

authenticationhash string nein Benötigt fürfriendAuth.(siehe Kapitel 3,Authentifizierung)



memo.* - Merkzettel

78

memo.{objects|objectsAuth}Die Objekte einer Liste in einem Merkzettel abfragen.

JSON-RPC XML-RPC

memo.objects memo.objects

memo.objectsAuth memo.objectsAuth



Parameter


listtitle String nein Name der Merkzettel-Liste, deren Objekteausgegeben werdensollen

memoid Integer ja Id des Merkzettels

useridentification string nein Benötigt fürobjectsAuth.(siehe Kapitel 3,Authentifizierung)

authenticationhash string nein Benötigt fürobjectsAuth.(siehe Kapitel 3,Authentifizierung)


AusgabeEs wird eine Liste der Objekte in der angegebenen Merkzettel-Liste ausgegeben. Zu jedemObjekt werden jeweils die Immonet-Id und die gespeicherte Notiz ausgegeben.

Formatbeschreibung: MemoObjectsResponseType (http://api.immonet.de/api/xsd/MemoService.xsd)



memo.* - Merkzettel

79

memo.memoMemoByPersonIdOrEmailListe in einem Merkzettel umbenennen.

JSON-RPC XML-RPC

memo.memoByPersonIdOrEmail memo.memoByPersonIdOrEmail


ja nein

Parameter


useridentification string ja PersonId, E-Mail-Addresse oderBenutzername desregistierten Immonet-Nutzers für den derMerkzettel geholtwerden soll.

authenticationhash string ja Authentifizierungs-Hash (sieheKapitel 3,Authentifizierung)

BemerkungenFalls für die Funktionen memo.complete, memo.create oder memo.setPerson eineAuthentifizierung benötigt wird kann stattdessen diese Methode eingesetzt werden.

AusgabeDie Methode holt anhand der E-Mail-Adresse oder PersonId den Merkzettel einesregistierten Immonet-Nutzers. Wenn kein Merkzettel zu dieser E-Mail-Adresse oderPersonId vorhanden ist, dann wird ein neuer personalisierter Merkzettel angelegt. DieVerknüpfung zwischen der Person und dem neuangelegten Merkzettel wird für zukünftigenGebrauch hergestellt und zurückgeliefert.

80

Kapitel 11. option.* - Kategorien/Typen

Funktionen zur Ausgabe der Kategorien und Typen, nach denen die Immobilien-Objekte inder Immonet-Datenbank strukturiert sind.

Diese Funktionen überstützen die Generierung von Auswahllisten in Suchformularen.

option.* - Kategorien/Typen

81

option.featuresLiefert zu einer Immobilienart und einer Vertriebsart eine Liste der Ausstattungsmerkmale,die in der Immonet-Datenbank vorhanden sind.

JSON-RPC XML-RPC

option.features option.features


nein nein

Parameter


parentcatid integer ja ID der Immobilienart

marketingtypeid integer ja ID der Vertriebsart

Bemerkungenkeine

AusgabeEs wird eine Liste der Ausstattungsmerkmale ausgegeben.

Formatbeschreibung: OptionInfoListResponseType (http://api.immonet.de/api/xsd/OptionService.xsd)




82

option.marketingtypesLiefert eine Liste der Vertriebsarten (Kauf, Miete, etc.), die in der Immonet-Datenbankvorhanden sind.

JSON-RPC XML-RPC

option.marketingtypes option.marketingtypes


nein nein

Parameterkeine

Bemerkungenkeine

AusgabeEs wird eine Liste der Vertriebsarten ausgegeben.





83

option.objectcatsLiefert eine Liste der Immobilienarten (Einfamilienhaus, Grundstück, Bürofläche, etc.), diein der Immonet-Datenbank vorhanden sind.

JSON-RPC XML-RPC

option.objectcats option.objectcats


nein nein

Parameterkeine

Bemerkungenkeine

AusgabeEs wird eine Liste der Immobilienarten ausgegeben.





84

option.objectstatesLiefert eine Liste der Objektzustände (Neubau, neuwertig, saniert, etc.), die in derImmonet-Datenbank vorhanden sind.

JSON-RPC XML-RPC

option.objectstates option.objectstates


nein nein

Parameterkeine

Bemerkungenkeine

AusgabeEs wird eine Liste der Objektzustände ausgegeben.





85

option.objecttypeParentcatsLiefert zu einem Immobilientyp eine Liste der Immobilienarten, die in der Immonet-Datenbank vorhanden sind.

JSON-RPC XML-RPC

option.objecttypeParentcats option.objecttypeParentcats


nein nein

Parameter


objecttypeid integer ja ID desImmobilientyps

Bemerkungenkeine

AusgabeEs wird eine Liste der Immobilienarten ausgegeben.





86

option.objecttypesLiefert eine Liste der Immobilientypen (Wohnen, Anlage, Gewerbe, etc.), die in derImmonet-Datenbank vorhanden sind.

JSON-RPC XML-RPC

option.objecttypes option.objecttypes


nein nein

Parameterkeine

Bemerkungenkeine

AusgabeEs wird eine Liste der Immobilientypen ausgegeben.





87

option.parentcatsLiefert eine Liste der grundlegenden Immobilienarten (Einfamilienhaus, Grundstück,Bürofläche, etc.), die in der Immonet-Datenbank vorhanden sind.

JSON-RPC XML-RPC

option.parentcats option.parentcats


nein nein

Parameterkeine

Bemerkungenkeine

AusgabeEs wird eine Liste der grundlegenden Immobilienarten ausgegeben.





88

option.pricesLiefert eine Liste der Preisbezeichnungen, die in der Immonet-Datenbank vorhanden sind.

JSON-RPC XML-RPC

option.prices option.prices


nein nein

Parameterkeine

Bemerkungenkeine

AusgabeEs wird eine Liste der Preisbezeichnungen ausgegeben.





89

option.searchfeatureFeaturesLiefert alle Searchfeatures mit ihrer Feature-Zuordnung.

JSON-RPC XML-RPC

option.searchfeatureFeatures option.searchfeatureFeatures


nein nein

Parameterkeine

Bemerkungenkeine

AusgabeEs wird eine Liste aller Searchfeatures mit ihrer Feature-Zuordnung ausgegeben.

Formatbeschreibung: OptionSearchfeatureFeaturesResponseType (http://api.immonet.de/api/xsd/OptionService.xsd)




90

option.searchfeaturesLiefert zu einer Immobilienart eine Liste der Suchfeatures, die in der Immonet-Datenbankvorhanden sind.

JSON-RPC XML-RPC

option.searchfeatures option.searchfeatures


nein nein

Parameter


objectcatid integer ja ID der Immobilienart

Bemerkungenkeine

AusgabeEs wird eine Liste der Suchfeatures ausgegeben.




91

Kapitel 12. search.* - SucheDie Suchfunktionen der Immonet-API ermöglichen eine flexible Suche im Immobilien-Datenbestand. Angeboten werden

• eine freie Suche, die es ermöglicht, die kompletten Exposes und Immobilien-Kategorienzu durchsuchen,

• und eine hierarchische (Felder-)Suche, die die Treffermenge über geografischeMerkmale (Staat, Bundesland, Ort, Stadtteil,...) eingrenzt.

Um zu verhindern, dass über die Suche die Immobilien-Datenbank ausgelesen wird,beschränkt die API die Anzahl der Suchtreffer, die ausgeliefert werden. Die Anzahl wirdfür jede Anwender-ID individuell festgelegt und kann über die Meta-Funktion system.limitsabgerufen werden (ein typischer Wert sind 1000 Treffer).

search.* - Suche

92

search.fieldinfosFührt eine Felder-Suche in der Objekt-Datenbank aus und liefert eine Statistik übergefundene Orte, Ortsteile, Immobilienarten, Immobilientypen und Ausstattungsmerkmale.

JSON-RPC XML-RPC

search.fieldinfos search.fieldinfos


nein ja

ParameterSiehe „search.fields“

BemerkungenSiehe „search.fields“

AusgabeEs werden mehrere Statistiklisten und die Tracking-URL ausgegeben.

Formatbeschreibung: SearchFieldinfosResultType (http://api.immonet.de/api/xsd/SearchService.xsd)



search.* - Suche

93

search.fieldsFührt eine Felder-Suche in der Objekt-Datenbank aus und liefert eine Liste mitKurzbeschreibungen der gefundenen Objekte.

JSON-RPC XML-RPC

search.fields search.fields


nein ja

Parameter


query array/hash ofSearchFieldType

ja Begriffe, nach denengesucht werden soll

sortby array ofSortFieldType

nein siehe Abschnitt:„Anwendung vonsortby“

first integer nein Nummer desersten Treffers, derausgegeben werdensoll. Der erste Trefferhat die Nummer 1.Defaultwert: 1

count integer nein Anzahl der Treffer,die ausgegebenwerden sollen.Defaultwert: 10

responsefields Array of strings/Maps nein siehe Abschnitt:„Anwendung vonresponsefields“

BemerkungenDie folgenden Felder können in der Feldersuche durchsucht werden:

Tabelle 12.1. Suchfelder der Feldersuche

Feldname Datentyp Bedeutung

bourse integer ID der Börse. Wenn gesetzt,werden folgende Parameternicht berücksichtigt:continent, county, hnr,region, regionarea, street,searchfeature

city integer ID der Stadt (geo.cities)

continent integer ID des Kontinentes(geo.continents)

county integer ID des Landkreises(geo.counties)

search.* - Suche

94

Feldname Datentyp Bedeutung

department integer ID des Stadtgebietes(geo.departments)

district integer ID des Stadtteils(geo.districts)

encodedpolygonlist Array of Array of string Außeres Array: Arrayvon Polygonen, inneresArray: Array von codiertenPolylinien (https://developers.google.com/maps/documentation/utilities/polylinealgorithm). ErsterEintrag: UmschließendesPolygon. Optionale weitereEinträge: Löcher imumschließenden Polygon.

facilities Array of integer ID derAusstattungsmerkmale(option.features)

federalstate integer ID des Bundeslandes(geo.federalstates)

fromarea dezimal Mindestfläche

fromplotarea dezimal Mindestgrundstücksgröße

fromprice dezimal Mindestpreis

fromrooms dezimal Mindestanzahl Räume/Zimmer

hnr string Hausnummer

markasnewreferencedate long (Unix-timestamp) Bei Angabe eines Unix-Timestamps, werdenObjekte die nach derangegebenen Zeit erstelltwurden, mit dem Parameternew als Neu markiert. (AbVersion 2.3)

marketingtype integer ID der Vertriebsart(option.marketingtypes)

objectcat integer ID der Immobilienart(option.objectcats)

objecttype integer ID der Objekt-Typ-Hauptkategorie(option.objecttypes)

parentcat integer ID der grundlegendenImmobilienart(option.parentcats)

polygonlist Array of Array ofGeolocationType

Außeres Array: Array vonPolygonen, inneres Array:Array von GeolocationType(http://api.immonet.de/api/xsd/immonet.xsd)

projectrelation string Flag für das Filternnach Objekte mit

https://developers.google.com/maps/documentation/utilities/polylinealgorithm






search.* - Suche

95

Feldname Datentyp BedeutungProjektzugehörigkeit(Default: false)

radius dezimal Radius in Kilometern(Default: 0, wenn nach derPostleitzahl gesucht wird)

region integer ID der Region

regionarea integer ID des Regierungsbezirkes

sft string Ausstattung des Objektes(Balkon, etc.). MehrereAusstattungsmerkmale durchKomma getrennt auflisten.

state integer ID des Landes (Default: 1 =Deutschland)

street string Strasse

toarea dezimal Maximalfläche

toplotarea dezimal Maximalgrundstücksgröße

toprice dezimal Maximalpreis

torooms dezimal Maximalanzahl Räume/Zimmer

zip string Postleitzahl

Übersteigt die Summe der Parameter first(-1) und count die maximale Anzahl derSuchtreffer für den Anwender, so werden diese Parameter automatisch heruntergesetzt.Dabei wird zunächst versucht, den Wert von first soweit zu verkleinern, dass die in countangegebene Anzahl der gewünschten Treffer geliefert werden kann. Sollte das nichtausreichen, wird auch der Wert von count verkleinert.

Beispiele (maximale Anzahl = 1000):

first = 901, count = 200 => first = 801, count = 200 first = 901, count = 1500 => first = 1, count = 1000

Einschränkungen für Polygone

Die Fläche der Polygone ist in der Größe nach oben und unten begrenzt.

• Miminum: 0,785 qm (Entspricht einem Umkreis von 0,5 km). Die Beschränkung gilt fürdie Fläche eines Polygons.

• Maximum: 7850 qm (Entspricht einem Umkreis von 50 km). Die Beschränkung gilt fürdie Summe der Fläche aller angegebenen Polygone.

Anwendung von sortby

Der Parameter beschreibt die Namen der Felder und die Sortierrichtungen („asc“ =steigend, „desc“ = fallend) nach denen die Suchergebnisliste sortiert werden soll. Wirdkein Feld angegeben, wird nach Preis steigend sortiert. Folgende Felder können für dieSortierung verwendet werden: city, district, livingarea, plotsize, price, rooms. Ein kurzesPHP-Beispiel für die Anwendung von "sortby" sieht so aus:

$client->call('search.fields', (object)array('query' => array('city' => '12345'),

search.* - Suche

96

'sortby' => array(array('name' => 'rooms', 'order' => 'desc')),'count' => '10')

Anwendung von responsefields

Der Parameter gibt an, welche Felder in der Antwort enthalten sein sollen. Dabei musseine spezielle Struktur eingehalten werden. Ein kurzes PHP-Beispiel für die Anwendungvon "responsefields" sieht so aus:

print_r( $client->call( 'search.fields', (object)array( 'query' => array( 'encodedpolygonlist' => array( array('gbcfIgz|{@pgAaeTxkHjwCkkBdpV_hGmbF') ), 'version' => '2.3' ), 'count' => '2', 'responsefields' => array( 'trackingurl', (object)array('result' => array( 'first', 'found', (object)array('hits' => array( 'immonetid', 'city', (object)array('livingarea' => array('value')), (object)array('price' => array('name')), 'area' ) ) ) ) ) ) ) );

Dabei ist zu beachten, dass die gewünschten Objektfelder unter dem Parameterresponsefields.result.hits in einem Array angegeben werden müssen. Zusätzlich könnendiese Felder durch eine Array Verschachtelung weiter eingegrenzt werden.

AusgabeEs wird eine Liste der gefundenen Objekte und die Tracking-URL ausgegeben.

Formatbeschreibung: SearchResponseType (http://api.immonet.de/api/xsd/SearchService.xsd)



search.* - Suche

97

search.oowDurchsucht die Objekt-Datenbank nach Objekten, die für die aktuelle Woche als Objekt derWoche markiert sind. Liefert eine Liste mit Kurzbeschreibungen der gefundenen Objekte.

JSON-RPC XML-RPC

search.oow search.oow


nein ja

Parameterkeine

BemerkungenEs gibt genau fünf Objekte der Woche.

AusgabeEs wird eine Liste der gefundenen Objekte und die Tracking-URL ausgegeben.

Formatbeschreibung: SearchResponseType (http://api.immonet.de/api/xsd/SearchService.xsd)



98

Kapitel 13. session.* - SessionsFunktionen für das Session-Management.

session.* - Sessions

99

session.closeBeendet die aktuelle Session.

JSON-RPC XML-RPC

session.close session.close


ja nein

Parameterkeine

BemerkungenWenn die aktuelle Session nicht mehr gültig ist, löst der Aufruf dieser Funktion einenFehler aus.

AusgabeWenn die aktuelle Session noch gültig ist, wird ein leeres Antwort-Paket zurückgegeben.


100

session.openStartet eine neue Session.

JSON-RPC XML-RPC

session.open session.open


nein nein

Parameterkeine

Bemerkungenkeine

AusgabeEs wird die ID der gestarteten Session zurückgegeben.


101

session.pingPrüft, ob die aktuelle Session noch gültig ist.

JSON-RPC XML-RPC

session.ping session.ping


ja nein

Parameterkeine

BemerkungenDurch den Aufruf dieser Funktion wird die Zeitmessung für die aktuelle Session neugestartet. Wenn die aktuelle Session nicht mehr gültig ist, löst der Aufruf dieser Funktioneinen Fehler aus.

AusgabeWenn die aktuelle Session noch gültig ist, wird ein leeres Antwort-Paket zurückgegeben.

102

Kapitel 14. system.* - Meta-Funktionen

Mit Hilfe der Meta-Funktionen können Anwender Informationen über die API selbstabrufen.

system.* - Meta-Funktionen

103

system.limitsLiefert eine Liste der Limits, die für die Anwender-ID gelten, die in der Service-URLübergeben wurde (URL-Parameter uid).

JSON-RPC XML-RPC

system.limits system.limits


nein nein

Parameterkeine

Bemerkungenkeine

AusgabeEin Datenpaket mit den aktuellen Limits.


104

system.listMethodsLiefert eine Liste der Funktionen, die mit der Anwender-ID benutzt werden dürfen, die inder Service-URL übergeben wurde (URL-Parameter uid).

JSON-RPC XML-RPC

system.listMethods system.listMethods


nein nein

Parameterkeine

Bemerkungenkeine

AusgabeEine Liste mit den Namen der erlaubten Methoden.


105

system.versionVersion der API abrufen

JSON-RPC XML-RPC

system.version system.version


nein nein

Parameterkeine

Bemerkungenkeine

AusgabeEin String mit der aktuellen Versionsbezeichnung der API.

106

Kapitel 15. statistics.* - ExposeStatistiken

Schreibt die Statistiken würde Expose Ansicht und Kontakte.

statistics.* - Expose Statistiken

107

statistics.writeSchreibt die Statistiken würde Expose Ansicht und Kontakte.

JSON-RPC XML-RPC

statistics.write statistics.write


nein nein

Parameter


type String ja EXPOSEHIT,CONTACTHIT,PHONEHIT,FORWARDHIT,BROKERURLHIT

objectid integer ja ID des Objekt

personid integer nein ID des Objekt-Anbieters

Bemerkungenkeine

AusgabeEin Datenpaket mit den aktuellen Limits.

108

Kapitel 16. user.* - BenutzerFunktionen für den Abruf von Infos über einen Benutzer.

user.* - Benutzer

109

user.* - Benutzer

110

user.saltErmittlung eines Salts für den übergebenen Benutzer.

JSON-RPC XML-RPC

user.salt user.salt


nein nein

Parameter


useridentification String ja E-Mail oderPersonen-ID desBenutzers

BemerkungenKeine.

AusgabeSalt

Date post:	07-Feb-2018
Category:	Documents
Upload:	vodan
View:	263 times
Download:	7 times

Webservices für Immonet Immonet-APIapi.immonet.de/doc/Immonet-API_Handbuch.pdf · 3 Kapitel 2....

Documents