Cloud Services API ReferenceIndustrial ScenariosIndustry SolutionsSmart Community APIsSmart Community Data Integration ServiceRooms and Users ManagementQuery Details of Relation Between Resident and House

Query Details of Relation Between Resident and House

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

Query the details of the relationship between a resident and a house. The resident information including the resident type is returned.

API address

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

Request parameter

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

Return parameter

Parameter name	Type	Description
result	HighwayRoomUserDetailResponse

Description of result

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	Indicates whether a resident' identity is verified. 0: No. 1: Yes.
real_name	String	The name of a resident.
real_name_status	Integer	Indicates whether a resident has passed real-name verification. 0: The application for the real-name verification is not submitted. 1: The resident has passed the real-name verification. 2: The resident failed to pass the real-name verification.
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 specified house.
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	The method in which the resident moved out of the house. 0: removed by the property management company. 1: removed by the owner. 2: automatically move out when due.
gmt_create	Long	The timestamp when the data was created.

Description of parent_id_list

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

Request example

GET: /v1.0/iot-02/community/room-user?blockId=136767399153950xxxx&roomUserId=139215249742181xxxx

/v1.0/iot-02/community/room-user?blockId=136767399153950xxxx&roomUserId=139215249742181xxxx

Return example

{
    "emergency_contact_number": "",
    "household_registry_address": "",
    "sex": 1,
    "householder_id": "139566323965991xxxx",
    "mobile": "1300312xxxx",
    "real_name": "Peter",
    "if_identify": 0,
    "card_no": "",
    "user_id": "138258404436502xxxx",
    "employer": "",
    "emergency_contact": ""
}

Error code

For more information, see error code.

Prev DocCreate Relationship Between Resident and House

Next DocList of Relationships Between Residents and Houses