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

查询住户列表

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

本文介绍查询住户列表的 API。

接口描述

支持通过小区 ID，以分页的形式获取目标住户的信息。您也可以通过添加住户的手机号（大于 4 位）和名称等属性完成住户的信息查询。

接口地址

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

请求参数

参数名	类型	参数位置	是否必填	说明
block_id	String	query	true	小区 ID
page_no	Integer	query	true	当前页
page_size	Integer	query	true	分页大小
mobile_or_name	String	query	false	用户手机号或姓名，如果是手机号必须是大于等于四位
sex	String	query	false	性别 1：男 2：女
if_identify	String	query	false	是否已认证 0：未认证 1：已认证
apply_source	String	query	false	住户申请来源 0：物业录入 1：APP注册 2：业主邀请
if_upload_face	String	query	false	人脸录入 0：未录入 1：已录入
field_order_by	String	query	false	创建时间排序 CREATE_TIME_DESC：降序 CREATE_TIME_ASC：升序

返回参数

参数名	类型	说明
result	HighwayHouseholderListResponse	住户列表返回

result 说明

参数名	类型	说明
total_record	Long	总记录
data	List	住户列表

data 说明

参数名	类型	说明
user_id	String	用户 ID
householder_id	String	住户 ID
real_name	String	住户姓名
sex	Integer	性别 1：男 2：女
mobile	String	手机号码
card_type	Integer	证件类型，1：身份证
card_no	String	证件号
if_identify	Integer	认证状态 0：未认证 1：已认证
apply_source	Integer	住户申请来源 0：物业录入 1：APP注册 2：业主邀请
if_upload_face	Integer	人脸录入 0：未录入 1：已录入
gmt_create	Long	创建时间戳
block_id	String	项目下的小区标识
household_registry_type	Integer	户籍类型 1：农业户口 2：非农业户口
household_registry_address	String	户籍地址
marital_status	Integer	婚姻状态 0：未知 1: 未婚 2: 已婚 3: 离异 4: 分居 5: 丧偶
employer	String	工作单位
political_status	Integer	政治面貌 1：党员 2：团员 3：群众
emergency_contact	String	紧急联系人
emergency_contact_number	String	紧急联系方式，例如：手机号

请求示例

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

返回示例

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

错误码

参考错误码。

上一篇创建住户

下一篇修改住户信息