HC小区接口文档

业主报修接口文档

提交报修
查询报修单
查询待办单
办理报修

一、接口名称

业主报修接口,提交保修单

二、接口描述

该接口用于业主提交报修信息,包括报修内容、预约时间、联系方式等,并支持上传报修图片。

三、接口路径

http://{ip}:{port}/app/ownerRepair.saveOwnerRepair

四、请求方法

POST

五、请求头

参数名称 必填 类型 描述
Authorization String 用户认证token,通过登录接口获取
app-id String 应用ID,由系统分配
transaction-id String 请求流水号,格式:1000000000+YYYYMMDDhhmmss+6位序列
sign String 签名
req-time String 请求时间,格式:YYYYMMDDhhmmss

六、请求参数

6.1 请求体参数(JSON格式)

参数名称 必填 类型 描述 示例
communityId String 小区编码 "2022032267510001"
appointmentTime String 预约时间(格式:YYYY-MM-DD HH:mm:ss) "2022-11-26 15:18:00"
context String 报修内容 "水管漏水"
photos Array<String> 报修图片(Base64编码或URL) ["image1.jpg", "image2.jpg"]
repairName String 报修人姓名 "张三"
repairObjName String 报修人住址 "1号楼1单元202室"
roomId String 房屋ID "752022090312040033"
tel String 报修联系电话 "15239726115"
repairType String 报修类型 "102022081592760001"
repairChannel String 报修渠道(如:Z-自助) "Z"
repairObjType String 报修对象类型(如:004-房屋) "004"
repairObjId String 报修对象ID "752022090312040033"

七、返回值

7.1 返回数据(JSON格式)

参数名称 类型 描述 示例
code int 返回码(0-成功,非0-失败) 0
msg String 返回信息 "成功"
page int 分页信息(默认0) 0
records int 记录数(默认0) 0
rows int 行数(默认0) 0
total int 总数(默认0) 0

八、示例请求

{
  "repairName": "张三",
  "repairType": "102022081592760001",
  "appointmentTime": "2022-11-26 15:18:00",
  "tel": "15239726115",
  "roomId": "752022090312040033",
  "photos": ["image1.jpg", "image2.jpg"],
  "context": "水管漏水",
  "communityId": "2022032267510001",
  "repairObjType": "004",
  "repairChannel": "Z",
  "repairObjId": "752022090312040033",
  "repairObjName": "1号楼1单元202室"
}

九、示例响应

{
  "code": 0,
  "msg": "成功",
  "page": 0,
  "records": 0,
  "rows": 0,
  "total": 0
}

十、业务逻辑说明

  1. 参数校验

    • 校验必填参数(repairTyperepairNametelrepairObjTyperepairObjIdrepairObjNameappointmentTimecontextcommunityId)。
    • 检查用户是否存在。
    • 检查该房屋是否存在未处理的报修费用(超过限制则不允许报修)。
  2. 报修信息存储

    • 生成报修单号(repairId)。
    • 设置报修状态为“待处理”(STATE_WAIT)。
    • 计算超时时间(timeout)。
    • 保存报修记录(repairPool)。
  3. 报修流程记录

    • 记录报修流程(repairUser),状态为“提交”(STATE_SUBMIT)。
  4. 图片存储

    • 如果图片是Base64编码,则存储到文件服务器并返回URL。
    • 关联图片与报修单(fileRel)。
  5. 关联业主反馈(可选)

    • 如果存在noteId,则关联报修单与业主反馈记录。

十一、错误码

错误码 描述 可能原因
非0 报修失败 参数缺失、用户不存在、房屋存在未处理费用、数据库操作失败