Get an existing values list. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the section.
Get existing values of the object
This endpoint retrieves all property valuation entries currently recorded for a real estate object, such as its taxation value or WOZ value across different years. It applies to any object type.
The object can be identified by its internal reference, its external identifier, or both.
The response can contain more than one entry with the same valueTypeName and year, since the Add a new value endpoint does not prevent duplicates.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
reference | string | Conditional | Internal identifier of the object. Either reference or externalIdentifier must be provided. If both are given, the object must match both values. |
externalIdentifier | string | Conditional | External identifier of the object, as set by the integrating system. Either reference or externalIdentifier must be provided. If both are given, the object must match both values. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
valueTypeName | string | Yes | Type of value, for example sales value or rent value. Maximum length 30 characters. |
year | integer | Yes | Calendar year the value applies to. Minimum 1900, maximum 2100. |
amount | number (double) | Yes | Value amount. Decimals are separated with a period. Minimum 0. |
measureDate | string (date) | No | Date the value was measured or assessed, if different from the calendar year alone. ISO 8601 format. |
The internal identifier of the model (i.e. Reference, Code, Name, depends on model).
The external API identifier of the model.
OK
The requested real estate object was not found.