# 成员管理接口

# 获取成员列表

# 功能说明

获取管理的成员列表

# 调用说明

地址：

https://api2.qingsuyun.com/site/api/openApi/listUser

方式：get

# 请求参数

名称	类型	是否必选	示例值	描述
factoryCode	String	是	123456	组织编号
sign	String	是	eyJhbGciOiJIUzI1NiJ9	签名
pageNum	Integer	是	1	请求页码
pageSize	Integer	是	10	每页条数，最大1000
userState	Integer	否	1	用户状态：0.正常 1.注册的考生(属于正常状态) 2.待审核 3.报名注册的
userCode	String	否	姓名	用户姓名或账号

# 返回数据

名称	类型	示例值	描述
code	String	200	状态码，详见说明
body	String	Json格式字符串	返回数据信息或错误信息
total	Integer	172	总条数
userId	String	123a121212d	用户Id
userCode	String	18081427165	用户账号
nickName	String	芳芳	用户姓名
deptName	String	总部	部门名称
roleName	String	编辑	角色名称
tagName	String	标签123	标签名称

# 示例

请求示例

https://api2.qingsuyun.com/site/api/openApi/listUser?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9&pageNum=1&pageSize=10

正常返回示例

JSON格式

{
    "code": "200",
    "body": [
        {
            "userId": "0611c2d4cb864e03a65174d511394204",
            "userCode": "admin99999",
            "nickName": "李逍遥",
            "userType": 2,
            "createTime": 1693445068000,
            "updateTime": 1693466949000,
            "userState": 0,
            "deptPath": "234/",
            "isSupplyed": 0,
            "sortIndex": 2125,
            "credit": 0,
            "thirdType": 7,
            "deptName": "蜀山派",
            "roleName": "全局管理员",
            "tagName": "神功初成"            
        }
    ]
}

# 创建成员

# 功能说明

创建成员（按deptIdList）

# 调用说明

地址：

https://api2.qingsuyun.com/site/api/openApi/create/user

方式：post

# 请求参数

名称	类型	是否必选	示例值	描述
factoryCode	String	是	123456	组织编号
sign	String	是	eyJhbGciOiJIUzI1NiJ9	签名
userCode	String	是	1231242312	用户账号
nickName	String	否	芳芳	用户姓名
password	String	否	000000	登录密码，不填则提供默认密码
deptIdList	Array	否	["id123","id234"]	组织架构id列表

# 返回数据

名称	类型	示例值	描述
code	String	200	状态码，详见说明
body	String	Json格式字符串	返回数据信息或错误信息

# 示例

请求示例

https://api2.qingsuyun.com/site/api/openApi/create/user?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9

post请求request body参数内容

{
    "userCode":"1231242312",
    "password":"000000",
    "nickName":"芳芳",
    "deptIdList": [ "01412e40d4c711eba17800163e08954a","02385cedd00311eba04d00163e08954a" ]
}

正常返回示例

JSON格式

{
  "code" : "200",
  "body" : "创建成员成功"
}

# 修改成员

# 功能说明

修改成员（按deptIdList）

# 调用说明

地址：

https://api2.qingsuyun.com/site/api/openApi/update/user

方式：post

# 请求参数

名称	类型	是否必选	示例值	描述
factoryCode	String	是	123456	组织编号
sign	String	是	eyJhbGciOiJIUzI1NiJ9	签名
userCode	String	否	1231242312	用户账号
nickName	String	否	芳芳	用户姓名
userId	String	是	123ad123d1	用户Id
deptIdList	Array	否	["id123","id234"]	组织架构id列表

# 返回数据

名称	类型	示例值	描述
code	String	200	状态码，详见说明
body	String	Json格式字符串	返回数据信息或错误信息

# 示例

请求示例

https://api2.qingsuyun.com/site/api/openApi/update/user?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9&userId=123ad123d1&userCode=1231242312&nickName=芳芳

post请求request body参数内容

{
    "userId":" 123ad123d1",
    "userCode":"1231242312",
    "nickName":"芳芳",
    "deptIdList": [ "01412e40d4c711eba17800163e08954a","02385cedd00311eba04d00163e08954a" ]
}

正常返回示例

JSON格式

{
  "code" : "200",
  "body" : "修改成员成功"
}

# 重置密码

# 功能说明

重置成员登录密码

# 调用说明

地址：

地址：https://api2.qingsuyun.com/site/api/openApi/resetUserPassword

方式：get

# 请求参数

名称	类型	是否必选	示例值	描述
factoryCode	String	是	123456	组织编号
sign	String	是	eyJhbGciOiJIUzI1NiJ9	签名
userId	String	是	123ad123d1	用户Id
password	String	是	1231242312	登录密码

# 返回数据

名称	类型	示例值	描述
code	String	200	状态码，详见说明
body	String	Json格式字符串	返回数据信息或错误信息

# 示例

请求示例

https://api2.qingsuyun.com/site/api/openApi/resetUserPassword?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9&userId=123ad123d1&password=1231242312

正常返回示例

JSON格式

{
  "code" : "200",
  "body" : "重置密码成功"
}

# 强制删除成员

# 功能说明

强制删除成员

# 调用说明

地址：

https://api2.qingsuyun.com/site/api/openApi/deleteUser

方式：get

# 请求参数

名称	类型	是否必选	示例值	描述
factoryCode	String	是	123456	组织编号
sign	String	是	eyJhbGciOiJIUzI1NiJ9	签名
userIdS	String	是	1q2w3e4r,123abc	用户Id，多个用,隔开

# 返回数据

名称	类型	示例值	描述
code	String	200	状态码，详见说明
body	String	Json格式字符串	返回数据信息或错误信息

# 示例

请求示例

https://api2.qingsuyun.com/site/api/openApi/deleteUser?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9&userIdS=123ad123d1,1d231a23

正常返回示例

JSON格式

{
  "code" : "200",
  "body" : "删除成员成功"
}

# 根据账号获取成员信息

# 功能说明

根据账号获取成员信息

# 调用说明

地址：

https://api2.qingsuyun.com/site/api/openApi/userDetail

方式：get

# 请求参数

名称	类型	是否必选	示例值	描述
factoryCode	String	是	123456	组织编号
sign	String	是	eyJhbGciOiJIUzI1NiJ9	签名
userCode	String	是	18081427165	用户账号(精确匹配)

# 返回数据

名称	类型	示例值	描述
code	String	200	状态码，详见说明
body	String	Json格式字符串	返回数据信息或错误信息
userId	String	123a121212d	用户Id
userCode	String	18081427165	用户账号
nickName	String	芳芳	用户姓名
deptName	String	总部	部门名称

# 示例

请求示例

https://api2.qingsuyun.com/site/api/openApi/userDetail?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9&userCode=18081427165

正常返回示例

JSON格式

{
  "code": "200",
  "body": {
    "userId": "1712071317449708531518756@222",
    "userCode": "18005161958",
    "nickName": "方芳芳",
    "deptName": "总部"
  }
}

# 修改成员标签信息（按userIds）

# 功能说明

修改成员标签信息

# 调用说明

地址：

https://api2.qingsuyun.com/site/api/openApi/setUserTag

方式：post

# 请求参数

名称	类型	是否必选	示例值	描述
factoryCode	String	是	123456	组织编号
sign	String	是	eyJhbGciOiJIUzI1NiJ9	签名
userIds	Array	是	["zolidf733"]	用户id，不能为空
tagIds	Array	否	["3hh28ah3498"]	标签id集合，为空则清空对应成员的标签

# 返回数据

名称	类型	示例值	描述
code	String	200	状态码，详见说明
body	String		返回数据信息或错误信息

# 示例

请求示例

https://api2.qingsuyun.com/site/api/openApi/setUserTag?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9

post请求request body参数内容

{
  "tagIds": [
    "e31df5ae9782454d906d6498b601089a", "04805b43b30f40cb8daf7a55c573a212"
  ],
  "userIds": [
    "460d99660d434f16ab5aebd0046c113d", "29736ef936cc48708429e1a979c99b41"
  ]
}

正常返回示例

JSON格式

{
  "code": "200"
}

# 修改成员标签信息（按userCodes）

# 功能说明

修改成员标签信息

# 调用说明

地址：

https://api2.qingsuyun.com/site/api/openApi/setUserTags

方式：post

# 请求参数

名称	类型	是否必选	示例值	描述
factoryCode	String	是	123456	组织编号
sign	String	是	eyJhbGciOiJIUzI1NiJ9	签名
userCodes	Array	是	["1001","1002"]	用户userCode，不能为空
tagIds	Array	否	["3hh28ah3498"]	标签id集合，为空则清空对应成员的标签

# 返回数据

名称	类型	示例值	描述
code	String	200	状态码，详见说明
body	String	-	返回数据信息或错误信息

# 示例

请求示例

https://api2.qingsuyun.com/site/api/openApi/setUserTags?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9

post请求request body参数内容

{
  "tagIds": [
    "e31df5ae9782454d906d6498b601089a", "04805b43b30f40cb8daf7a55c573a212"
  ],
  "userCodes": [
    "11122333", "44445555"
  ]
}

正常返回示例

JSON格式

{
  "code": "200"
}

# 自定义补充信息项查询

# 功能说明

查询已设置的成员自定义补充信息

# 调用说明

地址：

https://api2.qingsuyun.com/site/api/openApi/supply/detail

方式：get

# 请求参数

名称	类型	是否必选	示例值	描述
factoryCode	String	是	123456	组织编号
sign	String	是	eyJhbGciOiJIUzI1NiJ9	签名

# 返回数据

名称	类型	示例值	描述
code	String	200	状态码，详见说明
body	Array	补充信息数组	返回数据信息或错误信息
id	String	64d4f6asd48	补充项唯一标识
fieldName	String	自定义信息项	补充项名称
fieldType	int	2	字段类型（0：姓名框；1：组织架构；2：普通文本；3：下拉框）
required	int	0	是否为必填（1：必填；0：选填）
sortIndex	int	2	排序编号
isMemberInput	int	0	学员是否可填（0：否；1：是）
selectDatas	Array	[{id:xx, supplySetId:xx, value:xx}]	当fieldType=3时补充信息选择框数据有效（id：选项唯一标识，supplySetId对应上层id；value：选项内容）

# 示例

请求示例

https://api2.qingsuyun.com/site/api/openApi/supply/detail?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9

正常返回示例

JSON格式

{
  "code": "200",
  "body": [
    {
      "id": "f6009509483a4673acb11406336f3132",
      "fieldName": "信息名称",
      "fieldType": 2,
      "required": 0,
      "sortIndex": 2,
      "isMemberInput": 1
    },
    {
      "id": "5d51b1f87e504da983c0707b03d63173",
      "fieldName": "性别",
      "fieldType": 3,
      "required": 0,
      "sortIndex": 5,
      "isMemberInput": 0,
      "selectDatas": [
        {
          "id": "7fa1fef35b504323966c13587f4e2fdd",
          "supplySetId": "5d51b1f87e504da983c0707b03d63173",
          "value": "男"
        },
        {
          "id": "d39ebd7dd87a43e5a3294a0fd63211d2",
          "supplySetId": "5d51b1f87e504da983c0707b03d63173",
          "value": "女"
        }
      ]
    }
  ]
}

# 创建自定义补充信息

# 功能说明

新创建成员补充信息

# 调用说明

地址：

https://api2.qingsuyun.com/site/api/openApi/supply/create

方式：post

# 请求参数

名称	类型	是否必选	示例值	描述
factoryCode	String	是	123456	组织编号
sign	String	是	eyJhbGciOiJIUzI1NiJ9	签名
fieldName	String	是	新加字段	新的补充项标签
fieldType	int	是	2	字段类型（0：姓名框；1：组织架构；2：普通文本；3：下拉框）
isMemberInput	int	是	0	学员是否可填（0：否；1：是）
required	int	是	0	是否为必填（1：必填；0：选填）

# 返回数据

名称	类型	示例值	描述
code	String	200	状态码，详见说明
body	json	标签信息内容	返回数据信息或错误信息

# 示例

请求示例

https://api2.qingsuyun.com/site/api/openApi/supply/create?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9

post请求request body参数内容

{
  "fieldName": "新加字段",
  "fieldType": 2,
  "isMemberInput": 1,
  "required": 0
}

正常返回示例

JSON格式

{
  "code": "200",
  "body": {
    "id": "842bd65b85f64625b7f001615ea0ab3e",
    "fieldName": "新加字段",
    "fieldType": 2,
    "required": 0,
    "isMemberInput": 1
  }
}

# 更新自定义补充信息

# 功能说明

更新成员自定义补充信息

# 调用说明

地址：

https://api2.qingsuyun.com/site/api/openApi/supply/update

方式：post

# 请求参数

名称	类型	是否必选	示例值	描述
factoryCode	String	是	123456	组织编号
sign	String	是	eyJhbGciOiJIUzI1NiJ9	签名
id	String	是	df65ds684	补充项唯一标识
fieldName	String	是	新加字段	新的补充项标签
fieldType	int	是	2	字段类型（0：姓名框；1：组织架构；2：普通文本；3：下拉框）
isMemberInput	int	是	0	学员是否可填（0：否；1：是）
required	int	是	0	是否为必填（1：必填；0：选填）

# 返回数据

名称	类型	示例值	描述
code	String	200	状态码，详见说明
body	String		返回数据信息或错误信息

# 示例

请求示例

https://api2.qingsuyun.com/site/api/openApi/supply/update?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9

post请求request body参数内容

{
  "fieldName": "新修改后的标签",
  "fieldType": 2,
  "id": "842bd65b85f64625b7f001615ea0ab3e",
  "isMemberInput": 0,
  "required": 0
}

正常返回示例

JSON格式

{
  "code": "200"
}

# 删除自定义补充信息

# 功能说明

删除成员自定义补充信息

# 调用说明

地址：

https://api2.qingsuyun.com/site/api/openApi/supply/delete

方式：get

# 请求参数

名称	类型	是否必选	示例值	描述
factoryCode	String	是	123456	组织编号
sign	String	是	eyJhbGciOiJIUzI1NiJ9	签名
id	String	是	64d4f6asd48	补充项唯一标识

# 返回数据

名称	类型	示例值	描述
code	String	200	状态码，详见说明
body	String		返回数据信息或错误信息

# 示例

请求示例

https://api2.qingsuyun.com/site/api/openApi/supply/delete?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9&id=842bd65b85f64625b7f001615ea0ab3e

正常返回示例

JSON格式

{
  "code": "200"
}

← 数据接口组织架构管理 →