施工、维修工单管理

施工、维修工单管理，通过api委托服务商施工/维修工单，由服务商SaaS完成施工流程。

API 列表

请求方式	API	描述
POST	/v1.0/osaas/projects/{project_id}/construction/order	创建施工工单
GET	/v1.0/osaas/construction/orders	分页查询施工工单列表
GET	/v1.0/osaas/construction/orders/{order_id}	获取施工工单详情
POST	/v1.0/osaas/projects/{project_id}/maintenance/order	创建维修工单
GET	/v1.0/osaas/maintenance/orders	分页查询维修工单列表
GET	/v1.0/osaas/maintenance/orders/{order_id}	获取维修工单详情

创建施工工单

接口描述

调用该接口创建施工工单

接口地址

POST /v1.0/osaas/projects/{project_id}/construction/order

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	String	URI	项目唯一标识	是
contractor_uid	String	BODY	施工商用户唯一标识	否
room_ids	String[]	BODY	房屋唯一标识列表	否
zigbee_categories	Arrays	BODY	Zigbee 品类集	否
wifi_categories	Arrays	BODY	Wifi 品类集	否

zigbee_categories 参数说明

参数名	类型	参数类型	说明	是否必需
quantity	Integer	BODY	设备数量	是
category	String	BODY	产品类别	是

wifi_categories 参数说明

参数名	类型	参数类型	说明	是否必需
quantity	Integer	BODY	设备数量	是
category	String	BODY	产品类别	是

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	String	工单唯一标识

请求示例

POST {url}/v1.0/osaas/projects/123382396505******/construction/order

{
  "contractor_uid": "bay******fcDz",
  "room_ids": [
    "11608239650531******"
  ],
  "zigbee_categories": [
    {
      "quantity": 1,
      "category": "zig_cz"
    }
  ],
  "wifi_categories": [
    {
      "quantity": 1,
      "category": "wf_dj"
    }
  ]
}

响应成功示例

{
  "result": "11298837765053******",
  "success": true,
  "t": 1561381210234
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

分页查询施工工单列表

接口描述

调用该接口分页查询施工工单列表

接口地址

GET /v1.0/osaas/construction/orders

请求参数

参数名	类型	参数类型	说明	是否必需
page_no	Integer	URL	页码(page_no>0)(默认1)	否
page_size	Integer	URL	页条数(0<page_size<100)(默认20)	否
project_id	String	URL	项目唯一标识	否
contractor_uid	String	URL	服务商用户唯一标识	否
construction_status	String	URL	施工状态: UNASSIGNED:未分配 PENDING_CONSTRUCTION:待施工 IN_CONSTRUCTION:施工中 PENDING_ACCEPTANCE:待验收 ACCEPTANCE_COMPLETE:验收完成	否
construction_begin_begin_time	Long	URL	开始时间，13位时间戳(施工开始)	否
construction_begin_end_time	Long	URL	结束时间，13位时间戳(施工开始)	否
construction_end_begin_time	Long	URL	开始时间，13位时间戳(施工结束)	否
construction_end_end_time	Long	URL	结束时间，13位时间戳(施工结束)	否

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Object	返回结果

result参数说明

参数名	类型	说明
total	Integer	总条数
page_no	Integer	页码
page_size	Integer	页条数
construction_orders	Arrays	施工工单列表

construction_orders参数说明

参数名	类型	说明
order_id	String	施工工单唯一标识
contractor_name	String	施工商名称
project_id	String	项目 id
project_name	String	项目名称
room_quantity	Integer	房屋数量
device_quantity	Integer	设备数量
construction_status	String	施工状态: UNASSIGNED:未分配 PENDING_CONSTRUCTION:待施工 IN_CONSTRUCTION:施工中 PENDING_ACCEPTANCE:待验收 ACCEPTANCE_COMPLETE:验收完成
begin_time	Long	施工开始时间，13 位时间戳
end_time	Long	施工结束时间，13 位时间戳

请求示例

GET {url}/v1.0/osaas/construction/orders

响应成功示例

{
  "result": {
    "total": 1,
    "page_no": 1,
    "page_size": 20,
    "construction_orders": [
      {
        "order_id": "12550217287******",
        "contractor_name": "****** 服务商",
        "project_id": "1233224487******",
        "project_name": "测试项目",
        "room_quantity": 0,
        "device_quantity": 6,
        "construction_status": "ACCEPTANCE_COMPLETE",
        "begin_time": 1559707046000,
        "end_time": 1559707046000
      }
    ]
  },
  "success": true,
  "t": 1561381210234
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

获取施工工单详情

接口描述

调用该接口获取施工工单详情

接口地址

GET /v1.0/osaas/construction/orders/{order_id}

请求参数

参数名	类型	参数类型	说明	是否必需
order_id	String	URI	工单唯一标识	是

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Object	返回结果

result参数说明

参数名	类型	说明
order_id	String	施工工单唯一标识
contractor_name	String	施工商名称
project_id	String	项目 id
project_name	String	项目名称
construction_status	String	施工状态: UNASSIGNED:未分配 PENDING_CONSTRUCTION:待施工 IN_CONSTRUCTION:施工中 PENDING_ACCEPTANCE:待验收 ACCEPTANCE_COMPLETE:验收完成
begin_time	Long	施工开始时间，13 位时间戳
end_time	Long	施工结束时间，13 位时间戳
zigbee_categories	Arrays	Zigbee 品类集
wifi_categories	Arrays	Wifi 品类集
room_ids	Arrays	房间id集合

zigbee_categories、wifi_categories 参数说明

参数名	类型	说明
quantity	Integer	设备数量
category	String	产品类别
name	String	产品类别名称

参数名	类型	说明
room_id	String	房屋唯一标识

请求示例

GET {url}/v1.0/osaas/construction/orders/12550217287******

响应成功示例

{
  "result": {
    "order_id": "12550217287******",
    "contractor_name": "****** 服务商",
    "project_id": "1233224487******",
    "project_name": "测试项目",
    "construction_status": "ACCEPTANCE_COMPLETE",
    "begin_time": 1559707046000,
    "end_time": 1559707046000,
    "zigbee_categories": [
      {
        "category": "wf_zig_wfcon",
        "quantity": 1
      }
    ],
    "wifi_categories": [
      {
        "category": "wf_dj",
        "name": "照明",
        "quantity": 1
      }
    ],
    "room_device_relations": [
      {
        "room_id": "1452678965053******"
      }
    ]
  },
  "success": true,
  "t": 1561381210234
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

创建维修工单

调用该接口创建维修工单,不支持红外子设备创建维修工单，选择父设备创建维修工单即可。

接口地址

POST /v1.0/osaas/projects/{project_id}/maintenance/order

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	String	URI	项目唯一标识	是
contractor_uid	String	BODY	施工商用户唯一标识	是
room_device_relations	Arrays	BODY	房屋设备关系列表	是

room_device_relations参数说明

参数名	类型	参数类型	说明	是否必需
room_id	String	BODY	房屋唯一标识	是
device_ids	Arrays	BODY	设备唯一标识列表	是

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	String	工单唯一标识

请求示例

POST {url}/v1.0/osaas/projects/1233823965053******/maintenance/order

{
  "contractor_uid": "bay******fcDz",
  "room_device_relations": [
    {
      "room_id": "1452678965053******",
      "device_ids": [
        "00122433******"
      ]
    }
  ]
}

响应成功示例

{
  "success": true,
  "result":"1281002******",
  "t": 1566053034624
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

分页查询维修工单列表

接口描述

调用该接口分页查询维修工单列表

接口地址

GET /v1.0/osaas/maintenance/orders

请求参数

参数名	类型	参数类型	说明	是否必需
page_no	Integer	URL	页码(page_no>0)(默认1)	否
page_size	Integer	URL	页条数(0<page_size<100)(默认20)	否
project_id	String	URL	项目唯一标识	否
contractor_uid	String	URL	服务商用户唯一标识	否
maintenance_status	String	URL	维修状态: UNASSIGNED:未分配 PENDING_MAINTENANCE:待维修 IN_MAINTENANCE:维修中 PENDING_ACCEPTANCE:待验收 ACCEPTANCE_COMPLETE:验收完成	否
maintenance_begin_begin_time	Long	URL	开始时间13位时间戳(维修开始)	否
maintenance_begin_end_time	Long	URL	结束时间13位时间戳(维修开始)	否
maintenance_end_begin_time	Long	URL	开始时间13位时间戳(维修结束)	否
maintenance_end_end_time	Long	URL	结束时间13位时间戳(维修结束)	否

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Object	返回结果

result参数说明

参数名	类型	说明
total	int	总条数
page_no	int	页码
page_size	int	页条数
maintenance_orders	Array	维修工单列表

maintenance_orders参数说明

参数名	类型	说明
order_id	String	维修工单唯一标识
contractor_name	String	施工商名称
project_id	String	项目 id
project_name	String	项目名称
room_quantity	Integer	房屋数量
device_quantity	Integer	设备数量
maintenance_status	String	维修状态: UNASSIGNED:未分配 PENDING_MAINTENANCE:待维修 IN_MAINTENANCE:维修中 PENDING_ACCEPTANCE:待验收 ACCEPTANCE_COMPLETE:验收完成
begin_time	Long	维修开始时间，13 位时间戳
end_time	Long	维修开始时间，13 位时间戳

请求示例

GET {url}/v1.0/osaas/maintenance/orders

响应成功示例

{
  "result": {
    "total": 1,
    "page_no": 1,
    "page_size": 100,
    "maintenance_orders": [
      {
        "order_id": "12550217287******",
        "contractor_name": "****** 服务商",
        "project_id": "1233224487******",
        "project_name": "测试项目",
        "room_quantity": 0,
        "device_quantity": 6,
        "maintenance_status": "ACCEPTANCE_COMPLETE",
        "begin_time": 1559707046000,
        "end_time": 1559707046000
      }
    ]
  },
  "success": true,
  "t": 1561381210234
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

获取维修工单详情

接口描述

调用该接口获取维修工单详情

接口地址

GET /v1.0/osaas/maintenance/orders/{order_id}

请求参数

参数名	类型	参数类型	说明	是否必需
order_id	String	URI	工单唯一标识	是

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Object	返回结果

result参数说明

参数名	类型	说明
order_id	String	维修工单唯一标识
contractor_name	String	施工商名称
project_id	String	项目 id
project_name	String	项目名称
room_quantity	Integer	房屋数量
maintenance_status	String	维修状态: UNASSIGNED:未分配 PENDING_MAINTENANCE:待维修 IN_MAINTENANCE:维修中 PENDING_ACCEPTANCE:待验收 ACCEPTANCE_COMPLETE:验收完成
begin_time	Long	维修开始时间，13 位时间戳
end_time	Long	维修开始时间，13 位时间戳
room_device_relations	Arrays	房屋设备关系列表

room_device_relations 参数说明

参数名	类型	说明
room_id	String	房屋唯一标识
device_ids	Array	设备唯一标识列表

请求示例

GET {url}/v1.0/osaas/maintenance/orders/12550217287******

响应成功示例

{
  "result": {
    "order_id": "12550217287******",
    "contractor_name": "****** 服务商",
    "project_id": "1233224487******",
    "project_name": "测试项目",
    "begin_time": 1559707046000,
    "end_time": 1559707046000,
    "maintenance_status": "ACCEPTANCE_COMPLETE",
    "room_device_relations": [
      {
        "room_id": "14526789650531******",
        "device_ids": [
          "00122433******"
        ]
      }
    ]
  },
  "success": true,
  "t": 1561381210234
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

错误码

以下为该接口常见的业务异常，更多的异常错误，请参见全局错误码。

错误码	说明
500	系统错误