GET 获取房间列表

GET /clip/v2/resource/room

说明

• 获取房间列表
• 支持额外数据, 支持以下字段:
  • include_all_room
  • include_no_room
• 支持扩展, 支持以下字段:
  • ext_device
  • ext_light

请求参数

名称	位置	类型	必选	中文名	说明
include_all_room	query	string	否		额外包含 "全屋" 这个房间
include_no_room	query	string	否		额外包含 "未分配" 这个房间
ext_device	query	string	否		额外查询 device 信息
ext_light	query	string	否		额外查询 light 信息

返回示例

{
  "code": 0,
  "data": {
    "arr": [
      {
        "id": "F80253CD-1118-44E8-A700-3A5953538B63",
        "type": "room",
        "name": "卧室",
        "room_kind": 0,
        "room_type": "",
        "icon": "assets/room/room3.png",
        "background": 1,
        "sequence": 0,
        "children": [
          {
            "rid": "241D3783-0052-4B35-A892-EF3211F311F5",
            "rtype": "device"
          }
        ],
        "services": [
          {
            "rid": "2F84620F-C289-4AA3-8A1E-D6DE9C33D1F5",
            "rtype": "group_light"
          }
        ]
      }
    ],
    "len": 1,
    "obj": {}
  },
  "msg": "success"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» code	integer	true	none	状态码	none
» msg	string	true	none	消息	none
» data	object	true	none		none
»» arr	[object]	true	none		none
»»» id	string	true	none	房间UUID	none
»»» type	string	true	none	类型	此处必然为 room
»»» name	string	true	none	名称	房间名字
»»» room_kind	integer	true	none	房间种类	0普通, 1全屋, 2未分配
»»» room_type	string	true	none	房间分类	任意字符串, 暂未定义, 可以是 "卧室", "厨房" 等
»»» icon	string	true	none		BweeApp专用
»»» background	integer	true	none		BweeApp专用
»»» sequence	integer	true	none		BweeApp专用
»»» children	[ResInfo]	true	none	包含的设备	目前children的 rtype 必然为 device
»»»» rid	string	true	none	资源UUID	none
»»»» rtype	string	true	none	资源类型	none
»»» services	[ResInfo]	true	none	服务列表	一般一个房间会包含一个 group_light 的服务
»»»» rid	string	true	none	资源UUID	none
»»»» rtype	string	true	none	资源类型	none