Cloud Services API ReferenceIndustrial ScenariosIndustry SolutionsSmart Community APIsSmart Community Data Integration ServiceHousehold ManagementQuery the List of Residents

Query the List of Residents

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

Get the list of residents by community ID and display the list on multiple pages. You can also query the residents by mobile phone number of more than four digits, name, or other attributes.

API address

GET: /v1.0/iot-02/community/householders

Request parameter

Parameter name	Type	IN	Required	Description
block_id	String	query	true	The ID of the community in which the resident lives.
page_no	Integer	query	true	The current page.
page_size	Integer	query	true	The paging size.
mobile_or_name	String	query	false	The resident's mobile phone number or name. 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.

Return parameter

Parameter name	Type	Description
result	HighwayHouseholderListResponse	The list of returned residents.

Description of result

Parameter name	Type	Description
total_record	Long	The total items.
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.
real_name	String	The name of a resident.
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 the residents' identity is verified. 0: No. 1: Yes.
apply_source	Integer	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	Integer	Indicates whether the resident's face is enrolled. 0: No. 1: Yes.
gmt_create	Long	The timestamp when the resident record was created.
block_id	String	The identification of the community under the project.
household_registry_type	Integer	The type of household registration. 1: agricultural household. 2: non-agricultural household.
household_registry_address	String	Household registration address.
marital_status	Integer	Marital status. 0: unknown. 1: unmarried. 2: married. 3: divorced. 4: separated. 5: widowed.
employer	String	Work unit.
political_status	Integer	Political status. 1: member of Communist Party of China. 2: member of Communist Youth League. 3: masses.
emergency_contact	String	The emergency contact.
emergency_contact_number	String	The emergency contact information, such as a mobile phone number.

Request example

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

Return example

{
    "data": [
        {
            "apply_source": 0,
            "gmt_create": 1620735665276,
            "sex": 2,
            "householder_id": "13920923942660xxxx",
            "mobile": "1814956xxxx",
            "real_name": "Jane",
            "card_type": 1,
            "if_identify": 0,
            "card_no": "34412319901200xxxx",
            "if_upload_face": 0,
            "user_id": "138550527242797xxxx"
        }
    ],
    "total_record": 1
}

Error code

For more information, see error code.

Prev DocRegister Resident

Next DocModify Resident Information