新增人房关系

更新时间：2023-06-15 06:06:01

本文介绍新增人房关系的 API。

接口描述

新增人房关系，例如住户类型、房屋信息，返回人房关系 ID。

接口地址

POST: /v1.0/iot-02/community/room-user

请求参数

body 说明

参数名	类型	是否必填	说明
block_id	String	true	小区 ID
householder_id	String	true	住户 ID
room_user_type	String	true	住户类型 HOUSEHOLDER：业主 FAMILY：家人 TENANT：租客 FRIEND：朋友 RELATIVES：亲属 COLLEAGUE：同事 DECORATOR：装修人员 BABYSITTER：保姆 OTHER：其它
tree_id	String	true	房屋节点的空间 ID
expire_date	String	false	有效期，为空代表长期

返回参数

参数名	类型	说明
result	HighwayRoomUserOperateResponse

result 说明

参数名	类型	说明
room_user_id	String	人房关系 ID
success	Boolean	是否成功
operation	String	错误原因新增住户失败编辑住户失败系统已自动更正住户信息该住户已存在且绑定了同一个房屋该手机号已存在不可重复添加

请求示例

POST: /v1.0/iot-02/community/room-user

{
  "block_id": "138258104436502xxxx",
  "room_user_type": "FAMILY",
  "householder_id": "138258104436502xxxx",
  "expire_date": 20210513,
  "tree_id": "138258404436502xxxx"
}

返回示例

{
    "room_user_id": "136767399153950xxxx",
    "success": true
}

错误码

参考错误码。

上一篇人房管理

下一篇查询人房关系详情