调用该接口获取家的列表信息。

路径 /living/home/query
版本号 1.1.0
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权 是
超时时间 10000

请求参数

名称类型是否必选示例值描述
名称 类型 是否必选 示例值 描述
pageNo Int 是 1 分页页码，从 1 开始。
pageSize Int 是 10 分页大小，大于等于 1，小于等于 20。

返回数据

名称类型示例值描述
名称 类型 示例值 描述
code Int

接口返回码。200表示成功。
message String

调用失败时，返回的出错信息。
localizedMsg String

本地语言的错误消息。
data JSON

响应的结果。
total Long

满足条件的家总数。
pageNo Int

分页页码。
pageSize Int

分页大小。
data JSON

满足条件家的详情列表。
homeId String

家的ID，生活物联网平台赋予家的唯一标识符。
name String

家的名称。
currentHome Boolean

表示此家是否为用户当前活跃的家。
myRole String

用户和家的关系。可取值为：ADMIN（表示管理员），MEMBER（表示成员）。
createMillis Long

家的创建时间，UNIX时间戳。单位：毫秒。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.1.0",
		"iotToken": "token"
	},
	"params":{
		"pageNo":1,
		"pageSize":10
	}
}

正常返回示例

JSON 格式 

{
    "id":"4de2c367-c1db-417c-aa15-8c585e595d92",
    "code":200,
    "message":null,
    "localizedMsg":null,
    "data":{
        "total":1,
        "pageNo":1,
        "pageSize":10,
        "data":[
            {
                "homeId":"1***4",
                "name":"我的家",
                "myRole":"ADMIN",
                "currentHome":true,
                "createMillis":1572929803000
            }
        ]
    }
}

异常返回示例

JSON 格式 

{
    "id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
    "code": 500,
    "message": "server error.",
    "localizedMsg": null,
    "data": null
}