Cloud Services API ReferenceIndustrial ScenariosIndustry SolutionsSmart Community APIsSmart Community Data Integration ServiceHousehold ManagementRegister Resident

Register Resident

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

Enter a mobile phone number to register a resident. You can enter extension information, such as certificate type, work unit, and marital status. After the resident is registered, a unique resident ID in the SaaS solution is returned. The resident ID is required to call the API operations to edit and query resident information.

API address

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

Request parameter

Description of body

Parameter name	Type	Required	Description
block_id	String	true	The ID of the community.
real_name	String	true	The name of a resident.
sex	Integer	true	Gender. Valid values: `1`: male. `2`: female.
mobile	String	true	The mobile phone number.
card_type	Integer	false	The type of certificate. `1`: identity card.
card_no	String	false	The certificate number.
apply_source	Integer	false	Request origin. `0`: enrolled by the property management company. `1`: registered on the app. `2`: invited by an owner.
household_registry_type	Integer	false	The type of household registration. `1`: agricultural household. `2`: non-agricultural household.
household_registry_address	String	false	The household registration address.
marital_status	Integer	false	The marital status. Valid values: `0`: unknown. `1`: unmarried. `2`: married. `3`: divorced. `4`: separated. `5`: widowed.
employer	String	false	The workplace.
political_status	Integer	false	The political status. Valid values: `1`: member of Communist Party of China. `2`: member of Communist Youth League. `3`: masses.
emergency_contact	String	false	The emergency contact.
emergency_contact_number	String	false	The emergency contact information, such as a mobile phone number.

Return parameter

Parameter name	Type	Description
result	HighwayHouseholderOperateResponse	The returned result.

Description of result

Parameter name	Type	Description
householder_id	String	The ID of a resident.
success	Boolean	Indicates whether the operation is successful.
operation	String	Error cause. Failed to create a resident. Failed to edit a resident. The system has automatically corrected the resident information. The resident already exists and is bound to the same house. The mobile phone number already exists. Cannot be added repeatedly.

Request example

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

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

Return example

{
    "householder_id": "138230001234567xxxx",
    "success": true,
    "operation": ""
}

Error code

For more information, see error code.

Prev DocQuery Details of a Resident

Next DocQuery the List of Residents