Create Relationship Between Resident and House

Last Updated on : 2023-06-15 06:06:02

Create a relationship between a resident and a house, such as the resident type and house information. A relationship ID is returned.

API address

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

Request parameter

Description of body

Parameter name	Type	Required	Description
block_id	String	true	The ID of a community.
householder_id	String	true	The ID of a resident.
room_user_type	String	true	The type of resident. `HOUSEHOLDER`: owner. `FAMILY`: family member. `TENANT`: tenant. `FRIEND`: friend. `RELATIVES`: relative `COLLEAGUE`: colleague. `DECORATOR`: decorator. `BABYSITTER`: babysitter. `OTHER`: others.
tree_id	String	true	The space ID of a specified house node.
expire_date	String	false	The validity period. An empty value indicates that it is permanently valid.

Return parameter

Parameter name	Type	Description
result	HighwayRoomUserOperateResponse

Description of result

Parameter name	Type	Description
room_user_id	String	The ID of the relationship between a resident and a house.
success	Boolean	Indicates whether the operation is successful.
operation	String	Error cause. Failed to create a resident. Failed to edit a resident. The system has automatically updated the resident information. The resident already exists and is bound to the same house. The mobile phone number already exists. Cannot be added repeatedly.

Request example

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

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

Return example

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

Error code

For more information, see error code.

Prev DocRooms and Users Management

Next DocQuery Details of Relation Between Resident and House