Modify Relationship Between Resident and House

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

Modify the relationship between a resident and a house, such as the resident type and house information. A response is returned to indicate whether the operation is successful.

API address

PUT: /v1.0/iot-02/community/room-user/{room_user_id}

Request parameter

Description of body

Parameter name	Type	Required	Description
room_user_id	String	true	The ID of the relationship between a resident and a house.
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	Boolean	Indicates whether the operation is successful.

Request example

PUT: /v1.0/iot-02/community/room-user/136767399153950xxxx

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

Return example

true

Error code

For more information, see error code.

Prev DocDelete Relationship Between Resident and House

Next DocMove-in Review