Modify Estates

Resource type: estate

With this API call estates can be modified. If you use the multi-language module, you can write the estate language-dependent via the parameter estatelanguage.

Further information on the multi-language module is available here.

You can find more information about multilingual estates via API here.

In addresses, estates and other modules you can set relations like e.g. tenant, buyer, owner, contact person, estate units etc. These relations are not queried and set via estate or address calls, but this information is queried or set via the API calls “Create, Modify, Delete and Get relations”.

Parameters:

• data
  ARRAY
  • „field name“ (individually)
    Name of the target field (key) and value to set (value). The possible field names can be read out via “Get field configuration”. The following fields are system fields whose values are set automatically: Id (data record number), erstellt_am (created on), erstellt_von (created by), provisionsbetrag (commission amount (internal)), summe_innenprovision (Total listing agent’s brokerage (internal)), summe_aussenprovision (Total buyer’s agent brokerage (internal)).
  • benutzer
    INTEGER. Field “Betreuer” (“Support”). You need to specify the user ID to set “Betreuer”. The user id can be retrieved with the Read user call.
  • verkauft
    TINYINT(1) . Value 1 sets the field marketing status on value sold or rented, depending on the value of the field marketing method.
  • reserviert
    TINYINT(1) . Value 1 sets the field marketing status on value reserved.
  • Land
    country as ISO 3166-1 alpha-3 value
  • status
    TINYINT(1). “Active / Aktiv” = 1, “Pending / Inaktiv” = 2, “Archive / Archiviert” = 0.
  • multiParkingLot
    OBJECT. Parking lots of the estate, keyed by parking lot type. Same structure as in “Read Estates”. Supported keys: carport, duplex, parkingSpace, garage, multiStoryGarage, undergroundGarage, otherParkingLot. Each parking lot type passed must contain all three properties:
    • Count: non-negative integer, or numeric string without decimals.
    • Price: non-negative number, or numeric string with a dot as decimal separator.
    • MarketingType: "buy", "rent" or null.
    Partial update:
    • Parking lot types that are passed are replaced completely.
    • Parking lot types that are not passed remain unchanged.
    • Partial changes within a parking lot type are not possible: Count, Price and MarketingType must always be passed together.
    To clear a parking lot type, set Count and Price to 0 and MarketingType to null.
  • parkingLotTypePriority
    STRING. Field “Standardwert” (default parking lot type). Defines which single parking lot type is transmitted to ImmobilienScout24. Passed separately from multiParkingLot and can be modified independently of it. Allowed values: "" (no information), carport, duplex, parkingSpace, garage, multiStoryGarage, undergroundGarage, otherParkingLot, gesamt (total). An empty string resets the field to “no information”. This field is not returned by “Read Estates”.

            {
                "actionid":"urn:onoffice-de-ns:smart:2.5:smartml:action:modify",
                "resourceid":"116",
                "identifier":"",
                "resourcetype":"estate",
                "parameters":{
                    "data":{
                        "objektart":"haus",
                        "nutzungsart":"wohnen",
                        "vermarktungsart":"kauf",
                        "objekttyp":"einfamilienhaus",
                        "plz":52068,
                        "ort":"Aachen",
                        "land":"DEU",
                        "heizungsart":["ofen","fussboden"],
                        "kaufpreis":200000
                    }
                }
            }

   
{
    "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:modify",
    "resourceid": "205",
    "identifier": "",
    "resourcetype": "estate",
    "parameters": {
        "data": {
            "multiParkingLot": {
                "garage": {
                    "Count": 1,
                    "Price": 25000.00,
                    "MarketingType": "buy"
                },
                "undergroundGarage": {
                    "Count": 2,
                    "Price": 120.00,
                    "MarketingType": "rent"
                }
            },
            "parkingLotTypePriority": "garage"
        }
    }
}

   
{
  "status": {
    "code": 200,
    "errorcode": 0,
    "message": "OK"
  },
  "response": {
    "results": [
      {
        "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:modify",
        "resourceid": "205",
        "resourcetype": "estate",
        "cacheable": false,
        "identifier": "",
        "data": {
          "meta": {
            "cntabsolute": null
          },
          "records": [
            {
              "id": 0,
              "type": "estate",
              "elements": {
                "success": "success"
              }
            }
          ]
        },
        "status": {
          "errorcode": 0,
          "message": "OK"
        }
      }
    ]
  }
}