施工管理

更新时间：2024-06-07 07:07:45下载pdf

本文介绍下发施工任务相关接口服务。

请求方式	API	描述
POST	/v2.0/illumination/construction/record	创建施工授权记录
GET	/v2.0/illumination/construction/task/rooms	查询空间施工信息列表
GET	/v2.0/illumination/construction/task/records	查询施工任务授权记录列表
GET	/v2.0/illumination/construction/task/record/{recordId}	获取施工任务授权记录详情
DELETE	/v2.0/illumination/construction/task/cancelAuthorization/{recordId}	取消施工授权

创建施工授权记录

功能描述

创建施工授任务。

接口地址

POST /v2.0/illumination/construction/record

请求参数

参数名	类型	参数类型	说明	是否必需
requestType	int	body	请求类型	是
recordId	String	body	授权记录 ID	否
projectId	String	body	项目 ID	是
userAccount	String	body	施工员手机号或者邮箱	是
countryCode	String	body	国家码	是
operatorName	String	body	施工人员名称	是
deviceTypes	int[]	body	施工设备类型 0：智能灯 1：网关 3：开关 4：传感器	否
startTime	long	body	施工开始时间	是
endTime	long	body	施工结束时间	是
remark	String	body	备注	否
roomIds	String[]	body	房间 ID 列表	否

返回参数

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

result 参数说明

{
  "recordId": "String //授权记录id",
  "success": "boolean"
}

请求示例

{
    "roomIds":[
        "136678083547004****"
    ],
    "requestType":1,
    "countryCode":"86",
    "userAccount":"china***@***mail.com",
    "remark":"测试",
    "endTime":1615046460000,
    "operatorName":"沉香",
    "projectId":"133336182632647****"
}

响应示例

{
  "recordId": "120684995791562****",
  "success":true
}

查询空间施工信息列表

功能描述

查询空间施工信息列表。

接口地址

GET /v2.0/illumination/construction/task/rooms

请求参数

参数名	类型	参数类型	说明	是否必需
page	int	body	页码参数，最小为1	是
pageSize	int	body	每页记录数量，最大为100	是
projectId	String	body	筛选条件中的项目 ID，此字段必传，如果用户没有创建项目，此字段传空字符串	是
authorizationStatus	String[]	body	授权状态： 0：未授权 1：已授权 2：已过期	否
roomName	String	body	筛选条件中的房间名称	否

返回参数

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

result 参数说明

{
  "total": "int",
  "list": [
    {
      "roomId": "String //房间id",
      "roomName": "String //房间名称",
      "roomType": "int //房间类型，当前只有两种值：2表示楼层，4表示房间，如果前端拿到此字段为4，则是最底级的层级",
      "deviceCountOnline": "int //在线设备数",
      "taskStatus": "int //任务状态，0表示未分配，1表示待施工，2表示施工中，3表示施工完成，4表示已延期",
      "authorizationStatus": "int //授权状态 0未授权 1授权中 2已过期 3取消授权",
      "recordId": "String //施工授权记录id，如果当前这个房间没有创建过施工任务，则此字段不传给前端",
      "taskId": "String //任务id，如果当前这个房间没有创建过施工任务，则此字段不传给前端",
      "deviceCountConstruction": "long //待施工设备数量",
      "deviceCountFinish": "int //完成施工设备数量",
      "roomExtendId": "long //房间扩展信息id"
    }
  ]
}

请求示例

{
  "pageSize": "10",
  "page": "1",
  "projectId": "135861962678679****",
  "authorizationStatus": "0",
  "taskStatus": "1",
  "roomName": ""
}

响应示例

{
    "list":[
        {
            "authorizationStatus":0,
            "deviceCountOnline":0,
            "roomId":"136454967987810****",
            "roomName":"cd"
        },
        {
            "authorizationStatus":0,
            "deviceCountOnline":0,
            "roomId":"136376023104097****",
            "roomName":"yiji 二级 三级 四级3"
        },
        {
            "authorizationStatus":0,
            "deviceCountOnline":0,
            "roomId":"135865913932409****",
            "roomName":"yiji 二级 三级 四级1"
        }
    ],
    "total":8
}

查询施工任务授权记录列表

功能描述

查询施工任务授权记录列表(1.5.0 及以上版本支持)。

接口地址

GET /v2.0/illumination/construction/task/records

请求参数

参数名	类型	参数类型	说明	是否必需
page	int	body	页码参数，最小为1	是
pageSize	int	body	每页记录数量，最大为100	是
projectId	String	body	筛选条件中的项目 ID，此字段必传，如果用户没有创建项目，此字段传空字符串	是
authorizationStatus	String[]	body	授权状态： 0：未授权 1：已授权 2：已过期	否
operatorName	String	body	筛选条件中的施工人员	否
startTime	long	body	筛选条件中的施工开始时间	否
endTime	long	body	筛选条件中的施工结束时间	否

返回参数

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

result 参数说明

{
  "total": "int",
  "list": [
    {
      "recordId": "String //授权记录id",
      "taskNum": "String //任务编号",
      "userAccount": "String //施工人员手机号码或邮箱",
      "countryCode": "String //国家码",
      "operatorName": "String //施工人员姓名",
      "operatorUid": "String //施工人员uid",
      "address": "String //安装地点",
      "startTime": "long //施工开始时间",
      "endTime": "long //施工结束时间",
      "deviceCount": "int //施工设备数量",
      "taskStatus": "int //任务状态，1表示待施工，2表示施工中，3表示施工完成，4表示已延期",
      "authorizationStatus": "int //授权状态 0未授权 1授权中 2已过期 3取消授权",
      "roomName": "String[] //施工空间名称",
      "deviceCountFinish": "int //完成施工设备数量"
    }
  ]
}

请求示例

{
  "pageSize": "10",
  "page": "1",
  "startTime": "1614817212134",
  "endTime": "1614827801047",
  "projectId": "135861962678679****",
  "operatorName": "",
  "taskStatus": "1"
}

响应示例

{
    "list":[
        {
            "authorizationStatus":1,
            "deviceCountFinish":0,
            "endTime":1615564799999,
            "operatorName":"测试",
            "recordId":"1367313487243620352",
            "roomName":[
                "yiji 二级"
            ],
            "startTime":1614827914626,
            "userAccount":"18655286****"
        }
    ],
    "total":1
}

获取施工任务授权记录详情

功能描述

获取施工任务授权记录详情。

接口地址

GET /v2.0/illumination/construction/task/record/{recordId}

请求参数

参数名	类型	参数类型	说明	是否必需
recordId	String	url	记录 ID	是

返回参数

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

result 参数说明

{
  "projectId": "String //项目id",
  "recordId": "String //授权记录id",
  "taskNum": "String //任务编号",
  "userAccount": "String //施工人员手机号码或邮箱",
  "countryCode": "String //国家码",
  "operatorName": "String //施工人员姓名",
  "address": "String //安装地点",
  "startTime": "long //施工开始时间",
  "endTime": "long //施工结束时间",
  "deviceCountFinish": "int //完成施工设备数量",
  "deviceCountTotal": "int //全部施工设备数量",
  "roomCountFinish": "int //完成施工的房间数量",
  "roomCountTotal": "int //全部房间数量",
  "taskStatus": "int //任务状态，1表示待施工，2表示施工中，3表示施工完成，4表示已延期",
  "authorizationStatus": "int //授权状态 0未授权 1授权中 2已过期 3取消授权",
  "remark": "String //备注",
  "rooms": [
    {
      "roomId": "String //房间id",
      "roomName": "String //房间名称",
      "roomType": "int //房间类型，当前只有两种值：2表示楼层，4表示房间，如果前端拿到此字段为4，则是最底级的层级",
      "deviceCountOnline": "int //在线设备数",
      "taskStatus": "int //任务状态，0表示未分配，1表示待施工，2表示施工中，3表示施工完成，4表示已延期",
      "authorizationStatus": "int //授权状态 0未授权 1授权中 2已过期 3取消授权",
      "recordId": "String //施工授权记录id，如果当前这个房间没有创建过施工任务，则此字段不传给前端",
      "taskId": "String //任务id，如果当前这个房间没有创建过施工任务，则此字段不传给前端",
      "deviceCountConstruction": "long //待施工设备数量",
      "deviceCountFinish": "int //完成施工设备数量",
      "roomExtendId": "long //房间扩展信息id"
    }
  ],
  "deviceTypes": [
    {
      "id": "int",
      "name": "String"
    }
  ]
}

请求示例

{
  "recordId": "1367313487243620352"
}

响应示例

{
    "result":{
        "authorizationStatus":1,
        "countryCode":"86",
        "endTime":1615564799999,
        "operatorName":"测试",
        "recordId":"136731348724362****",
        "remark":"",
        "rooms":[
            {
                "deviceCountFinish":0,
                "roomId":"135861997159213****",
                "roomName":"yiji 二级"
            }
        ],
        "startTime":1614827914626,
        "userAccount":"1865528****"
    },
    "success":true,
    "t":1614828003226
}

取消施工授权

功能描述

取消施工授权。

接口地址

DELETE /v2.0/illumination/construction/task/cancelAuthorization/{recordId}

请求参数

参数名	类型	参数类型	说明	是否必需
recordId	String	url	授权记录ID	否

返回参数

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

result 参数说明

{
  "success": "boolean"
}

请求示例

{
  "recordId": "136731348724362****"
}

响应示例

{
    "result":{
        "success":true
    },
    "success":true,
    "t":1614828114641
}

错误码

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

错误码	说明
500	系统错误
1106	非法权限

上一篇空间管理

下一篇网络管理