> ## Documentation Index
> Fetch the complete documentation index at: https://www.bloxs.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Update an energy label
> Update an energy label of existing real estate object.
## OpenAPI
````json PUT /api/v1/realestateobjects/energylabels
{
"openapi": "3.0.4",
"info": {
"title": "RealEstateObjects V1",
"description": "Welcome to BETA version of the new RealEstateObjects API - intended for client public testing before the launch of the final version. During this BETA phase, we'll be improving the API based on specific client's feedbacks.",
"version": "v1"
},
"security": [
{}
],
"tags": [
{
"name": "Admin"
},
{
"name": "Buildings"
},
{
"name": "Complexes"
},
{
"name": "Generic"
},
{
"name": "Metadata"
},
{
"name": "PublishObjects"
},
{
"name": "ScoringPointTotals"
},
{
"name": "Sections"
},
{
"name": "Units"
}
],
"paths": {
"/api/v1/realestateobjects/energylabels": {
"put": {
"tags": [
"Generic"
],
"summary": "Update an energy label",
"description": "Update an energy label of existing real estate object.",
"operationId": "UpdateObjectEnergyLabel",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnergyLabelAPIModel"
}
}
}
},
"responses": {
"200": {
"description": "The energy label was updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnergyLabelAPIDetailModel"
}
}
}
},
"400": {
"description": "The energy label has validation issues",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorMessageModel"
}
}
}
}
},
"x-d360-narrative-url": "Update an energy label
This endpoint updates the energy label of an existing real estate object, optionally replacing its supporting document.
The object to update is identified by its internal reference, its external identifier, or both. If both are given, they must refer to the same object, otherwise the request fails.
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. |
energyLabelName | string | Yes | 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 | Yes (within document) | Name of the supporting document being uploaded. Maximum length 512 characters. |
document.mimeType | string | Yes (within document) | MIME type of the supporting document, for example application/pdf or image/png. Maximum length 100 characters. |
document.base64 | string | Yes (within document) | Base64-encoded content of the supporting document. |
Response Fields
Field | Type | Required | Description |
|---|
energyLabelName | string | No | Energy label of the object, expressed as a letter grade. |
energyLabelValidUntilDate | string (date) | No | Date until which the energy label is valid. ISO 8601 format. |
document.fileName | string | No | Name of the supporting document linked to the object. |
document.fileSize | integer (int64) | Yes | Size, in bytes, of the supporting document linked to the object. |