GET EstatesAndBuildings/{dataSource}/{partnerName}

Get a list of all estates and buildings Estate is the main level and building is the sublevel, but some items is both levels (an estate with only one building)

Request Information

URI Parameters

Name	Description	Type	Additional information
dataSource		DataSourceEnum	Required
partnerName		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of EstatesAndBuildings

Name	Description	Type	Additional information
mieExtraInfoBuilding		MieExtraInfoBuilding	None.
dataSource		DataSourceEnum	None.
estateIdApi		string	None.
isEstate		boolean	None.
isBuilding		boolean	None.
buildingIdApi		string	None.
builtYear	From version 1.6.4 if isBuilding and Vitec	integer	None.
rebuiltYear	From version 1.6.4 if isBuilding and Vitec	integer	None.
realEstateName	realEstateName From version 1.5.2 for Estate and Building and from version 1.7.8.30 also RentalObjects estateName is normally streetAddress and houseNumber but might sometimes be the popular name of the estate instead	string	None.
streetAddress	Street address without housenumber this building	string	Required
houseNumber	Street housenumber	string	None.
postalCode	If foreign country: Include landcode in postalcode and country name in field landName	string	None.
city	Postal place	string	None.
landName	landName, only required if foreign country	string	None.
areaId	Areaid is used for search purposes	string	None.
areaName	Areaname is usuallay a part of a city	string	None.
latitude		decimal number	None.
longitude		decimal number	None.
energyLabel	energyLabel is in this version only delivered for Netherland	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "mieExtraInfoBuilding": {
      "company": {
        "name": "sample string 1",
        "legal_id": "sample string 2",
        "street_address": "sample string 3",
        "zip_code": "sample string 4",
        "country": "sample string 5",
        "region": "sample string 6",
        "municipality": "sample string 7",
        "city": "sample string 8",
        "external_system_id": "sample string 9",
        "book_currency": "sample string 10",
        "invoice_currency": "sample string 11",
        "other_code_name": "sample string 12",
        "accounting_system_id": "sample string 13",
        "street_number": "sample string 14",
        "power_of_attorney": {},
        "deposit_bank_name": "sample string 16",
        "deposit_iban": "sample string 17",
        "deposit_bic": "sample string 18",
        "legacy": "sample string 19",
        "description": "sample string 20",
        "attachment_folders": "sample string 21",
        "migration_group": 22,
        "xanoRentResponse": {}
      },
      "plot": 1,
      "area": 2,
      "floors": 3
    },
    "dataSource": 0,
    "estateIdApi": "sample string 1",
    "isEstate": true,
    "isBuilding": true,
    "buildingIdApi": "sample string 4",
    "builtYear": 1,
    "rebuiltYear": 1,
    "realEstateName": "sample string 5",
    "streetAddress": "sample string 6",
    "houseNumber": "sample string 7",
    "postalCode": "sample string 8",
    "city": "sample string 9",
    "landName": "sample string 10",
    "areaId": "sample string 11",
    "areaName": "sample string 12",
    "latitude": 1.0,
    "longitude": 1.0,
    "energyLabel": "sample string 13"
  },
  {
    "mieExtraInfoBuilding": {
      "company": {
        "name": "sample string 1",
        "legal_id": "sample string 2",
        "street_address": "sample string 3",
        "zip_code": "sample string 4",
        "country": "sample string 5",
        "region": "sample string 6",
        "municipality": "sample string 7",
        "city": "sample string 8",
        "external_system_id": "sample string 9",
        "book_currency": "sample string 10",
        "invoice_currency": "sample string 11",
        "other_code_name": "sample string 12",
        "accounting_system_id": "sample string 13",
        "street_number": "sample string 14",
        "power_of_attorney": {},
        "deposit_bank_name": "sample string 16",
        "deposit_iban": "sample string 17",
        "deposit_bic": "sample string 18",
        "legacy": "sample string 19",
        "description": "sample string 20",
        "attachment_folders": "sample string 21",
        "migration_group": 22,
        "xanoRentResponse": {}
      },
      "plot": 1,
      "area": 2,
      "floors": 3
    },
    "dataSource": 0,
    "estateIdApi": "sample string 1",
    "isEstate": true,
    "isBuilding": true,
    "buildingIdApi": "sample string 4",
    "builtYear": 1,
    "rebuiltYear": 1,
    "realEstateName": "sample string 5",
    "streetAddress": "sample string 6",
    "houseNumber": "sample string 7",
    "postalCode": "sample string 8",
    "city": "sample string 9",
    "landName": "sample string 10",
    "areaId": "sample string 11",
    "areaName": "sample string 12",
    "latitude": 1.0,
    "longitude": 1.0,
    "energyLabel": "sample string 13"
  }
]

application/xml, text/xml

Sample:

<ArrayOfEstatesAndBuildings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HeimModel">
  <EstatesAndBuildings>
    <areaId>sample string 11</areaId>
    <areaName>sample string 12</areaName>
    <city>sample string 9</city>
    <energyLabel>sample string 13</energyLabel>
    <houseNumber>sample string 7</houseNumber>
    <landName>sample string 10</landName>
    <latitude>1</latitude>
    <longitude>1</longitude>
    <postalCode>sample string 8</postalCode>
    <realEstateName>sample string 5</realEstateName>
    <streetAddress>sample string 6</streetAddress>
    <buildingIdApi>sample string 4</buildingIdApi>
    <builtYear>1</builtYear>
    <dataSource>Unknown</dataSource>
    <estateIdApi>sample string 1</estateIdApi>
    <isBuilding>true</isBuilding>
    <isEstate>true</isEstate>
    <mieExtraInfoBuilding>
      <area>2</area>
      <company xmlns:d4p1="http://schemas.datacontract.org/2004/07/MieModel">
        <d4p1:accounting_system_id>sample string 13</d4p1:accounting_system_id>
        <d4p1:attachment_folders>sample string 21</d4p1:attachment_folders>
        <d4p1:book_currency>sample string 10</d4p1:book_currency>
        <d4p1:city>sample string 8</d4p1:city>
        <d4p1:country>sample string 5</d4p1:country>
        <d4p1:deposit_bank_name>sample string 16</d4p1:deposit_bank_name>
        <d4p1:deposit_bic>sample string 18</d4p1:deposit_bic>
        <d4p1:deposit_iban>sample string 17</d4p1:deposit_iban>
        <d4p1:description>sample string 20</d4p1:description>
        <d4p1:external_system_id>sample string 9</d4p1:external_system_id>
        <d4p1:invoice_currency>sample string 11</d4p1:invoice_currency>
        <d4p1:legacy>sample string 19</d4p1:legacy>
        <d4p1:legal_id>sample string 2</d4p1:legal_id>
        <d4p1:migration_group>22</d4p1:migration_group>
        <d4p1:municipality>sample string 7</d4p1:municipality>
        <d4p1:name>sample string 1</d4p1:name>
        <d4p1:other_code_name>sample string 12</d4p1:other_code_name>
        <d4p1:power_of_attorney />
        <d4p1:region>sample string 6</d4p1:region>
        <d4p1:street_address>sample string 3</d4p1:street_address>
        <d4p1:street_number>sample string 14</d4p1:street_number>
        <d4p1:xanoRentResponse />
        <d4p1:zip_code>sample string 4</d4p1:zip_code>
      </company>
      <floors>3</floors>
      <plot>1</plot>
    </mieExtraInfoBuilding>
    <rebuiltYear>1</rebuiltYear>
  </EstatesAndBuildings>
  <EstatesAndBuildings>
    <areaId>sample string 11</areaId>
    <areaName>sample string 12</areaName>
    <city>sample string 9</city>
    <energyLabel>sample string 13</energyLabel>
    <houseNumber>sample string 7</houseNumber>
    <landName>sample string 10</landName>
    <latitude>1</latitude>
    <longitude>1</longitude>
    <postalCode>sample string 8</postalCode>
    <realEstateName>sample string 5</realEstateName>
    <streetAddress>sample string 6</streetAddress>
    <buildingIdApi>sample string 4</buildingIdApi>
    <builtYear>1</builtYear>
    <dataSource>Unknown</dataSource>
    <estateIdApi>sample string 1</estateIdApi>
    <isBuilding>true</isBuilding>
    <isEstate>true</isEstate>
    <mieExtraInfoBuilding>
      <area>2</area>
      <company xmlns:d4p1="http://schemas.datacontract.org/2004/07/MieModel">
        <d4p1:accounting_system_id>sample string 13</d4p1:accounting_system_id>
        <d4p1:attachment_folders>sample string 21</d4p1:attachment_folders>
        <d4p1:book_currency>sample string 10</d4p1:book_currency>
        <d4p1:city>sample string 8</d4p1:city>
        <d4p1:country>sample string 5</d4p1:country>
        <d4p1:deposit_bank_name>sample string 16</d4p1:deposit_bank_name>
        <d4p1:deposit_bic>sample string 18</d4p1:deposit_bic>
        <d4p1:deposit_iban>sample string 17</d4p1:deposit_iban>
        <d4p1:description>sample string 20</d4p1:description>
        <d4p1:external_system_id>sample string 9</d4p1:external_system_id>
        <d4p1:invoice_currency>sample string 11</d4p1:invoice_currency>
        <d4p1:legacy>sample string 19</d4p1:legacy>
        <d4p1:legal_id>sample string 2</d4p1:legal_id>
        <d4p1:migration_group>22</d4p1:migration_group>
        <d4p1:municipality>sample string 7</d4p1:municipality>
        <d4p1:name>sample string 1</d4p1:name>
        <d4p1:other_code_name>sample string 12</d4p1:other_code_name>
        <d4p1:power_of_attorney />
        <d4p1:region>sample string 6</d4p1:region>
        <d4p1:street_address>sample string 3</d4p1:street_address>
        <d4p1:street_number>sample string 14</d4p1:street_number>
        <d4p1:xanoRentResponse />
        <d4p1:zip_code>sample string 4</d4p1:zip_code>
      </company>
      <floors>3</floors>
      <plot>1</plot>
    </mieExtraInfoBuilding>
    <rebuiltYear>1</rebuiltYear>
  </EstatesAndBuildings>
</ArrayOfEstatesAndBuildings>