English
English
简体中文
Contact Us
Register
Log In

Query user family list

Last Updated on : 2022-04-29 05:35:29download

Query the list of households where the user is located.

API address

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

Request parameter

Parameter nameTypeINRequiredDescription
uidStringuritrueUser ID

Return parameter

Parameter nameTypeDescription
resultList

Description of result

Parameter nameTypeDescription
home_idLongFamily ID
nameStringFamily Name
lonDoubleLongitude
latDoubleLatitude
geo_nameStringFamily detailed address
roleStringRoles

Request example

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

Return example

{
    "result": [
        {
            "lon": 120.1,
            "name": "Nest",
            "home_id": 2421212,
            "lat": 30.27,
            "geo_name": "Gudang Street in Lake District"
        }
    ],
    "t": 1541508940996,
    "success": true
}

Error code

For more information, see error code.