Get list of Real Estates
- 17 Jan 2024
- 2 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Get list of Real Estates
- Updated on 17 Jan 2024
- 2 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/real-estate/
Operation is used to get a list of Real Estates
Real Estate data can be filtered by giving filtering parameters at HTTP querystring (see parameters).
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Query parameters
offset
integer
Offset to start returning results.
Minimum0
limit
integer
Limit number of results returned.
Minimum1
__any of the object fields__
string
Filters list by selected object field value. Supports structured queries via +__+ delimiter. Supports ending keywords via +__+ delimiter:
- For string fields: istartswith, startswith, iendswith, endswith, contains, icontains, isnull
- For numerics: gt, lt, gte, lte, isnull
- For spatial fields: contains, isnull, within, intersects, disjoint, touches, overlaps, covers, coveredby Examples:
+++usage_state__txt__istartswith=in+++,+++plan__state__txt__startswith=In+++,+++creation_date__gte=2019-01-02T15:32:01+++,+++location__within=POLYGON ((641503.89 6944059.81, 641406.52 6943933.87, 641369.48 6943772.48, 641474.25 6943704.74, 641873.78 6943735.96, 641848.38 6943975.15, 641607.08 6944167.76, 641653.11 6944102.15, 641503.89 6944059.81))+++
orderby
string
Selects the object field to order the returned objects by. Can be used to sort in reverse order with '-' prefix. Can have several ordering rules separated by comma. Can be used only for object own fields and does not supports structured queries. Example: orderby=creator,-creation_date
Responses
200
A result response object
object
Next
string (url)
Url to next page of the list if applicable. (Null if none)
Prev
string (url)
Url to previous page of the list if applicable. (Null if none)
Results
Array of object (RealEstate)
List of fetched Keydh Nodes
object
Address
object (Apartment)
address
object (Address)
buildingId
string
Building id
city
string
Building city name
cityAlt
string
Building city name in alternative language
country
string
Building country
createdBy
string
creator
createdTs
string (date-time)
Creation date and time
district
string
Building district
id
integer
Primary key
location
string (ewkt)
Geographical location
municipality
string
Building municipality
propertyId
string
Property number
province
string
Building province
streetname
string
Building street name
streetnameAlt
string
Building street name in alternative language
streetno
string
Building number
subdivision
string
Building municipality subdivision
updatedBy
string
Last updater
updatedTs
string (date-time)
Last update date time
usagePurpose
object (BuildingUsage)
Building usage purpose
groupname
Group name of constant
Valid values[ "BUILDING_USAGE" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
txt
string
Human readable textual representation
usagePurposeAlt
object (AddressSecondaryUsage)
Address usage purpose
groupname
Group name of constant
Valid values[ "KN_ADDR_SPEC" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
txt
string
Human readable textual representation
zipcode
string
Building zipcode
apartmentDivision
string
apartment division
apartmentLetter
string
apartment letter
apartmentNumber
string
apartment number
id
integer
Primary key
originProperty
string
apartment original property id
originalStreetno
string
apartment original streen number
usagePurpose
object (ApartmentUsage)
Apartment Usage purpose
groupname
Group name of constant
Valid values[ "APARTMENT_USAGE" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
txt
string
Human readable textual representation
usagePurposeAlt
object (AddressSecondaryUsage)
Address usage purpose
groupname
Group name of constant
Valid values[ "KN_ADDR_SPEC" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
txt
string
Human readable textual representation
usageState
object (ApartmentStatus)
Apartment status
groupname
Group name of constant
Valid values[ "APARTMENT_STATUS" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
txt
string
Human readable textual representation
basement_area
integer
Basement area
build_date
string (date)
Build date
building_classification
string
Building classification
construction_licence
integer
Construction license
flat_area
integer
Flat area
floor_area
integer
Floor area
floor_number
integer
Floor number
id
integer
Primary key
location
string (ewkt)
Geographical location
owner
string
Owner
real_estate_name
string
Real estate name
real_estate_number
string
Real estate number
total_area
integer
Total area
volume
integer
Volume
Total
integer
Total number of Real Estate objects in the list
401
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}object
details
string
Detailed description of error
Was this article helpful?
