HC小区接口文档

基础接口

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

资产接口

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

业主接口

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

费用接口

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

工单接口

报修接口 投诉接口

物业公司查询接口文档

添加物业
修改物业
删除物业
查询物业

一、接口名称

查询物业公司信息

二、接口描述

该接口主要用于查询物业公司信息，支持按物业编号、名称、电话等条件筛选，并返回分页结果。

三、接口路径

http://{ip}:{port}/app/property.listProperty

四、请求方法

GET

五、请求头

参数名称 必填 类型 描述
Authorization 是 String 用户认证Token（Base Token）
app-id 是 String 应用ID（由系统分配）
transaction-id 是 String 请求流水号（格式：1000000000+YYYYMMDDhhmmss+6位序列）
sign 是 String 签名（用于请求校验）
req-time 是 String 请求时间（YYYYMMDDhhmmss）

六、请求参数

6.1 查询参数

参数名称 必填 类型 描述 示例值
storeId 否 String 物业公司编号 10001
name 否 String 物业公司名称 某某物业
tel 否 String 物业公司联系电话 13800138000
page 否 int 当前页码（默认1） 1
row 否 int 每页行数（默认10） 10

七、返回值

7.1 响应结构

参数名称 类型 描述
code int 返回码（0=成功，非0=失败）
msg String 返回信息（如"成功"）
data Object 返回数据（物业公司列表）

7.2 data 结构

参数名称 类型 描述
storeId String 物业公司编号
name String 物业公司名称
nearbyLandmarks String 地标（如"XX公园旁"）
tel String 物业公司联系电话
address String 公司地址
corporation String 法人代表
foundingTime String 成立日期

八、示例请求

请求URL

http://127.0.0.1:8080/app/property.listProperty?storeId=10001&name=某某物业&tel=13800138000&page=1&row=10

请求头示例

{
  "Authorization": "Bearer xxxxxx",
  "app-id": "micro-community",
  "transaction-id": "100000000020220101120000000001",
  "sign": "xxxxxx",
  "req-time": "20221001120000"
}

九、示例响应

成功响应

{
  "code": 0,
  "msg": "成功",
  "data": [
    {
      "storeId": "10001",
      "name": "某某物业",
      "nearbyLandmarks": "XX公园旁",
      "tel": "13800138000",
      "address": "XX市XX区XX路1号",
      "corporation": "张三",
      "foundingTime": "2010-01-01"
    }
  ],
  "total": 1,
  "pages": 1
}

失败响应

{
  "code": 1001,
  "msg": "参数校验失败",
  "data": null
}

十、业务逻辑说明

  1. 权限校验：

    • 如果传入 storeId，会校验该物业公司是否存在。
    • 如果是管理员账号（STORE_TYPE_ADMIN），则忽略 storeId 查询所有物业公司。

  2. 分页查询：

    • 默认每页10条数据，可通过 row 调整。

  3. 数据合并：

    • 查询物业公司基本信息后，补充地标信息（nearbyLandmarks）。

十一、注意事项

  • 请求需携带有效 Authorization Token。
  • page 和 row 用于分页，若不传则默认返回第一页10条数据。
  • 查询条件均为可选，若不传则返回所有符合条件的物业公司。

文档版本：v1.0
最后更新：2023-10-01
作者：吴学文
联系方式：928255095@qq.com