云服务 API 参考行业场景垂直行业解决方案智慧社区 API智慧社区数据集成服务住户管理创建住户

创建住户

更新时间：2023-06-21 07:13:10下载pdf

本文介绍创建住户的 API。

接口描述

以您输入的手机号为维度新增一个住户，并且支持多个维度的拓展信息录入，例如证件类型、工作单位、婚姻状况等其他信息。新增成功会返回住户 ID（SaaS 下唯一）。在调用编辑、查询住户信息的 API 中需要使用住户 ID。

接口地址

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

请求参数

body 说明

参数名	类型	是否必填	说明
block_id	String	true	小区 ID
real_name	String	true	住户姓名
sex	Integer	true	性别 1：男 2：女
mobile	String	true	手机号码
card_type	Integer	false	证件类型 1：身份证
card_no	String	false	证件号
apply_source	Integer	false	住户申请来源 0：物业录入 1：APP注册 2：业主邀请
household_registry_type	Integer	false	户籍类型 1：农业户口 2：非农业户口
household_registry_address	String	false	户籍地址
marital_status	Integer	false	婚姻状态 0：未知 1：未婚 2：已婚 3：离异 4：分居 5：丧偶
employer	String	false	工作单位
political_status	Integer	false	政治面貌 1：党员 2：团员 3：群众
emergency_contact	String	false	紧急联系人
emergency_contact_number	String	false	紧急联系方式，例如：手机号

返回参数

参数名	类型	说明
result	HighwayHouseholderOperateResponse	返回结果

result 说明

参数名	类型	说明
householder_id	String	住户 ID
success	Boolean	是否成功
operation	String	错误原因新增住户失败编辑住户失败系统已自动更正住户信息该住户已存在且绑定了同一个房屋该手机号已存在不可重复添加

请求示例

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

{
  "block_id": "138230001889922xxxx",
  "real_name": "李四",
  "sex": 1,
  "mobile": "1566901xxxx",
  "card_type": 1,
  "card_no": "32122119901010xxxx",
  "household_registry_type": 1,
  "marital_status": 2,
  "employer": "杭州xxxx有限公司",
  "political_status": 1,
  "emergency_contact": "Jane",
  "emergency_contact_number": "1566901xxxx",
  "household_registry_address": "CHN,110000,110100,110118,110118109;北京市/市辖区/密云区/不老屯镇"
}

返回示例

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

错误码

参考错误码。

上一篇查询住户详情

下一篇查询住户列表