API 接口文档：删除物业公司
1. 接口名称
删除物业公司
2. 接口描述
该接口用于删除物业公司信息，包括物业公司数据、关联员工数据、小区绑定关系及权限。
3. 接口路径
POST http://{ip}:{port}/app/property.deleteProperty
4. 请求方法
POST
5. 请求头
| 参数名称 | 必填 | 类型 | 描述 |
|---|---|---|---|
Authorization |
是 | String |
用户认证 Token（Base Token，通过登录接口获取） |
app-id |
是 | String |
应用 ID（系统 dev 账户分配） |
transaction-id |
是 | String |
请求流水号（不能重复，格式：1000000000+YYYYMMDDhhmmss+6位序列） |
sign |
是 | String |
签名 |
req-time |
是 | String |
请求时间（格式：YYYYMMDDhhmmss） |
6. 请求参数
6.1 请求体（JSON）
| 参数名称 | 必填 | 类型 | 描述 | 示例 |
|---|---|---|---|---|
storeId |
是 | String |
物业公司编号 | "102022083062960025" |
storeTypeCd |
是 | String |
物业公司类型编码 | "XXX" |
7. 返回值
7.1 返回数据（JSON）
| 参数名称 | 类型 | 描述 | 示例 |
|---|---|---|---|
code |
int |
返回码（0 表示成功，其他表示失败） |
0 |
msg |
String |
返回信息 | "成功" |
8. 示例请求
{
"storeId": "102022083062960025",
"storeTypeCd": "XXX"
}
9. 示例响应
{
"code": 0,
"msg": "成功"
}
10. 业务逻辑说明
参数校验
- 检查
storeId和storeTypeCd是否为空。
- 检查
删除物业公司
- 调用
storeV1InnerServiceSMOImpl.deleteStore()删除物业公司数据。
- 调用
删除关联员工
- 查询并删除该物业公司下的所有员工数据。
解除小区绑定
- 查询物业公司绑定的所有小区，并解除绑定关系。
删除小区权限
- 删除该物业公司在所有小区的权限数据。
返回结果
- 如果所有操作成功，返回
{"code":0,"msg":"成功"}。
- 如果所有操作成功，返回
11. 错误码
| 错误码 | 描述 | 可能原因 |
|---|---|---|
非 0 |
操作失败 | 数据库操作失败、参数校验失败等 |
注意事项
- 事务管理：该接口使用了
@Java110Transactional注解，确保所有操作在事务内执行，失败时回滚。 - 权限控制：调用该接口需要相应的权限，否则可能返回
403错误。
文档版本：1.0
最后更新：2023-10-10
作者：吴学文
官网：http://www.homecommunity.cn