Contents x
    Insert a scoring point total
    • 28 Mar 2025
    • 3 Minutes to read
    • Print
    • Dark
      Light
    Contents

    Insert a scoring point total

    • Updated on 28 Mar 2025
    • 3 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    Post
    /api/v1/realestateobjects/scoringpointtotals

    [PREVIEW] Insert a new scoring point total for an object and period. Will automatically be activated after insertion, marking any existing scoring point total for the same object and period as revised in the process.

    Description

    Add a scoring points total to an existing object. While in the Bloxs application detailed calculation can be made, through the API the user can only enter the total points, the maximum rent value and to which time period it applies. If a calculation for the time period already exists in the Bloxs application, this one will be archived. The new values will replace the archived values as the active scoring points total. The maximum rent value is indicative and no business logic is present through this data field preventing the indexation to rise above this value. However, the user will see a notification in the Bloxs application. For example, the current rent is 980, the maximum rent value is 1000 and the indexation is 5%. This means that at the next indexation period the rent price will rise above the maximum rent. The maximum rent entered through the API does not prevent this. The user needs to set this in the Bloxs application as a limit, which is not available in the API. The maximum rent value should annually be updated by the user, this is not automatically updated by Bloxs.

    Use Case

    The Bloxs user has recently registered a new Unit in Bloxs and therefore wants to enter the scoring points for this object. Since the user already knows the points value, the user does not need to perform the calculation in the Bloxs application. Rather the user wants to only add the total points and for this can use this endpoint.

    Request fields

    The request contains the following fields:

    FieldDescription
    externalIdentifierThe unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system. This externalIdentifier is linked to the entry of the scoring points, and should not be confused with the externalIdentifier of the object.
    realEstateObjectReference
    		The reference of the real estate object which the scoring point total applies to. In order to retrieve this reference one of the GET operations in the RealEstateObjects API should be used.
    homeType
    		This property identifies the type of the home. Value '1' stands independent whereas value '2' stands for dependent.
    timePeriodTitle
    		The title of the time period to which the score points entry applies to. Different time periods can have different scores. Only values which are part of the existing list of time periods can be entered here. In order to retrieve the list the GET Timeperiods should be used.
    pointTotal
    		The total amount of scoring points for this specific time period. In the Bloxs application a detailed calculation can be made and points can be entered per category, in order to derive a total. The API only offers the possibility to enter the total amount.
    finalPriceThe maximum rent price associated with the the total scoring points, and for this specific time period.
    fileName

    For every scoring points total entry which is added, documentation as proof is obligatory. This documentation needs to be added in both Dutch and English.

    This property defines the name of the file which is added.

    mimeType
    		The format of the file in accordance with the MIME standards. The only MIME type which is accepted is PDF (application/pdf).
    base64
    		The base64 string of the document.


    Response fields

    The response contains the fields in the table below. 

    FieldDescription
    referenceThis is the generated reference for the point calculation by Bloxs.
    Security
    HTTP
    Type Bearer

    Please enter a valid token

    Body parameters
    Expand All
    object
    externalIdentifier
    string Required
    Min length0
    Max length100
    realEstateObjectReference
    string Required
    Min length0
    Max length100
    homeType
    integer (int32) Required

    1 = Independent

    2 = Dependent

    Valid values[ \1\, \2\ ]
    timePeriodTitle
    string Required
    Min length0
    Max length256
    pointTotal
    integer (int32) Required
    finalPrice
    number (double) Required
    file_Dutch
    object (APIFilePutModel) Required
    fileName
    string Required
    Min length1
    Max length512
    mimeType
    string Required
    Min length1
    Max length100
    base64
    string Required
    Min length1
    file_English
    object (APIFilePutModel) Required
    fileName
    string Required
    Min length1
    Max length512
    mimeType
    string Required
    Min length1
    Max length100
    base64
    string Required
    Min length1
    Responses
    200

    The scoring point total was created

    object
    externalIdentifier
    string
    Min length0
    Max length100
    realEstateObjectReference
    string
    Min length0
    Max length100
    homeType
    integer (int32)

    1 = Independent

    2 = Dependent

    Valid values[ \1\, \2\ ]
    timePeriodTitle
    string
    Min length0
    Max length256
    pointTotal
    integer (int32)
    finalPrice
    number (double)
    reference
    string
    Min length0
    Max length100
    400

    The scoring point total data 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