Get an existing energy label. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the section.
Get an energy label of an object
This endpoint retrieves the current energy label registered for a real estate object, along with the supporting document if one was uploaded. It applies to any object type (building, complex, section, or unit).
The object can be identified by its internal reference, its external identifier, or both.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
reference | string | Conditional | Internal identifier of the object. Either reference or externalIdentifier must be provided. If both are given, the object must match both values. |
externalIdentifier | string | Conditional | External identifier of the object, as set by the integrating system. Either reference or externalIdentifier must be provided. If both are given, the object must match both values. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
energyLabelName | string | No | Energy label of the object, expressed as a letter grade. Values are configurable in the Bloxs application. Maximum length 6 characters. |
energyLabelValidUntilDate | string (date) | No | Date until which the energy label is valid. ISO 8601 format. |
document.fileName | string | No | Name of the supporting document (energy report) linked to the object. Only the file name is returned, not the file content itself. |
document.fileSize | integer (int64) | Yes | Size, in bytes, of the supporting document linked to the object. Only the file size is returned, not the file content itself. |
The internal identifier of the model (i.e. Reference, Code, Name, depends on model).
The external API identifier of the model.
OK
The requested real estate object was not found.