Contents x
    Get buildings filtered and paged
    • 21 Feb 2025
    • 5 Minutes to read
    • Print
    • Dark
      Light
    Contents

    Get buildings filtered and paged

    • Updated on 21 Feb 2025
    • 5 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    Post
    /api/v1/realestateobjects/buildings/filter

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

    Description

    Retrieve a paged list of existing buildings, optionally filtered to the given parameters. The Bloxs real estate objects-api offers 2 options to get buildings filtered and paged. One is through the POST option, and as an alternative there is a GET operation available. The functional difference is that the POST option offers the ability to sort the results. Furthermore, the POST includes the parameters in the body whereas the GET includes them in the url.

    Either reference or externalIdentifier must have a value. Please note that if both identifiers are given, both must match; otherwise, an error message will be generated. It is recommended that the user utilizes only one identifier, with a preference for the reference.

    A building is a standalone entity. It refers to a terraced house or an entire building that is not divided into multiple parts. A building is a rentable unit. If it contains multiple rental units, it is no longer considered a single building. A building can be included in a rental contract.

    Use Case

    The Bloxs user has an external App connected to Bloxs. Through this operation the user can display a paged list of buildings & the related information. This operation can be used if the user wants to display multiple buildings rather than just a specific one. If the user wants to display a single building the preference is to use the GET (buildings) operation.   

    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).
    nameThe custom name assigned to the object. This is used for reporting and to distinguish the object when the address alone is insufficient. In the case of room rentals, this would be the address + room number. This name can also be displayed on invoices and bills.
    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.
    ownerReferenceProperty owner. This field is used to link the property to its owner. Since a property must have an owner, this field is mandatory. It is part of the contracts triangle of properties, owners, and tenants. The OwnerReference corresponds to the 'Reference' in the Relations. This unique ID is generated by the Bloxs portal and should not be confused with the external identifier. A property can have only one owner.
    estateAgentReference

    Real estate agent for the property

    This field links the property to a real estate agent. It must be an existing agent who has been previously added either through the Bloxs application or via the API. The estateAgentReference corresponds to the 'Reference' previously assigned to the real estate agent. This unique ID is generated by the Bloxs application and should not be confused with the external identifier. A property can have only one real estate agent.

    addressStreetAndHousenumberStreet and house number of the object. 
    addressPostalCodePostal Code of the object.
    addressCityCity in which the object is located.
    addressCountryISOCodeCountry in which the object is located.
    ISO language code. Use the 2-letter code from the ISO 639-1 Code list.
    rawFloorArea.from

    Gross Floor Area

    The total measured floor area according to the NEN2580 standards. Decimals are separated with a period (.).

    The minimum raw floor area that must be used for the selection.

    rawFloorArea.to

    Gross Floor Area

    The total measured floor area according to the NEN2580 standards. Decimals are separated with a period (.).

    The maximum raw floor area that must be used for the selection.

    rentableFloorArea.from

    Rentable Floor Area

    Rentable floor area according to the NEN2580 standards. Decimals are separated with a period (.).

    The minimum rentable floor area that must be used for the selection.

    rentableFloorArea.toRentable Floor Area

    Rentable floor area according to the NEN2580 standards. Decimals are separated with a period (.).

    The maximum rentable floor area that must be used for the selection.

    usableFloorArea.fromUsable Floor Area

    The surface of the floor that can actually be used.

    The minimum usable floor area that must be used for the selection.
    usableFloorArea.to
    		The maximum usable floor area that must be used for the selection.
    underManagementSince.fromFrom this date, the user has become the manager of the object. The date is initially entered and remains unchanged until the sale/termination of management.
    underManagementSince.toThe end date from which the user is no longer the manager of the object.
    salesDate.fromThe starting date on which the object was sold or is no longer under management.
    salesDate.toThe end date on which the object was sold or is no longer under management.
    LastModified.fromThe starting date on which a building was last modified
    LastModified.toThe end date on which a building was last modified.
    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 (BuildingSearchRequestFilter)
    name
    string | null
    reference
    string | null
    externalIdentifier
    string | null
    ownerReference
    string | null
    estateAgentReference
    string | null
    addressStreetAndHouseNumber
    string | null
    addressPostalCode
    string | null
    addressCity
    string | null
    addressCountryISOCode
    string | null
    rawFloorArea
    object (CompareFilterModelDecimal)
    from
    number (double) | null
    to
    number (double) | null
    rentableFloorArea
    object (CompareFilterModelDecimal)
    from
    number (double) | null
    to
    number (double) | null
    usableFloorArea
    object (CompareFilterModelDecimal)
    from
    number (double) | null
    to
    number (double) | null
    underManagementSince
    object (CompareFilterModelDateTime)
    from
    string (date-time) | null
    to
    string (date-time) | null
    salesDate
    object (CompareFilterModelDateTime)
    from
    string (date-time) | null
    to
    string (date-time) | null
    lastModified
    object (CompareFilterModelDateTime)
    from
    string (date-time) | null
    to
    string (date-time) | 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\ ]
    buildings
    Array of object (BuildingSearchResultFilter) | null
    object
    name
    string | null
    reference
    string | null
    externalIdentifier
    string | null
    ownerReference
    string | null
    estateAgentReference
    string | null
    addressStreetAndHouseNumber
    string | null
    addressPostalCode
    string | null
    addressCity
    string | null
    addressCountryISOCode
    string | null
    rawFloorArea
    number (double) | null
    rentableFloorArea
    number (double) | null
    usableFloorArea
    number (double) | null
    underManagementSince
    string (date-time) | null
    salesDate
    string (date-time) | null
    lastModified
    string (date-time)
    What's Next