查询家庭

更新时间：2023-06-01 06:20:49下载pdf

本文介绍查询家庭的 API。

接口描述

根据家庭 ID 查询家庭的基础信息。

接口地址

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

请求参数

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

返回参数

参数名	类型	说明
result	HomeRes

result 说明

参数名	类型	说明
home_id	Long	家庭ID
name	String	家庭名称
lon	Double	经度
lat	Double	纬度
geo_name	String	家庭详细地址
role	String	角色

请求示例

GET: /v1.0/homes/3182004

{}

返回示例

{
    "result": {
        "lon": 120.5,
        "name": "⼩明的家庭",
        "home_id": 318312,
        "lat": 30.16,
        "geo_name": "杭州市，涂鸦智能"
    },
    "t": 1540955256215,
    "success": true
}

错误码

参考错误码。

上一篇添加家庭

下一篇修改家庭