- 07 Feb 2025
- 1 Minute to read
- Print
- DarkLight
Get a list of energy labels
- Updated on 07 Feb 2025
- 1 Minute to read
- Print
- DarkLight
[PREVIEW] Get a list of existing energy labels.
Description
Energy labels can be assigned to RealEstateObjects. However, in order to add the correct energy label the Bloxs user needs to know which labels are available in the application. This endpoint can be used to retrieve the available energy labels. This is a standard list, however it can be edited by the user in the Bloxs application (it is not possible through the API).
The response provides the full list of available energy labels as an array.
Use Case
By using the Energylabels/PUT operation the user wants to change the energy label of an Real estate object. However, the user does not know which options are available as energy labels. Therefore, the user can use this endpoint to retrieve all available labels.
Response fields
The response contains the fields in the table below. For every energy label both properties will be included in the response.
Field | Description |
---|---|
energyLabelName | A representation of the energy performance of the property. Defined as a letter. This is a standard list, but it can be modified by the user. |
orderIndex | The order in which the energy labels are shown, starting with 1 from the top. |
Please enter a valid token
OK