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

查询住户详情

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

本文介绍查询住户详情的 API。

接口描述

根据住户 ID 查询录入住户时的详细信息，例如：手机号、姓名、证件类型等信息。

接口地址

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

请求参数

参数名	类型	参数位置	是否必填	说明
block_id	String	query	true	小区 ID
householder_id	String	query	true	住户 ID

返回参数

参数名	类型	说明
result	HighwayHouseholderDetailResponse	用户详情

result 说明

参数名	类型	说明
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/householder?block_id=136767399153950xxxx&householder_id=139215249742181xxxx

返回示例

{
    "emergency_contact_number": "1566901xxxx",
    "household_registry_type": 1,
    "household_registry_address": "CHN,110000,110100,110118,110118109;北京市/市辖区/密云区/不老屯镇",
    "sex": 1,
    "householder_id": "139346615626157xxxx",
    "mobile": "1566901xxxx",
    "real_name": "王二",
    "card_type": 1,
    "if_identify": 0,
    "marital_status": 2,
    "political_status": 1,
    "card_no": "32122119901011xxxx",
    "user_id": "",
    "employer": "杭州xxxx有限公司",
    "emergency_contact": "Jane"
}

错误码

参考错误码。

上一篇住户管理

下一篇创建住户