Objekte

Hier erfahren Sie, wie Sie erweiterte Zusatzinformationen über ein Objekt abfragen.

Wichtig: Die Expose-Berechtigng ist in der API-Registrierung nur dann enthalten, wenn Sie die Option "Objekte eines bestimmten Anbieters/Börse auswählen". Die andere Option "IS24-Komplettbestand enthält nämlich nicht die Expose-Berechtigung.

Objekt aufrufen

Für das auslesen eines kompletten Datensatz für ein Objekt benötigt man die ID des Objekts. Diese ID erhält man z.B. über die "Suche nach Radius" oder die "Suche nach ID (GeoCode)". Anschließend kann folgende Funktion mit dieser ID aufgerufen werden:

<?php

$aParameter = array('exposeid'=>12345678);
$res = $oImmocaster->getExpose($aParameter);

?>

Wichtig: Über die oben genannte Methode erhält man nur Objekte, die in der Administration von IS24 mit "Für Homepage veröffentlichen" markiert wurden. Möchte man z.B. auf eigene Objekte zugreifen, auch wenn diese nicht veröffentlicht sind, muss man zuerst die Applikation zertifizieren. Anschließend kann man folgenden Code ausführen:

<?php

$aParameter = array('username' => 'me','exposeid' => '12345678');
print_r($oImmocaster->getUserExpose($aParameter));

?>

Rückgabe

Die Funktion liefert neben allen Daten (Preis, Größe, Informationen, Heizarten, usw.) auch alle Attachments (z.B. Links zu Bilder) des Objekts zurück.

Parameter

exposeid - Die ID des Exposes ist ein Pflichtparameter. Dieser Parameter steht für die eindeutige ID des Objektes. Arbeitet man mit eigenen Objekten und möchte ein Objekt anhand einer eigenen ID aufrufen, so gibt man als "exposeid" einfach seine ID an und hängt davor ein "ext-" (z.B. "ext-12345678").

username - Wird nur beim Aufruf eigener Objekte über die Offer-API benötigt. Hier kann "me" für den eigenen Usernamen verwendet werden. Dafür muss die Applikation zertifiziert werden. ***Wichtig: wenn Sie das SDK für mehrere Accounts verwenden, können Sie nicht mit "me" arbeiten, sondern müssen den Benutzernamen der jeweiligen Accounts eintragen.

Attachments ermitteln

Entwickelt man eine Anwendung bei der die Medienelemente (z.B. Bilder) der Objekte im Vordergrund stehen, benötigt man evtl. nur die Mediendaten und nicht die kompletten Informationen zum Objekt. Hierfür steht die Funktion "getAttachment" zur Verfügung:

<?php

$aParameter = array('exposeid'=>12345678);
$res = $oImmocaster->getAttachment($aParameter);

?>

Rückgabe

Mit der genannten Funktion erhält man alle Anhänge (Multimedia-Daten) für ein Objekt.

Parameter

exposeid - Die ID des Exposes ist ein Pflichtparameter. Dieser Parameter übergibt die eindeutige ID des Objektes, dessen Anhänge ausgelesen werden sollen.

attachmentid - Optional kann der Funktion der Parameter "attachmentid" mit der ID des Anhangs (z.B. ein Bild) mitgegeben werden um nur diesen einzelnen Anhang auszulesen.

Kontaktanfrage senden

Um dem Anbieter eines Objekts eine Anfrage zu senden benötigt man die Objekt-ID und muss zusätzlich einen Request-Body zusammenstellen und als String übergeben. Die Vorlage für diesen gibt es unter: http://developerwiki.immobilienscout24.de/wiki/Contact/POST

<?php

$sRequestBody = '<expose:contactForm
  xmlns:expose="http://rest.immobilienscout24.de/schema/search/expose/1.0"
  xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://rest.immobilienscout24.de/schema/search/expose/1.0 expose-1.0.xsd"
  contactFormType="EMAIL">
  <firstname>firstname</firstname>
  <lastname>lastname</lastname>
  <phoneNumber>phoneNumber</phoneNumber>
  <emailAddress>emailAddress@mail.de</emailAddress>
  <appointmentRequested>YES</appointmentRequested>
  <message>message</message>
  <address xsi:type="common:Address">
    <street>street</street>
    <houseNumber>houseNumber</houseNumber>
    <postcode>12345</postcode>
    <city>city</city>
  </address>
</expose:contactForm>';	
$aContactParameter = array('exposeid'=>'12345678','request_body'=>$sRequestBody);
$resContact = $oImmocaster->sendContact($aContactParameter);

?>

Rückgabe

Die Funktion liefert Informationen über die Kontaktanfrage zurück.

Parameter

exposeid - Die Expose-ID des Anbieters, an den der Kontakt gesendet werden soll.

request_body - Der Request-Body wird als XML per String übergeben und enthält alle Infos für den Versand. Infos gibt es unter http://developerwiki.immobilienscout24.de/wiki/Contact/POST

Impressum auslesen

Für das auslesen des Impressums, dass einem Objekt zugeordnet ist, benötigt man lediglich die ID des Objekts. Mit dieser ID kann dann folgende Funktion aufgerufen werden:

<?php

$aParameter = array('exposeid'=>12345678);
$res = $oImmocaster->getExposeImprint($aParameter);

?>

Rückgabe

Die Funktion liefert alle Informationen zurück, die der User für das Impressum des Exposes hinterlegt hat.

Parameter

exposeid - Die ID des Exposes ist ein Pflichtparameter und steht für die eindeutige ID des Objektes.