Cloud Services API ReferenceSmart HomeSmart Home Basic ServiceHome ManagementQuery User Home List

Query Home List

Last Updated on : 2024-01-11 05:58:21download

Based on the user ID, query the list of homes where the specified user belongs.

API address

GET: /v1.0/users/{uid}/homes

Request parameter

Parameter name	Type	IN	Required	Description
uid	String	uri	true	The user ID.

Return parameter

Parameter name	Type	Description
result	List	The returned result.

Description of result

Parameter name	Type	Description
home_id	Long	The home ID.
name	String	The name of the specified home.
lon	Double	The longitude.
lat	Double	The latitude.
geo_name	String	The detailed address.
role	String	The role.

Request example

GET: /v1.0/users/ay152896****0qLVPu/homes

Return example

{
    "tid": "5f9f26317d3811ee82c7664ef4d3e193",
    "result": [
        {
            "role": "OWNER",
            "lon": 120.06379847441336,
            "name": "My Home",
            "home_id": 1600008315,
            "lat": 30.302736025227816,
            "geo_name": "Hangzhou Grand Center"
        },
        {
            "role": "OWNER",
            "lon": 0,
            "name": "My Home 2",
            "home_id": 165000289,
            "lat": 0,
            "geo_name": ""
        }
    ],
    "t": 1699339157175,
    "success": true
}

Error code

For more information, see error code.

Prev DocQuery Room Device

Next DocAdd Device to Room