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 nameTypeINRequiredDescription
block_idString trueThe ID of the community.
real_nameString trueThe name of a resident.
sexInteger trueGender. Valid values:
  • 1: male.
  • 2: female.
mobileString trueThe mobile phone number.
card_typeInteger falseThe type of certificate.
  • 1: identity card.
card_noString falseThe certificate number.
apply_sourceInteger falseRequest origin.
  • 0: enrolled by the property management company.
  • 1: registered on the app.
  • 2: invited by an owner.
household_registry_typeInteger falseThe type of household registration.
  • 1: agricultural household.
  • 2: non-agricultural household.
household_registry_addressString falseThe household registration address.
marital_statusInteger falseThe marital status. Valid values:
  • 0: unknown.
  • 1: unmarried.
  • 2: married.
  • 3: divorced.
  • 4: separated.
  • 5: widowed.
employerString falseThe workplace.
political_statusInteger falseThe political status. Valid values:
  • 1: member of Communist Party of China.
  • 2: member of Communist Youth League.
  • 3: masses.
emergency_contactString falseThe emergency contact.
emergency_contact_numberString falseThe emergency contact information, such as a mobile phone number.

Return parameter

Parameter nameTypeDescription
resultHighwayHouseholderOperateResponseThe returned result.

Description of result

Parameter nameTypeDescription
householder_idStringThe ID of a resident.
successBooleanIndicates whether the operation is successful.
operationStringError 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.