Search for Estates (Quick Search for Estate address, Owner and external Estate number)

Resource type:search

Search for estates via quick search

Parameters:

  • input
    Search string. The estate fields objektnr_extern, ort, strasse and the address fields Vorname and Name of the estate owner will be searched through.

Response:

  • externalestateno
    ImmoNr. / external estate no
  • zipcode
    ZIP code
  • city
    City
  • street
    Street
  • houseno
    House number
  • owner
    Owner of estate
  • extendedclaim
    STRING. Mandatory for marketplace providers. Not relevant for all other users. To verify the user which uses the marketplace return the “apiClaim” parameter from the service call as “extendedclaim”. User rights are then observed by the marketplace provider API user.

Request example:

"actions":
[
	{
		"actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:get",
		"identifier": "x",
		"resourceid": "estate",
		"resourcetype": "search",
		"parameters":
		{
			"input": "Musterstrasse"
		}
	}
]

Response example:

"actions":
            {
                "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:get",
                "resourceid": "estate",
                "resourcetype": "search",
                "cacheable": false,
                "identifier": "x",
                "data": {
                    "meta": {
                        "cntabsolute": null
                    },
                    "records": [
                        {
                            "id": 1237,
                            "type": "estate",
                            "elements": {
                                "externalestateno": "PC910",
                                "zipcode": "52064",
                                "city": "Aachen, Innenstadt",
                                "street": "Musterstrasse",
                                "houseno": "12",
                                "owner": "Max Mustermann"
                            }
                        }
                    ]
                },
                "status": {
                    "errorcode": 0,
                    "message": "OK"
                }
            }