Contents x
    Get scoring point totals filtered and paged
    • 28 Mar 2025
    • 2 Minutes to read
    • Print
    • Dark
      Light
    Contents

    Get scoring point totals filtered and paged

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

    Post
    /api/v1/realestateobjects/scoringpointtotals/filter

    [PREVIEW] Get a paged list of existing scoring point totals, optionally filtered to the given parameters.

    Description

    Retrieve a paged list of existing scoring points totals, filtered to the given parameters. 

    The filter options include both the reference and the externalIdentifier. Please note that if both identifiers are given, both must match; otherwise, an error message will be generated. It is recommended that the user utilises only one identifier, with a preference for the reference.

    Use Case

    The user wants to know which scoring points totals are currently registered in Bloxs. For example, the user wants to see how many of the objects currently have a scoring points total between 200 - 250. Or, what values were registered for the previous time period.

    Request fields

    The request contains the following fields:

    FieldDescription
    paging.pageSizeThe maximum number of pages to be returned per request. The default number is 100 and the maximum is 1.000. If more results are returned than specified in the PageSize, the remaining pages are dropped based on the reference (number).
    paging.pageNumberThis allows the requesting party to specify which of the pages they want to receive.
    sorting.columnNameThe data field based on which sorting will be applied. For example, if the user wants to sort the results based on ascending name, the value 'name' should be given here.
    sorting.orderBased on this value, the property defined in 'columnName' will either be sorted ascending (a-z) or descending (z-a).
    referenceThis is the generated reference for the point calculation by Bloxs.
    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.
    homeTypeThis property identifies the type of the home. Value '1' stands independent whereas value '2' stands for dependent.
    timePeriodTitleThe 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.fromThe minimum of total scoring points for results to be included in the response.
    pointTotal.toThe maximum of total scoring points for results to be included in the response.
    finalPrice.fromThe minimum final price for results to be included in the response.
    finalPrice.to
    Security
    HTTP
    Type Bearer

    Please enter a valid token

    Body parameters
    Expand All
    object
    paging
    object (PagingInfo)
    pageSize
    integer (int32) | null
    Minimum1
    Maximum1000
    pageNumber
    integer (int32) | null
    Minimum1
    Maximum9999
    sorting
    object (SortingInfo)
    columnName
    string | null
    order
    integer (int32)

    0 = Ascending

    1 = Descending

    Valid values[ \0\, \1\ ]
    filter
    object (ScoringPointTotalSearchRequestFilter)
    reference
    string | null
    externalIdentifier
    string | null
    realEstateObjectReference
    string | null
    homeType
    integer (int32)

    1 = Independent

    2 = Dependent

    Valid values[ \1\, \2\ ]
    timePeriodTitle
    string | null
    pointTotal
    object (CompareFilterModelInteger)
    from
    integer (int32) | null
    to
    integer (int32) | null
    finalPrice
    object (CompareFilterModelDecimal)
    from
    number (double) | null
    to
    number (double) | null
    Responses
    200

    OK

    Expand All
    object
    paging
    object (PagingInfo)
    pageSize
    integer (int32) | null
    Minimum1
    Maximum1000
    pageNumber
    integer (int32) | null
    Minimum1
    Maximum9999
    sorting
    object (SortingInfo)
    columnName
    string | null
    order
    integer (int32)

    0 = Ascending

    1 = Descending

    Valid values[ \0\, \1\ ]
    scoringPointTotals
    Array of object (ScoringPointTotalSearchResultFilter) | null
    object
    reference
    string | null
    externalIdentifier
    string | null
    realEstateObjectReference
    string | null
    homeType
    integer (int32)

    1 = Independent

    2 = Dependent

    Valid values[ \1\, \2\ ]
    timePeriodTitle
    string | null
    pointTotal
    integer (int32)
    finalPrice
    number (double)
    What's Next