Skip to content

Building Projects

Preconditions

  • Please send us an email via service@immobilienscout24.de and apply for a sandbox user account with building project permissions. If you already have a sandbox account, than send us the username and we'll set the permissions.
  • Do 3-legged oAuth.
  • It's necessary to publish the project before adding a real estate to it.
  • Projects booked as "BASIC" product have a limit of 15 real estates.

Get started:

1) Get the project ID (projects are created by our employees):

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

Result will be for example 1111

2) Get the objects belonging to a project:

1
GET https://rest.sandbox-immobilienscout24.de/restapi/api/offer/v1.0/user/me/realestateproject/1111/realestateprojectentry

3) Add a real estate to a project Perform a GETALL REALESTATE for the user, select a real estate (for example: 62616792) and add this by the following request:

1
POST https://rest.sandbox-immobilienscout24.de/restapi/api/offer/v1.0/user/me/realestateproject/1111/realestateprojectentry

Body:

1
2
3
4
5
<realestateproject:realEstateProjectEntries xmlns:realestateproject="http://rest.immobilienscout24.de/schema/offer/realestateproject/1.0" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ns4="http://rest.immobilienscout24.de/schema/platform/gis/1.0">
  <realEstateProjectEntry>
    <realEstateId>62616792</realEstateId>
  </realEstateProjectEntry>
</realestateproject:realEstateProjectEntries>

The response should look like:

1
2
3
4
5
6
7
8
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<realestateproject:realEstateProjectEntries xmlns:realestateproject="http://rest.immobilienscout24.de/schema/offer/realestateproject/1.0" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ns4="http://rest.immobilienscout24.de/schema/platform/gis/1.0">
  <realEstateProjectEntry>
    <messageCode>MESSAGE_RESOURCE_CREATED</messageCode>
    <message>previously published in vario contingent package real estate with id 62616792 was added to project 1111</message>
    <realEstateId>62616792</realEstateId>
  </realEstateProjectEntry>
</realestateproject:realEstateProjectEntries>