HC小区接口文档

员工待办维修单接口文档

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

一、接口名称

员工待办维修单查询

二、接口描述

查询员工待办的维修工单列表,用于物业或维修人员查看待处理的维修任务。

三、接口路径

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

四、请求方法

GET

五、请求头

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

六、请求参数

6.1 查询参数

参数名称 必填 类型 描述
communityId String 小区ID
staffId String 员工ID
page Integer 当前页码(默认1)
row Integer 每页记录数(默认10)

七、返回值

7.1 返回数据结构

参数名称 类型 描述
code int 返回码,0表示成功,其他表示失败
msg String 返回信息
data Array 维修工单列表
data[].appointmentTime String 预约时间
data[].repairName String 报修名称
data[].repairId String 工单ID
data[].context String 报修内容
page int 当前页码
records int 总记录数
total int 总页数

八、示例请求

GET /app/ownerRepair.listUndoRepairsByStaff?communityId=2023013154290059&staffId=302023013185270087&page=1&row=10
Headers:
  Authorization: Bearer xxxxxx
  app-id: hc-community
  transaction-id: 100000000020230101120000000001
  sign: xxxxxx
  req-time: 20230101120000

九、示例响应

{
  "code": 0,
  "msg": "成功",
  "data": [
    {
      "appointmentTime": "2023-02-18 23:34:23",
      "repairName": "飞蛾打印机报修单测试",
      "repairId": "822023021809940002",
      "context": "飞蛾打印机报修单测试"
    }
  ],
  "page": 1,
  "records": 1,
  "total": 1
}

十、业务逻辑说明

  1. 校验必填参数 communityIdstaffId
  2. 调用 IRepairInnerServiceSMO 查询待办维修单
  3. 返回分页数据

十一、注意事项

  • 必须传入有效的 communityIdstaffId
  • 分页参数 pagerow 可选,默认 page=1row=10
  • 返回数据按 appointmentTime 排序