[TOC]
四、工单模块API
1. 工单模块
1.1. 查询工单模板列表
请求描述:查询工单模板列表
请求地址:/order-user-api/rest-api/v5/order/template/queryServiceList.json
请求方式:POST
接口说明:
页面截图:
1.2. 查询工单模板详情表单
请求描述:查询工单模板详情表单
请求地址:/order-user-api/rest-api/v5/order/template/queryServFormList.json
请求方式:POST
接口说明:
页面截图:
1.3. 创建工单
请求描述:创建工单
请求地址:/order-user-api/rest-api/v5/order/handle/submitOrderByMideadc.json
请求方式:POST
接口说明:
名称 |
位置 |
类型 |
必填 |
描述 |
communityId |
BODY |
STRING |
否 |
项目ID |
communityName |
BODY |
Long |
是 |
项目名称 |
templateId |
BODY |
STRING |
是 |
模版类型 |
busiTypeId |
BODY |
STRING |
否 |
业务类型 |
templateInstId |
BODY |
STRING |
否 |
服务实例ID |
custId |
BODY |
STRING |
否 |
客户ID |
houseId |
BODY |
Long |
是 |
房间ID |
houseInfo |
BODY |
STRING |
是 |
房间信息 |
contactName |
BODY |
Integer |
否 |
联系人名称 |
contactTel |
BODY |
STRING |
否 |
联系人手机号 |
bespeakDate |
BODY |
Long |
是 |
预约日期 |
bespeakTimes |
BODY |
STRING |
是 |
预约时间端 |
transportTypeId |
BODY |
STRING |
否 |
接入类型:1: APP终端接入 2: 400电话界面接入 3: 系统内部接入 |
isUrgent |
BODY |
Long |
是 |
是否加急(0:不加急[默认];1:加急) |
variables |
BODY |
STRING |
是 |
属性 |
页面截图:
1.4. 查看我的工单
请求描述:查看我的工单
请求地址:/order-user-api/rest-api/v5/order/query/queryCustHisSubmitOrder.json
请求方式:POST
接口说明:
页面截图:
1.5. 工单轨迹
请求描述:工单轨迹
请求地址:/order-user-api/rest-api/v5/order/query/queryTrackList.json
请求方式:POST
接口说明:
页面截图:
1.6. 工单详情
请求描述:工单详情
请求地址:/order-user-api/rest-api/v5/order/query/queryOrderBaseInfo.json
请求方式:POST
接口说明:
页面截图:
1.7. 提单信息
请求描述:提单信息
请求地址:/order-user-api/rest-api/v5/order/query/queryOrderDetail.json
请求方式:POST
接口说明:
页面截图:
1.8. 工单详情|动作表单列表
请求描述:工单详情|动作表单列表
请求地址:/order-user-api/rest-api/v5/order/query/queryActionForms.json
请求方式:POST
接口说明:
页面截图:
1.9. 查询工单点赞业主
请求描述:查询工单点赞业主
请求地址:/order-user-api/rest-api/v5/order/query/getZanInfo.json
请求方式:POST
接口说明:
2.0. 处理工单
请求描述:处理工单
请求地址:/order-user-api/rest-api/v5/order/handle/handleOrder.json
请求方式:POST
接口说明:
2.1. 获取工单支付明细
请求描述:获取工单支付明细
请求地址:/order-user-api/rest-api/v5/order/paid/queryPayDetail.json
请求方式:POST
接口说明:
2.2. 查询工单支付方式
请求描述:查询工单支付方式
请求地址:/order-user-api/rest-api/v5/order/paid/getPayMethodListNew.json
请求方式:POST
接口说明:
2.2. 创建工单支付订单
请求描述:创建工单支付订单
请求地址:/order-user-api/noauth/v1/order/paid/servicePayV2.json
请求方式:POST
接口说明:
3.1. 工单模板获取(设备报障)
请求描述:根据相应组织机构ID渠道和模板大类获取工单模板信息
请求地址:/parking-midea/rest-api/v1/openApi/midea/getTempInfoByTemplateCode
请求方式:POST
请求参数
名称 |
位置 |
类型 |
必填 |
描述 |
organId |
BODY |
STRING |
是 |
组织机构ID |
channel |
BODY |
STRING |
是 |
默认填0 |
templateCode |
BODY |
STRING |
否 |
例如需要查设备告警类模板就输入设备告警模板类型 |
{
"channel": "0",
"organId": 21441119,
"templateCode": "IOTSER"
}
返回参数
名称 |
位置 |
类型 |
必填 |
描述 |
code |
BODY |
STRING |
是 |
|
msg |
BODY |
STRING |
是 |
|
data |
BODY |
数组 |
否 |
例如需要查设备告警类模板就输入设备告警模板类型 |
templateDifId |
data |
String |
是 |
模板类型ID |
templateName |
data |
String |
是 |
模板类型名称 |
templateInstName |
data |
String |
是 |
模板名称 |
busiTypeId |
data |
String |
是 |
模板分类ID |
busiName |
data |
String |
是 |
模板分类名称 |
busiCode |
data |
String |
是 |
服务子类 |
{
"code": "0",
"data": [{
"busiTypeId": 12000376,
"templateDifId": 12000141,
"busiName": "客服",
"templateName": "IOT工单服务",
"busiCode": "K001",
"templateInstName": "IOT服务工单"
}, {
"busiTypeId": 12000377,
"templateDifId": 12000141,
"busiName": "工程",
"templateName": "IOT工单服务",
"busiCode": "G001",
"templateInstName": "IOT服务工单"
}, {
"busiTypeId": 12000378,
"templateDifId": 12000141,
"busiName": "环境",
"templateName": "IOT工单服务",
"busiCode": "H001",
"templateInstName": "IOT服务工单"
}
],
"msg": "查询成功"
}
接口使用位置
3.2. 工单模板属性获取(设备报障)
请求描述:根据模板类型ID获取模板对应属性
请求地址:/parking-midea/rest-api/v1/openApi/midea/searchServFormListByDifId
请求方式:POST
请求参数
名称 |
位置 |
类型 |
必填 |
描述 |
organId |
BODY |
STRING |
是 |
组织机构ID |
templateDifId |
BODY |
STRING |
否 |
模板ID |
{
"organId": 21441119,
"templateDifId": 12000141
}
返回参数
名称 |
位置 |
类型 |
必填 |
描述 |
code |
BODY |
STRING |
是 |
|
msg |
BODY |
STRING |
是 |
|
data |
BODY |
数组 |
否 |
例如需要查设备告警类模板就输入设备告警模板类型 |
attrInstId |
data |
String |
是 |
属性ID |
attrName |
data |
String |
是 |
属性名称 |
attrCode |
data |
String |
是 |
属性编码 |
required |
data |
String |
是 |
是否必传1必传,0非必传 |
widgetType |
data |
String |
是 |
属性类型 |
contentLengthLimit |
data |
String |
是 |
长度限制 |
title |
data |
String |
是 |
标题 |
markedWords |
data |
String |
是 |
提示语 |
expressCode |
data |
String |
是 |
正则表达式,判断输入数据是否满足条件 |
readable |
data |
String |
是 |
1可读,0否 |
writable |
data |
String |
是 |
1可写,0否 |
attrValue |
data |
String |
是 |
提示语 |
initData |
data |
数组 |
是 |
初始值 |
disGroupid |
data |
String |
属性显示分组 |
seq |
data |
String |
是 |
顺序 |
{
"code": 200,
"data": [{
"attrInstId": "12305424",
"attrCode": "device_code_id",
"widgetType": "text",
"contentLengthLimit": "151",
"title": "设备编号",
"markedWords": "设备编号输入",
"expressCode": "",
"attrValueType": "2",
"readable": "1",
"writable": "1",
"required": "0",
"attrValue": "",
"initData": "[]",
"disGroupid": "0",
"seq": "1"
}, {
"attrInstId": "12305425",
"attrCode": "address_ID",
"widgetType": "text",
"contentLengthLimit": "131",
"title": "详细地址",
"markedWords": "请填写地址信息",
"expressCode": "",
"attrValueType": "2",
"readable": "1",
"writable": "1",
"required": "0",
"attrValue": "",
"initData": "[]",
"disGroupid": "0",
"seq": "3"
}, {
"attrInstId": "12305426",
"attrCode": "sj_no",
"widgetType": "text",
"contentLengthLimit": "100",
"title": "事件单号",
"markedWords": "事件单号",
"expressCode": "",
"attrValueType": "2",
"readable": "1",
"writable": "1",
"required": "0",
"attrValue": "",
"initData": "[]",
"disGroupid": "1",
"seq": "1"
}, {
"attrInstId": "12305427",
"attrCode": "gj_dj",
"widgetType": "label",
"contentLengthLimit": "0",
"title": "告警等级",
"markedWords": "告警等级",
"expressCode": "",
"attrValueType": "2",
"readable": "1",
"writable": "1",
"required": "0",
"attrValue": "",
"initData": "[]",
"disGroupid": "1",
"seq": "4"
}, {
"attrInstId": "12305428",
"attrCode": "REMARK9",
"widgetType": "textarea",
"contentLengthLimit": "128",
"title": "告警描述",
"markedWords": "情况说明",
"expressCode": "",
"attrValueType": "2",
"readable": "1",
"writable": "1",
"required": "0",
"attrValue": "",
"initData": "[]",
"disGroupid": "1",
"seq": "3"
}, {
"attrInstId": "12315425",
"attrCode": "dtType",
"widgetType": "text",
"contentLengthLimit": "11",
"title": "设备类型",
"markedWords": "设备类型",
"expressCode": "",
"attrValueType": "2",
"readable": "1",
"writable": "1",
"required": "0",
"attrValue": "",
"initData": "[]",
"disGroupid": "0",
"seq": "0"
}, {
"attrInstId": "12315426",
"attrCode": "XJ_device_name_id",
"widgetType": "text",
"contentLengthLimit": "121",
"title": "设备名称",
"markedWords": "请输入设备名称",
"expressCode": "",
"attrValueType": "2",
"readable": "1",
"writable": "1",
"required": "0",
"attrValue": "",
"initData": "[]",
"disGroupid": "0",
"seq": "2"
}, {
"attrInstId": "12315427",
"attrCode": "equmentPositon",
"widgetType": "text",
"contentLengthLimit": "50",
"title": "设备位置信息",
"markedWords": "",
"expressCode": "",
"attrValueType": "4",
"readable": "1",
"writable": "1",
"required": "0",
"attrValue": "",
"initData": "[]",
"disGroupid": "1",
"seq": "0"
}, {
"attrInstId": "12315428",
"attrCode": "sjlx_attr",
"widgetType": "label",
"contentLengthLimit": "0",
"title": "事件类型",
"markedWords": "事件类型",
"expressCode": "",
"attrValueType": "2",
"readable": "1",
"writable": "1",
"required": "0",
"attrValue": "",
"initData": "[]",
"disGroupid": "1",
"seq": "2"
}, {
"attrInstId": "12315429",
"attrCode": "gjsj_id",
"widgetType": "datetime_nosecond",
"contentLengthLimit": "0",
"title": "告警时间",
"markedWords": "告警时间",
"expressCode": "",
"attrValueType": "2",
"readable": "1",
"writable": "1",
"required": "0",
"attrValue": "",
"initData": "[]",
"disGroupid": "1",
"seq": "5"
}, {
"attrInstId": "12315430",
"attrCode": "SCZP_ID",
"widgetType": "photo",
"contentLengthLimit": "10",
"title": "上传照片",
"markedWords": "请上传照片",
"expressCode": "",
"attrValueType": "2",
"readable": "1",
"writable": "1",
"required": "0",
"attrValue": "",
"initData": "[]",
"disGroupid": "2",
"seq": "0"
}
],
"msg": "查询成功"
}
接口使用位置
3.3. 报障工单上传接口(设备报障)
请求描述:创建设备报障工单
请求地址:/parking-midea/rest-api/v1/openApi/midea/createOrderV3
请求方式:POST
请求参数
名称 |
位置 |
类型 |
必填 |
描述 |
organId |
BODY |
STRING |
是 |
组织机构ID |
templateDifId |
BODY |
STRING |
是 |
模板ID |
busiTypeCode |
BODY |
STRING |
是 |
服务子类 |
variables |
BODY |
STRING |
是 |
属性列表 |
attrInstId |
variables |
STRING |
是 |
属性ID |
attrCode |
variables |
STRING |
是 |
属性编码 |
attrValue |
variables |
STRING |
是 |
属性值 |
{
"templateDifId": "12000141",
"organId": "21291201",
"busiTypeCode": "K001",
"variables": [{
"attrCode": "device_code_id",
"attrInstId": "12305424",
"attrValue": 1390634895,
"widgetType": "text"
}, {
"attrCode": "address_ID",
"attrInstId": "12305425",
"attrValue": "",
"widgetType": "text"
}, {
"attrCode": "sj_no",
"attrInstId": "12305426",
"attrValue": "7c24fb6e-6a71-4a07-8a78-df1cdf3c8eae",
"widgetType": "text"
}, {
"attrCode": "gj_dj",
"attrInstId": "12305427",
"attrValue": "严重",
"widgetType": "label"
}, {
"attrCode": "REMARK9",
"attrInstId": "12305428",
"attrValue": "",
"widgetType": "textarea"
}, {
"attrCode": "dtType",
"attrInstId": "12315425",
"attrValue": "",
"widgetType": "text"
}, {
"attrCode": "XJ_device_name_id",
"attrInstId": "12315426",
"attrValue": "19F走廊",
"widgetType": "text"
}, {
"attrCode": "equmentPositon",
"attrInstId": "12315427",
"attrValue": "智慧生活体验馆01",
"widgetType": "text"
}, {
"attrCode": "sjlx_attr",
"attrInstId": "12315428",
"attrValue": "垃圾满溢事件",
"widgetType": "label"
}, {
"attrCode": "gjsj_id",
"attrInstId": "12315429",
"attrValue": "2022-07-26 09:54:43",
"widgetType": "datetime_nosecond"
}, {
"attrCode": "SCZP_ID",
"attrInstId": "12315430",
"attrValue": "https://document.smartmideazy.com:60172/group1/M00/42/3B/wKgMzWLfSWCAVPCvAATR0Dap3dY858.png",
"widgetType": "photo"
}
]
}
返回参数
名称 |
位置 |
类型 |
必填 |
描述 |
code |
BODY |
STRING |
是 |
|
msg |
BODY |
STRING |
是 |
|
data |
BODY |
String |
是 |
工单ID |
{
"code": "0",
"data": "41037880463",
"msg": "查询成功"
}
接口使用位置
3.4. 查询工单详情
请求描述:查询工单详情
请求地址:/order-web-api/rest-api/v5/common/order/queryOrderDetail
请求方式:POST
请求参数
名称 |
位置 |
类型 |
必填 |
描述 |
organId |
BODY |
STRING |
是 |
组织机构ID |
serviceOrderId |
BODY |
STRING |
是 |
工单ID |
{
"organId": 21441119,
"serviceOrderId": "12000141"
}
返回参数
名称 |
位置 |
类型 |
必填 |
描述 |
code |
BODY |
STRING |
是 |
|
msg |
BODY |
STRING |
是 |
|
data |
BODY |
String |
是 |
工单ID |
{
"code": "0",
"msg": "查询成功!",
"data": [{
"attrInstId": "",
"seq": "",
"disGroupid": "",
"readable": "1",
"writable": "1",
"required": "1",
"attrCode": "",
"widgetType": "",
"contentLengthLimit": ""
"title": "",
"markedWords": "",
"expressCode": "",
"attrValueType": "",
"initData": "[{\"id\":\"1\",\"value\":\"test\"}]",
"attrValue": ""
}
]
}
3.5. 查查工单基本信息
请求描述:查工单基本信息
请求地址:/order-web-api/rest-api/v5/common/order/queryOrderBaseInfo
请求方式:POST
请求参数
名称 |
位置 |
类型 |
必填 |
描述 |
organId |
BODY |
STRING |
是 |
组织机构ID |
serviceOrderId |
BODY |
STRING |
是 |
工单ID |
{
"organId": 21441119,
"serviceOrderId": "12000141"
}
返回参数
名称 |
位置 |
类型 |
必填 |
描述 |
code |
BODY |
STRING |
是 |
|
msg |
BODY |
STRING |
是 |
|
data |
BODY |
String |
是 |
工单ID |
{
"code": "0",
"msg": "查询成功!",
"data": {
"serviceOrderId": "服务工单ID",
"serviceOrderCode": "服务工单编码",
"templateInstName": "服务模板名称, //公共取定义表,其他取别名",
"templateCode": "服务模板编码",
"busiTypeId": "业务类型Id",
"busiTypeName": "业务类型名称",
"busiTypeCode": "业务类型编码",
"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": "工单创建时间" ,
"remark": "备注",
"trackId": "轨迹ID" ,
"status": "工单状态(0-未完成;1-已完成)",
"urgentLevel": "加急等级(0-不加急;大于0-加急)",
"isBespeak": "是否预约(0-否;1-是)",
"bespeakBegintime": "预约开始时间(isBespeak=1时有效)",
"bespeakEndtime": "预约结束时间(isBespeak=1时有效)",
"voiceId": "语音ID",
"hangStatus": "工单挂起关闭延期标识0:解挂或到期;1:挂起申请中;2:挂起成功;3:挂起失败;4:强制关闭审核;5:强制关闭成功;6:强制关闭失败;7:取消挂起;8:延期申请;9:延期审核;10:延期成功;11:延期失败",
"companyName": "提单人所属公司(企业成员提单才有值),userType = 1才展示",
"custType": "客户类型(1000-客户,1001-客户成员,2000-普通租户,2001-租户成员,4000-访客),userType = 1才展示",
"personType": "客户性质(1-个人,2-企业),userType = 1才展示",
"custLevel": "客户等级,userType = 1才展示",
"custLevelName": "客户等级名称,userType = 1才展示",
"upCustName": "所属企业/业主/租户, userType = 1才展示",
"hangTrackFlag": "是否挂起跟进,1:是,0:否",
"otherSystem": "0:正常单,四格处理(默认),1:转派地产处理",
"showDealOrgan": "是否展示处理组织,1:是,0:否",
"custEval": "是否需要对客户评价 1是 2否",
"subOrderInfo": "67|4008888,67|4008348 ",
"parentOrderInfo": "67|4008888",
"userType": "提单人类型 1:客户 2:员工"
}
}
接口使用截图