Get complexes filtered and paged
- 21 Feb 2025
- 4 Minutes to read
- Print
- DarkLight
Get complexes filtered and paged
- Updated on 21 Feb 2025
- 4 Minutes to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Get
/api/v1/realestateobjects/complexes/filter
[PREVIEW] Get a paged list of existing complexes, optionally filtered to the given parameters. A param-based alternative to the '/filter' POST endpoint.
Description
Retrieve a paged list of existing complexes, optionally filtered to the given parameters. The Bloxs real estate objects-api offers 2 options to get complexes 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 complex is a collection of rentable units. This is often under one roof but not necessarily. Example of not being under one roof: the employee housing site from a company, where all the different buildings are considered buildings within a complex. Typically, complexes are under one roof.
Use Case
The Bloxs user has an external App connected to Bloxs. Through this operation the user can display a paged list of complexes & the related information. This operation can be used if the user wants to display multiple complexes rather than just a specific one. If the user wants to display a single complex the preference is to use the GET (complexes) operation.
Request fields
The request contains the following fields:
| Field | Description |
|---|---|
| paging.pageSize | The 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.pageNumber | This allows the requesting party to specify which of the pages they want to receive. |
| name | The 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. |
| reference | The relationship number within Bloxs. This is unique (per client specific environment) for all objects. The relationship number is generated by the Bloxs system. |
| externalIdentifier | The unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system. |
| ownerReference | Property 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. |
| addressStreetandHouseNumber | Street in which the object is located. |
| addressPostalCode | Postal Code of the object |
| addressCity | City in which the object is located. |
| addressCountryISOCode | ISO country code. Use the 2-letter code from the ISO 639-1 Code list. |
Response fields
In addition to the fields in the request, the response also contains the fields in the table below.
| Field | Description |
|---|---|
| underManagementSince | From 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. |
| salesDate | Date on which the building was sold. |
| lastModifed | Date on which the data for this building was last modified. |
Security
HTTP
Type Bearer
Please enter a valid token
Query parameters
pageSize
integer (int32)
The requested page size. Defaults to 100 when not given.
Minimum1
Maximum1000
pageNumber
integer (int32)
The requested page number. Defaults to 1 when not given.
Minimum1
Maximum9999
name
string
Optional filter on the name of the complex.
reference
string
Optional filter on the reference of the complex.
externalIdentifier
string
Optional filter on the external API identifier of the complex.
ownerReference
string
Optional filter on the reference of the owner the complex belongs to.
estateAgentReference
string
Optional filter on the reference of the estate agent of the complex.
addressStreetAndHouseNumber
string
Optional filter on the street and house number of the address of the complex.
addressPostalCode
string
Optional filter on the postal code of the address of the complex.
addressCity
string
Optional filter on the city of the address of the complex.
addressCountryISOCode
string
Optional filter on the country ISO code of the address of the complex.
Responses
200
OK
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 ]
complexes
Array of object (ComplexSearchResultFilter) | 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
underManagementSince
string (date-time) | null
salesDate
string (date-time) | null
lastModified
string (date-time)