Listen und Regionen

Hier erfahren Sie alles über Abfragen von kompletten Immobilienbeständen nach Regionen oder Umkreis. Es wird auch erklärt, wie man auf den eigenen Bestand zugreifen kann.

Regionen ermitteln

Für eine Suche nach einer Region benötigt man mindestens drei Buchstaben die als Parameter "q" übergeben werden. Anhand dieser Buchstaben wird eine Autovervollständigung ausgeführt. So erhält man für den Wert "Ber" beispielsweise "Berlin", "Berlin-Kreuzberg" sowie auch "Bergkamen" zurück.

<?php

$aParameter = array('q'=>'Ber');
$res = $oImmocaster->getRegions($aParameter);

?>

Rückgabe

Als Rückgabe erhält man eine Liste mit allen Regionen die mit "Ber" beginnen. Diese Liste enthält neben dem Namen der Region auch die Geo-ID und die Anzahl der gefundenen Objekte in der Region. Eine Liste könnte in etwa so aussehen.

<region:regions xmlns:region="http://rest.immobilienscout24.de/schema/search/region/1.0">
    <region>
        <name>Berlin</name>
        <geoCodeId>1276003001</geoCodeId>
        <amount>10026</amount>
    </region>
    <region>
        <name>Berlin-Spandau (Spandau)</name>
        <geoCodeId>1276003001063</geoCodeId>
        <amount>686</amount>
    </region>
    ...
</region:regions>

Parameter

q - Der Pflichtparameter "q" muss einen String übergeben, der aus mindestens drei Buchstaben besteht. Dieser String steht für die jeweilige Region, die gesucht wird. Z.b. wird bei der Suche nach "ber" u. A. die Stadt Berlin gefunden.

realEstateType - Sobald man der Funktion den Parameter "realEstateType" mitgibt, erhält man die Anzahl der Objekte des jeweiligen Typs als "amount" im Ergebnis zurück.

GIS - Geo Service

Die ImmobilienScout24 API benötigt oftmals GeoCode-IDs um Regionen eindeutig zu identifizieren. Um diese IDs zu ermitteln steht einem die Funktion zum ermitteln von Regionen zur Verfügung, bei der die ID anhand des Namen der Region gesucht wird. Für den umgekehrten Weg benötigt man folgende Funktion, die anhand der ID den Namen der Region zurückliefert.

<?php

$aParameter = array('country-id'=>276,'region-id'=>2,'list'=>true);
$res = $oImmocaster->geoService($aParameter);

?>

Rückgabe

Man erhält für das obige Beispiel die Daten (alle Städte bzw. Kreise) für Bayern, da als "country-id" die 276 hinterlegt wurde. Die 276 steht für Deutschland. Als "region-id" wurde die 2 (für Bayern) hinterlegt. Das Ergebnis würde folgendermaßen aussehen.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<gis:cities xmlns:gis="http://rest.immobilienscout24.de/schema/platform/gis/1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
    <City creation="2011-06-28T15:58:59.220+02:00" modification="2011-06-28T15:58:59.220+02:00" label="Aichach-Friedberg (Kreis)" id="1" xlink:href="http://rest.immobilienscout24.de/restapi/api/gis/v1.0/country/276/region/2/city/1"/>
    <City creation="2011-06-28T15:58:59.220+02:00" modification="2011-06-28T15:58:59.220+02:00" label="Altötting (Kreis)" id="2" xlink:href="http://rest.immobilienscout24.de/restapi/api/gis/v1.0/country/276/region/2/city/2"/>
    <City creation="2011-06-28T15:58:59.220+02:00" modification="2011-06-28T15:58:59.220+02:00" label="Amberg" id="3" xlink:href="http://rest.immobilienscout24.de/restapi/api/gis/v1.0/country/276/region/2/city/3"/>
    ...
</gis:cities>

Würde man den Parameter "list" von true auf false ändern, so würde man lediglich die ausgewählte Region (Bayern) erhalten für die man die ID übergeben hat. Somit würde also das Ergebnis für dieses Beispiel so aussehen:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<gis:region xmlns:gis="http://rest.immobilienscout24.de/schema/platform/gis/1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
    <name>Bayern</name>
    <geoCodeId>2</geoCodeId>
</gis:region>

Parameter

list - Der Parameter "list" muss einen Boolean-Wert haben und ist ein Pflichtparameter. Mit "true" gibt man an, dass man eine komplette Liste als Rückgabewert haben möchte. Bei "false" erhält man lediglich die Infos zur gewünschten Region, ohne die nächst kleinere Einheit (Land>Bundesland>Stadt>Bezirk).

country-id - Die ID für das jeweilige Land.

region-id - Die ID für die jeweilige Region.

city-id - Die ID für die jeweilige Stadt.

quarter-id - Die ID für den jeweiligen den jeweiligen Bezirk.