HC小区接口文档

业主报修列表查询接口文档

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

一、接口名称

业主报修列表查询

二、接口描述

该接口用于查询小区内业主的报修记录列表,支持分页查询,可返回报修详情、相关图片、维修人员信息以及评分等信息。

三、接口路径

http://ip:port/app/ownerRepair.listOwnerRepairs

四、请求方法

GET

五、请求头

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

六、请求参数

6.1 查询参数

参数名称 必填 类型 描述 示例
communityId String 小区ID 7020181217000001
page Integer 页码,默认为1 1
row Integer 每页记录数,默认为10 10
ownerId String 业主ID 7720181217000001
roomId String 房屋ID,支持多个ID用逗号分隔 7420181217000001,7420181217000002
repairType String 报修类型 1
repairId String 报修单ID 7920181217000001
state String 报修状态 1000
startTime String 开始时间(yyyy-MM-dd) 2023-01-01
endTime String 结束时间(yyyy-MM-dd) 2023-12-31
reqSource String 请求来源(pc_mobile表示PC端和手机端) pc_mobile

七、返回值

7.1 返回值结构

参数名称 类型 描述
code String 返回码 0 成功 其他失败
msg String 返回信息
data Object 返回数据

7.2 data对象结构

参数名称 类型 描述
total Integer 总记录数
records Integer 当前页记录数
rows List 报修记录列表

7.3 RepairDto对象结构

参数名称 类型 描述
repairId String 报修单ID
communityId String 小区ID
repairType String 报修类型
repairName String 报修名称
tel String 联系电话
roomId String 房屋ID
roomName String 房屋名称
state String 报修状态
stateName String 报修状态名称
context String 报修内容
createTime String 创建时间
finishTime String 完成时间
timeout String 超时时间
submitHours String 处理时长
appraiseScore String 综合评价得分
doorSpeedScore String 上门速度评分
repairmanServiceScore String 维修员服务评分
average String 平均分
staffId String 维修人员ID
staffName String 维修人员姓名
photos List 所有相关图片
repairPhotos List 维修图片
beforePhotos List 维修前图片
afterPhotos List 维修后图片

7.4 PhotoVo对象结构

参数名称 类型 描述
url String 图片URL
relTypeCd String 图片类型

八、示例请求

GET /app/ownerRepair.listOwnerRepairs?communityId=7020181217000001&page=1&row=10&startTime=2023-01-01&endTime=2023-12-31
Headers:
  Authorization: Bearer xxxxxxxx
  app-id: xxxxxxxx
  transaction-id: 100000000020231201143000000001
  sign: xxxxxxxx
  req-time: 20231201143000

九、示例响应

{
  "code": "0",
  "msg": "成功",
  "data": {
    "total": 15,
    "records": 10,
    "rows": [
      {
        "repairId": "7920181217000001",
        "communityId": "7020181217000001",
        "repairType": "1",
        "repairName": "水管漏水",
        "tel": "13800138000",
        "roomId": "7420181217000001",
        "roomName": "1栋1单元101室",
        "state": "1000",
        "stateName": "已完成",
        "context": "厨房水管漏水严重",
        "createTime": "2023-05-10 09:30:00",
        "finishTime": "2023-05-10 11:45:00",
        "submitHours": "2小时15分钟",
        "appraiseScore": "5",
        "doorSpeedScore": "4",
        "repairmanServiceScore": "5",
        "average": "4.67",
        "staffId": "8820181217000001",
        "staffName": "张三",
        "photos": [
          {
            "url": "http://xxx.com/upload/20230510/xxxx.jpg",
            "relTypeCd": "10000"
          }
        ],
        "repairPhotos": [
          {
            "url": "http://xxx.com/upload/20230510/xxxx.jpg",
            "relTypeCd": "10000"
          }
        ],
        "beforePhotos": [
          {
            "url": "http://xxx.com/upload/20230510/xxxx.jpg",
            "relTypeCd": "11000"
          }
        ],
        "afterPhotos": [
          {
            "url": "http://xxx.com/upload/20230510/xxxx.jpg",
            "relTypeCd": "12000"
          }
        ]
      }
    ]
  }
}

十、业务逻辑说明

  1. 参数验证

    • 验证分页参数
    • 验证小区ID必填
    • 验证物业属性
  2. 数据处理

    • 处理时间参数格式
    • 处理多个房屋ID的情况
    • 根据请求来源过滤数据(pc_mobile表示只返回PC端和手机端员工登记的数据)
  3. 数据查询

    • 查询报修记录总数
    • 查询报修记录列表
  4. 数据计算

    • 计算各项评分(综合评价、上门速度、维修服务)及平均分
    • 计算处理时长
    • 检查是否超时
  5. 数据补充

    • 补充维修人员信息
    • 补充相关图片信息(维修图片、维修前图片、维修后图片)
  6. 返回结果

    • 返回分页信息和报修记录列表