Contents x
    Add a new value for the object
    • 07 Feb 2025
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    Add a new value for the object

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

    Post
    /api/v1/realestateobjects/propertyvaluations

    [PREVIEW] Add a new value for existing real estate object.

    Description

    Add a value (including type) to an existing 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.

    Use Case

    A building will soon be made available for rent. Therefore the user wants to register the rent value of this property. This operation can be used to add this value.

    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.
    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 (.)

    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

    Body parameters
    object
    reference
    string | null
    externalIdentifier
    string | null
    valueTypeName
    string Required
    Min length1
    Max length30
    year
    integer (int32) Required
    Minimum1900
    Maximum2100
    amount
    number (double) Required
    Minimum0
    Maximum2147483647
    Responses
    200

    The value was added

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

    The value has validation issues

    Expand All
    object
    type
    string | null
    title
    string | null
    traceId
    string | null
    status
    integer (int32)
    errors
    object | null
    property*
    Array of string | null additionalProperties
    string
    What's Next