Skip to content

[GET] Building Summary

/api/tenant-metering/building

BuildingSummaryRequestDTO

Attributes:

Name Type Description
start_datetime datetime

datetime in "YYYY-MM-DD HH:MM:SS" ISO format

end_datetime datetime

datetime in "YYYY-MM-DD HH:MM:SS" ISO format

site_id int

id of the Site.

BuildingSummaryResponseDTO

Attributes:

Name Type Description
statistics BuildingSummaryStatisticsDTO

contains total energy and peak power information for the building

area_information List[AreaInformationDTO]

list of area information including consumption and losses

BuildingSummaryStatisticsDTO

Attributes:

Name Type Description
total_energy Optional[Decimal]

Total energy which is the summation of all area consumption in kWh

AreaInformationDTO

Attributes:

Name Type Description
area_meter_id int

Unique ID assigned to an area meter

area_name str

Name of the area meter

area_consumption Optional[Decimal]

Total consumption recorded by the area meter in kWh

tenant_consumption Optional[Decimal]

Total consumption recorded by all tenant meters under the area meter in kWh

kwh_losses Optional[Decimal]

Difference between area consumption and tenant consumption in kWh