Update a Real Estate

Updates the resource identified by the following URL.This method changes a real estate object by Scout object ID or by your own object id.

PUT /offer/v1.0/user/{username}/realestate/{id} or .../ext-{externalId}

Supported media types:
XML
JSON

Notes:

  • the realestate type (e.g. apartment rent -> apartment buy) cannot be changed. You need to copy the real estate and insert it, again (GET REALESTATE -> POST REALESTATE)
  • The tag "contact" is optional. If you don't enter a contact id, we'll take the standard contact address of the realtor.
  • the tag "wgs84Coordinate" is optional. If it is not entered, than the address will be geocoded by us
  • the attribute "marketingType" in the price element and additionalCosts element is optional
  • Free text fields: only the HTML tag 'BR' is supported (CDATA is not supported)
  • Please encode space " " in the URL with "%20"
  • You have to send all attributes, also if only one attribute has changed. Otherwise we cannot interpret if a missing attribute should be filled in with NULL or not.
  • realEstateProjectId couldn't be set! Use the RealEstateProject resource to add the realEstates to your project.

Request

Path Parameters

PARAMETER DESCRIPTION
Username the username which the user uses for logging in to www.immobilienscout24
me "me" can be used instead of the username, when the user is logged in by 3-legged oauth
id the unique scout object ID, which is being created by POST REALESTATE automatically
external-id can be used instead of the scout object ID. it is the customer-defined ID of the real estate, must be unique per user

Query Parameters

usenewenergysourceenev2014values=true: New param since 20.08.2014. Due to downward compatibility you can see the new energySourceEnev2014 values:

PARAMETER VALUE
energySourceEnev2014 BIO_ENERGY, WIND_ENERGY, HYDRO_ENERGY, ENVIRONMENTAL_THERMAL_ENERGY, COMBINED_HEAT_AND_POWER_FOSSIL_FUELS, COMBINED_HEAT_AND_POWER_RENEWABLE_ENERGY, COMBINED_HEAT_AND_POWER_REGENERATIVE_ENERGY, COMBINED_HEAT_AND_POWER_BIO_ENERGY

XML:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<realestates:apartmentBuy xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0" xmlns:ns2="http://rest.immobilienscout24.de/schema/platform/gis/1.0" xmlns:realestates="http://rest.immobilienscout24.de/schema/offer/realestates/1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
    <title>RestAPi appartmentBuy</title>
    <address>
        <street>Andreasstraße</street>
        <houseNumber>10</houseNumber>
        <postcode>10243</postcode>
        <city>Berlin</city>
        <wgs84Coordinate>
            <latitude>52.51245</latitude>
            <longitude>13.43134</longitude>
        </wgs84Coordinate>
    </address>
    <apiSearchData>
        <searchField1>apiSearchField1</searchField1>
        <searchField2>apiSearchField2</searchField2>
        <searchField3>apiSearchField3</searchField3>
    </apiSearchData>
    <realEstateState>INACTIVE</realEstateState>
    <descriptionNote>Objektbeschreibung(noch 2000 Zeichen) description-note
 after line break this text is in the next row</descriptionNote>
    <furnishingNote>Ausstattung(noch 2000 Zeichen)</furnishingNote>
    <locationNote>Lage(noch 2000 Zeichen)</locationNote>
    <otherNote>Sonstiges(noch 2000 Zeichen)</otherNote>
    <showAddress>true</showAddress>
    <apartmentType>MAISONETTE</apartmentType>
    <floor>2</floor>
    <lift>true</lift>
    <energyCertificate>
        <energyCertificateAvailability>AVAILABLE</energyCertificateAvailability>
        <energyCertificateCreationDate>BEFORE_01_MAY_2014</energyCertificateCreationDate>
    </energyCertificate>
    <cellar>YES</cellar>
    <handicappedAccessible>YES</handicappedAccessible>
    <numberOfParkingSpaces>1</numberOfParkingSpaces>
    <condition>WELL_KEPT</condition>
    <lastRefurbishment>2010</lastRefurbishment>
    <interiorQuality>SOPHISTICATED</interiorQuality>
    <constructionYear>1995</constructionYear>
    <freeFrom>sofort</freeFrom>
    <heatingTypeEnev2014>FLOOR_HEATING</heatingTypeEnev2014>
    <energySourcesEnev2014>
        <energySourceEnev2014>WOOD_CHIPS</energySourceEnev2014>
        <energySourceEnev2014>LIQUID_GAS</energySourceEnev2014>
        <energySourceEnev2014>COAL_COKE</energySourceEnev2014>
        <energySourceEnev2014>COAL</energySourceEnev2014>
        <energySourceEnev2014>HEAT_SUPPLY</energySourceEnev2014>
        <energySourceEnev2014>COMBINED_HEAT_AND_POWER_RENEWABLE_ENERGY</energySourceEnev2014>
        <energySourceEnev2014>DISTRICT_HEATING</energySourceEnev2014>
        <energySourceEnev2014>ENVIRONMENTAL_THERMAL_ENERGY</energySourceEnev2014>
        <energySourceEnev2014>WOOD</energySourceEnev2014>
        <energySourceEnev2014>SOUR_GAS</energySourceEnev2014>
        <energySourceEnev2014>STEAM_DISTRICT_HEATING</energySourceEnev2014>
        <energySourceEnev2014>WIND_ENERGY</energySourceEnev2014>
        <energySourceEnev2014>ACID_GAS</energySourceEnev2014>
        <energySourceEnev2014>BIO_ENERGY</energySourceEnev2014>
        <energySourceEnev2014>LOCAL_HEATING</energySourceEnev2014>
        <energySourceEnev2014>SOLAR_HEATING</energySourceEnev2014>
        <energySourceEnev2014>COMBINED_HEAT_AND_POWER_REGENERATIVE_ENERGY</energySourceEnev2014>
        <energySourceEnev2014>GEOTHERMAL</energySourceEnev2014>
        <energySourceEnev2014>HYDRO_ENERGY</energySourceEnev2014>
        <energySourceEnev2014>GAS</energySourceEnev2014>
        <energySourceEnev2014>COMBINED_HEAT_AND_POWER_FOSSIL_FUELS</energySourceEnev2014>
        <energySourceEnev2014>OIL</energySourceEnev2014>
        <energySourceEnev2014>PELLET_HEATING</energySourceEnev2014>
        <energySourceEnev2014>COMBINED_HEAT_AND_POWER_BIO_ENERGY</energySourceEnev2014>
        <energySourceEnev2014>ELECTRICITY</energySourceEnev2014>
    </energySourcesEnev2014>
    <buildingEnergyRatingType>ENERGY_CONSUMPTION</buildingEnergyRatingType>
    <thermalCharacteristic>123.85</thermalCharacteristic>
    <energyConsumptionContainsWarmWater>YES</energyConsumptionContainsWarmWater>
    <numberOfFloors>5</numberOfFloors>
    <usableFloorSpace>70.00</usableFloorSpace>
    <numberOfBedRooms>1</numberOfBedRooms>
    <numberOfBathRooms>2</numberOfBathRooms>
    <guestToilet>YES</guestToilet>
    <parkingSpaceType>UNDERGROUND_GARAGE</parkingSpaceType>
    <rented>YES</rented>
    <rentalIncome>895.00</rentalIncome>
    <listed>YES</listed>
    <parkingSpacePrice>15000.00</parkingSpacePrice>
    <summerResidencePractical>YES</summerResidencePractical>
    <price>
        <value>175000.00</value>
        <currency>EUR</currency>
        <marketingType>PURCHASE</marketingType>
        <priceIntervalType>ONE_TIME_CHARGE</priceIntervalType>
    </price>
    <livingSpace>75.00</livingSpace>
    <numberOfRooms>3</numberOfRooms>
    <energyPerformanceCertificate>true</energyPerformanceCertificate>
    <builtInKitchen>true</builtInKitchen>
    <balcony>true</balcony>
    <certificateOfEligibilityNeeded>false</certificateOfEligibilityNeeded>
    <garden>true</garden>
    <courtage>
        <hasCourtage>YES</hasCourtage>
        <courtage>Provisionshöhe (brutto)</courtage>
        <courtageNote>Provisionshinweis (noch 500 Zeichen)</courtageNote>
    </courtage>
    <serviceCharge>575</serviceCharge>
</realestates:apartmentBuy>

JSON:

{
       "realestates.apartmentBuy":
       {
           "@id": "74719808",
           "externalId": "extID",
           "title": "RestAPi appartmentBuy",
           "address":
           {
               "street": "Andreasstraße",
               "houseNumber": "10",
               "postcode": "10243",
               "city": "Berlin",
               "wgs84Coordinate":
               {
                   "latitude": 52.51245,
                   "longitude": 13.43134
               },
           },
           "apiSearchData":
           {
               "searchField1": "apiSearchField1",
               "searchField2": "apiSearchField2",
               "searchField3": "apiSearchField3"
           },
           "realEstateState": "INACTIVE",
           "descriptionNote": "Objektbeschreibung(noch 2000 Zeichen) description-note \n after line break this text is in the next row",",
           "furnishingNote": "Ausstattung(noch 2000 Zeichen)",
           "locationNote": "Lage(noch 2000 Zeichen)",
           "otherNote": "Sonstiges(noch 2000 Zeichen)",
           "showAddress": "true",
           "contact":
           {
               "@id": "53323004"
           },
           "apartmentType": "MAISONETTE",
           "floor": 2,
           "lift": "true",
           "energyCertificate":
           {
               "energyCertificateAvailability": "AVAILABLE",
               "energyCertificateCreationDate": "BEFORE_01_MAY_2014"
           },
           "cellar": "YES",
           "handicappedAccessible": "YES",
           "numberOfParkingSpaces": 1,
           "condition": "WELL_KEPT",
           "lastRefurbishment": 2010,
           "interiorQuality": "SOPHISTICATED",
           "constructionYear": 1995,
           "freeFrom": "sofort",
           "heatingTypeEnev2014": "FLOOR_HEATING",
           "energySourcesEnev2014":
           {
               "energySourceEnev2014":
               [
                   "WOOD_CHIPS",
                   "LIQUID_GAS",
                   "COAL_COKE",
                   "COAL",
                   "HEAT_SUPPLY",
                   "COMBINED_HEAT_AND_POWER_RENEWABLE_ENERGY",
                   "DISTRICT_HEATING",
                   "ENVIRONMENTAL_THERMAL_ENERGY",
                   "WOOD",
                   "SOUR_GAS",
                   "STEAM_DISTRICT_HEATING",
                   "WIND_ENERGY",
                   "ACID_GAS",
                   "BIO_ENERGY",
                   "LOCAL_HEATING",
                   "SOLAR_HEATING",
                   "COMBINED_HEAT_AND_POWER_REGENERATIVE_ENERGY",
                   "GEOTHERMAL",
                   "HYDRO_ENERGY",
                   "GAS",
                   "COMBINED_HEAT_AND_POWER_FOSSIL_FUELS",
                   "OIL",
                   "PELLET_HEATING",
                   "COMBINED_HEAT_AND_POWER_BIO_ENERGY",
                   "ELECTRICITY"
               ]
           },
           "buildingEnergyRatingType": "ENERGY_CONSUMPTION",
           "thermalCharacteristic": 123.85,
           "energyConsumptionContainsWarmWater": "YES",
           "numberOfFloors": 5,
           "usableFloorSpace": 70,
           "numberOfBedRooms": 1,
           "numberOfBathRooms": 2,
           "guestToilet": "YES",
           "parkingSpaceType": "UNDERGROUND_GARAGE",
           "rented": "YES",
           "rentalIncome": 895,
           "listed": "YES",
           "parkingSpacePrice": 15000,
           "summerResidencePractical": "YES",
           "price":
           {
               "value": 175000,
               "currency": "EUR",
               "marketingType": "PURCHASE",
               "priceIntervalType": "ONE_TIME_CHARGE"
           },
           "livingSpace": 75,
           "numberOfRooms": 3,
           "energyPerformanceCertificate": "true",
           "builtInKitchen": "true",
           "balcony": "true",
           "certificateOfEligibilityNeeded": "false",
           "garden": "true",
           "courtage":
           {
               "hasCourtage": "YES",
               "courtage": "Provisionshöhe (brutto)",
               "courtageNote": "Provisionshinweis (noch 500 Zeichen)"
           },
           "serviceCharge": 575
       }
    }

Response

XML:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<common:messages xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0"
    xmlns:xlink="http://www.w3.org/1999/xlink">
    <message>
        <messageCode>MESSAGE_RESOURCE_UPDATED</messageCode>
        <message>Resource [NAME] with id [ID] has been updated. </message>
    </message>
</common:messages>

JSON:

{
  "common.messages":[
    {
      "message":{
        "messageCode":"MESSAGE_RESOURCE_UPDATED",
        "message":"Resource [NAME] with id [ID] has been updated."
      }
    }
  ]
}