调用该接口获取指定家的详细信息。

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

请求参数

名称类型是否必选示例值描述
名称 类型 是否必选 示例值 描述
homeId String 是 50f5op1556f65de314b983fd5bca4f2f2810**** 家的ID，生活物联网平台赋予家的唯一标识符。

返回数据

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

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

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

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

响应的结果。
homeId String

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

家的名称。
myRole String

用户和家的关系，可取值：ADMIN 和 MEMBER。
currentHome Boolean

表示该 home 是否为当前活跃的家。
roomCnt Int

该家下的房间总数。
deviceCnt Int

归属于该家的设备总数。
createMillis Long

家的创建时间。
deviceOnlineCnt Int

归属于该家的在线设备总数。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.1.0",
		"iotToken": "token"
	},
	"params":{
		"homeId": "50f5op1556f65de314b983fd5bca4f2f2810****"
	}
}

正常返回示例

JSON 格式 

{
    "id": "4de2c367-c1db-417c-****-8c585e595d92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data": {
        "homeId":"xxx",
        "name": "xxx",
        "myRole":"ADMIN",
        "roomCnt":10,
        "deviceCnt":36,
        "deviceOnlineCnt":25,
        "createMillis":1569232952000
    }
}

异常返回示例

JSON 格式 

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