Energy Diagnosis

Update energy performance diagnosis

Updates an existing energy performance diagnosis

put/energy-diagnoses/{id}

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/energy-diagnoses/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Energy performance diagnosis ID

Request body

reference_numberstring nullable

DPE reference number

diagnosis_datestring date nullable

Diagnosis date

valid_untilstring date nullable

Diagnosis validity date (10 years maximum)

energy_label'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G'

DPE energy label (A to G)

energy_consumptionnumber double nullable

Energy consumption in kWh/m²/year.

Update behavior:

  • Field absent: the existing value is preserved
  • null: the value is removed (set to NULL in database)
  • Numeric value: the value is updated
ges_label'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G'

DPE GHG (Greenhouse Gas) label (A to G)

ges_emissionnumber double nullable

GHG emission in kg CO2/m²/year.

Update behavior:

  • Field absent: the existing value is preserved
  • null: the value is removed (set to NULL in database)
  • Numeric value: the value is updated
heated_areanumber double nullable

Heated area in m².

Update behavior:

  • Field absent: the existing value is preserved
  • null: the value is removed (set to NULL in database)
  • Numeric value: the value is updated
construction_yearinteger nullable

Construction year of the property

diagnostician_contact_idstring uuid nullable

Diagnostician contact ID.

Update behavior:

  • Field absent: the existing value is preserved
  • null: the value is removed (set to NULL in database)
  • Valid UUID: the value is updated
notesstring nullable

Additional notes about the diagnosis.

Update behavior:

  • Field absent: the existing value is preserved
  • null: the value is removed (set to NULL in database)
  • String value: the value is updated
media_idstring uuid nullable

Media ID of the uploaded DPE PDF document.

Update behavior:

  • Field absent: the existing value is preserved
  • null: the value is removed (set to NULL in database)
  • Valid UUID: the value is updated

Example request

{
  "reference_number": "DPE-2024-002",
  "diagnosis_date": "2024-02-10",
  "valid_until": "2034-02-10",
  "energy_label": "B",
  "energy_consumption": 125.8,
  "ges_label": "B",
  "ges_emission": 28.7,
  "heated_area": 65,
  "construction_year": 2010,
  "diagnostician_contact_id": "550e8400-e29b-41d4-a716-446655440003",
  "notes": "Apartment with reinforced insulation",
  "media_id": "550e8400-e29b-41d4-a716-446655440010"
}

Response

Energy performance diagnosis updated successfully

idstring uuid nullable required

Unique identifier of the DPE

estate_idstring uuid nullable

Property (if DPE for a specific property) ID

place_idstring uuid nullable

Place (if DPE for a specific place) ID

reference_numberstring nullable required

DPE reference number

diagnosis_datestring date nullable required

Diagnosis date

valid_untilstring date nullable required

Diagnosis validity date (10 years maximum)

energy_label'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' required

DPE energy label (A to G)

energy_consumptionnumber double nullable

Energy consumption in kWh/m²/year

ges_label'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' required

DPE GHG (Greenhouse Gas) label (A to G)

ges_emissionnumber double nullable

GHG emission in kg CO2/m²/year

heated_areanumber double nullable

Heated area in m²

construction_yearinteger nullable required

Construction year of the property

diagnostician_contact_idstring uuid nullable

Diagnostician contact ID

notesstring nullable

Internal notes about the diagnosis

media_idstring uuid nullable

Media ID of the uploaded DPE PDF document

created_atstring date-time nullable required

Creation date

updated_atstring date-time nullable required

Last modification date

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "estate_id": "550e8400-e29b-41d4-a716-446655440001",
  "place_id": "550e8400-e29b-41d4-a716-446655440002",
  "reference_number": "DPE-2024-002",
  "diagnosis_date": "2024-02-10",
  "valid_until": "2034-02-10",
  "energy_label": "B",
  "energy_consumption": 125.8,
  "ges_label": "B",
  "ges_emission": 28.7,
  "heated_area": 65,
  "construction_year": 2010,
  "diagnostician_contact_id": "550e8400-e29b-41d4-a716-446655440003",
  "notes": "Apartment with reinforced insulation",
  "media_id": "550e8400-e29b-41d4-a716-446655440010",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.