Temp name

In this tutorial you will learn how is the workflow from creating a real estate object to adding on-top product.

Create a real-estate

URL should look like this:

https://rest.sandbox-immobilienscout24.de/restapi/api/offer/v1.0/user/me/realestate

The body in our case contains basic parameters:

<realestates:apartmentBuy xmlns:realestates="http://rest.immobilienscout24.de/schema/offer/realestates/1.0" xmlns:xlink="http://www.w3.org/1999/xlink"> 
 <title>RestAPI - Immobilienscout24 Testobjekt! Wohnung Kauf</title> 
 <address> 
     <street>Andreas Str</street> 
     <houseNumber>10</houseNumber> 
     <postcode>10243</postcode> 
      <city>Berlin</city> 
 </address> 
 <showAddress>true</showAddress> 
 <price> 
     <value>100000</value> 
     <currency>EUR</currency> 
 </price>
 <livingSpace>50</livingSpace> 
 <numberOfRooms>2</numberOfRooms> 
 <courtage> 
     <hasCourtage>YES</hasCourtage> 
     <courtage>7,14%</courtage> 
 </courtage> 
 </realestates:apartmentBuy>

Once the object has been created, you should receive the following response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<common:messages xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0" xmlns:offerlistelement="http://rest.immobilienscout24.de/schema/offer/listelement/1.0" xmlns:ns5="http://rest.immobilienscout24.de/schema/search/expose/1.0" xmlns:ns6="http://rest.immobilienscout24.de/schema/customer/1.0" xmlns:realestates="http://rest.immobilienscout24.de/schema/offer/realestates/1.0" xmlns:ns8="http://rest.immobilienscout24.de/schema/attachmentsorder/1.0" xmlns:gis="http://rest.immobilienscout24.de/schema/platform/gis/1.0" xmlns:search="http://rest.immobilienscout24.de/schema/search/common/1.0" xmlns:videoupload="http://rest.immobilienscout24.de/schema/videoupload/1.0" xmlns:ns12="http://rest.immobilienscout24.de/schema/entitlement/1.0">
    <message>
        <messageCode>MESSAGE_RESOURCE_CREATED</messageCode>
        <message>Resource [realestate] with id [315652241] has been created.</message>
        <id>315652241</id>
    </message>
</common:messages>

Publish a real-estate

URL should look like this:

https://rest.sandbox-immobilienscout24.de/restapi/api/offer/v1.0/publish

The body will look like this:

<common:publishObject xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
  <realEstate id="315652241"/> 
  <publishChannel id="10000"/>
</common:publishObject>

Response:

 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <common:messages xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0" xmlns:gis="http://rest.immobilienscout24.de/schema/platform/gis/1.0" xmlns:search="http://rest.immobilienscout24.de/schema/search/common/1.0" xmlns:ns5="http://rest.immobilienscout24.de/schema/search/shortlist/1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
     <message>
         <messageCode>MESSAGE_RESOURCE_CREATED</messageCode>
         <message>Resource [publish] with id [315652241_10000] has been created.</message>
         <id>315652241_10000</id>
     </message>
 </common:messages>

Add OnTop placement

There are 3 option of OnTop placement which you can see here. In this tutorial we will use "topplacement"

https://rest.sandbox-immobilienscout24.de/restapi/api/offer/v1.0/user/me/realestate/315652241/topplacement

Response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<common:messages xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0" xmlns:gis="http://rest.immobilienscout24.de/schema/platform/gis/1.0" xmlns:search="http://rest.immobilienscout24.de/schema/search/common/1.0" xmlns:ns5="http://rest.immobilienscout24.de/schema/search/shortlist/1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
    <message>
        <messageCode>MESSAGE_RESOURCE_CREATED</messageCode>
        <message>Resource [topplacement] with id [315652241] has been created.</message>
        <id></id>
    </message>
</common:messages>

Creat Contact

https://rest.sandbox-immobilienscout24.de/restapi/api/offer/v1.0/user/me/contact

Thee body will look like this:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<common:realtorContactDetail xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0" xmlns:xlink="http://www.w3.org/1999/xlink" 
xmlns:ns4="http://rest.immobilienscout24.de/schema/customer/1.0" xmlns:ns5="http://rest.immobilienscout24.de/schema/user/1.0" > 
  <email>max.mustermann@immobilienscout24.de</email> 
  <salutation>MALE</salutation> 
  <firstname>Max</firstname> 
  <lastname>Maxmann</lastname> 
  <faxNumberCountryCode>+49</faxNumberCountryCode> 
  <faxNumberAreaCode>30</faxNumberAreaCode> 
  <faxNumberSubscriber>243010001</faxNumberSubscriber> 
  <phoneNumberCountryCode>+49</phoneNumberCountryCode> 
  <phoneNumberAreaCode>30</phoneNumberAreaCode> 
  <phoneNumberSubscriber>243010123</phoneNumberSubscriber> 
  <cellPhoneNumberCountryCode>+49</cellPhoneNumberCountryCode> 
  <cellPhoneNumberAreaCode>179</cellPhoneNumberAreaCode> 
  <cellPhoneNumberSubscriber>24301000</cellPhoneNumberSubscriber> 
  <address> 
    <street>Andreasstr.</street> 
    <houseNumber>10</houseNumber> 
    <postcode>10243</postcode> 
    <city>Berlin</city> 
  </address>
  <countryCode>DEU</countryCode> 
  <title>Master</title> 
  <additionName>HuiBuh</additionName> 
  <homepageUrl>http://www.immobilienscout24.de</homepageUrl> 
  <position>position oder taetigkeit im unternehmen</position>
  <defaultContact>false</defaultContact> 
  <localPartnerContact>false</localPartnerContact> 
  <businessCardContact>false</businessCardContact> 
  <realEstateReferenceCount>2</realEstateReferenceCount> 
  <externalId>a-001</externalId>
  <showOnProfilePage>true</showOnProfilePage> 
</common:realtorContactDetail>

Response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<common:messages xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0" xmlns:gis="http://rest.immobilienscout24.de/schema/platform/gis/1.0" xmlns:search="http://rest.immobilienscout24.de/schema/search/common/1.0" xmlns:ns5="http://rest.immobilienscout24.de/schema/search/shortlist/1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
    <message>
        <messageCode>MESSAGE_RESOURCE_CREATED</messageCode>
        <message>Resource [contact] with id [97059626] has been created.</message>
        <id>97059626</id>
    </message>
</common:messages>