Cloud Services API ReferenceIndustrial ScenariosIndustry SolutionsSmart Community APIsSmart Community Data Integration ServiceHousehold ManagementQuery Details of a Resident

Query Details of a Resident

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

Query the enrollment details of a specified resident by redient ID, including mobile phone number, name, certificate type, and other information.

API address

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

Request parameter

Parameter name	Type	IN	Required	Description
block_id	String	query	true	The ID of the community in which the resident lives.
householder_id	String	query	true	The ID of a resident.

Return parameter

Parameter name	Type	Description
result	HighwayHouseholderDetailResponse	The resident's details.

Description of result

Parameter name	Type	Description
user_id	String	The ID of the community in which the resident lives.
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. /ul>
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. /ul>
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/householder?block_id=136767399153950xxxx&householder_id=139215249742181xxxx

Return example

{
    "emergency_contact_number": "1566901xxxx",
    "household_registry_type": 1,
    "household_registry_address": "CHN,110000,110100,110118,110118109; Beijing/Municipal District/Miyun District/Bulaotun Town",
    "sex": 1,
    "householder_id": "139346615626157xxxx",
    "mobile": "1566901xxxx",
    "real_name": "Jack",
    "card_type": 1,
    "if_identify": 0,
    "marital_status": 2,
    "political_status": 1,
    "card_no": "32122119901011xxxx",
    "user_id": "",
    "employer": "Hangzhou xxxx Co., LTD",
    "emergency_contact": "Jane"
}

Error code

For more information, see error code.

Prev DocHousehold Management

Next DocRegister Resident