Contents x
    Get an existing values of the object
    • 07 Feb 2025
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    Get an existing values of the object

    • Updated on 07 Feb 2025
    • 1 Minute to read
    • Print
    • Dark
      Light
    Article summary

    Get
    /api/v1/realestateobjects/propertyvaluations

    [PREVIEW] Get an existing values list. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the section.

    Description

    Retrieve all known values (including the type) of a specific object. A real estate object can have several different types of values. Examples are the sales value or the rent value. 

    Both the 'reference' and the 'externalIdentifier' can be used to identify the object. Preferably only the reference is used. If this is not available, the externalIdentifier can be used. If both properties are used it is important that both are correct and match with the same entity (object). If this is not the case, the request will return with an error code.

    The response provides the full list of available types of values as an array.

    Use Case

    In a connected application the user wants to display all the value information of a specific property. In order to show these values this operation can be used.

    Request fields

    The request contains the following fields:

    FieldDescription
    referenceThe relationship number within Bloxs. This is unique (per client specific environment) for all objects. The relationship number is generated by the Bloxs system.
    externalIdentifierThe unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system.

    Response fields

    The response contains the fields in the table below:

    FieldDescription
    valueTypeNameThe value type. Examples are the sales value or the rent value.
    yearThe year in which the value has been assigned.
    amountThe actual value in numbers. Decimals are separated with a period (.)
    Security
    HTTP
    Type Bearer

    Please enter a valid token

    Query parameters
    reference
    string

    The internal identifier of the model (i.e. Reference, Code, Name, depends on model).

    externalIdentifier
    string

    The external API identifier of the model.

    Responses
    200

    OK

    Array of object
    object
    valueTypeName
    string
    Min length1
    Max length30
    year
    integer (int32)
    Minimum1900
    Maximum2100
    amount
    number (double)
    Minimum0
    Maximum2147483647
    404

    The requested real estate object was not found.

    What's Next