5 工单API

API列表

5.1: 查询模板列表(可用)

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：workorder/template/queryList

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
  "communityId": "1356753468"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
  "code": "200",
  "message": "success",
  "data":[{
      "templateInstId":"",//模板实例ID
      "templateDifId":"",//服务定义ID
      "aliasName":"", //别名
      "aliasIcon":"", //图标
      "templateId":"",//模板ID
      "templateName":"",//模板大类名称
      "isBespeak":"",//是否支持可预约(0-不支持,1-支持)
      "busiType":[{
      "busiName": "",  //名称 
      "busiCode": "",  //编码
          "busiTypeId": ""  //业务类型ID 
      }],
      "categoryId":"" // 模版服务类型
   }]
}

异常返回示例

{"code":"401","message":"签名无效"}

错误码

5.2: 查询模板详情

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：workorder/template/queryFormDetailList

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
  "communityId": "1356753468",
  "templateInstId": "1234"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
  "code": "200",
  "message": "success",
  "data":[{
      "attrInstId" : "", //属性id
      "seq": "", //顺序
      "disGroupid": "", //属性显示分组
      "attrCode" : "",//属性编码
      "widgetType" : "",//控件类型
      "contentLengthLimit":"",//内容限制的长度
      "title" : "",//标题
      "markedWords" : "",//提示语
      "expressCode" : "", //正则表达式，判断输入数据是否满足条件
      "attrValueType":"",//属性值type( 1.枚举值, 2.用户输入,3.固定值) 
      "readable":"",//读权限
      "writable":"",//写权限
      "required":"",//是否必填
      "attrValue":"",//属性值 2、3时参考
      "initData"："[{\“id\”:\”1\”,\”value\”:\”test\”}]",//JSON格式string，属性值type 1时必填
      } ....]
}

异常返回示例

{"code":"401","message":"签名无效"}

错误码

5.3: 创建工单

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：workorder/submit

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
       "communityId ":"", //真实项目ID（必填）
    "communityName":"",//真实项目名称
    "templateId":"",  //模板类型 
    "busiTypeId":"",  //业务类型（必填）
    "templateInstId":"", //服务实例ID（必填）
    "custId":"",//客户ID（必填）
    "houseId":"",//房屋ID （必填）
    "houseInfo":"",//房屋全名
    "contactName":"", //联系人
    "contactTel":"",//联系人电话
    "bespeakDate":"", //预约日期（今天之后日期）’yyyy-mm-dd’
    "bespeakTimes":"", //预约时间段(举例: 08:00~10:00  字典表编码：BESPEAL_TIME_SLOT)
    "transportTypeId": "", //接入类型 1: APP寻常生活 2: 400电话界面接入 3: 系统内部接入
    "isUrgent":"",//是否加急（0：不加急[默认]；1：加急）
    "variables":[{
        "attrInstId":"", //属性实例ID
        "attrValue":"" //属性值
    }]
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
  "code": "200",
  "message": "success",
  "data":{
        "serviceOrderId"："服务工单ID"  
  }
}

异常返回示例

{"code":"401","message":"签名无效"}

错误码

5.4: 查询我的工单

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：workorder/queryCustHisSubmitOrder

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
      "communityId": "1356753468",
      "custId": "1234",
       "pageLength":"20",
    "pageNo":"1"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
  "code": "200",
  "message": "success",
  "data":{
    "paginator": {
      "pageLength": "10",
      "pageNo": "1",
      "totalCount": "1"
     },
    "resultList": [{
      "serviceOrderId": "", //工单ID
      "trackId": "", //轨迹ID
      "contactName": "", //提单人
      "createTime": "", //提单时间
      "templateName": "", //模板类型
      "templateInstName": "", //模板实例名称 
      "busiTypeName":"", //业务类型
      "organId": "", //组织机构ID
      "organName":"",//组织机构名称
      "houseInfo":"",//房屋地址
      "chanel":"",//来源渠道
      "remark":"",//备注
      "evalue":"",//评价值
      "resultCode":"",//当前环节编码 
      "resultName":"",//当前环节名称
      "categoryId": 0 // 模版服务类型  
    }]
  }
}

异常返回示例

{"code":"401","message":"签名无效"}

错误码

5.5: 查询工单基本信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：workorder/queryBaseInfo

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
      "serviceOrderId": "1356753468",
      "organId": "1234"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
  "code": "200",
  "message": "success",
  "data":{
      "serviceOrderId": "服务工单ID",
    "serviceOrderCode": "服务工单编码",
    "trackId": "", //轨迹ID
    "templateType": "模板类型编码",
    "templateInstName": "服务模板名称", //公共取定义表，其他取别名
    "busiTypeId": "业务类型Id",
    "busiTypeCode": "业务类型编码",
    "busiTypeName": "业务类型名称",
    "resultCode":"处理结果",
    "resultCodeName":"处理结果名称",
    "houseId": "房屋号",
    "houseInfo": "软件园1栋1单元101房",
    "transportTypeId": "接入类型", //1: APP终端接入 2: 400电话界面接入 3: 系统内部接入
    "transportTypeName": "接入类型名称", //1: APP终端接入 2: 400电话界面接入 3: 系统内部接入
    "noteName": "", //录单人姓名
    "contactName": "联系人姓名",
    "contactTel": "联系人电话",
    "organId": "组织机构ID",
    "organName": "项目名称",
    "createDate": "工单创建时间",
    "beginDate": "工单计划开始时间",
    "endDate": "工单计划结束时间",
    "remark": "备注",
    "status": "工单状态(0-未完成;1-已完成)",
    "supflag":"",//超时标识 1 ，2，3分别标识几级超时 0 或者空未超时
    "suptype":"",//处理过的环节，超时处理 000：未处理，001：一级督办，011：二级督办，111：三级督办  非000或空时参考supflag。
    "urgentLevel": "加急等级(0-不加急;大于0-加急)",
    "categoryId": 0 ,// 模版服务类型
    "isBespeak": "是否预约(0-否;1-是)",
    "bespeakBegintime": "预约开始时间(isBespeak=1时有效)",
    "bespeakEndtime": "预约结束时间(isBespeak=1时有效)"
  }
}

异常返回示例

{"code":"401","message":"签名无效"}

错误码

5.6: 查询工单提单信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：workorder/queryDetailList

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
      "serviceOrderId": "1356753468",
      "organId": "1234"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
  "code": "200",
  "message": "success",
  "data":[{
     "attrInstId": "",//属性实例id
     "seq": "", //顺序
     "disGroupid": "", //属性显示分组
     "readable": "1",
     "writable": "1",
     "required": "1",
     "attrCode": "",//属性编码
     "widgetType" : "",//控件类型
     "contentLengthLimit": "",//内容限制的长度
     "title" : "",//标题
     "markedWords" : "",//提示语
     "expressCode" :"", //正则表达式，判断输入数据是否满足条件
     "attrValueType":"",//属性值type 1. 枚举值 ，2. 用户输入 ，3. 固定值 
     "initData":"[{\“id\”:\”1\”,\”value\”:\”test\”}]",//JSON字符串，attrValueType 1时必填
     "attrValue": ""//属性值
  }]
}

异常返回示例

{"code":"401","message":"签名无效"}

错误码

5.7: 查询工单轨迹信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：workorder/queryTrackList

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
      "serviceOrderId": "1356753468",
      "organId": "1234"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
  "code": "200",
  "message": "success",
  "data":[{
    "trackId": "轨迹id",
    "trackCode": "轨迹编码",
    "trackName": "轨迹名称",
    "createDate": "创建时间",
    "handleDate": "服务处理时间",
    "trackStatus": "", //0 待处理，1 已处理
    "overType": "", // 0正常完结，1取消（终止）5系统关闭 6强制关闭
    "currentUser": [{ 
        "userId": "",
        "userName": "",
        "userType": ""
    }], // 当前待处理用户,或处理用户
    "nextTrackCode": "下一环节轨迹编码",
    "nextTrackName": "下一环节轨迹名称",
    "nextUser": [], // 下一步处理人
    "dealAdvise": "处理意见", // 处理意见、评价描述
    "evalue":"评价值",
    "evalueChannel":"评价来源1. 业主APP，2短信，3. ",
    "isAgree":"是否通过（同意）回访、审核;1：通过，2不通过",
    "opUserType":"操作用户量类型[评价、回访]：1. 提单人or用户，2. 系统,3 员工",
    "overTimeflag":"超时级别（取supflag）",
    “charge”:””,//总金额，有偿服务总费用(分)
    “isPayService”:””,// 是否收费
    "variables": [{ // 按低保真 处理环节有 照片、语音、视频 （有则下发）
          "title": "", // 标题
          "widgetType": "", // 控件类型
          "attrValueType": "", // 属性值type 1. 枚举值 ，2. 用户输入 ，3. 固定值 
          "initData": "[{\"id\":\"1\",\"value\":\"test\"}]", //JSON格式string，属性值type 1时必填
          "attrValue": "" //属性值
    }],
    "materiels": [{ // 物料
        "goodsName": "", // 名称
        "goodsBrand": "",// 品牌
        "goodsModel": "", // 类型
        "price": "", // 单价(分)
        "useCount": "" // 数量
        "unit": "" // 单位
    }],
    "payServices": [{ // 有偿服务
        "serviceName": "", 
        "pirce": ""
    }]
  }]
}

异常返回示例

{"code":"401","message":"签名无效"}

错误码

5.8: 查询工单动作信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：workorder/queryActionForms

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
      "serviceOrderId": "1356753468",
      "organId": "1234",
    "custId":""
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
  "code": "200",
  "message": "success",
  "data":{
      "trackId": "", //轨迹ID
      "actionList": [{
         "actionCode":"", //动作编码
         "actionName":"",//动作名称
         "formList":[{
              "attrInstId": "", //属性实例id
             "seq": "", //顺序
             "disGroupid": "", //属性显示分组
             "readable": "1",
             "writable": "1",
             "required": "1",
             "attrCode": "", //属性编码
             "widgetType": "", //控件类型
             "contentLengthLimit": "", //内容限制的长度
             "title": "", //标题
             "markedWords": "", //提示语
             "expressCode": "", //正则表达式，判断输入数据是否满足条件
             "attrValueType": "", //属性值type 1. 枚举值 ，2. 用户输入 ，3. 固定值 
             "initData": "[{\“id\”:\”1\”,\”value\”:\”test\”}]", //JSON字符串，属性值type=1时必填
             "attrValue": "" //属性值
         }......]
      }......]
   }
}

异常返回示例

{"code":"401","message":"签名无效"}

错误码

5.9: 查询工单点赞业主

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：workorder/queryPraiseInfos

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
      "serviceOrderId": "1356753468",
      "organId": "1234"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
  "code": "200",
  "message": "success",
  "data":{
      "adminName": "林德壕",
      "communityName": "海文花园",
      "grandDate": "2017年12月21",
      "organName": "XX物业管理有限公司",
      "userName":"XX"
   }
}

异常返回示例

{"code":"401","message":"签名无效"}

错误码

5.10: 处理工单

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：workorder/handle

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
      "serviceOrderId": "1356753468",
      "organId": "1234",
    "trackId":"xxx",
    "custId":"xxx",
    "actionCode":"xxx",
    "variables":[{
        "attrInstId":"",
        "attrValue":""
    }]
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
  "code": "200",
  "message": "success",
  "data":{
      "trackId": "xxx" //最新的轨迹ID
   }
}

异常返回示例

{"code":"401","message":"签名无效"}

错误码

5.11: 查询工单支付明细

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：workorder/queryPayDetail

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
      "serviceOrderId": "1356753468",
      "organId": "1234"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
  "code": "200",
  "message": "success",
  "data":{
      "receivableFee": "", //总应收(元)
      "preferentialFee": "", //优惠费用(元)，优惠费用为0时不展示
      "totalFee": "", // 实际需收费（元）
      "materiels": [{ // 物料
            "type": "1", //0:其他，1:工单配置物料，2：仓库数据；
            "catalogName": "",
            "goodsList": [{
                "goodsName": "", // 名称
                "goodsBrand": "", // 品牌
                "goodsModel": "", // 类型
                "price": "", // 单价
                "useCount": "", // 数量
                "unit": "", // 单位
                "verificationType": "2" // 1: 不收费,2 :收费
            }]
        }],
        "payServices": [{ // 有偿服务
            "type": "1", //0:其他，1:有偿选择；
            "catalogName": "",
            "serviceList": [{
                "serviceName": "",
                "model": "规格",
                "useCount": "" // 数量
                "unit": "" // 单位
                "price": ""
            }]
        }]
     }
   }
}

异常返回示例

{"code":"401","message":"签名无效"}

错误码

5.12: 查询工单支付方式

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：workorder/queryPayMethodList

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
      "serviceOrderId": "1356753468",
      "organId": "1234"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
  "code": "200",
  "message": "success",
  "data":{
      "menthods": [{
            "payMethod": "2",
            "name": "合并账单"
       }, {
            "payMethod": "3",
            "name": "微信支付"
       }]

  }
}

异常返回示例

{"code":"401","message":"签名无效"}

错误码

5.13: 创建工单支付订单

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：workorder/servicePay

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
      "serviceOrderId": "1356753468",
      "organId": "1234",
    "payMethod":"3",
    "payChannel":"2",
    "appId":"123456",
    "wxOpenid": "wx"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

//payChannel=1：app调用支付
{
  "code": "200",
  "message": "success",
  "data":{
     "charSet": "字符集String可选默认UTF-8",
     "signType": "签名方式String可选默认MD5",
     "sign": "签名",
     "result": "",
     "resultCode": "业务结果String0表示成功非0表示失败",
     "mchId": "商户号String",
     "payInfo": "支付信息String用户唤起微信的参数",
     "vpayId": "商户订单号String",
     "transactionId": "平台流水号String用于查询或退款",
     "addInfo":"附加信息可选商家数据包，返回时原样返回，不能包含<>字符。",
      "nouceStr": "随机码String随机串，重发消息时，需要修改"
   }
}

//payChannel=2：商户在微信公众号中集成微信支付
{
  "code": "200",
  "message": "success",
  "data":{
       "charSet": "字符集String可选默认UTF-8",
    "signType": "签名方式String可选默认MD5",
    "sign": "签名",
    "result": "",
    "resultCode": "业务结果String 0表示成功非0表示失败",
    "mchId": "商户号String ",
    "payInfo": "支付信息",
    "vpayId": "商户订单号",
    "transactionId": "平台流水号",
    "addInfo": "附加信息可选商家数据包,返回时原样返回，不能包含<>字符。",
    "nouceStr": "随机码String随机串，重发消息时，需要修改 "
}

异常返回示例

{"code":"401","message":"签名无效"}

错误码

5.14: 创建设备事件工单

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：workorder/event/create

方法：POST

请求参数

请求Body描述(非Form表单数据)

// 设备离线
{
    "eventId":"xxxx",
    "version":"1",
    "eventTime":"100",
       "eventObject": "DEVICE", 
    "extra":{
        "type":"OFFLINE",
        "communityId":"11130121",
        "deviceId":"1356753468",
        "deviceName": "设备名称"
    }
}
// xAgent
{
    "eventId":"xxxx",
    "version":"1",
    "eventTime":1565582371997,
       "eventObject": "XAGENT", 
    "extra":{
        "type":"OFFLINE",
        "communityId":"11130121",
        "manufactor":"xxxxx"
    }
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
  "code": "200",
  "message": "success",
  "data":{
     "serviceOrderId"："服务工单ID"  
   }
}

异常返回示例

{"code":"401","message":"签名无效"}

错误码

5.15: 文件上传

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：workorder/file/upload

方法：POST

请求参数 (Form表单)

请求参数描述(Form表单数据)

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
  "code": 200,
  "message": "success",
  "data":{
     "fileUrl": "http://mideazy-user.oss-cn-hangzhou.aliyuncs.com/workorderPic/1565421237883test.jpg"
   }
}

5.16: 查询我的服务进度

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：workorder/queryMyOrderProgressList

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
      "communityId": "1356753468",
      "custId": "1234",
       "pageLength":"20",
    "pageNo":"1"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
  "code": "200",
  "message": "success",
  "data":{
    "paginator": {
      "pageLength": "10",
      "pageNo": "1",
      "totalCount": "1"
     },
    "resultList": [{
      "serviceOrderId": "", //工单ID
      "trackId": "", //轨迹ID
      "contactName": "", //提单人
      "createTime": "", //提单时间
      "templateName": "", //模板类型
      "templateInstName": "", //模板实例名称 
      "busiTypeName":"", //业务类型
      "organId": "", //组织机构ID
      "organName":"",//组织机构名称
      "houseInfo":"",//房屋地址
      "chanel":"",//来源渠道
      "remark":"",//备注
      "evalue":"",//评价值
      "resultCode":"",//当前环节编码 
      "resultName":"",//当前环节名称
      "categoryId": 0, // 模版服务类型
      "trackList":[] //工单轨迹信息，详情见[5.7查询工单轨迹信息]
    }]
  }
}

5.17: 四格通用查询api

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：workorder/queryCommon

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
      "url": "/order-user-api/rest-api/v5/order/query/queryCustHisSubmitOrder.json",
    "method":"POST",
      "urlParam": {},    
       "body":{
       "communityId":"123",
       "custId":"21",
       "pageLength":"10",
       "pageNo":"1"
    }
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
  "code": "200",
  "message": "success",
  "data":{
    "code":"0",
    "msg":"查询成功!",
    "data":{
        "msg": "组织机构不能为空!",
        "code": "-1",
        "data": "",
        "message": "组织机构不能为空!"
    }
  }
}

5.18: 物业工单通用api

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/user/ + 物业接口文档地址

方法：POST

请求参数

请求Body描述(非Form表单数据)

{
    "url": "/user/bussiness-order/record/list",
    "method":"POST",
    "urlParam": "id=1277543808108568578",    
    "body":{
       "communityId":"123",
       "custId":"21",
       "pageLength":"10",
       "pageNo":"1"
    }
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": 200,
    "data": {
        "records": [
            {
                "createUser": "1123598821738675201",
                "createTime": "2020-06-29 18:05:54",
                "updateUser": "1123598821738675201",
                "updateTime": "2020-06-29 18:05:54",
                "status": 1,
                "isDeleted": 0,
                "id": "1277543808108568578",
                "orderName": "处理人_投诉",
                "orderDetailId": "1277543808058236930",
                "sourceType": "3",
                "sourceId": "-1",
                "flowInstId": "flowable:154:f6a1d490-b2ca-11ea-8e8a-0028f80f31b1",
                "flowStatus": 3,
                "categoryType": -1,
                "transportType": 1,
                "orderPriority": 2,
                "statusCd": -1,
                "beginDate": "2020-06-29 18:05:54",
                "endDate": "",
                "makeUserId": -1,
                "makeUserType": 2,
                "takeUserId": -1,
                "takeUserType": 2,
                "parentId": "-1",
                "remark": "",
                "orderTemplateId": "1274244782675968002",
                "makeUserName": "1",
                "takeUserName": "处理人",
                "flowTemplateId": "flowable:154:f6a1d490-b2ca-11ea-8e8a-0028f80f31b1",
                "mandatoryFields": "",
                "processor": "1272768492535586819",
                "processorGroup": 4,
                "processorName": "提单人",
                "orderDetailData": "",
                "templateName": "",
                "templateTypeName": "",
                "categoryTypeName": "",
                "source": ""
            }
        ],
        "total": 16,
        "size": 10,
        "current": 1,
        "orders": [],
        "hitCount": false,
        "searchCount": true,
        "pages": 2
    },
    "message": "success"
}

异常返回示例

{"code":"401","message":"签名无效"}

错误码

错误码列表(15001-15999)