空间利用率统计

本文介绍热力图统计相关接口，基于 PIR 设备统计空间下有人、无人状态。该接口需要拥有该增值应用权限，且被分配过后的项目使用。

请求方式	API	描述
GET	/v1.0/illumination/addvalue/heatpower/realtime/get	获取房间热力统计（实时统计）
GET	/v1.0/illumination/addvalue/heatpower/room/get	空间利用率展示
GET	/v1.0/illumination/addvalue/heatpower/compare/single	单空间空间利用率对比
GET	/v1.0/illumination/addvalue/heatpower/compare/multi	多空间利用率对比

获取房间热力统计(实时统计)

功能描述

获取房间热力统计，最近一个小时空间有人无人状态。

接口地址

GET /v1.0/illumination/addvalue/heatpower/realtime/get

请求参数

参数名	类型	参数类型	说明	是否必需
roomId	String	body	房间 ID	true

返回参数

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

Result 说明

参数名	类型	说明
roomId	String	房间 ID
spaceHeatPowerList	List	空间热力分布列表
spacePurposeId	String	空间用途 ID
average	Double	平均值
max	Double	峰值
happenTime	String	峰值发生时间
nextLevelRoomId	String	下级房间 ID
nextLevelRoomName	String	下级房间名称
spacePurposeName	String	空间用途名称
mappingInfo	String	绘制的图层坐标信息
deviceHeatPowerList	List	设备热力分布列表
deviceId	String	设备 ID
deviceName	String	设备名称
pointId	String	点位 ID
average	Double	平均热度
x	Double	点位x轴横坐标
y	Double	点位y轴纵坐标

请求示例

{
  "roomId": "skd2221kkksds2"
}

响应示例

{
  "roomId": "skd2221kkksds2",
  "spaceHeatPowerList": [
    {
      "spacePurposeId": "sksjdsdsds1112",
      "average": 30.2,
      "max": 40.4,
      "happenTime": "2021-02-03",
      "nextLevelRoomId": "sdk23132232",
      "nextLevelRoomName": "这是个子空间名称",
      "spacePurposeName": "会议室",
      "mappingInfo": "{"x":223}"
    }
  ],
  "deviceHeatPowerList": [
    {
      "deviceId": "xxx232sx",
      "deviceName": "设备传感器名称",
      "pointId": "ss2232kkks2",
      "average": 34.3,
      "x": 20.3,
      "y": 34
    }
  ]
}

空间利用率展示

功能描述

根据时间展示单空间利用率，会返回关联的下级空间利用率。

接口地址

GET /v1.0/illumination/addvalue/heatpower/room/get

请求参数

参数名	类型	参数类型	说明	是否必需
roomId	String	body	房间 ID	true
startTime	long	body	开始时间	true
endTime	long	body	结束时间	true
weekDay	int[]	body	星期几，从 0 开始	true
startHour	String	body	小时范围开始，00-23	true
endHour	String	body	小时范围结束，00-23	true
projectId	String	body	项目 ID	true

返回参数

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

Result 说明

参数名	类型	说明
roomId	String	房间 ID
spaceHeatPowerList	List	空间热力分布列表
spacePurposeId	String	空间用途 ID
average	Double	平均值
max	Double	峰值
happenTime	String	峰值发生时间
nextLevelRoomId	String	下级房间 ID
nextLevelRoomName	String	下级房间名称
spacePurposeName	String	空间用途名称
mappingInfo	String	绘制的图层坐标信息
deviceHeatPowerList	List	设备热力分布列表
deviceId	String	设备 ID
deviceName	String	设备名称
pointId	String	点位 ID
average	Double	平均热度
x	Double	点位x轴横坐标
y	Double	点位y轴纵坐标

请求示例

{
  "roomId": "ssk223132323"
}

响应示例

{
  "roomId": "skd2221kk****",
  "spaceHeatPowerList": [
    {
      "spacePurposeId": "sksjdsdsd****",
      "average": 30.2,
      "max": 40.4,
      "happenTime": "2021-02-03",
      "nextLevelRoomId": "sdk2313****",
      "nextLevelRoomName": "这是个子空间名称",
      "spacePurposeName": "会议室",
      "mappingInfo": "{"x":223}"
    }
  ],
  "deviceHeatPowerList": [
    {
      "deviceId": "*****",
      "deviceName": "设备传感器名称",
      "pointId": "ss2232k****",
      "average": 34.3,
      "x": 20.3,
      "y": 34
    }
  ]
}

单空间空间利用率对比

功能描述

项目下单个空间利用率状态进行比较。

接口地址

GET /v1.0/illumination/addvalue/heatpower/compare/single

请求参数

参数名	类型	参数类型	说明	是否必需
roomId	String[]	body	房间 ID	true
queryType	int	body	查询类型: 1: 日报 2: 月报 3: 年报	true
queryTime	long	body	查询时间	true
projectId	String	body	项目 ID	true

返回参数

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

Result 说明

参数名	类型	说明
roomId	String	房间 ID
roomName	String	房间名称
average	Double	平均利用率
max	Double	峰值利用率
averageValues	List	平均值利用率列表
ts	String	下标
value	Double	平均利用率值
maxValues	List	峰值利用率列表
ts	String	下标
value	Double	峰值

请求示例

{
  "queryTime": "2023132302",
  "projectId": "xsj32skjda2",
  "queryType": 1
}

响应示例

{
  "roomId": "ssda****",
  "roomName": "这是一个房间",
  "average": 33.3,
  "max": 44.4,
  "averageValues": [
    {
      "ts": "00",
      "value": 22.2
    },
    {
      "ts": "01",
      "value": 21.2
    }
  ],
  "maxValues": [
   {
      "ts": "00",
      "value": 32.2
    },
    {
      "ts": "01",
      "value": 41.2
    }
  ]
}

多空间利用率对比

功能描述

项目下多个空间利用率进行对比。

接口地址

GET /v1.0/illumination/addvalue/heatpower/compare/multi

请求参数

参数名	类型	参数类型	说明	是否必需
roomId	String[]	body	房间 ID	true
queryType	int	body	查询类型: 1: 日报 2: 月报 3: 年报	true
queryTime	long	body	查询时间	true
projectId	String	body	项目 ID	true

返回参数

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

Result 说明

参数名	类型	说明
roomId	String	房间 ID
roomName	String	房间名称
average	Double	平均利用率
max	Double	峰值利用率
averageValues	List	平均值利用率列表
ts	String	下标
value	Double	平均利用率值
maxValues	List	峰值利用率列表
ts	String	下标
value	Double	峰值

请求示例

{
  "queryTime": "2020223112323",
  "projectId": "00232sks****",
  "queryType": "1"
}

响应示例

{
    "这是一个空间ABC": {
        "roomId": "ssda2232",
        "roomName": "这是一个空间ABC",
        "average": 33.3,
        "max": 44.4,
        "averageValues": [
            {
                "ts": "00",
                "value": 22.2
            },
            {
                "ts": "01",
                "value": 21.2
            }
        ],
        "maxValues": [
            {
                "ts": "00",
                "value": 32.2
            },
            {
                "ts": "01",
                "value": 41.2
            }
        ]
    }
}

错误码

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

错误码	说明
500	系统错误