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

成员列表

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

本文介绍成员列表的 API。

接口描述

成员的分页查询接口，支持根据成员状态过滤。

接口地址

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

请求参数

参数名	类型	参数位置	是否必填	说明
block_id	String	query	true	小区 ID
page_no	Integer	query	true	当前页
page_size	Integer	query	true	分页大小
mobile_or_name	String	query	false	员工信息(手机号或姓名，如果是手机号必须是>=4位)
status	Integer	query	false	状态 1：启用 2：禁用 3：未激活

返回参数

参数名	类型	说明
result	HighwayMemberListResponse

result 说明

参数名	类型	说明
total_record	Long	总条数
data	List	成员列表

data 说明

参数名	类型	说明
member_id	String	成员ID，英文逗号隔开
admin_name	String	姓名
role_infos	List	角色列表
mobile	String	手机号
blocks	List	组织列表
account_status	Integer	状态 1：启用 2：禁用 3：未激活
structure_id	String	组织ID
structure_name	String	组织名称
sex	Integer	性别 1：男 2：女
myself	Integer	是否是本人 1：是 2：否
admin	Integer	是否是管理员 1：是 2：否

role_infos 说明

参数名	类型	说明
role_id	String	角色ID
role_name	String	角色名称

blocks 说明

参数名	类型	说明
block_id	String	小区ID
block_name	String	小区名称
related_structure_name	String	管理组织名称

请求示例

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

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

返回示例

[
    {
        "member_id": "136767399153950xxxx",
        "birthday": 0,
        "education": "小学",
        "blocks": "136767399153950xxxx",
        "sex": 1,
        "myself": 2,
        "mobile": "1300000****",
        "admin": 0,
        "structure_id": "136767399153950xxxx",
        "account_status": 1,
        "card_type": 1,
        "role_infos": [
        ],
        "country_code": "86",
        "structure_infos": [
        ],
        "card_no": "31162119920918xxxx",
        "structure_name": "test",
        "structure_path_name": "test",
        "admin_name": "水电运维",
        "position": "水电工"
    }
]

错误码

参考错误码。

上一篇成员修改

下一篇删除成员