List of Relationships Between Residents and Houses

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

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 nameTypeINRequiredDescription
block_idStringquerytrueThe ID of a community.
room_user_stageStringqueryfalseroom user stage
page_noIntegerquerytrueThe current page number.
page_sizeIntegerquerytrueThe paging size.
tree_idStringqueryfalseThe space ID of a specified house node.
mobile_or_nameStringqueryfalseThe resident's name or mobile phone number. A mobile phone number must be four or more digits in length.
  • 1: Male.
  • 2: Female.
if_identifyStringqueryfalseIndicates whether the residents' identity is verified.
  • 0: No.
  • 1: Yes.
apply_sourceStringqueryfalseThe origin of the request.
  • 0: enrolled by the property management company.
  • 1: registered on the app.
  • 2: invited by an owner.
if_upload_faceStringqueryfalseIndicates whether the resident's face is enrolled.
  • 0: No.
  • 1: Yes.
field_order_byStringqueryfalseSort the results by creation time.
  • CREATE_TIME_DESC: in descending order.
  • CREATE_TIME_ASC: in ascending order.

Return parameter

Parameter nameTypeDescription
resultHighwayRoomUserPageResponseThe list of residents.

Description of result

Parameter nameTypeDescription
total_countLongThe total number of results.
dataListThe list of residents.

Description of data

Parameter nameTypeDescription
user_idStringThe user ID.
householder_idStringThe ID of a resident.
room_user_typeStringThe type of resident.
  • HOUSEHOLDER: owner.
  • FAMILY: family member.
  • TENANT: tenant.
  • FRIEND: friend.
  • RELATIVES: relative
  • COLLEAGUE: colleague.
  • DECORATOR: decorator.
  • BABYSITTER: babysitter.
  • OTHER: others.
tree_idStringThe value of treeId for a specified house.
expire_dateStringThe validity period. An empty value indicates that it is permanently valid.
country_codeStringThe country code.
  • 1: male.
  • 2: female.
mobileStringThe mobile phone number.
card_typeIntegerThe type of certificate. 1: ID card.
card_noStringThe certificate number.
if_identifyIntegerThe status of verification.
  • 0: not verified.
  • 1: verified.
real_nameStringThe name of a resident.
space_tree_nameStringThe name of a specified house.
room_user_idStringThe ID of the relationship between a resident and a house.
room_addressStringThe address of a resident.
room_user_type_textStringThe type of resident.
auth_timeLongThe time when the application of the real-name verification was submitted.
audit_timeLongThe time when the application of the real-name verification was reviewed.
move_out_timeLongThe time when the resident moved out of the house.
gmt_createLongThe timestamp when the resident record was created.
audit_reasonStringReason for rejection.
room_user_stageIntegerThe review tag.
  • 0: pending.
  • 10: rejected.
  • 20: approved (moved in).
  • 30: moved out.
apply_timeLongThe application time.
move_out_time_textStringThe time when the resident moved out of the house.

Description of parent_id_list

Parameter nameTypeDescription
parent_idStringThe 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

Error code

For more information, see error code.