Skip to content

[GET] Area Summary

/api/tenant-metering/area

AreaSummaryRequestDTO

Attributes:

Name Type Description
area_meter_id int

Unique ID assigned to an area meter.

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

AreaSummaryResponseDTO

Attributes:

Name Type Description
type Literal['virtual', 'physical']
statistics AreaSummaryDTO

contains total energy and peak power information for the area

tenant_summaries List[TenantConsumptionDTO]

List of tenant consumption summaries

AreaSummaryDTO

Attributes:

Name Type Description
total_energy Optional[Decimal]

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

TenantConsumptionDTO

Attributes:

Name Type Description
unit str

Name of the tenant unit

previous_reading Optional[Decimal]

Meter reading value at the start datetime

current_reading Optional[Decimal]

Current meter reading value