添加家庭

更新时间：2023-06-20 15:34:46下载pdf

本文介绍添加家庭的 API。

接口描述

给⽤户添加⼀个家庭以及家庭下的房间。

说明： 可以只添加家庭，房间留空。

接口地址

POST: /v1.0/home/create-home

请求参数

body 说明

参数名	类型	参数位置	是否必填	说明
home	HomeObject	body	true	家庭
rooms	List	body	false	房间
uid	String	body	true	用户 ID

home 说明

参数名	类型	参数位置	是否必填	说明
name	String	home	true	家庭名字
geo_name	String	home	false	家庭地理位置
lon	Double	home	false	经度
lat	Double	home	false	纬度

返回参数

参数名	类型	说明
result	Long	家庭 ID，即 home_id。

请求示例

POST: /v1.0/home/create-home

{
  "uid": "ay1528964101460qLVPu",
  "home": {
    "geo_name": "杭州市，浙商财富中⼼",
    "name": "我的家庭",
    "lat": 30.16,
    "lon": 120.5
  },
  "rooms": [
    "厨房",
    "洗澡间"
  ]
}

返回示例

{
    "result": 3182004,
    "t": 1540615024283,
    "success": true
}

错误码

参考错误码。

上一篇全屋管理

下一篇查询家庭