Get apartment details
- 29 Aug 2023
- 3 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Get apartment details
- Updated on 29 Aug 2023
- 3 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/apartments/{id}/
Operation is used to retrieve full details of given apartment id. Available from product version 3.0.22.
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Path parameters
id
integer Required
Id of apartment
Responses
200
Apartment
object
address
object
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
Creation date and time
district
string
Building district
empty
integer
Address with this value as 1 is default address. Modifying or deleting such address is prohibited.
Valid values[0,1]
id
integer
Primary key
location
string
Geographical location
municipality
string
Building municipality
propertyId
string
Property number
province
string
Building province
sourceSystem
object
Source system
groupname
Group name of constant
Valid values["SOURCE_SYSTEM"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
txt
string
Human readable textual representation
sourceSystemKey
integer
source system key
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
Last update date time
usagePurpose
object
Building usage purpose
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values["BUILDING_USAGE"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
usagePurposeAlt
object
Address usage purpose
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values["KN_ADDR_SPEC"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
zipcode
string
Building zipcode
apartmentDivision
string
apartment division
apartmentLetter
string
apartment letter
apartmentNumber
string
apartment number
empty
integer
Apartment with this value as 1 is default apartment. Modifying or deleting such apartment is prohibited.
Valid values[0,1]
id
integer
Primary key
originProperty
string
apartment original property id
originalStreetno
string
apartment original streen number
sourceSystem
object
Source system
groupname
Group name of constant
Valid values["SOURCE_SYSTEM"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
txt
string
Human readable textual representation
sourceSystemKey
integer
source system key
usagePurpose
object
Apartment Usage purpose
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values["APARTMENT_USAGE"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
usagePurposeAlt
object
Address usage purpose
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values["KN_ADDR_SPEC"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
usageState
object
Apartment status
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values["APARTMENT_STATUS"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
401
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}object
details
string
Detailed description of error
404
Object was not found
{
"details": "Not found."
}object
details
string
Detailed description of error
Was this article helpful?
