GET ObjectInfo/{dataSource}/{partnerName}/{objectIdApi}

Get one rental object with all rental info except attachments

Request Information

URI Parameters

Name	Type	Additional information
dataSource	DataSourceEnum	Required
partnerName	string	Required
objectIdApi	string	Required

Body Parameters

None.

Response Information

Resource Description

RentalObjectApi

Name	Description	Type	Additional information
descriptionHtml	Field descriptionHtml is not delivered when objectDetailLevel is 'search fields only' due to performace (the limiting objectDetailLevel = 'search fields only' is only used when the result is a LIST OF ALL rental objects) • Sweden and Denmark : The field descriptionHtml is a rather short description while the complete prospect is in the attachment "marketing URL" • Norway : The field descriptionHtml is all text for the complete prospect.The "marketing URL" is NOT delivered for Norway except for some very few business prospects.	string	None.
objectProperties	objectProperties is not delivered when objectDetailLevel is 'search fields only' due to performace (the limiting objectDetailLevel = 'search fields only' is only used when the result is a LIST OF ALL rental objects)	Collection of ObjectProperty	None.
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:

{
  "descriptionHtml": "sample string 1",
  "objectProperties": [
    {
      "objectPropertyType": 0,
      "objectPropertySourceId": "sample string 1",
      "nameWeb": "sample string 2",
      "comments": "sample string 3"
    },
    {
      "objectPropertyType": 0,
      "objectPropertySourceId": "sample string 1",
      "nameWeb": "sample string 2",
      "comments": "sample string 3"
    }
  ],
  "dataSource": 0,
  "objectIdApi": "sample string 2",
  "buildingIdApi": "sample string 3",
  "estateIdApi": "sample string 4",
  "objectDetailLevel": 20,
  "mieExtraInfoUnit": {
    "aqusitionDate": "2025-12-12T02:15:23.0066831+01:00",
    "operationEndDate": "2025-12-12T02:15:23.0066831+01:00",
    "companyIdAccounting": 1,
    "publishStatus": 2
  },
  "objectMainType": 0,
  "objectSubType": 0,
  "objectRestriction": 0,
  "objectTypeText": "sample string 5",
  "rooms": 1,
  "flatNumber": "sample string 6",
  "objectShortName": "sample string 7",
  "floor": 8,
  "isGroundFloor": true,
  "objectMainState": 1,
  "availableFromDate": "2025-12-12T02:15:23.0066831+01:00",
  "availableFromLatestDate": "2025-12-12T02:15:23.0066831+01:00",
  "showComment": "sample string 10",
  "showDates": [
    {
      "showdateStart": "2025-12-12T02:15:23.0066831+01:00",
      "showdateEnd": "2025-12-12T02:15:23.0066831+01:00"
    },
    {
      "showdateStart": "2025-12-12T02:15:23.0066831+01:00",
      "showdateEnd": "2025-12-12T02:15:23.0066831+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 11",
  "extraCostAmount": 1,
  "extraCostDescription": "sample string 12",
  "sizeMain": 13.0,
  "sizeMainType": 0,
  "sizeMainMax": 1.0,
  "realEstateName": "sample string 14",
  "streetAddress": "sample string 15",
  "houseNumber": "sample string 16",
  "postalCode": "sample string 17",
  "city": "sample string 18",
  "landName": "sample string 19",
  "areaId": "sample string 20",
  "areaName": "sample string 21",
  "latitude": 1.0,
  "longitude": 1.0,
  "energyLabel": "sample string 22"
}

application/xml, text/xml

Sample:

<RentalObjectApi xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HeimModel">
  <areaId>sample string 20</areaId>
  <areaName>sample string 21</areaName>
  <city>sample string 18</city>
  <energyLabel>sample string 22</energyLabel>
  <houseNumber>sample string 16</houseNumber>
  <landName>sample string 19</landName>
  <latitude>1</latitude>
  <longitude>1</longitude>
  <postalCode>sample string 17</postalCode>
  <realEstateName>sample string 14</realEstateName>
  <streetAddress>sample string 15</streetAddress>
  <availableFromDate>2025-12-12T02:15:23.0066831+01:00</availableFromDate>
  <availableFromLatestDate>2025-12-12T02:15:23.0066831+01:00</availableFromLatestDate>
  <buildingIdApi>sample string 3</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 4</estateIdApi>
  <extraCostAmount>1</extraCostAmount>
  <extraCostDescription>sample string 12</extraCostDescription>
  <flatNumber>sample string 6</flatNumber>
  <floor>8</floor>
  <isGroundFloor>true</isGroundFloor>
  <mieExtraInfoUnit>
    <aqusitionDate>2025-12-12T02:15:23.0066831+01:00</aqusitionDate>
    <companyIdAccounting>1</companyIdAccounting>
    <operationEndDate>2025-12-12T02:15:23.0066831+01:00</operationEndDate>
    <publishStatus>2</publishStatus>
  </mieExtraInfoUnit>
  <objectDetailLevel>AllRentalFields</objectDetailLevel>
  <objectIdApi>sample string 2</objectIdApi>
  <objectMainState>Occupied</objectMainState>
  <objectMainType>Unknown</objectMainType>
  <objectRestriction>NoRestriction</objectRestriction>
  <objectShortName>sample string 7</objectShortName>
  <objectSubType>DefaultSubtype</objectSubType>
  <objectTypeText>sample string 5</objectTypeText>
  <rentalCost>1</rentalCost>
  <rentalCostDescription>sample string 11</rentalCostDescription>
  <rooms>1</rooms>
  <showComment>sample string 10</showComment>
  <showDates>
    <Showdate>
      <showdateEnd>2025-12-12T02:15:23.0066831+01:00</showdateEnd>
      <showdateStart>2025-12-12T02:15:23.0066831+01:00</showdateStart>
    </Showdate>
    <Showdate>
      <showdateEnd>2025-12-12T02:15:23.0066831+01:00</showdateEnd>
      <showdateStart>2025-12-12T02:15:23.0066831+01:00</showdateStart>
    </Showdate>
  </showDates>
  <sizeMain>13</sizeMain>
  <sizeMainMax>1</sizeMainMax>
  <sizeMainType>StandardAreaType</sizeMainType>
  <descriptionHtml>sample string 1</descriptionHtml>
  <objectProperties>
    <ObjectProperty>
      <comments>sample string 3</comments>
      <nameWeb>sample string 2</nameWeb>
      <objectPropertySourceId>sample string 1</objectPropertySourceId>
      <objectPropertyType>OtherProperty</objectPropertyType>
    </ObjectProperty>
    <ObjectProperty>
      <comments>sample string 3</comments>
      <nameWeb>sample string 2</nameWeb>
      <objectPropertySourceId>sample string 1</objectPropertySourceId>
      <objectPropertyType>OtherProperty</objectPropertyType>
    </ObjectProperty>
  </objectProperties>
</RentalObjectApi>