Create Estates

Resource type: estate

Creates a new estate record, if the user has the necessary rights. The parameter data of this action include all fields active in enterprise for estate records.

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”. For more information on the relations of the multi-property module, which manages property complexes, see here.

If an property number that already exists in the system is included in the API call as parameter objektnr_extern, a new, unique number is generated based on the stored numbering scheme. In this case, externalestatenoOverwritten is added to the response, indicating the newly assigned object number.

Parameters:

• data
  ARRAY
  • (individually). The possible field names can be read out via “Get field configuration”. The following fields are system fields whose values are set automatically: 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. If neither verkauft or reserviert are set, marketing status will be set to open.
    • status
      TINYINT(1). “Active / Aktiv” = 1, “Pending / Inaktiv” = 2, “Archive / Archiviert” = 0.
    • land
      country as ISO 3166-1 alpha-3 value.
    • 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.
      Parking lot types that are not passed are created with their default values. See example 2.
    • parkingLotTypePriority
      STRING. Field “Standardwert” (default parking lot type). Defines which single parking lot type is transmitted to ImmobilienScout24. Passed separately from multiParkingLot. Allowed values: "" (no information), carport, duplex, parkingSpace, garage, multiStoryGarage, undergroundGarage, otherParkingLot, gesamt (total). This field is not returned by “Read Estates”.

    {
        "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:create",
        "resourceid": "",
        "identifier": "",
        "resourcetype": "estate",
        "parameters": {
            "data": {
                "objektart": "haus",
                "nutzungsart": "wohnen",
                "vermarktungsart": "kauf",
                "objekttyp": "einfamilienhaus",
                "plz": 52068,
                "ort": "Aachen",
                "land": "DEU",
                "nebenkosten": 100,
                "heizkosten": 80,
                "mietpreis_pro_qm": 12,
                "wohnflaeche": 75,
                "anzahl_zimmer": 3,
                "anzahl_schlafzimmer": 1,
                "anzahl_badezimmer": 1,
                "breitengrad": "50.7762106",
                "laengengrad": "6.0857545",
                "heizungsart": [
                    "zentral",
                    "fussboden"
                ],
                "stellplatzart": [
                    "freiplatz",
                    "carport"
                ],
                "kaufpreis": 200000
            }
        }
    }

   
{
    "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:create",
    "resourceid": "",
    "identifier": "",
    "resourcetype": "estate",
    "parameters": {
        "data": {
            "objektart": "haus",
            "nutzungsart": "wohnen",
            "vermarktungsart": "kauf",
            "multiParkingLot": {
                "carport": {
                    "Count": 1,
                    "Price": 15000,
                    "MarketingType": "buy"
                },
                "duplex": {
                    "Count": 2,
                    "Price": 10000,
                    "MarketingType": "buy"
                }
            },
            "parkingLotTypePriority": "duplex"
        }
    }
}

Response:

• id
  The ID of the new estate record

...
"response":{
        "results":[
            {
                "actionid":"urn:onoffice-de-ns:smart:2.5:smartml:action:create",
                "resourceid":"",
                "resourcetype":"estate",
                "identifier":"",
                "data":{
                    "meta":{
                        "cntabsolute":null
                    },
                    "records":[
                        {
                            "id":102,
                            "type":"estate",
                            "elements":[

                            ]
                        }
                    ]
                },
                "status":{
                    "errorcode":0,
                    "message":"OK"
                }
            }
        ]
...