查询家庭下的房间列表

更新时间：2023-05-22 06:38:13下载pdf

本文介绍查询家庭下的房间列表的 API。

接口描述

查询某个家庭下的房间列表。

接口地址

GET: /v1.0/homes/{home_id}/rooms

请求参数

参数名	类型	参数位置	是否必填	说明
home_id	Long	uri	true	家庭 ID

返回参数

参数名	类型	说明
result	HomeAndRoomsRes	房间列表

result 说明

参数名	类型	说明
home_id	Long	家庭 ID
name	String	家庭名称
lon	Double	经度
lat	Double	纬度
geo_name	String	家庭详细地址
rooms	List	房间列表

rooms 说明

参数名	类型	说明
room_id	Long	房间 ID
name	String	房间名称

请求示例

GET: GET /v1.0/homes/337403/rooms

返回示例

{
    "result": {
        "rooms": [
            {
                "room_id": 587609,
                "name": "客厅"
            },
            {
                "room_id": 587610,
                "name": "主卧"
            },
            {
                "room_id": 587611,
                "name": "次卧"
            }
        ],
        "lon": 120.0640923396687,
        "name": "测试家庭",
        "home_id": 337403,
        "lat": 30.302553689454005,
        "geo_name": "杭州市 华策中心A座"
    },
    "t": 1611394597651,
    "success": true
}

错误码

参考错误码。

上一篇添加房间

下一篇删除房间