HC小区接口文档

基础接口

登陆接口 接口签名 员工接口

资产接口

小区接口 物业接口 楼栋接口 单元接口 房屋接口 交房 退房 车位接口 车辆接口

业主接口

业主接口 家庭成员 查询房屋认证 认证审核 账户接口 撤销账户明细

费用接口

费用项接口 创建费 查询费用 缴费接口 结束费用 缴费记录 水电抄表

工单接口

报修接口 投诉接口

API接口文档：查询业主成员列表

添加家庭成员
修改家庭成员
删除家庭成员
查询家庭成员

一、接口名称

查询业主成员列表（Query Owner Members）

二、接口描述

该接口用于查询指定小区（communityId）下的业主成员列表，支持分页查询。返回的业主成员信息可能包含脱敏处理（如身份证号、手机号部分隐藏），具体取决于当前用户的权限。

三、接口路径

owner.queryOwnerMembers（Java110Cmd 服务编码）

四、请求方法

POST（基于Java110Cmd框架，实际HTTP方法可能由网关转换）

五、请求头

参数名称 必填 类型 描述
Authorization 是 String 用户认证Token（Base Token），通过登录接口获取
app-id 是 String 应用ID，由系统dev账户分配
transaction-id 是 String 请求流水号，格式：1000000000+YYYYMMDDhhmmss+6位序列（需保证唯一）
sign 是 String 签名，用于请求验证
req-time 是 String 请求时间，格式：YYYYMMDDhhmmss
user-id 是 String 当前用户ID（用于权限校验）

六、请求参数

6.1 请求体（JSON格式）

参数名称 必填 类型 描述 示例值
communityId 是 String 小区ID "123456789"
ownerTypeCd 否 String 业主类型（默认为成员类型OWNER_TYPE_CD_MEMBER） "1001"
page 否 Integer 当前页码（默认值：1） 1
row 否 Integer 每页记录数（默认值：10） 10
其他过滤字段 否 - 支持OwnerDto中的其他字段作为过滤条件（如name、roomNum等） "name":"张三"

请求体示例：

{
  "communityId": "123456789",
  "page": 1,
  "row": 10
}

七、返回值

7.1 响应格式（JSON）

参数名称 类型 描述
code String 返回码：0表示成功，非0表示失败
msg String 返回信息（如错误详情）
data Object 分页数据，包含total（总记录数）、records（当前页数据列表）等字段

7.2 响应状态码

  • 200：请求成功
  • 400：参数校验失败（如缺少communityId）
  • 500：服务器内部错误

7.3 数据字段说明（records中的OwnerDto对象）

字段名 类型 描述 脱敏规则（无权限时）
ownerId String 业主ID -
name String 业主姓名 -
idCard String 身份证号（可能脱敏） "110105******1234"（前6后4保留）
link String 联系电话（可能脱敏） "138****1234"（前3后4保留）
ownerTypeCd String 业主类型编码 -
communityId String 小区ID -

八、示例请求

curl -X POST \
  http://gateway.example.com/api/cmd \
  -H 'Authorization: Bearer xxxxxx' \
  -H 'app-id: web-app' \
  -H 'transaction-id: 100000000020240101120000000001' \
  -H 'req-time: 20240101120000' \
  -H 'user-id: 1001' \
  -d '{
    "serviceCode": "owner.queryOwnerMembers",
    "reqJson": {
      "communityId": "123456789",
      "page": 1,
      "row": 10
    }
  }'

九、示例响应

成功响应：

{
  "code": "0",
  "msg": "成功",
  "data": {
    "total": 25,
    "records": [
      {
        "ownerId": "1001",
        "name": "张三",
        "idCard": "110105******1234",
        "link": "138****1234",
        "ownerTypeCd": "1001",
        "communityId": "123456789"
      },
      {
        "ownerId": "1002",
        "name": "李四",
        "idCard": "310115******5678",
        "link": "139****5678",
        "ownerTypeCd": "1001",
        "communityId": "123456789"
      }
    ],
    "page": 1,
    "rows": 10
  }
}

错误响应（缺少参数）：

{
  "code": "400",
  "msg": "请求中未包含communityId信息",
  "data": null
}

十、业务逻辑说明

  1. 权限控制：
    • 检查用户是否有/roomCreateFee权限，若无权限则对敏感字段（身份证号、手机号）进行脱敏处理。
  2. 数据库操作：
    • 调用IOwnerInnerServiceSMO.queryOwnersMemberCount查询总记录数。
    • 调用IOwnerInnerServiceSMO.queryOwnerMembers分页查询业主列表。
  3. 分页逻辑：
    • 默认每页10条记录，可通过row参数调整。