Contents x
    Update an energy label
    • 07 Feb 2025
    • 2 Minutes to read
    • Print
    • Dark
      Light
    Contents

    Update an energy label

    • Updated on 07 Feb 2025
    • 2 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    Put
    /api/v1/realestateobjects/energylabels

    [PREVIEW] Update an energy label of existing real estate object.

    Description

    Update an existing energy label of an object. Both the 'reference' and the 'externalIdentifier' can be used to identify the object. Preferably only the reference is used. If this is not available, the externalIdentifier can be used. If both properties are used it is important that both are correct and match with the same entity (object). If this is not the case, the request will return with an error code.

    Use Case

    After retrieving the energy label of an object with the Get an energy label operation the user notices that the value is outdated and should be changed. The user can call the put operation to change the value.  

    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.
    energyLabelNameA 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.
    energyLabelNameValidUntilDateThe 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.mimeType

    The technical specification of the file (e.g., application/pdf, image/png).

    document.base64The file in base64 encoding.

    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

    Body parameters
    Expand All
    object
    reference
    string | null
    externalIdentifier
    string | null
    energyLabelName
    string Required
    Min length1
    Max length6
    energyLabelValidUntilDate
    string (date) | null
    document
    object (APIFilePutModel)
    fileName
    string Required
    Min length1
    Max length512
    mimeType
    string Required
    Min length1
    Max length100
    base64
    string Required
    Min length1
    Responses
    200

    The energy label was updated

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

    The energy label has validation issues

    Expand All
    object
    type
    string | null
    title
    string | null
    traceId
    string | null
    status
    integer (int32)
    errors
    object | null
    property*
    Array of string | null additionalProperties
    string
    What's Next