Contents x
    Get an energy label of an object
    • 07 Feb 2025
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    Get an energy label of an object

    • Updated on 07 Feb 2025
    • 1 Minute to read
    • Print
    • Dark
      Light
    Article summary

    Get
    /api/v1/realestateobjects/energylabels

    [PREVIEW] Get an existing energy label. Either reference or externalIdentifier must have a value. If both are given, both are used for retrieving the section.

    Description

    Retrieve the energy label of a certain real estate object.

    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.

    Use Case

    The user wants to show the energy label of a certain real estate object in an application connected to the Bloxs API. 

    Request fields

    The request contains the following fields:

    FieldDescription
    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.

    Response fields

    The response contains the fields in the table below. 

    FieldDescription
    energyLabelA 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.
    energyLabelValidUntilDateThe date until when the energy label is valid.
    document.fileNameThe name of the file (energy report) which is linked to the real estate object. This does not contain the actual file itself.
    document.fileSizeThe size of the file (energy report) which is linked to the real estate object. This does not contain the actual file itself.
    Security
    HTTP
    Type Bearer

    Please enter a valid token

    Query parameters
    reference
    string

    The internal identifier of the model (i.e. Reference, Code, Name, depends on model).

    externalIdentifier
    string

    The external API identifier of the model.

    Responses
    200

    OK

    Expand All
    object
    energyLabelName
    string | null
    energyLabelValidUntilDate
    string (date) | null
    document
    object (EnergyLabelDocumentAPIDetailsModel)
    fileName
    string | null
    fileSize
    integer (int64)
    404

    The requested real estate object was not found.

    What's Next