GET ObjectsPublishedAll/{dataSource}/{partnerName}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
dataSource

DataSourceEnum

Required

partnerName

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of RentalObjectBasic
NameDescriptionTypeAdditional information
dataSource

DataSourceEnum

None.

objectIdApi

string

None.

buildingIdApi

Id for the buliding. Sweden from version 1.5.3.70 : Delivered in routine /ObjectInfo/ but not in /ObjectsPublishedAll/ Norway and Denmark : Always delivered

string

None.

estateIdApi

estateIdApi is in this version only for Iceland

string

None.

objectDetailLevel

ObjectDetailLevel

None.

mieExtraInfoUnit

Only for MIE sync

MieExtraInfoUnit

None.

objectMainType

ObjectMainType

None.

objectSubType

ObjectSubType

None.

objectRestriction

ObjectRestriction

None.

objectTypeText

Description of this object type in local language. Examples for objectMainType=Living and datasource Norway is Hybel, 1-roms, 2-roms, 3-roms

string

None.

rooms

Number of rooms when objectMainType=Living

integer

None.

flatNumber

Flat number

string

None.

objectShortName

objectShortName is a related alfacode for objectIdApi. The field is not mandatory (probably only delivered when datasource is Norway)

string

None.

floor

integer

None.

isGroundFloor

boolean

None.

objectMainState

ObjectMainState

None.

availableFromDate

Null means unknown date for when this object will be available

date

None.

availableFromLatestDate

Only delivered for data from Sweden and is contract expire date

date

None.

showComment

string

None.

showDates

Showdates list is not delivered for all datasource countries

Collection of Showdate

None.

contactsAndRoles

contactsAndRoles list is in this version only one row and is the main contact in Heimstaden for this rental

Collection of ContactAndRole

None.

rentalCost

integer

None.

rentalCostDescription

Default is price pr. month Norway Buisness apartments : RentalCostDescription will normally be price pr. squuare meter and with the spelling 'Pris pr. kvm'

string

None.

extraCostAmount

extraCostAmount and extraCostDescription is only in use for Netherlands and is the serviceCosts

integer

None.

extraCostDescription

string

None.

sizeMain

Size with max one decimal

decimal number

Matching regular expression pattern: [0-9]{0,}\.[0-9]

sizeMainType

Datasource Sweden and Denmark will always return the StandardAreaType as value. For datasource Norway : LivingPrimaryArea=P-rom areal, LivingMaxArea=BRA, GrossArea=BTA For datasource Norway will additional areatypes and sizes also be described in the descriptionHtml field when required.

ArealSqmType

None.

sizeMainMax

decimal number

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:
[
  {
    "dataSource": 0,
    "objectIdApi": "sample string 1",
    "buildingIdApi": "sample string 2",
    "estateIdApi": "sample string 3",
    "objectDetailLevel": 20,
    "mieExtraInfoUnit": {
      "aqusitionDate": "2025-12-12T02:15:27.3169799+01:00",
      "operationEndDate": "2025-12-12T02:15:27.3169799+01:00",
      "companyIdAccounting": 1,
      "publishStatus": 2
    },
    "objectMainType": 0,
    "objectSubType": 0,
    "objectRestriction": 0,
    "objectTypeText": "sample string 4",
    "rooms": 1,
    "flatNumber": "sample string 5",
    "objectShortName": "sample string 6",
    "floor": 7,
    "isGroundFloor": true,
    "objectMainState": 1,
    "availableFromDate": "2025-12-12T02:15:27.3169799+01:00",
    "availableFromLatestDate": "2025-12-12T02:15:27.3169799+01:00",
    "showComment": "sample string 9",
    "showDates": [
      {
        "showdateStart": "2025-12-12T02:15:27.3169799+01:00",
        "showdateEnd": "2025-12-12T02:15:27.3169799+01:00"
      },
      {
        "showdateStart": "2025-12-12T02:15:27.3169799+01:00",
        "showdateEnd": "2025-12-12T02:15:27.3169799+01:00"
      }
    ],
    "contactsAndRoles": [
      {
        "contactIdApi": "sample string 1",
        "roleType": 0,
        "title": "sample string 2",
        "name": "sample string 3",
        "mobilePhone": "sample string 4",
        "workPhone": "sample string 5",
        "email": "sample string 6"
      },
      {
        "contactIdApi": "sample string 1",
        "roleType": 0,
        "title": "sample string 2",
        "name": "sample string 3",
        "mobilePhone": "sample string 4",
        "workPhone": "sample string 5",
        "email": "sample string 6"
      }
    ],
    "rentalCost": 1,
    "rentalCostDescription": "sample string 10",
    "extraCostAmount": 1,
    "extraCostDescription": "sample string 11",
    "sizeMain": 12.0,
    "sizeMainType": 0,
    "sizeMainMax": 1.0,
    "realEstateName": "sample string 13",
    "streetAddress": "sample string 14",
    "houseNumber": "sample string 15",
    "postalCode": "sample string 16",
    "city": "sample string 17",
    "landName": "sample string 18",
    "areaId": "sample string 19",
    "areaName": "sample string 20",
    "latitude": 1.0,
    "longitude": 1.0,
    "energyLabel": "sample string 21"
  },
  {
    "dataSource": 0,
    "objectIdApi": "sample string 1",
    "buildingIdApi": "sample string 2",
    "estateIdApi": "sample string 3",
    "objectDetailLevel": 20,
    "mieExtraInfoUnit": {
      "aqusitionDate": "2025-12-12T02:15:27.3169799+01:00",
      "operationEndDate": "2025-12-12T02:15:27.3169799+01:00",
      "companyIdAccounting": 1,
      "publishStatus": 2
    },
    "objectMainType": 0,
    "objectSubType": 0,
    "objectRestriction": 0,
    "objectTypeText": "sample string 4",
    "rooms": 1,
    "flatNumber": "sample string 5",
    "objectShortName": "sample string 6",
    "floor": 7,
    "isGroundFloor": true,
    "objectMainState": 1,
    "availableFromDate": "2025-12-12T02:15:27.3169799+01:00",
    "availableFromLatestDate": "2025-12-12T02:15:27.3169799+01:00",
    "showComment": "sample string 9",
    "showDates": [
      {
        "showdateStart": "2025-12-12T02:15:27.3169799+01:00",
        "showdateEnd": "2025-12-12T02:15:27.3169799+01:00"
      },
      {
        "showdateStart": "2025-12-12T02:15:27.3169799+01:00",
        "showdateEnd": "2025-12-12T02:15:27.3169799+01:00"
      }
    ],
    "contactsAndRoles": [
      {
        "contactIdApi": "sample string 1",
        "roleType": 0,
        "title": "sample string 2",
        "name": "sample string 3",
        "mobilePhone": "sample string 4",
        "workPhone": "sample string 5",
        "email": "sample string 6"
      },
      {
        "contactIdApi": "sample string 1",
        "roleType": 0,
        "title": "sample string 2",
        "name": "sample string 3",
        "mobilePhone": "sample string 4",
        "workPhone": "sample string 5",
        "email": "sample string 6"
      }
    ],
    "rentalCost": 1,
    "rentalCostDescription": "sample string 10",
    "extraCostAmount": 1,
    "extraCostDescription": "sample string 11",
    "sizeMain": 12.0,
    "sizeMainType": 0,
    "sizeMainMax": 1.0,
    "realEstateName": "sample string 13",
    "streetAddress": "sample string 14",
    "houseNumber": "sample string 15",
    "postalCode": "sample string 16",
    "city": "sample string 17",
    "landName": "sample string 18",
    "areaId": "sample string 19",
    "areaName": "sample string 20",
    "latitude": 1.0,
    "longitude": 1.0,
    "energyLabel": "sample string 21"
  }
]

application/xml, text/xml

Sample:
<ArrayOfRentalObjectBasic xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HeimModel">
  <RentalObjectBasic>
    <areaId>sample string 19</areaId>
    <areaName>sample string 20</areaName>
    <city>sample string 17</city>
    <energyLabel>sample string 21</energyLabel>
    <houseNumber>sample string 15</houseNumber>
    <landName>sample string 18</landName>
    <latitude>1</latitude>
    <longitude>1</longitude>
    <postalCode>sample string 16</postalCode>
    <realEstateName>sample string 13</realEstateName>
    <streetAddress>sample string 14</streetAddress>
    <availableFromDate>2025-12-12T02:15:27.3169799+01:00</availableFromDate>
    <availableFromLatestDate>2025-12-12T02:15:27.3169799+01:00</availableFromLatestDate>
    <buildingIdApi>sample string 2</buildingIdApi>
    <contactsAndRoles>
      <ContactAndRole>
        <email>sample string 6</email>
        <mobilePhone>sample string 4</mobilePhone>
        <name>sample string 3</name>
        <workPhone>sample string 5</workPhone>
        <contactIdApi>sample string 1</contactIdApi>
        <roleType>MainContact</roleType>
        <title>sample string 2</title>
      </ContactAndRole>
      <ContactAndRole>
        <email>sample string 6</email>
        <mobilePhone>sample string 4</mobilePhone>
        <name>sample string 3</name>
        <workPhone>sample string 5</workPhone>
        <contactIdApi>sample string 1</contactIdApi>
        <roleType>MainContact</roleType>
        <title>sample string 2</title>
      </ContactAndRole>
    </contactsAndRoles>
    <dataSource>Unknown</dataSource>
    <estateIdApi>sample string 3</estateIdApi>
    <extraCostAmount>1</extraCostAmount>
    <extraCostDescription>sample string 11</extraCostDescription>
    <flatNumber>sample string 5</flatNumber>
    <floor>7</floor>
    <isGroundFloor>true</isGroundFloor>
    <mieExtraInfoUnit>
      <aqusitionDate>2025-12-12T02:15:27.3169799+01:00</aqusitionDate>
      <companyIdAccounting>1</companyIdAccounting>
      <operationEndDate>2025-12-12T02:15:27.3169799+01:00</operationEndDate>
      <publishStatus>2</publishStatus>
    </mieExtraInfoUnit>
    <objectDetailLevel>AllRentalFields</objectDetailLevel>
    <objectIdApi>sample string 1</objectIdApi>
    <objectMainState>Occupied</objectMainState>
    <objectMainType>Unknown</objectMainType>
    <objectRestriction>NoRestriction</objectRestriction>
    <objectShortName>sample string 6</objectShortName>
    <objectSubType>DefaultSubtype</objectSubType>
    <objectTypeText>sample string 4</objectTypeText>
    <rentalCost>1</rentalCost>
    <rentalCostDescription>sample string 10</rentalCostDescription>
    <rooms>1</rooms>
    <showComment>sample string 9</showComment>
    <showDates>
      <Showdate>
        <showdateEnd>2025-12-12T02:15:27.3169799+01:00</showdateEnd>
        <showdateStart>2025-12-12T02:15:27.3169799+01:00</showdateStart>
      </Showdate>
      <Showdate>
        <showdateEnd>2025-12-12T02:15:27.3169799+01:00</showdateEnd>
        <showdateStart>2025-12-12T02:15:27.3169799+01:00</showdateStart>
      </Showdate>
    </showDates>
    <sizeMain>12</sizeMain>
    <sizeMainMax>1</sizeMainMax>
    <sizeMainType>StandardAreaType</sizeMainType>
  </RentalObjectBasic>
  <RentalObjectBasic>
    <areaId>sample string 19</areaId>
    <areaName>sample string 20</areaName>
    <city>sample string 17</city>
    <energyLabel>sample string 21</energyLabel>
    <houseNumber>sample string 15</houseNumber>
    <landName>sample string 18</landName>
    <latitude>1</latitude>
    <longitude>1</longitude>
    <postalCode>sample string 16</postalCode>
    <realEstateName>sample string 13</realEstateName>
    <streetAddress>sample string 14</streetAddress>
    <availableFromDate>2025-12-12T02:15:27.3169799+01:00</availableFromDate>
    <availableFromLatestDate>2025-12-12T02:15:27.3169799+01:00</availableFromLatestDate>
    <buildingIdApi>sample string 2</buildingIdApi>
    <contactsAndRoles>
      <ContactAndRole>
        <email>sample string 6</email>
        <mobilePhone>sample string 4</mobilePhone>
        <name>sample string 3</name>
        <workPhone>sample string 5</workPhone>
        <contactIdApi>sample string 1</contactIdApi>
        <roleType>MainContact</roleType>
        <title>sample string 2</title>
      </ContactAndRole>
      <ContactAndRole>
        <email>sample string 6</email>
        <mobilePhone>sample string 4</mobilePhone>
        <name>sample string 3</name>
        <workPhone>sample string 5</workPhone>
        <contactIdApi>sample string 1</contactIdApi>
        <roleType>MainContact</roleType>
        <title>sample string 2</title>
      </ContactAndRole>
    </contactsAndRoles>
    <dataSource>Unknown</dataSource>
    <estateIdApi>sample string 3</estateIdApi>
    <extraCostAmount>1</extraCostAmount>
    <extraCostDescription>sample string 11</extraCostDescription>
    <flatNumber>sample string 5</flatNumber>
    <floor>7</floor>
    <isGroundFloor>true</isGroundFloor>
    <mieExtraInfoUnit>
      <aqusitionDate>2025-12-12T02:15:27.3169799+01:00</aqusitionDate>
      <companyIdAccounting>1</companyIdAccounting>
      <operationEndDate>2025-12-12T02:15:27.3169799+01:00</operationEndDate>
      <publishStatus>2</publishStatus>
    </mieExtraInfoUnit>
    <objectDetailLevel>AllRentalFields</objectDetailLevel>
    <objectIdApi>sample string 1</objectIdApi>
    <objectMainState>Occupied</objectMainState>
    <objectMainType>Unknown</objectMainType>
    <objectRestriction>NoRestriction</objectRestriction>
    <objectShortName>sample string 6</objectShortName>
    <objectSubType>DefaultSubtype</objectSubType>
    <objectTypeText>sample string 4</objectTypeText>
    <rentalCost>1</rentalCost>
    <rentalCostDescription>sample string 10</rentalCostDescription>
    <rooms>1</rooms>
    <showComment>sample string 9</showComment>
    <showDates>
      <Showdate>
        <showdateEnd>2025-12-12T02:15:27.3169799+01:00</showdateEnd>
        <showdateStart>2025-12-12T02:15:27.3169799+01:00</showdateStart>
      </Showdate>
      <Showdate>
        <showdateEnd>2025-12-12T02:15:27.3169799+01:00</showdateEnd>
        <showdateStart>2025-12-12T02:15:27.3169799+01:00</showdateStart>
      </Showdate>
    </showDates>
    <sizeMain>12</sizeMain>
    <sizeMainMax>1</sizeMainMax>
    <sizeMainType>StandardAreaType</sizeMainType>
  </RentalObjectBasic>
</ArrayOfRentalObjectBasic>