get-powerconsumption-all 2018-10-05T16:32:00+08:00

GET /service/facilities/power_consumption/all

Return all reading records of power meters in UM since they were installed. This API also supports time range search.

Resource URL

https://api.data.um.edu.mo/service/facilities/power_consumption/v1.0.0/all

Resource Information

Response formatJSON
Requires authorization?Yes
Rate limited?Yes

Parameters

ParameterRelated FiledRequiredDescriptionTypeFilter TypeExample
zone_codezoneCodeoptionalZone ID, please refer to List of Zone IDs for detailsquerysimpleE1-E2
meter_codemeterCodeoptionalMeter IDquerysimple1A01_1
date_fromrecordDatetimeoptionalDatetime, in UTC+08:00 (inclusive)queryrange2018-03-23T15:00:00
date_torecordDatetimeoptionalDatetime, in UTC+08:00 (inclusive)queryrange2018-03-23T15:15:00

Example Request

https://api.data.um.edu.mo/service/facilities/power_consumption/v1.0.0/all?zone_code=E1-E2&meter_code=1A01_1&date_from=2018-03-23T15:00:00&date_to=2018-03-23T15:15:00

(Example to retrieve all reading records of power meters 1A01_1 in zone E1-E2 from 2018/03/23 15:00:00 to 2018/03/23 15:15:00)

Example Response

Top 100 records will be returned.

{
  "_embedded": [
    {
      "_id": "5ab9cb7fe7940a931af0e5d3",
      "meterCode": "1A01_1",
      "recordDatetime": "2018-03-23T15:15:00+08:00",
      "zoneCode": "E1-E2",
      "readings": {
        "kwh": 11430894,
        "kvarh": 525420,
        "pf": -982,
        "freq": 5002,
        "i1": 743,
        "i2": 647,
        "i3": 587,
        "v1": 2300,
        "v2": 2300,
        "v3": 2305,
        "thd_i1": 156,
        "thd_i2": 195,
        "thd_i3": 219,
        "thd_v1": 22,
        "thd_v2": 21,
        "thd_v3": 23
      }
    },
    {
      "_id": "5ab9cb67e7940a931af0e4b2",
      "meterCode": "1A01_1",
      "recordDatetime": "2018-03-23T15:00:00+08:00",
      "zoneCode": "E1-E2",
      "readings": {
        "kwh": 11430786,
        "kvarh": 525419,
        "pf": 980,
        "freq": 4997,
        "i1": 727,
        "i2": 608,
        "i3": 582,
        "v1": 2300,
        "v2": 2299,
        "v3": 2303,
        "thd_i1": 155,
        "thd_i2": 212,
        "thd_i3": 218,
        "thd_v1": 21,
        "thd_v2": 23,
        "thd_v3": 21
      }
    }
  ],
  "_returned": 2
}