Glossary
Areas
The following flyer shows the official IS24 naming of the areas of commercial properties( click to enlarge):
Areas, Office
Note that in the search all REST parameters are lowercased.
Attachment
Attachment refers to a multimedia object that is attached to a real estate object (e. g. a picture or floorplan of an real estate object). German: Anhang, Multimediaobjekt (MMO)
To retrieve or upload an attachment using the RESTful API, we suggest to use a binary encoding format as representation (e. g. multipart).
Supported attachment types: Image/Picture, Document (PDF), Video, Streaming Video. Images/Pictures and PDF documents can be used to provide a floorplan (Grundriss).
PENDING: first/title picture, description
User attachments This kind of attachment is related to user created content (e. g pictures taken with a mobile phone and stored with an user's shortlist entry).
Budget Rent
Budget Rent is the ammount of money which has to be payed periodically to the owner of the real estate. This may be the plain net rent, the net rent plus service charges or the net rent plus service charges plus heating costs. When searching for "budgetrent", the price will contain the best guess of a sum of rent, service charges and heating costs. It will also contain a marker, which information was available to do this guess. A result list has to conain a visual information depending on this marker to let the user distinguish the different types of data which lead to the sum in price.
The budget rent will be delivered in the calculated price element of the result list. These are the possible "rentScope" facets:
-
NET_RENT only net rent information is available
-
GROSS_RENT net rent plus service charges without heating costs are available
-
INCONSISTENT_WARM_RENT net rent, service charges and heating costs are available, but the given information is inconsistent. E.g the renter can't charge one for heating costs when the heating is a kind of individual heating like oven or individual gas heating.
-
WARM_RENT net rent plus service charges plus heating costs. There is no information in the data, that let us assume, that more charges have to be payed. Example Results for Budget Rent
GeoCodeId
An internal unique identifier to identify an element in a geohierarchy. The following categories of geohierarchy elements are supported: continent, country, region, city, district. For example, the geocode of the continent Europe is 1, the geocode of the country Germany is 276. An qualified geocode consist of the id 1 (for Europe) and the id 276 (for Germany): "1276" (as an encoded representation).
A valid geocode id could be:
1 | |
- /geocode: the root resource
- /continent/1: a path parameter representing the continent in the geocode hierarchy
- /country/276: a path parameter representing the country within a continent in the geocode hierarchy
- /region/...: a path parameter representing the region (e.g. federal state) within a country in the geocode hierarchy
- /city/...: a path parameter representing an city within a region in the geocode hierarchy
- /quarter/...: a path parameter representing a district within a city in the geocode hierarchy It is suggested to use id's where ever a name is not unique. You can use sub resources instead of path parameters, if required.
Imprint
Imprint (German Impressum) contains the information that the realtor is bound by the law to uncover to his customers.
Real Estate Type
The following real estate types are supported on our platform:
Not all of these real estate types might be supported by all services. If these real estate types are used as query parameters in the search context they have to be lowercased without '_', e.g. apartmentbuy instead of APARTMENT_BUY, see the Search Query Parameters Page for further details.
| in output/schemas | numerical value in resultlistEntries | as URL parameter value |
|---|---|---|
| APARTMENT_BUY (Wohnung zum Kauf) | 2 | apartmentbuy |
| APARTMENT_RENT (Mietwohnung) | 0 | apartmentrent |
| ASSISTED_LIVING (Betreutes Wohnen) | 20 | assistedliving |
| COMPULSORY_AUCTION (Zwangsversteigerung) | 13 | compulsoryauction |
Realtor
A realtor (e. g. a real estate agent) offers real estate objects. German: Anbieter