HC小区接口文档

API接口文档:删除费用项配置

查询费用项
删除费用项
保存费用项
修改费用项

一、接口名称

删除费用项配置接口

二、接口描述

该接口用于删除指定小区中的费用项配置。删除前会校验该费用项是否为默认配置,如果是默认配置则不允许删除。

三、接口路径

http://{ip}:{port}/app/feeConfig.deleteFeeConfig (Java110Cmd服务编码)

四、请求方法

get

五、请求头

参数名称 必填 类型 描述
Authorization 是 String 用户认证token
app-id 是 String 应用ID
transaction-id 是 String 请求流水号(格式:1000000000+YYYYMMDDhhmmss+6位序列)
sign 是 String 签名
req-time 是 String 请求时间(YYYYMMDDhhmmss)

六、请求参数

请求体参数(JSON格式)

参数名称 必填 类型 描述 校验规则
configId 是 String 费用项ID 不能为空
communityId 是 String 小区ID 不能为空

七、返回值

响应格式(JSON)

参数名称 类型 描述
code String 返回码(0表示成功)
msg String 返回信息
data Object 返回数据(成功时为null)

状态码说明

  • 200:操作成功
  • 400:参数校验失败
  • 500:服务器内部错误

八、业务逻辑说明

  1. 校验必填参数(configId和communityId)
  2. 检查要删除的费用项是否为默认配置(IsDefault="T")
  3. 如果不是默认配置则执行删除操作
  4. 返回操作结果

九、数据库操作

  • 查询:通过feeConfigInnerServiceSMOImpl.queryFeeConfigsCount检查是否为默认配置
  • 删除:通过payFeeConfigV1InnerServiceSMOImpl.deletePayFeeConfig删除费用项配置

十、示例请求

POST /feeConfig.deleteFeeConfig
Headers:
{
  "Authorization": "Bearer xxxx",
  "app-id": "hc-micro",
  "transaction-id": "100000000020220101120000000001",
  "sign": "xxxx",
  "req-time": "20220101120000"
}

Body:
{
  "configId": "123456789",
  "communityId": "20220101123456"
}

十一、示例响应

成功响应:

{
  "code": "0",
  "msg": "成功",
  "data": null
}

失败响应(默认配置不能删除):

{
  "code": "1",
  "msg": "该费用项目不能删除",
  "data": null
}

十二、注意事项

  1. 只有非默认配置的费用项才能被删除
  2. 删除操作是物理删除,不可恢复
  3. 需要确保请求的小区ID和费用项ID对应关系正确