Insert a Real Estate

This method creates a real estate object.

Supported media types:
XML
JSON

POST /offer/v1.0/user/{username or me}/realestate/

Things you need to know

  • Here is a list of all ImmoScout24 supported real estate types.
  • Please respect the order of the fields when making requests for both XML and JSON, otherwise you will receive an error.
  • The newly created object is deactivated (not published by default). Please use publish request for publishing the Real-Estate.
  • Don't encode the xml/json if you send it within the body. It won't work (error code 409)
  • Price on demand ("Preis auf Anfrage") is set by entering a "0" in the price field. This is only supported for "Grundstücke" (plots) and all "Gewerbeimmotypen" (commercial real estate types).
  • The tag "contact" is optional. If you don't enter a contact id, we'll take the standard contact address of the realtor.
  • If the address cannot be geocoded by IS24 then you should send the "wgs84Coordinate" (vice versa: should be omitted for geocodable addresses)
  • externalID is optional. If it's not entered, than we'll set the scout object id automatically as externalId.
  • If you use an existing foreignobjectid, you'll get a 409 error message (the foreignobjectid needs to be unique within the real estate objects of a realtor/customer).
  • realEstateProjectId can't be set by the realestate endpoint! Use the RealEstateProject resource to add the realEstates to your project.
  • lastModificationDate is ignored
  • The attribute "marketingType" in the price element and additionalCosts element is optional. Default is rent. If you want to POST an object with marketingType = "buy", then you must change the commercialisationType to "BUY".
  • External id which contains "/" needs to be url encoded
  • "<" and ">" are not allowed

Request

XML:

<?xml version="1.0" encoding="utf-8"?>
<realestates:apartmentRent xmlns:realestates="http://rest.immobilienscout24.de/schema/offer/realestates/1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
    <externalId>ext-315695334</externalId>
    <title>New Flat Rental - REST-API</title>
    <address>
        <street>Andreasstr</street>
        <houseNumber>10</houseNumber>
        <postcode>10243</postcode>
        <city>Berlin</city>
        <wgs84Coordinate>
            <latitude>52.51261</latitude>
            <longitude>13.43145</longitude>
        </wgs84Coordinate>
        <geoHierarchy>
            <continent>
                <geoCodeId>1</geoCodeId>
                <fullGeoCodeId>1</fullGeoCodeId>
            </continent>
            <country>
                <geoCodeId>276</geoCodeId>
                <fullGeoCodeId>1276</fullGeoCodeId>
            </country>
            <region>
                <geoCodeId>3</geoCodeId>
                <fullGeoCodeId>1276003</fullGeoCodeId>
            </region>
            <city>
                <geoCodeId>1</geoCodeId>
                <fullGeoCodeId>1276003001</fullGeoCodeId>
            </city>
            <quarter>
                <geoCodeId>17</geoCodeId>
                <fullGeoCodeId>1276003001017</fullGeoCodeId>
            </quarter>
            <neighbourhood>
                <geoCodeId>11000000002348</geoCodeId>
            </neighbourhood>
        </geoHierarchy>
    </address>
    <realEstateState>INACTIVE</realEstateState>
    <attachments xlink:href="https://rest.sandbox-immobilienscout24.de/restapi/api/offer/v1.0/user/me/realestate/315766115/attachment"/>
    <showAddress>true</showAddress>
    <contact id="78965616"/>
    <apartmentType>NO_INFORMATION</apartmentType>
    <lift>false</lift>
    <cellar>NOT_APPLICABLE</cellar>
    <handicappedAccessible>NOT_APPLICABLE</handicappedAccessible>
    <condition>NO_INFORMATION</condition>
    <firingTypes>
        <firingType>NO_INFORMATION</firingType>
    </firingTypes>
    <energySourcesEnev2014>
        <energySourceEnev2014>NO_INFORMATION</energySourceEnev2014>
    </energySourcesEnev2014>
    <energyConsumptionContainsWarmWater>NOT_APPLICABLE</energyConsumptionContainsWarmWater>
    <guestToilet>NOT_APPLICABLE</guestToilet>
    <baseRent>100000.00</baseRent>
    <heatingCostsInServiceCharge>NOT_APPLICABLE</heatingCostsInServiceCharge>
    <petsAllowed>NO_INFORMATION</petsAllowed>
    <useAsFlatshareRoom>NOT_APPLICABLE</useAsFlatshareRoom>
    <livingSpace>10.00</livingSpace>
    <numberOfRooms>1</numberOfRooms>
    <builtInKitchen>false</builtInKitchen>
    <balcony>false</balcony>
    <certificateOfEligibilityNeeded>false</certificateOfEligibilityNeeded>
    <garden>false</garden>
    <courtage>
        <hasCourtage>NO</hasCourtage>
    </courtage>
</realestates:apartmentRent>

JSON:

{
  "realestates.apartmentRent":{
    "externalId":"ext-315695333",
    "title":"New Flat Rental - REST-API",
    "address":{
      "street":"Andreasstr",
      "houseNumber":"10",
      "postcode":"10243",
      "city":"Berlin",
      "wgs84Coordinate":{
        "latitude":52.51261,
        "longitude":13.43145
      },
      "geoHierarchy":{
        "continent":{
          "geoCodeId":1,
          "fullGeoCodeId":"1"
        },
        "country":{
          "geoCodeId":276,
          "fullGeoCodeId":"1276"
        },
        "region":{
          "geoCodeId":3,
          "fullGeoCodeId":"1276003"
        },
        "city":{
          "geoCodeId":1,
          "fullGeoCodeId":"1276003001"
        },
        "quarter":{
          "geoCodeId":17,
          "fullGeoCodeId":"1276003001017"
        },
        "neighbourhood":{
          "geoCodeId":11000000002348
        }
      }

    },
    "realEstateState":"ACTIVE",
    "attachments":[
      {
        "@xlink.href":"https:\/\/rest.sandbox-immobilienscout24.de\/restapi\/api\/offer\/v1.0\/user\/me\/realestate\/315695333\/attachment"
      }
    ]
    ,
    "showAddress":"true",
    "contact":{
      "@id":"78965616"
    },
    "apartmentType":"NO_INFORMATION",
    "lift":"false",
    "cellar":"NOT_APPLICABLE",
    "handicappedAccessible":"NOT_APPLICABLE",
    "condition":"NO_INFORMATION",
    "firingTypes":[
      {
        "firingType":"NO_INFORMATION"
      }
    ]
    ,
    "energySourcesEnev2014":{
      "energySourceEnev2014":"NO_INFORMATION"
    },
    "energyConsumptionContainsWarmWater":"NOT_APPLICABLE",
    "guestToilet":"NOT_APPLICABLE",
    "baseRent":100000,
    "heatingCostsInServiceCharge":"NOT_APPLICABLE",
    "petsAllowed":"NO_INFORMATION",
    "useAsFlatshareRoom":"NOT_APPLICABLE",
    "livingSpace":10,
    "numberOfRooms":1,
    "builtInKitchen":"false",
    "balcony":"false",
    "certificateOfEligibilityNeeded":"false",
    "garden":"false",
    "courtage":{
      "hasCourtage":"NO"
    }
  }
}

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_CREATED</messageCode>
        <message>Resource [REALESTATE] with id [123456] has been created.</message>
        <id>123456</id>
    </message>
</common:messages>

JSON:

{
  "common.messages":[
    {
      "message":{
        "messageCode":"MESSAGE_RESOURCE_CREATED",
        "message":"Resource [REALESTATE] with id [123456] has been created."
        "id":62558084
      }
    }
  ]
}