空间管理

通过以下开放 API 管理您项目下的空间。

API 列表

请求方式	API	描述
POST	“/v1.0/illumination/construction/room”	创建空间
PUT	“/v1.0/illumination/construction/room”	编辑空间
DELETE	“/v1.0/illumination/construction/room/{roomId}”	删除空间
GET	“/v2.0/illumination/construction/rooms/project/{projectId}”	获取项目下的空间树形结构

创建空间

功能描述

创建空间并上传点位图。

接口地址

POST "/v1.0/illumination/construction/room"

请求参数

参数名	类型	参数类型	说明	是否必需
projectId	String	body	项目ID	是
name	String	body	楼宇，楼层或者房间名称	是
parentId	String	body	上级房间ID，如果是最上级，传0	是
roomType	Integer	body	房间类型，1表示楼宇，2表示楼层，4表示房间	是
address	String	body	楼宇地址	否

返回参数

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

result参数说明

{
  "roomId": "string //房间ID",
  "currentBrightness": "int //当前设置的亮度阈值"
}

请求示例

{
    "projectId":"项目ID",
    "name":"楼宇，楼层或者房间名称",
    "parentId":"上级房间ID，如果是最上级，传0",
    "roomType":"房间类型，1表示楼宇，2表示楼层，4表示房间"
}

响应示例

{
  "roomId": "房间ID"
  "currentBrightness": "当前设置的亮度阈值"
}

编辑空间

功能描述

编辑空间名称和地址

接口地址

PUT "/v1.0/illumination/construction/room"

请求参数

参数名	类型	参数类型	说明	是否必需
roomId	String	body	房间ID	是
name	String	body	楼宇，楼层或者房间名称	是
address	String	body	楼宇地址	否

返回参数

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

result参数说明

{
  "roomId": "string //房间ID"
}

请求示例

{
  "roomId": "房间ID",
  "name": "楼宇，楼层或者房间名称",
  "address": "楼宇地址"
}

响应示例

{
	"roomId": "房间ID"
}

删除空间

功能描述

删除空间。

接口地址

DELETE "/v1.0/illumination/construction/room/{roomId}"

请求参数

参数名	类型	参数类型	说明	是否必需
roomId	String	url	房间ID	是

返回参数

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

result参数说明

{
  "success": "boolean //是否成功"
}

请求示例

{
  "roomId": "房间ID"
}

响应示例

{
	"success": "是否成功"
}

获取项目下的空间树形结构

功能描述

获取项目下的空间树形结构。

接口地址

GET "/v2.0/illumination/construction/rooms/project/{projectId}"

请求参数

参数名	类型	参数类型	说明	是否必需
projectId	String	url	项目ID	是

返回参数

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

result参数说明

{
  "totalRoomDeviceCount": "int",
  "list": [
    {
      "roomId": "string //房间ID",
      "name": "string //房间名称",
      "address": "string //楼宇地址",
      "roomType": "int //房间类型，1表示楼宇，2表示楼层，4表示房间",
      "roomSource": "int //房间来源，1表示用户自定义房间，2表示未分区房间",
      "rooms": [],
      "currentBrightness": "int //当前房间的亮度阈值",
      "deviceCount": "int //带有阈值dp点的设备数",
      "roomDeviceCount": "int //房间下 设备数为 公共区域+子集空间 的设备数之和"
    }
  ]
}

请求示例

{
  "projectId": "项目ID"
}

响应示例

{
  "totalRoomDeviceCount": "int",
  "list": [
    {
      "roomId": "房间ID",
      "name": "房间名称",
      "address": "楼宇地址",
      "roomType": "房间类型，1表示楼宇，2表示楼层，4表示房间",
      "roomSource": "房间来源，1表示用户自定义房间，2表示未分区房间",
      "rooms": [],
      "currentBrightness": "当前房间的亮度阈值",
      "deviceCount": "带有阈值dp点的设备数",
      "roomDeviceCount": "房间下 设备数为 公共区域+子集空间 的设备数之和"
    }
  ]
}

错误码

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

错误码	说明
500	系统错误