GET /service/facilities/power_consumption/{zoneCode}/records

Return all reading records of power meters under specified zone. It also supports search in a time range.

Resource URL

https://api.data.um.edu.mo/service/facilities/power_consumption/v1.0.0/{zoneCode}/records

Resource Information

Response format	JSON
Requires authorization?	Yes
Rate limited?	Yes

Parameters

Parameter	Related Field	Required	Description	Type	Filter Type	Example
zoneCode	zoneCode	required	Zone ID, please refer to List of Zone IDs for details	path	simple	`E1-E2`
date_from	recordDatetime	optional	Datetime, in UTC+08:00 (inclusive)	query	range	`2018-03-23T15:00:00`
date_to	recordDatetime	optional	Datetime, in UTC+08:00 (inclusive)	query	range	`2018-03-23T15:15:00`

Example Request

Example to retrieve all power meter reading records under zone E1-E2 begin from 2018-03-23 15:00:00 to 2018-03-23 15:15:00:

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

Example Response

Top 100 records will be returned.

{
  "_embedded": [
    {
      "_id": "5ab9edfae7940a931af3a68d",
      "meterCode": "2A01_1",
      "recordDatetime": "2018-03-23T15:15:00+08:00",
      "zoneCode": "E1-E2",
      "readings": {
        "kwh": 80917,
        "i1": 0,
        "i2": 0,
        "i3": 0
      }
    },
    {
      "_id": "5ab9edfae7940a931af3a688",
      "meterCode": "2A02_1",
      "recordDatetime": "2018-03-23T15:15:00+08:00",
      "zoneCode": "E1-E2",
      "readings": {
        "kwh": 10326608,
        "kvarh": 712081,
        "pf": 967,
        "freq": 5002,
        "i1": 555,
        "i2": 474,
        "i3": 393,
        "v1": 2307,
        "v2": 2303,
        "v3": 2306,
        "thd_i1": 228,
        "thd_i2": 248,
        "thd_i3": 282,
        "thd_v1": 19,
        "thd_v2": 18,
        "thd_v3": 17
      }
    },
    {
      "_id": "5ab9edfae7940a931af3a683",
      "meterCode": "2A03_1",
      "recordDatetime": "2018-03-23T15:15:00+08:00",
      "zoneCode": "E1-E2",
      "readings": {
        "kwh": 8,
        "i1": 0,
        "i2": 0,
        "i3": 0
      }
    },
--> Skipped data, too much data for displaying on web page
    {
      "_id": "5ab9cb57e7940a931af0e3f8",
      "meterCode": "1A03_6",
      "recordDatetime": "2018-03-23T15:00:00+08:00",
      "zoneCode": "E1-E2",
      "readings": {
        "kwh": 7750612
      }
    }
  ],
  "_returned": 66
}