# 成员管理接口
# 获取成员列表
# 功能说明
获取管理的成员列表
# 调用说明
地址:
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": {
"pageNum": 1,
"pageSize": 1,
"nextPage": 2,
"total": 2129,
"pages": 2129,
"list": [
{
"userId": "ff784427d95c44e613d6eb1",
"userCode": "10086",
"nickName": "比克大魔王",
"userType": 2,
"createTime": 1698738157000,
"updateTime": 1719298767000,
"userState": 0,
"deptPath": "215/",
"isSupplyed": 0,
"sortIndex": 2180,
"credit": 15,
"thirdType": 7,
"memberType": 0,
"deptName": "四大部洲",
"roleName": "全局管理员",
"courseStudyDuration": 45
}
],
"isLastPage": false,
"size": 2129,
"isFirstPage": true
}
}
# 创建成员
# 功能说明
创建成员
# 调用说明
地址:
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 | 否 | ["12gffg3","gfd3532"] | 组织架构id |
tags | Array | 否 | 见请求示例 | 标签 |
id(tags) | String | 否 | 406fa42d40faf0 | 标签id |
suppleInfos | Array | 否 | 见请求示例 | 用户自定义信息 |
id(suppleInfos) | String | 否 | 68cdaeb7800 | 自定义信息id |
answerContent | String | 否 | 123456 | 自定义信息内容 |
selectValue | String | 否 | 12345 | 自定义信息下拉框选项名称 |
memberType | int | 否 | 1 | 是否新员工(1:是;其他:否) |
# 返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | String | 200 | 状态码,详见说明 |
body | String | Json格式字符串 | 返回数据信息或错误信息 |
userId | String | daeb7800 | 用户id |
factoryCode | String | 123456 | 组织编号 |
suppleInfos | Array | 见返回示例 | 自定义信息 |
tags | Array | 见返回示例 | 标签id |
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/create/user?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9
post请求request body参数内容
{
"userCode": "tangxj",
"password": "12345678",
"nickName": "唐雪见",
"deptIdList": [
"61145a2f9c2211eba3367cd30aeb7800",
"1b478cef3b9a47c38cc3afee71306d8d"
],
"suppleInfos": [
{
"id": "e6a1892a7e9d5048f6c",
"answerContent": "13099999999"
},
{
"id": "986dd827adc04aaf90512fa0e8aaa943",
"answerContent": "0b2175990b,feaa99d23b6b4,b765acf2"
},
{
"id": "a11e3a46fea04b33b2ec39414602d709",
"selectValue": "选项1",
"answerContent": "c29b8004cc4f8"
}
],
"tags": [
{
"id": "c0e54bbd39cc4da0b3aa11fd20bfd135"
},
{
"id": "406fa42d405d440aa7289b045e82faf0"
}
],
"memberType": 1
}
正常返回示例
JSON格式
{
"code": "200",
"body": {
"userId": "f9fd5d881b024c6dba7d9619e32fffd3",
"factoryCode": "123456",
"userCode": "tangxj",
"nickName": "唐雪见",
"creatorId": "b7467bc6bbde11e9957c00163e0f0e40",
"creatorType": 0,
"sortIndex": 1090,
"thirdType": 6,
"memberType": 1,
"deptIdList": [
"61145a2f9c2211eba3367cd30aeb7800",
"1b478cef3b9a47c38cc3afee71306d8d"
],
"suppleInfos": [
{
"id": "e6a1892a7e9e4dffb3e9805dd5048f6c",
"fieldType": 2,
"answerContent": "13099999999"
},
{
"id": "986dd827adc04aaf90512fa0e8aaa943",
"fieldType": 5,
"answerContent": "0b2675990b,feaa996b4d,b765ac9d22",
"selectValue": "A1,A2,第B级"
},
{
"id": "a11e3a46fea04b33b2ec39414602d709",
"fieldType": 3,
"answerContent": "c29b8004cc6a42e38962778114fdb4f8",
"selectValue": "选项1"
}
],
"tags": [
{
"id": "c0e54bbd39cc4da0b3aa11fd20bfd135"
},
{
"id": "406fa42d405d440aa7289b045e82faf0"
}
]
}
}
# 修改成员
# 功能说明
修改成员
# 调用说明
地址:
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列表 |
tags | Array | 否 | 见请求示例 | 标签 |
id(tags) | String | 否 | 406fa42d40faf0 | 标签id |
suppleInfos | Array | 否 | 见请求示例 | 用户自定义信息 |
id(suppleInfos) | String | 否 | 406fa42d40faf0 | 自定义信息id |
infoId | String | 否 | 68cdaeb7800 | 成员自定义信息id |
answerContent | String | 否 | 123456 | 自定义信息内容 |
selectValue | String | 否 | 12345 | 自定义信息下拉框选项名称 |
memberType | int | 否 | 1 | 是否新员工(1:是;其他:否) |
# 返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
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":"0516edcfe16f48f2a30e65338a9807f9",
"userCode": "tangxuejian",
"password": "123456",
"nickName": "糖雪见",
"deptIdList": [
"61145a2f9c2211eba3367cd30aeb7800",
"1b478cef3b9a47c38cc3afee71306d8d"
],
"suppleInfos": [
{
"id": "e6a1892a7e9e4dffb3e9805dd5048f6c",
"infoId": "ad1eb4f01c9911ef8f361070fd94fd7a",
"answerContent": "13088888888"
},
{
"id": "986dd827adc04aaf90512fa0e8aaa943",
"infoId": "ad1ed2d21c9911ef8f361070fd94fd7a",
"answerContent": "0b2690b,feaa9986b4d,b765acf9359d22"
},
{
"id": "a11e3a46fea04b33b2ec39414602d709",
"infoId": "ad1ed45f1c9911ef8f361070fd94fd7a",
"selectValue": "选项1",
"answerContent": "c29b8004cc6a42e38962778114fdb4f8"
}
],
"tags": [
{
"id": "c0e54bbd39cc4da0b3aa11fd20bfd135"
},
{
"id": "406fa42d405d440aa7289b045e82faf0"
}
],
"memberType": 1
}
正常返回示例
JSON格式
{
"code" : "200"
}
# 重置密码
# 功能说明
重置成员登录密码
# 调用说明
地址:
地址: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 | 总部 | 部门名称 |
deptIds | String | 635844daa42efaea73e | 部门id |
suppleInfos | Array | 见返回示例 | 用户自定义信息 |
tags | Array | 见返回示例 | 用户标签信息 |
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/userDetail?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9&userCode=18081427165
正常返回示例
JSON格式
{
"code": "200",
"body": {
"userId": "53b168eb73fe4b6a836c459c704e9bef",
"factoryCode": "123456",
"userCode": "1001",
"nickName": "贾谊",
"userType": 2,
"userState": 0,
"deptPath": "374/380/386/",
"isSupplyed": 1,
"photo": "https://s.qingsuyun.com/123456/m/20240514/f37704ff5f07c.png",
"faceImg": "https://s.qingsuyun.com/123456/m/20240516/42f0b711fc9.png",
"thirdType": 8,
"memberType": 1,
"deptName": "蜀山仙剑派/锁妖塔/锁妖塔5层",
"roleName": "全能管理员",
"suppleInfos": [
{
"id": "e6a1892a7e9e4dffb3e9805dd5048f6c",
"fieldName": "手机号码",
"fieldType": 2,
"required": 0,
"sortIndex": 2,
"isMemberInput": 1,
"jsonData": {
"isCheck": 0,
"checkType": 4
},
"answerContent": "18952028497",
"infoId": "51986cb4e68011eebc80946daeb69ee6",
"userId": "53b168eb73fe4b6a836c459c704e9bef"
}
],
"tags": [
{
"id": "c0e54bbd39cc4da0b3aa11fd20bfd135",
"tagName": "西游传说",
"sortIndex": 1,
"checked": true
},
{
"id": "406fa42d405d440aa7289b045e82faf0",
"tagName": "水泊梁山",
"sortIndex": 2,
"checked": false
}
],
"deptIds": "120635844daa42efaea73e8425ff38a4"
}
}
# 修改成员标签信息(按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/setExpireDate
方式:post
# 请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
factoryCode | String | 是 | 123456 | 组织编号 |
sign | String | 是 | eyJhbGciOiJIUzI1NiJ9 | 签名 |
userId | Array | 是 | 123a121212d | 用户Id |
expireDate | String | 是 | 2006-01-02 15:54:05 | 过期时间 |
# 返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | String | 200 | 状态码,详见说明 |
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/setExpireDate?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9
post请求request body参数内容
{
"userIds": [
"53b168eb736c459c704e9bef",
"60d063e5e85a4ba79cc1875d"
],
"expireDate": "2006-01-02 15:54:05"
}
正常返回示例
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 | 自定义信息标识id |
fieldName | String | 邮箱 | 自定义信息名称 |
fieldType | int | 2 | 字段类型仅返回(2:普通文本;3:下拉框;5:多级下拉框),其余类型不返回 |
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:选项内容) |
selectPathDatas | Array | [{id:xx, selectName:xx, selectPath:1/2/,supplySetId:xx}] | 当fieldType=5时补充信息选择框数据有效(id:选项唯一标识;selectName:选项名称;selectPath:选项层级路径;supplySetId对应上层id) |
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/supply/detail?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9
正常返回示例
JSON格式
{
"code": "200",
"body": [
{
"id": "299dd7a519f74e0fb9eed6cdaf0176e6",
"fieldName": "手机号码",
"fieldType": 2,
"required": 0,
"sortIndex": 10,
"isMemberInput": 1,
"jsonData": {
"isCheck": 0,
"checkType": 1
}
},
{
"id": "6193ccafda3b4d1abda07e955f7edf29",
"fieldName": "多级下拉框",
"fieldType": 5,
"required": 0,
"sortIndex": 21,
"isMemberInput": 1,
"selectPathDatas": [
{
"id": "1cea45106c364596964f2db0036baafe",
"selectCode": "3",
"selectName": "A1",
"selectPath": "1/3/",
"supplySetId": "6193ccafda3b4d1abda07e955f7edf29",
"fullSelectPath": "第A级/A1/"
},
{
"id": "5b507936d0e4491f90cd56910b6ba42b",
"selectCode": "2",
"selectName": "第B级",
"selectPath": "2/",
"supplySetId": "6193ccafda3b4d1abda07e955f7edf29",
"fullSelectPath": "第B级/"
},
{
"id": "c9954698cb2e4bbda9073b9ed44de102",
"selectCode": "1",
"selectName": "第A级",
"selectPath": "1/",
"supplySetId": "6193ccafda3b4d1abda07e955f7edf29",
"fullSelectPath": "第A级/"
},
{
"id": "6ff3651c173d44c3b1610dbba0827e45",
"selectCode": "4",
"selectName": "A2",
"selectPath": "1/4/",
"supplySetId": "6193ccafda3b4d1abda07e955f7edf29",
"fullSelectPath": "第A级/A2/"
}
]
},
{
"id": "af25eb15225a4c688ace61918a6eb586",
"fieldName": "下拉框",
"fieldType": 3,
"required": 0,
"sortIndex": 23,
"isMemberInput": 1,
"jsonData": {
"isCheck": 0,
"checkType": 1
},
"selectDatas": [
{
"id": "8665687692e248e78710daf0641887a2",
"supplySetId": "af25eb15225a4c688ace61918a6eb586",
"value": "选项1"
},
{
"id": "4268e0819ae6416bbc40b4aa86bf9997",
"supplySetId": "af25eb15225a4c688ace61918a6eb586",
"value": "选项2"
},
{
"id": "b96ef578317048d49de2e59d8cc65e0f",
"supplySetId": "af25eb15225a4c688ace61918a6eb586",
"value": "选项3"
}
]
}
]
}
# 创建成员自定义信息
# 功能说明
新创建成员补充信息
# 调用说明
地址:
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:下拉框;4:账号;5:多级下拉框) |
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:下拉框;4:账号;5:多级下拉框) |
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"
}
# 获取自定义信息下拉框列表
# 功能说明
获取某个下拉框类型的自定义信息选项列表
# 调用说明
地址:
https://api2.qingsuyun.com/site/api/openApi/supply/selectList
方式:get
# 请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
factoryCode | String | 是 | 123456 | 组织编号 |
sign | String | 是 | eyJhbGciOiJIUzI1NiJ9 | 签名 |
supplySetId | String | 是 | 64d4f6asd48 | 自定义信息id |
# 返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | String | 200 | 状态码,详见说明 |
body | Array | 见返回示例 | 返回数据信息或错误信息 |
id | String | c29b8078114fdb4f8 | 选项id |
value | String | 选项1 | 选项内容 |
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/supply/selectList?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9&supplySetId=842bd65b85f64625b7f001615ea0ab3e
正常返回示例
JSON格式
{
"code": "200",
"body": [
{
"id": "c29b8004cc6a42e38962778114fdb4f8",
"value": "选项1"
},
{
"id": "6ebf9893e3454f039a63e598c1c3cc14",
"value": "选项2"
},
{
"id": "f9e7f75dcb754bab9212d12c9012db9b",
"value": "选项3"
},
{
"id": "634869573bbd489c866988e51d02e7f5",
"value": "选项4"
}
]
}
# 创建自定义信息下拉框选项
# 功能说明
在某个下拉框类型的自定义信息下追加选项
# 调用说明
地址:
https://api2.qingsuyun.com/site/api/openApi/supply/selectSave
方式:post
# 请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
factoryCode | String | 是 | 123456 | 组织编号 |
sign | String | 是 | eyJhbGciOiJIUzI1NiJ9 | 签名 |
supplySetId | String | 是 | a46fea04b33b2ec394 | 自定义信息id |
value | String | 否 | 选项ABC | 选项名称(不传则创建空选项) |
# 返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | String | 200 | 状态码,详见说明 |
body | String | 见返回示例 | 返回数据信息或错误信息 |
id | String | 5cae3088e | 新增选项id |
supplySetId | String | a11602d7c394 | 自定义信息id |
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/supply/selectSave?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9
post请求request body参数内容
{
"supplySetId": "a11e3a46fea04b33b2ec39414602d709",
"value": "新的下拉框选项"
}
正常返回示例
JSON格式
{
"code": "200",
"body": {
"id": "2db19da29c7c434092975228b9ebb4be",
"supplySetId": "a11e3a46fea04b33b2ec39414602d709",
"value": "新的下拉框选项"
}
}
# 编辑自定义信息下拉框选项
# 功能说明
修改下拉框类型的自定义信息选项
# 调用说明
地址:
https://api2.qingsuyun.com/site/api/openApi/supply/selectEdit
方式:post
# 请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
factoryCode | String | 是 | 123456 | 组织编号 |
sign | String | 是 | eyJhbGciOiJIUzI1NiJ9 | 签名 |
supplySetId | String | 是 | 64d4f6asd48 | 自定义信息id |
id | String | 是 | a29c7c434092975 | 待修改的选项id |
value | String | 是 | 修改后的选项 | 选项名称 |
# 返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | String | 200 | 状态码,详见说明 |
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/supply/selectEdit?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9
post请求request body参数内容
{
"id": "2db19da29c7c434092975228b9ebb4be",
"value": "修改后的选项",
"supplySetId": "a11e3a46fea04b33b2ec39414602d709"
}
正常返回示例
JSON格式
{
"code": "200"
}
# 删除自定义信息下拉框选项
# 功能说明
删除下拉框类型的自定义信息选项
# 调用说明
地址:
https://api2.qingsuyun.com/site/api/openApi/supply/selectDel
方式:post
# 请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
factoryCode | String | 是 | 123456 | 组织编号 |
sign | String | 是 | eyJhbGciOiJIUzI1NiJ9 | 签名 |
supplySetId | String | 是 | 64d4f6asd48 | 自定义信息id |
id | String | 是 | a29c7c434092975 | 待删除的选项id |
# 返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | String | 200 | 状态码,详见说明 |
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/supply/selectDel?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9
post请求request body参数内容
{
"id": "2db19da29c7c434092975228b9ebb4be",
"supplySetId": "a11e3a46fea04b33b2ec39414602d709"
}
正常返回示例
JSON格式
{
"code": "200"
}
# 获取自定义信息多级下拉框列表
# 功能说明
全量获取多级下拉框类型的自定义信息选项列表
# 调用说明
地址:
https://api2.qingsuyun.com/site/api/openApi/supply/selectPathList
方式:get
# 请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
factoryCode | String | 是 | 123456 | 组织编号 |
sign | String | 是 | eyJhbGciOiJIUzI1NiJ9 | 签名 |
supplySetId | String | 是 | 64d4f6asd48 | 自定义信息id |
# 返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | String | 200 | 状态码,详见说明 |
body | Array | 见返回示例 | 返回数据信息或错误信息 |
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/supply/selectPathList?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9&supplySetId=842bd65b85f64625b7f001615ea0ab3e
正常返回示例
JSON格式
{
"code": "200",
"body": [
{
"id": "0b267e3e4ec848cfa930c93dd175990b",
"selectCode": "4",
"selectName": "A1",
"sortIndex": 1,
"selectPath": "1/4/",
"isAble": 1,
"classifyCode": "4",
"classifyPath": "1/4/",
"classifyName": "第A级/A1",
"name": "A1"
},
{
"id": "feaa99d23b6b4fb692efa62229286b4d",
"selectCode": "5",
"selectName": "A2",
"sortIndex": 2,
"selectPath": "1/5/",
"isAble": 1,
"classifyCode": "5",
"classifyPath": "1/5/",
"classifyName": "第A级/A2",
"name": "A2"
},
{
"id": "58c025058e96463f8ec5f08eb96db777",
"selectCode": "1",
"selectName": "第A级",
"sortIndex": 5,
"selectPath": "1/",
"isAble": 1,
"classifyCode": "1",
"classifyPath": "1/",
"classifyName": "第A级",
"name": "第A级"
}
]
}
# 创建自定义信息多级下拉框选项
# 功能说明
在某个多级下拉框类型的自定义信息下追加选项
# 调用说明
地址:
https://api2.qingsuyun.com/site/api/openApi/supply/selectPathCreate
方式:post
# 请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
factoryCode | String | 是 | 123456 | 组织编号 |
sign | String | 是 | eyJhbGciOiJIUzI1NiJ9 | 签名 |
supplySetId | String | 是 | 64d4f6asd48 | 自定义信息id |
parentId | String | 是 | 058e96463f8e | 上级选项id,为空则创建顶级选项 |
selectName | String | 是 | 第x级 | 选项名称 |
# 返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | String | 200 | 状态码,详见说明 |
body | Array | 见返回示例 | 返回数据信息或错误信息 |
id | String | 67f6a234d5b8f0a6 | 选项id |
selectPath | String | 1/10/ | 选项路径 |
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/supply/selectPathCreate?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9
post请求request body参数内容
{
"parentId": "58c025058e96463f8ec5f08eb96db777",
"selectName": "第x级",
"supplySetId": "986dd827adc04aaf90512fa0e8aaa943"
}
正常返回示例
JSON格式
{
"code": "200",
"body": {
"id": "33e4167f6a234d5b8f0a6b084224d128",
"factoryCode": "123456",
"selectCode": "10",
"selectName": "第x级",
"sortIndex": 4,
"creatorId": "b7467bc6bbde11e9957c00163e0f0e40",
"creatorType": 0,
"selectPath": "1/10/",
"supplySetId": "986dd827adc04aaf90512fa0e8aaa943",
"parentId": "58c025058e96463f8ec5f08eb96db777"
}
}
# 编辑自定义信息多级下拉框选项
# 功能说明
修改多级下拉框类型的自定义信息选项
# 调用说明
地址:
https://api2.qingsuyun.com/site/api/openApi/supply/selectPathUpdate
方式:post
# 请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
factoryCode | String | 是 | 123456 | 组织编号 |
sign | String | 是 | eyJhbGciOiJIUzI1NiJ9 | 签名 |
supplySetId | String | 是 | 64d4f6asd48 | 自定义信息id |
id | String | 是 | f6a234d5b8f0a6b0 | 待修改的选项id |
selectName | String | 是 | 新的选项名字 | 待修改的选项名称 |
# 返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | String | 200 | 状态码,详见说明 |
body | Array | 见返回示例 | 返回数据信息或错误信息 |
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/supply/selectPathUpdate?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9
post请求request body参数内容
{
"id": "33e4167f6a234d5b8f0a6b084224d128",
"selectName": "新的选项名字",
"supplySetId": "986dd827adc04aaf90512fa0e8aaa943"
}
正常返回示例
JSON格式
{
"code": "200",
"body": {
"id": "33e4167f6a234d5b8f0a6b084224d128",
"factoryCode": "123456",
"selectName": "新的选项名字",
"selectPath": "1/10/",
"supplySetId": "986dd827adc04aaf90512fa0e8aaa943"
}
}
# 删除自定义信息多级下拉框选项
# 功能说明
删除多级下拉框类型的自定义信息选项
# 调用说明
地址:
https://api2.qingsuyun.com/site/api/openApi/supply/selectPathDelete
方式:get
# 请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
factoryCode | String | 是 | 123456 | 组织编号 |
sign | String | 是 | eyJhbGciOiJIUzI1NiJ9 | 签名 |
supplySetId | String | 是 | 64d4f6asd48 | 自定义信息id |
selectId | String | 是 | 33e4167f6a234d | 待删除的选项id |
# 返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | String | 200 | 状态码,详见说明 |
body | Array | 见返回示例 | 返回数据信息或错误信息 |
# 示例
请求示例
https://api2.qingsuyun.com/site/api/openApi/supply/selectPathDelete?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9&supplySetId=842bd65b85&selectId=33e4167f6a234d
正常返回示例
JSON格式
{
"code": "200"
}