云服务 API 参考行业场景垂直行业解决方案智慧社区 API智慧社区数据集成服务人房管理人房关系列表

人房关系列表

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

本文介绍人房关系列表的 API。

接口描述

可以根据认证状态、房屋节点的空间 ID 等条件，分页查询人房关系列表，包含待审批、审批拒绝、已迁出等，返回人房关系列表。

接口地址

GET: /v1.0/iot-02/community/room-users

请求参数

参数名	类型	参数位置	是否必填	说明
block_id	String	query	true	小区 ID
room_user_stage	String	query	false	房屋审核状态 0：待审批 10：审批拒绝 20：审批通过（已迁入） 30：已迁出
page_no	Integer	query	true	当前页
page_size	Integer	query	true	分页大小
tree_id	String	query	false	房屋节点的空间 ID
mobile_or_name	String	query	false	手机号或姓名，手机号必须是大于等于 4 位
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：升序
move_out_type	String	query	false	迁出方式 0：物业移除 1：业主移除 2：到期自动迁出
room_user_type	String	query	false	住户类型 HOUSEHOLDER：业主 FAMILY：家人 TENANT：租客 FRIEND：朋友 RELATIVES：亲属 COLLEAGUE：同事 DECORATOR：装修人员 BABYSITTER：保姆 OTHER：其它

返回参数

参数名	类型	说明
result	HighwayRoomUserPageResponse	住户列表

result 说明

参数名	类型	说明
total_count	Long	总条数
data	List	住户列表

data 说明

参数名	类型	说明
user_id	String	用户 ID
householder_id	String	住户 ID
room_user_type	String	住户类型 HOUSEHOLDER：业主 FAMILY：家人 TENANT：租客 FRIEND：朋友 RELATIVES：亲属 COLLEAGUE：同事 DECORATOR：装修人员 BABYSITTER：保姆 OTHER：其它
tree_id	String	房屋 treeId
expire_date	String	有效期，为空代表长期
country_code	String	国家码
sex	Integer	性别， 1：男 2：女
mobile	String	手机号码
card_type	Integer	证件类型，1：身份证
card_no	String	证件号
if_identify	Integer	认证状态 0：未认证 1：已认证
real_name	String	住户姓名
real_name_status	Integer	实名认证， 0：未实名认证 1：已实名认证 2：实名不通过
space_tree_name	String	房屋名称
parent_id_list	List
room_user_id	String	人房关系 ID
room_address	String	住户地址
room_user_type_text	String	住户类型
auth_time	Long	认证时间
audit_time	Long	审核时间
move_out_time	Long	迁出时间
move_out_type	Integer	迁出方式， 0：物业移除 1：业主移除 2：到期自动迁出
gmt_create	Long	创建时间戳
audit_reason	String	驳回原因
room_user_stage	Integer	审核标志， 0：待审批 10：审批拒绝 20：审批通过（已迁入） 30：已迁出
apply_time	Long	申请时间
move_out_time_text	String	迁出时间

parent_id_list 说明

参数名	类型	说明
parent_id	String	父级节点

请求示例

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

/v1.0/iot-02/community/room-users?blockId=136767399153950xxxx&pageNo=1&pageSize=20

返回示例

{
    "data": [
        {
            "apply_source": 1,
            "gmt_create": 1621587021161,
            "sex": 1,
            "householder_id": "138258104436502xxxx",
            "mobile": "1300312xxxx",
            "real_name": "小静",
            "if_identify": 0,
            "card_no": "",
            "if_upload_face": 0,
            "user_id": "138258404436502xxxx"
        }
    ],
    "total_record": 1
}

错误码

参考错误码。

上一篇查询人房关系详情

下一篇删除人房关系