成员模块

一、成员查询列表

接口地址 https://www.yingxiongyun.com/tenant/api/v1/t/members

请求方式 GET

consumes ["application/json"]

produces ["*/*"]

接口描述 ``

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
memberIds	成员id列表	query	false	array	string
departmentIds	部门id集合	query	false	array	string
roleIds	角色id集合	query	false	array	string
keyword	搜索词	query	false	string
type	成员状态-RESIGN、已离职-ENABLE、已启用-INVITING、已停用-DEACTIVATE,可用值:RESIGN,ENABLE,INACTIVE,INVITING,DEACTIVATE	query	false	string
deptId	部门id	query	false	string
roleId	角色id	query	false	string
appId	应用id	query	false	string
rangeViewFlag	范围查看标识	query	false	boolean
appendPermissionFlag	查询成员是否追加权限过滤	query	false	boolean

响应状态

状态码	说明	schema
200	OK	响应结果对象«分页对象«成员响应数据»»
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code	结果码	integer(int32)	integer(int32)
data	结果数据	分页对象«成员响应数据»	分页对象«成员响应数据»
message	结果描述	string
timestamp	时间戳	integer(int64)	integer(int64)

schema属性说明

分页对象«成员响应数据»

参数名称	参数说明	类型	schema
body	分页数据	array	成员响应数据
pageNum	当前页数	integer(int32)
pageSize	每页条数	integer(int32)
total	总条数	integer(int64)

成员响应数据

参数名称	参数说明	类型	schema
avatar	头像	string
code	编号	string
deptDetails	部门详情列表	array	部门响应数据
deptManagerFlag	是否是部门主管	boolean
email	邮箱	string
gender	性别：man男，woman女	string
id	主键ID	string
isOwner	创建者标识	boolean
maindepartmentId	主部门ID	string
manageDept	管理部门(部门主管)	array
mobile	手机号	string
modifyCode	是否可修改编码	boolean
name	成员名称	string
nickname	昵称（别名）	string
phonePrefix	手机号码前缀	string
roleDetails	角色详情列表	array	角色响应数据
status	邀请状态 PENDING: 邀请中 ACCEPT: 接受 REFUSE: 拒绝,可用值:PENDING,ACCEPT,REFUSE	string
type	成员状态-RESIGN、已离职-ENABLE、已启用-INVITING、已停用-DEACTIVATE,可用值:RESIGN,ENABLE,INACTIVE,INVITING,DEACTIVATE	string
userKey	关联用户ID	string

部门响应数据

参数名称	参数说明	类型	schema
children	子节点列表	array	部门响应数据
description	描述	string
disabled	禁止选择	boolean
enableReadOrManageFlag	可见可管理	boolean
id	主键ID	string
name	部门名称	string
parentId	父部门id	string
rootNode	是否根节点	boolean

角色响应数据

参数名称	参数说明	类型
departmentIds	部门id集合	array
departments	部门列表	array
description	角色描述	string
enableManageFlag	可管理	boolean
groupId	角色组主键id	string
id	主键ID	string
name	角色名称	string
status	角色状态 normal正常，deactivate停用	string

响应示例


xxxxxxxxxx
{
    "code": 0,
    "data": {
        "body": [
            {
                "avatar": "",
                "code": "",
                "deptDetails": [
                    {
                        "children": [
                            {
                                "children": [
                                    {}
                                ],
                                "description": "",
                                "disabled": false,
                                "enableReadOrManageFlag": false,
                                "id": "",
                                "name": "",
                                "parentId": "",
                                "rootNode": false
                            }
                        ],
                        "description": "",
                        "disabled": false,
                        "enableReadOrManageFlag": false,
                        "id": "",
                        "name": "",
                        "parentId": "",
                        "rootNode": false
                    }
                ],
                "deptManagerFlag": false,
                "email": "",
                "gender": "",
                "id": "",
                "isOwner": false,
                "maindepartmentId": "",
                "manageDept": [],
                "mobile": "",
                "modifyCode": false,
                "name": "",
                "nickname": "",
                "phonePrefix": "",
                "roleDetails": [
                    {
                        "departmentIds": [],
                        "departments": [],
                        "description": "",
                        "enableManageFlag": false,
                        "groupId": "",
                        "id": "",
                        "name": "",
                        "status": ""
                    }
                ],
                "status": "",
                "type": "",
                "userKey": ""
            }
        ],
        "pageNum": 0,
        "pageSize": 0,
        "total": 0
    },
    "message": "",
    "timestamp": 0
}

二、修改成员

接口地址 https://www.yingxiongyun.com/tenant/api/v1/t/members/{memberId}

请求方式 PUT

consumes ["application/json"]

produces ["*/*"]

接口描述 修改一条记录

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
memberId	memberId	path	true	string


xxxxxxxxxx
        | body         |      body   |     body        |       true      | 成员修改请求体   | 成员修改请求体     |

schema属性说明

成员修改请求体

参数名称	参数说明	请求类型	是否必须	数据类型
avatar	头像	body	false	string
code	编号	body	false	string
departmentIds	部门主键id列表	body	false	array
email	邮箱	body	false	string
gender	性别：man男，woman女，unknown未知,可用值:MAN,WOMAN,UNKNOWN	body	false	string
isDeptManager	是否是部门管理员	body	false	boolean
mainDepartmentId	主部门ID	body	false	string
mobile	手机号	body	false	string
name	成员名称	body	false	string
nickname	昵称（别名）	body	false	string
phonePrefix	手机号码前缀	body	false	string
roleIds	角色id集合	body	false	array

响应状态

状态码	说明	schema
200	OK	响应结果对象«成员响应数据»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code	结果码	integer(int32)	integer(int32)
data	结果数据	成员响应数据	成员响应数据
message	结果描述	string
timestamp	时间戳	integer(int64)	integer(int64)

schema属性说明

成员响应数据

参数名称	参数说明	类型	schema
avatar	头像	string
code	编号	string
deptDetails	部门详情列表	array	部门响应数据
deptManagerFlag	是否是部门主管	boolean
email	邮箱	string
gender	性别：man男，woman女	string
id	主键ID	string
isOwner	创建者标识	boolean
maindepartmentId	主部门ID	string
manageDept	管理部门(部门主管)	array
mobile	手机号	string
modifyCode	是否可修改编码	boolean
name	成员名称	string
nickname	昵称（别名）	string
phonePrefix	手机号码前缀	string
roleDetails	角色详情列表	array	角色响应数据
status	邀请状态 PENDING: 邀请中 ACCEPT: 接受 REFUSE: 拒绝,可用值:PENDING,ACCEPT,REFUSE	string
type	成员状态-RESIGN、已离职-ENABLE、已启用-INVITING、未激活（只有企业微信同步成员时才有的状态）-INACTIVE、邀请中-（非企业同步成员才有的状态）-INVITING、已停用-DEACTIVATE,可用值:RESIGN,ENABLE,INACTIVE,INVITING,DEACTIVATE	string
userKey	关联用户ID	string

部门响应数据

参数名称	参数说明	类型	schema
children	子节点列表	array	部门响应数据
description	描述	string
disabled	禁止选择	boolean
enableReadOrManageFlag	可见可管理	boolean
id	主键ID	string
name	部门名称	string
parentId	父部门id	string
rootNode	是否根节点	boolean

角色响应数据

参数名称	参数说明	类型
departmentIds	部门id集合	array
departments	部门列表	array
description	角色描述	string
enableManageFlag	可管理	boolean
groupId	角色组主键id	string
id	主键ID	string
name	角色名称	string
status	角色状态 normal正常，deactivate停用	string

响应示例


xxxxxxxxxx
{
    "code": 0,
    "data": {
        "avatar": "",
        "code": "",
        "deptDetails": [
            {
                "children": [
                    {
                        "children": [
                            {}
                        ],
                        "description": "",
                        "disabled": false,
                        "enableReadOrManageFlag": false,
                        "id": "",
                        "name": "",
                        "parentId": "",
                        "rootNode": false
                    }
                ],
                "description": "",
                "disabled": false,
                "enableReadOrManageFlag": false,
                "id": "",
                "name": "",
                "parentId": "",
                "rootNode": false
            }
        ],
        "deptManagerFlag": false,
        "email": "",
        "gender": "",
        "id": "",
        "isOwner": false,
        "maindepartmentId": "",
        "manageDept": [],
        "mobile": "",
        "modifyCode": false,
        "name": "",
        "nickname": "",
        "phonePrefix": "",
        "roleDetails": [
            {
                "departmentIds": [],
                "departments": [],
                "description": "",
                "enableManageFlag": false,
                "groupId": "",
                "id": "",
                "name": "",
                "status": ""
            }
        ],
        "status": "",
        "type": "",
        "userKey": ""
    },
    "message": "",
    "timestamp": 0
}

三、启用成员

接口地址 https://www.yingxiongyun.com/tenant/api/v1/t/members/enable/{memberId}

请求方式 PUT

consumes ["application/json"]

produces ["*/*"]

接口描述 启用成员

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
memberId	memberId	path	true	string

响应状态

状态码	说明	schema
200	OK	响应结果对象«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code	结果码	integer(int32)	integer(int32)
data	结果数据	boolean
message	结果描述	string
timestamp	时间戳	integer(int64)	integer(int64)

响应示例


xxxxxxxxxx
{
    "code": 0,
    "data": false,
    "message": "",
    "timestamp": 0
}

四、禁用成员

接口地址 https://www.yingxiongyun.com/tenant/api/v1/t/members/deactivate/{memberId}

请求方式 PUT

consumes ["application/json"]

produces ["*/*"]

接口描述 启用成员

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型	schema
memberId	memberId	path	true	string

响应状态

状态码	说明	schema
200	OK	响应结果对象«boolean»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数

参数名称	参数说明	类型	schema
code	结果码	integer(int32)	integer(int32)
data	结果数据	boolean
message	结果描述	string
timestamp	时间戳	integer(int64)	integer(int64)

响应示例


xxxxxxxxxx
{
    "code": 0,
    "data": false,
    "message": "",
    "timestamp": 0
}