Get Tenant / Buyer seeker (Immomatching)

Resource type: qualifiedsuitors

Find suitable tenants / buyers based on estate data.

Parameters:

  • estatedata
    JSON object with arbitrary object data (search criteria). The key corresponds to the field name, the value to the searched criterion. Example: {"plz": "52074","ort":"Aachen"}. The comma-separated values form an OR operation. Regional addition (regionaler Zusatz) and other single-select fields cannot be specified as an array, only 1 value can be specified as a string.

Example:

1
2
3
4
5
6
7
8
9
10
11
12
{
    "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:get",
    "resourceid": "",
    "identifier": "",
    "resourcetype": "qualifiedsuitors",
    "parameters": {
        "estatedata": {
            "plz": "52074",
            "ort": "Aachen"
        }
    }
}

Response:

  • id
    KdNr of the respective address data record
  • percentage
    Hit rate of the most appropriate search criterion in percent
  • deviated
    List of deviated search criteria fields
  • searchcriteria
    ID of the most appropriate search criterion
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
...
{
    "status": {
        "code": 200,
        "errorcode": 0,
        "message": "OK"
    },
    "response": {
        "results": [
            {
                "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:get",
                "resourceid": "",
                "resourcetype": "qualifiedsuitors",
                "cacheable": true,
                "identifier": "",
                "data": {
                    "meta": {
                        "cntabsolute": 2
                    },
                    "records": [
                        {
                            "id": 191,
                            "type": "",
                            "elements": {
                                "percentage": 100,
                                "deviated": [
                                    []
                                ],
                                "searchcriteria": 521
                            }
                        },
                        {
                            "id": 18446077777783,
                            "type": "",
                            "elements": {
                                "percentage": 50,
                                "deviated": [
                                    {
                                        "strasse": 0
                                    }
                                ],
                                "searchcriteria": 517
                            }
                        }
                    ]
                },
                "status": {
                    "errorcode": 0,
                    "message": "OK"
                }
            }
        ]
    }
}
...