HC小区接口文档

基础接口

登陆 添加人员 修改人员 查询人员 删除人员

门禁

添加门禁 修改门禁 查询门禁 门禁开门 重启门禁 门禁授权 删除授权 查询授权 开门记录 删除门禁

道闸

查询停车场 删除车位 查询车位 添加车位 修改车位 添加车辆 修改车辆 删除车辆 查询车辆 查询道闸 开闸 关闸

查询停车位接口文档

一、接口名称

查询停车位列表

二、接口描述

该接口用于查询小区内的停车位信息，包括停车位状态、设备状态等信息。支持分页查询。

三、接口路径

http://{ip}:{port}/iot/api/parkingSpace.listParkingSpace

四、请求方法

GET

五、请求头

参数名称 必填 类型 描述
Authorization 是 String 用户认证token Base token 通过登录接口获取token
app-id 是 String 应用ID 系统dev账户分配
transaction-id 是 String 请求流水号 不能重复 1000000000+YYYYMMDDhhmmss+6位序列
sign 是 String 签名
req-time 是 String 请求时间 YYYYMMDDhhmmss

六、请求参数

6.1 查询参数

参数名称 必填 类型 描述 示例
communityId 是 String 小区ID 102023021386560001
page 否 int 页码，默认为1 1
row 否 int 每页记录数，默认为10 10

七、返回值

7.1 响应格式

JSON

7.2 响应状态码

HTTP 200 OK

7.3 响应参数

参数名称 类型 描述
code int 返回码，0表示成功
msg String 返回消息
data Array 停车位数据列表
page int 当前页码
records int 当前页记录数
total int 总记录数

data数组中的停车位对象字段：

参数名称 类型 描述
psId String 停车位ID
num String 停车位编号
communityId String 所属小区ID
createTime String 创建时间
remark String 备注
typeCd String 类型编码
psState String 停车位状态(占用/空闲)
psStateName String 停车位状态名称
lockState String 锁状态
lockStateName String 锁状态名称
machineStateName String 设备状态(在线/离线)

八、示例请求

GET /iot/api/parkingSpace.listParkingSpace?page=1&row=10&communityId=102023021386560001
Host: localhost:8080
Authorization: Bearer xxxxxx
app-id: xxxxxx
transaction-id: 100000000020230101120000000001
sign: xxxxxx
req-time: 20230101120000

九、示例响应

{
    "code": 0,
    "data": [
        {
            "communityId": "102023021386560001",
            "createTime": "2023-08-23 09:07:59",
            "num": "2",
            "psId": "102023082384250002",
            "page": -1,
            "records": 0,
            "remark": "1",
            "row": 0,
            "statusCd": "0",
            "total": 0,
            "typeCd": "1001",
            "psState": "OCCUPY",
            "psStateName": "占用",
            "lockState": "ON",
            "lockStateName": "开",
            "machineStateName": "设备在线"
        }
    ],
    "msg": "成功",
    "page": 0,
    "records": 1,
    "rows": 0,
    "total": 1
}

十、业务逻辑说明

  1. 接口会验证必填参数communityId是否存在
  2. 调用IParkingSpaceV1InnerServiceSMO接口查询停车位数量和列表
  3. 对查询结果进行处理：
    • 转换停车位状态码为可读名称
    • 转换锁状态码为可读名称
    • 根据心跳时间判断设备在线状态
  4. 返回分页结果

十一、注意事项

  1. communityId为必填参数
  2. 设备在线状态是根据最后心跳时间判断，2分钟内为在线状态
  3. 停车位状态和锁状态可能返回"未知"状态，表示状态码不在预期范围内