1. 通用查询API

API列表

编号 API名称 路径 版本
1.1 通用查询 /v1/iot/statis/common/query 1.0
1.2 门禁设备数 /v1/iot/statis/access/queryDoorTotalForDay 1.0
1.3 门禁离线设备数 /v1/iot/statis/access/queryDoorOfflineTotalForDay 1.0
1.4 梯控设备数 /v1/iot/statis/access/queryLiftTotalForDay 1.0
1.5 梯控离线设备数 /v1/iot/statis/access/queryLiftOfflineTotalForDay 1.0
1.6 邀请方式 /v1/iot/statis/access/queryVisitorTypeTotalForDay 1.0
1.7 通行方式 /v1/iot/statis/access//queryOpenModeTotalForDay 1.0
1.8 访客来访方式 /v1/iot/statis/access/queryVisitorWaysForDay 1.0
1.9 来访总数 /v1/iot/statis/access/queryVisitorTotalForDay 1.0
2.0 拜访总数 /v1/iot/statis/access/queryVisitoringTotalForDay 1.0
2.1 梯控异常总数 /v1/iot/statis/access/queryDeviceLiftTotalForDay 1.0
2.2 门禁异常总数 /v1/iot/statis/access/queryDeviceAccessTotalForDay 1.0
2.3 费用统计接口（返回欠费户，收楼户数，当前收缴率） /v1/iot/statis/payment/getCostStatis 1.0
2.4 工单统计接口（返回未完成工单，工单数，工单满意度） /v1/iot/statis/workorder/getWorkOrderStatis 1.0

API调用

1.1: 通用查询

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/statis/common/query

方法：POST

请求参数

名称 位置 类型 必填 描述
dataset body string y 数据集名称，由数据集设计文档提供。考虑SQL中的table
fields body array n 维度字段集合，维度字段集合与度量字段集合必填一。用于对统计数据进行分组，考虑SQL中的groupby
metrics body array y 度量字段集合，维度字段集合与度量字段集合必填一，允许度量参看附录3。用于对数据字段进行度量，考虑SQL中的统计方法
filters body array y 数据筛选条件。用于过滤分析数据，考虑SQL中的where
sorts body array y 排序方式。不带'-'为正序，带'-'为倒序。排序的字段必须是维度字段或度量结果字段，不然不会生效。

请求Body描述(Form表单数据)

{
  "dataset":"smart_cmty_ioc_statis_persontype",
  "fields": ["total", "hour"],
  "sorts": ["hour"],
  "filters": {
      "kind": {
          "__eq": "业主"
      }
  }
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
result 结果
返回结果示例
{
    "code": 200,
    "data": {
        "result": [
            {
                "total": 100,
                "hour": "01"
            },
            {
                "total": 89,
                "hour": "02"
            }
        ]
    },
    "message": "success"
}

1.2: 门禁设备数

描述 门禁设备数

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/statis/access/queryDoorTotalForDay

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId body string y 项目id

请求Body描述(Form表单数据)

{
    "projectId":"23414"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
    "code": 200,
    "data": {
        "result": 4
    },
    "message": "success"
}

1.3: 门禁离线设备数

描述 门禁设备数

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/statis/access/queryDoorOfflineTotalForDay

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId body string y 项目id

请求Body描述(Form表单数据)

{
    "projectId":"23414"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
    "code": 200,
    "data": {
        "result": 4
    },
    "message": "success"
}

1.4: 梯控设备数

描述 梯控设备数

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/statis/access/queryLiftTotalForDay

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId body string y 项目id

请求Body描述(Form表单数据)

{
    "projectId":"23414"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
    "code": 200,
    "data": {
        "result": 4
    },
    "message": "success"
}

1.5: 梯控离线设备数

描述 梯控离线设备数

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/statis/access/queryLiftOfflineTotalForDay

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId body string y 项目id

请求Body描述(Form表单数据)

{
    "projectId":"23414"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
    "code": 200,
    "data": {
        "result": 4
    },
    "message": "success"
}

1.6: 邀请方式统计

描述 邀请方式统计

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/statis/access/queryVisitorTypeTotalForDay

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId body string y 项目id

请求Body描述(Form表单数据)

{
    "projectId":"23414"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
    "code": 200,
    "data": {
        "result": [
           "typeName": "xx",
           "total":1
        ]
    },
    "message": "success"
}

1.7: 通行方式统计

描述 通行方式统计

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/statis/access/queryOpenModeTotalForDay

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId body string y 项目id

请求Body描述(Form表单数据)

{
    "projectId":"23414"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
    "code": 200,
    "data": {
        "result": [
            {
                "open_mode": "远程",
                "total": 16
            }
        ]
    },
    "message": "success"
}

1.8: 访客来访方式

描述 访客来访方式

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/statis/access/queryVisitorWaysForDay

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId body string y 项目id

请求Body描述(Form表单数据)

{
    "projectId":"23414"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
    "code": 200,
    "data": {
        "result": [
            {
                "person_num": 0,
                "project_id": "23414",
                "plate_num": 4
            }
        ]
    },
    "message": "success"
}

1.9: 来访总数

描述 来访总数

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/statis/access/queryVisitorTotalForDay

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId body string y 项目id

请求Body描述(Form表单数据)

{
    "projectId":"23414"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
    "code": 200,
    "data": {
        "result": 2
    },
    "message": "success"
}

2.0: 拜访总数

描述 拜访总数

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/statis/access/queryVisitoringTotalForDay

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId body string y 项目id

请求Body描述(Form表单数据)

{
    "projectId":"23414"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
    "code": 200,
    "data": {
        "result": 2
    },
    "message": "success"
}

2.1: 梯控异常总数

描述 梯控异常总数

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/statis/access/queryDeviceLiftTotalForDay

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId body string y 项目id

请求Body描述(Form表单数据)

{
    "projectId":"23414"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
    "code": 200,
    "data": {
        "result": 2
    },
    "message": "success"
}

2.2: 门禁异常总数

描述 门禁异常总数

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/statis/access/queryDeviceAccessTotalForDay

方法：POST

请求参数

名称 位置 类型 必填 描述
projectId body string y 项目id

请求Body描述(Form表单数据)

{
    "projectId":"23414"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
    "code": 200,
    "data": {
        "result": 2
    },
    "message": "success"
}

2.3: 费用统计接口（返回欠费户，收楼户数，当前收缴率）

描述 费用统计接口（返回欠费户，收楼户数，当前收缴率）

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/statis/payment/getCostStatis

方法：POST

请求参数

名称 位置 类型 必填 描述
communityId body string y 小区id 
{
    "communityId":"23414"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
debt data String 是 欠费户
acceptance data String 是 收楼户数
payRatio data String 是 当前收缴率
返回结果示例
{
    "code":200,
    "data":{
        "debt":"--",
        "acceptance":"--",
        "payRatio":"--"
    },
    "message":"success"
}

2.4: 工单统计接口（返回未完成工单，工单数，工单满意度）

描述 工单统计接口（返回未完成工单，工单数，工单满意度）

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/statis/workorder/getWorkOrderStatis

方法：POST

请求参数

名称 位置 类型 必填 描述
communityId body string y 小区id 
{
    "communityId":"23414"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
workorderIncomplete data String 是 未完成工单
workorderTotal data String 是 工单数
satisfyRatio data String 是 工单满意度
返回结果示例
{
    "code":200,
    "data":{
        "workorderIncomplete":"--",
        "workorderTotal":"--",
        "satisfyRatio":"--"
    },
    "message":"success"
}

results matching ""

    No results matching ""