新增人房关系

更新时间:2023-06-21 07:13:11下载pdf

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

接口描述

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

接口地址

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

请求参数

body 说明

参数名类型参数位置是否必填说明
block_idString true小区 ID
householder_idString true住户 ID
room_user_typeString true住户类型
  • HOUSEHOLDER:业主
  • FAMILY:家人
  • TENANT:租客
  • FRIEND:朋友
  • RELATIVES:亲属
  • COLLEAGUE:同事
  • DECORATOR:装修人员
  • BABYSITTER:保姆
  • OTHER:其它
tree_idString true房屋节点的空间 ID
expire_dateString false有效期,为空代表长期

返回参数

参数名类型说明
resultHighwayRoomUserOperateResponse

result 说明

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

请求示例

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
}

错误码

参考 错误码