PUT RealEstateProject

Updates the resource identified by the following URL.This method changes a real estate project by ID.

https://rest.immobilienscout24.de/restapi/api/offer/v1.0/user/{username}/realestateproject/{realestateprojectid}/

  • All fields of a real estate project are mandatory, except street and housenumber.
  • You cannot change the attributes "homepageUrl" and "minPriceProQm", since it is set by an is24 employee.

Supported media types

  • XML (Accept: application/xml)
  • JSON (Accept: application/json)

Authorization requirements

A System Key and an authenticated user are required for this operation:

Please use a secure connection (https) for this operation.

Request

Path Parameters

  • Username: the username which the user uses for logging in to www.immobilienscout24.

  • Username: "me" can be used instead of the username, when the user is logged in by 3-legged oauth.
  • realestateprojectid: the unique project ID, generated by IS24 when posting a real estate project

Query Parameters

  • none

Maximal values

field max value
name 40 characters
title 100 characters
price.minmal 2.111.111.111.111
price.maximal 8.999.999.999.999
space.minimal 10.000.000
space.maximal 20.000.000
numberOfHousingUnit 999
interiorQuality enum
freeFrom 50 characters
address.street 100 characters
address.houseNumber 30 characters
address.postcode 20 characters
address.city 50 characters

Body

XML

<realestateproject:realEstateProject 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">
   <name>Projektname</name>
   <title>testprojekt restapi</title>
   <price>
      <minimal>10000</minimal>
      <maximal>1000000</maximal>
   </price>
   <space>
      <minimal>200</minimal>
      <maximal>200</maximal>
   </space>
   <numberOfHousingUnit>3</numberOfHousingUnit>
   <interiorQuality>SOPHISTICATED</interiorQuality>
   <freeFrom>morgen</freeFrom>
   <address>
      <street>andreasstrasse</street>
      <houseNumber>10</houseNumber>
      <postcode>10179</postcode>
      <city>berlin</city>
   </address>
</realestateproject:realEstateProject>

JSON

{
  "realestateproject.realEstateProject":{
    "name":"Projektname",
    "title":"testprojekt restapi",
    "price":{
      "minimal":10000,
      "maximal":1000000
    },
    "space":{
      "minimal":200,
      "maximal":200
    },
    "numberOfHousingUnit":3,
    "interiorQuality":"SOPHISTICATED",
    "freeFrom":"morgen",
    "address":{
      "street":"andreasstrasse",
      "houseNumber":"10",
      "postcode":"10179",
      "city":"berlin"
    }
  }
}

Response

The following section includes the HTTP status code, a short description and examples for the response body content of a successful processed request.
Error responses as well as other simple message responses are described in detail within the common message responses.

  • Status 200 OK
  • This status code is returned after a new entity of a resource was successfully created.

Header

No special headers.

Body

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."
      }
    }
  ]
}