POST api/customers/{customerId}/contracts/{contractNo}/meters/{meterId}/comparedwithothers

GET consumption data for the given meter compared with other meters.

Request Information

URI Parameters

Name	Description	Type	Additional information
customerId	Customer ID	integer	Required
contractNo	Customer's contract number	integer	Required
meterId	Contract's meter ID	string	Required

Body Parameters

Required: FromTime as dateTime in UTC, ToTime as dateTime in UTC, Resolution [None=0, Hour=7, Day=20, Month=40, Year=50].

ConsumptionRequest

Name	Type	Additional information
ContractNo	integer	None.
CustomerId	integer	None.
FromTime	date	None.
ToTime	date	None.
IncludeLastYear	boolean	None.
IncludeWeather	boolean	None.
Resolution	ConsumptionSeriesResolution	None.
HasWattMeter	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "ContractNo": 1,
  "CustomerId": 2,
  "FromTime": "2025-05-20T03:05:24.0414729+00:00",
  "ToTime": "2025-05-20T03:05:24.0414729+00:00",
  "IncludeLastYear": true,
  "IncludeWeather": true,
  "Resolution": 0,
  "HasWattMeter": true
}

text/html

Sample:

{"ContractNo":1,"CustomerId":2,"FromTime":"2025-05-20T03:05:24.0414729+00:00","ToTime":"2025-05-20T03:05:24.0414729+00:00","IncludeLastYear":true,"IncludeWeather":true,"Resolution":0,"HasWattMeter":true}

Response Information

Resource Description

AssetCompareModel

Name	Type	Additional information
MeterAverage	Collection of ConsumptionTimeSerieValue	None.
ReferenceGroupAverage	Collection of ConsumptionTimeSerieValue	None.
EfficientsAverage	Collection of ConsumptionTimeSerieValue	None.
Score	integer	None.
EfficientComparisonPercentage	integer	None.
ReferenceGroupComparisonPercentage	integer	None.
Scores	Collection of DailyScoreValue	None.

Response Formats

application/json, text/json

Sample:

{
  "MeterAverage": [
    {
      "$id": "1",
      "MaxEffectValueTime": "2025-05-20T03:05:24.0414729+00:00",
      "ValueTime": "2025-05-20T03:05:24.0414729+00:00",
      "MaxEffect": 1.1,
      "Value": 1.1,
      "TimeSeriesType": 0
    },
    {
      "$ref": "1"
    }
  ],
  "ReferenceGroupAverage": [
    {
      "$ref": "1"
    },
    {
      "$ref": "1"
    }
  ],
  "EfficientsAverage": [
    {
      "$ref": "1"
    },
    {
      "$ref": "1"
    }
  ],
  "Score": 1,
  "EfficientComparisonPercentage": 1,
  "ReferenceGroupComparisonPercentage": 1,
  "Scores": [
    {
      "ValueTime": "2025-05-20T03:05:24.0414729+00:00",
      "Score": 1
    },
    {
      "ValueTime": "2025-05-20T03:05:24.0414729+00:00",
      "Score": 1
    }
  ]
}

text/html

Sample:

{"MeterAverage":[{"$id":"1","MaxEffectValueTime":"2025-05-20T03:05:24.0414729+00:00","ValueTime":"2025-05-20T03:05:24.0414729+00:00","MaxEffect":1.1,"Value":1.1,"TimeSeriesType":0},{"$ref":"1"}],"ReferenceGroupAverage":[{"$ref":"1"},{"$ref":"1"}],"EfficientsAverage":[{"$ref":"1"},{"$ref":"1"}],"Score":1,"EfficientComparisonPercentage":1,"ReferenceGroupComparisonPercentage":1,"Scores":[{"ValueTime":"2025-05-20T03:05:24.0414729+00:00","Score":1},{"ValueTime":"2025-05-20T03:05:24.0414729+00:00","Score":1}]}