GET api/city/timeseries/{objectKey}/typeClass/{typeClass}/resolution/{resolution}?from={from}&to={to}&utc={utc}

GET the consumption for a given meter as a time series.

Request Information

URI Parameters

Name	Description	Type	Additional information
objectKey	Object key	string	Required
typeClass	Timeseries type class	integer	Required
resolution	Resolution	integer	Required
from	From date in yyyy-MM-ddTHH:mm:ss format	string	Required
to	To date in yyyy-MM-ddTHH:mm:ss format	string	Required
utc	If values are in UTC	boolean	Default value is True

Body Parameters

None.

Response Information

Resource Description

Time series with consumption and max effect. Name=??, ConsumptionTimeseriesResolution=as Resolution in request, ConsumptionUnitType=1-Consumption.

TimeSerie

Name	Type	Additional information
TimeSeriesTypeClass	TimeSeriesTypeClass	None.
Resolution	TimeSeriesResolution	None.
Values	Collection of TimeValue	None.
ObjectKey	string	None.
UnitType	string	None.
Unit	string	None.

Response Formats

application/json, text/json

Sample:

{
  "TimeSeriesTypeClass": 1,
  "Resolution": 0,
  "Values": [
    {
      "$id": "1",
      "ValueTime": "2025-12-23T17:35:25.8623845+00:00",
      "Value": 1.1,
      "Status": 1
    },
    {
      "$ref": "1"
    }
  ],
  "ObjectKey": "sample string 1",
  "UnitType": "sample string 2",
  "Unit": "sample string 3"
}

text/html

Sample:

{"TimeSeriesTypeClass":1,"Resolution":0,"Values":[{"$id":"1","ValueTime":"2025-12-23T17:35:25.8623845+00:00","Value":1.1,"Status":1},{"$ref":"1"}],"ObjectKey":"sample string 1","UnitType":"sample string 2","Unit":"sample string 3"}