List of Relationships Between Residents and Houses

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

Query the list of relationships between residents and houses according to the verification status, space ID of house node, and other criteria. The review status includes pending, approval rejected, and removed. The list of relationships between residents and houses is returned.

API address

GET: /v1.0/iot-02/community/room-users

Request parameter

Parameter name	Type	IN	Required	Description
block_id	String	query	true	The ID of a community.
room_user_stage	String	query	false	room user stage
page_no	Integer	query	true	The current page number.
page_size	Integer	query	true	The paging size.
tree_id	String	query	false	The space ID of a specified house node.
mobile_or_name	String	query	false	The resident's name or mobile phone number. A mobile phone number must be four or more digits in length.
sex	String	query	false	Gender. 1: Male. 2: Female.
if_identify	String	query	false	Indicates whether the residents' identity is verified. 0: No. 1: Yes.
apply_source	String	query	false	The origin of the request. 0: enrolled by the property management company. 1: registered on the app. 2: invited by an owner.
if_upload_face	String	query	false	Indicates whether the resident's face is enrolled. 0: No. 1: Yes.
field_order_by	String	query	false	Sort the results by creation time. `CREATE_TIME_DESC`: in descending order. `CREATE_TIME_ASC`: in ascending order.
move_out_type	String	query	false	type
room_user_type	String	query	false	type

Return parameter

Parameter name	Type	Description
result	HighwayRoomUserPageResponse	The list of residents.

Description of result

Parameter name	Type	Description
total_count	Long	The total number of results.
data	List	The list of residents.

Description of data

Parameter name	Type	Description
user_id	String	The user ID.
householder_id	String	The ID of a resident.
room_user_type	String	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	The value of `treeId` for a specified house.
expire_date	String	The validity period. An empty value indicates that it is permanently valid.
country_code	String	The country code.
sex	Integer	Gender. 1: male. 2: female.
mobile	String	The mobile phone number.
card_type	Integer	The type of certificate. `1`: ID card.
card_no	String	The certificate number.
if_identify	Integer	The status of verification. 0: not verified. 1: verified.
real_name	String	The name of a resident.
real_name_status	Integer	status
space_tree_name	String	The name of a specified house.
parent_id_list	List
room_user_id	String	The ID of the relationship between a resident and a house.
room_address	String	The address of a resident.
room_user_type_text	String	The type of resident.
auth_time	Long	The time when the application of the real-name verification was submitted.
audit_time	Long	The time when the application of the real-name verification was reviewed.
move_out_time	Long	The time when the resident moved out of the house.
move_out_type	Integer	type
gmt_create	Long	The timestamp when the resident record was created.
audit_reason	String	Reason for rejection.
room_user_stage	Integer	The review tag. 0: pending. 10: rejected. 20: approved (moved in). 30: moved out.
apply_time	Long	The application time.
move_out_time_text	String	The time when the resident moved out of the house.

Description of parent_id_list

Parameter name	Type	Description
parent_id	String	The list of parent nodes.

Request example

GET: /v1.0/iot-02/community/room-users?room-users?block_id=136767399153950xxxx&page_no=1&page_size=20

/v1.0/iot-02/community/room-users?blockId=136767399153950xxxx&pageNo=1&pageSize=20

Error code

For more information, see error code.

Prev DocQuery Details of Relation Between Resident and House

Next DocDelete Relationship Between Resident and House