能耗管理

更新时间:2021-11-08 01:24:44下载pdf

本文介绍能耗管理相关 API。

API 列表

请求方式 API 描述
GET /v1.0/illumination/space/energy/query 空间能耗查询

空间能耗查询

功能描述

查询空间下某个时间段内的能耗数据。

补充说明
targetType=1时,时间戳必须为该天0点到次日0点,中间只能相差一天;targetType=2时,时间戳必须相差2-31天,即最小为该日0点到后天0点,最大为本月1日0点到次月1日0点(大月);targetType=3时,时间戳必须相差12个月内,即最小为1月到2月,最大为1月到次年1月(与日/时无关)。

天-同比:展示当天与上周同一天的能源数据对比。
月-同比:展示本月与去年同一月的能源数据对比。

天-环比:展示当天与昨天的能源数据对比。
月-环比:展示本月与上月的能源数据对比。
年-环比:展示本年与上一年的能源数据对比。

接口地址

GET /v1.0/illumination/space/energy/query

请求参数

参数名 类型 参数类型 说明 是否必需
projectId String body 项目 ID true
roomId String body 空间 ID false
targetType int body 查询类型,1:日;2:月;3:年 true
startTime long body 开始时间 true
endTime long body 结束时间 true

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功:(true:成功,false:失败)
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13位
result Object 返回结果

result参数说明

{
  "totalEnergy": "double //累计能耗",
  "averageEnergy": "double //平均能耗",
  "tbValue": "double //同期差值",
  "hbValue": "double //环期差值",
  "tb": "double //当前同比",
  "hb": "double //当前环比",
  "data": [
    {
      "sort": "int //排序字段",
      "time": "long //时间戳",
      "totalEnergy": "double //总能耗值",
      "data": [
        {
          "purposeCode": "int //用途",
          "i18nName": "String //多语言名称",
          "energy": "double //能耗值"
        }
      ]
    }
  ]
}

请求示例

{
  "targetType": "查询类型1表示日,2:月,3:年",
  "startTime": "开始时间",
  "endTime": "结束时间",
  "projectId": "项目ID",
  "roomId": "空间ID"
}

响应示例

{
  "totalEnergy": "累计能耗",
  "averageEnergy": "平均能耗",
  "tbValue": "同期差值",
  "hbValue": "环期差值",
  "tb": "当前同比",
  "hb": "当前环比",
  "data": [
    {
      "sort": "排序字段",
      "time": "时间戳",
      "totalEnergy": "总能耗值",
      "data": [
        {
          "purposeCode": "用途",
          "i18nName": "多语言名称",
          "energy": "能耗值"
        }
      ]
    }
  ]
}

错误码

以下为该接口常见的业务异常,更多的异常错误,参见全局错误码

错误码 说明
500 系统错误