简体中文
简体中文
English
联系我们
注册
登录
layout空间导航

添加家庭

更新时间:2022-04-29 05:34:22下载pdf

本文介绍添加家庭的 API。

接口描述

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

说明: 可以只添加家庭,房间留空。

接口地址

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

请求参数

body 说明

参数名类型参数位置是否必填说明
homeHomeObjectbodytrue家庭
roomsListbodyfalse房间
uidStringbodytrue用户 ID

home 说明

参数名类型参数位置是否必填说明
nameStringhometrue家庭名字
geo_nameStringhomefalse家庭地理位置
lonDoublehomefalse经度
latDoublehomefalse纬度

返回参数

参数名类型说明
resultLong家庭 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
}

错误码

参考 错误码