Move-in Review

Last Updated on : 2023-06-21 07:13:12download

Confirm information such as the community ID, resident ID, and resident type, and review the move-in process of the relationship between a resident and a house.

API address

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

Request parameter

Parameter name	Type	IN	Required	Description
room_user_id	String	query	true	The ID of the relationship between a resident and a house.

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 value of `treeId` for a specified house.
room_user_stage	Integer	true	The review tag. 0: pending. 10: rejected. 20: approved (moved in). 30: moved out.
audit_reason	String	true	The review opinions.
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

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

{
  "block_id": "138258104436502xxxx",
  "room_user_type": "FAMILY",
  "householder_id": "138258104436502xxxx",
  "expire_date": 1621587021161,
  "tree_id": "138258404436502xxxx",
  "room_user_stage": 20,
  "audit_reason": "Agree"
}

Return example

true

Error code

For more information, see error code.

Prev DocModify Relationship Between Resident and House

Next DocRemove Relation Between Resident and House