Resource type:search
Search for estates via quick search
Parameters:
input
Search string. The estate fieldsobjektnr_extern
,ort
,strasse
and the address fieldsVorname
andName
of the estate owner will be searched through. In case of combined search of street and house number, the results are restricted, i.e. they are linked with the AND operator.sortby
STRING. Field to sort by. The database field names have to be used:objektnr_extern
forexternalestateno
,ort
forcity
,strasse
forstreet
,hausnummer
forhouseno
.sortorder
STRING. Possible values:ASC
orDESC
. Ascending or descending.
Response:
externalestateno
ImmoNr. / external estate nozipcode
ZIP codecity
Citystreet
Streethouseno
House numberowner
Owner of estate
Request example:
{ "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" } }