HC小区接口文档

基础接口

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

资产接口

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

业主接口

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

费用接口

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

工单接口

报修接口 投诉接口

查询组织树接口文档

查询员工
保存员工
删除员工
重置密码
查询组织

一、接口名称

查询组织树

二、接口描述

该接口用于查询组织架构树形结构数据，主要用于添加员工时选择组织ID。返回的数据为树形结构，建议前端以树形方式展示（如物业系统的组织架构展示方式）。

三、接口路径

http://{ip}:{port}/app/org.listOrgTree

四、请求方法

POST

五、请求头

参数名称 必填 类型 描述
store-id 是 String 商户ID，用于标识当前请求所属的商户
user-id 是 String 用户ID，用于权限校验
Authorization 是 String 用户认证token
app-id 是 String 应用ID
transaction-id 是 String 请求流水号（不能重复）
sign 是 String 签名
req-time 是 String 请求时间（YYYYMMDDhhmmss）

六、请求参数

6.1 请求体（JSON）

参数名称 必填 类型 描述
orgId 否 String 组织ID（非必填，用于查询特定组织）
storeId 是 String 商户ID（如果请求头未传 store-id，则必须传此参数）
userId 是 String 用户ID（用于权限校验）

七、返回值

7.1 返回结构（JSON）

参数名称 类型 描述
code int 返回码（0 表示成功，其他表示失败）
msg String 返回信息（如“成功”）
data Object 返回的组织树数据

7.2 data 结构

参数名称 类型 描述
allOrgName String 组织名称（如“演示物业”）
id String 组织ID
parentId String 父级组织ID（-1 表示顶级组织）
text String 组织显示名称
icon String 组织图标路径
children Array 子组织列表（结构与 data 相同）

八、示例请求

8.1 请求示例

{
  "storeId": "123456789",
  "userId": "1001"
}

8.2 响应示例

{
  "code": 0,
  "msg": "成功",
  "data": {
    "allOrgName": "演示物业",
    "id": "842022081548770433",
    "parentId": "-1",
    "text": "演示物业",
    "icon": "/img/org.png",
    "children": [
      {
        "allOrgName": "演示物业 / 软件部",
        "id": "102022091988250052",
        "parentId": "842022081548770433",
        "text": "软件部",
        "icon": "/img/org.png"
      }
    ]
  }
}

九、业务逻辑说明

  1. 权限校验

    • 管理员（levelCd = ADMIN）可以查看所有组织架构。
    • 普通用户只能查看自己所属的组织架构。

  2. 数据查询

    • 根据 storeId 查询商户下的所有组织。
    • 构建树形结构，顶级组织为商户级别（ORG_LEVEL_STORE）。

  3. 返回数据

    • 返回的树形结构包含 children 字段，用于前端递归渲染。

十、注意事项

  1. 必传参数

    • storeId（商户ID）必须传递，否则会返回错误。
    • userId（用户ID）用于权限校验，必须传递。

  2. 数据格式

    • 返回的 children 字段可能有多层嵌套，前端需支持递归渲染。

  3. 错误码

    • code != 0 时表示查询失败，msg 会返回具体错误信息。

该文档已按照 RESTful API 规范 组织，并标注了必填参数、数据类型及业务逻辑说明。