学员管理
注: 所有接口只针对企业会员提供,非企业会员无法调用
学员管理接口提供了添加、修改、删除考生信息的功能,具体接口信息如下
添加学员
通过该接口,可以添加一个或多个学员。
接口如下所示:
POST https://www.hzxue.com/api/student/add参数:
token=权限码
students=[ //学员数组,每个元素对象代表一个学员
{ //代表一个考生信息对象
"gid": 11, //学员所属组的id
"fields": [ //学员信息
{
"sFid": 1, // 学员字段id,int类型,该值可通过"获取学员信息字段"API获取,如"手机"字段id为4, 姓名字段为1
"value":"王二" //学员字段的值,如sFid的值为1,这里则填写姓名
},
]
},
]
参数说明:
- token每个账户唯一对应的验证码,string类型,该值可联系好智学获取
- students 表示要添加的学员信息, 其中gid表示这个学员要加入到哪个组,如果是多个组,请用逗号分隔的字符串表示。 fields表示学员的信息项
该接口返回成功添加的学员sid
{
"status": "ok", //成功返回 ok,失败返回 error
"success": [ //成功添加的数据,每个元素都是对象,sid表示学员id, index表示要添加学员的数据索引
{
"sid":123,
"index":1
},
{
"sid":125,
"index":2
}
],
"fail": [3,4,5] //fail表示失败的学员索引
}
删除学员
通过该接口,可以删除一个或多个学员。
接口如下所示:
POST https://www.hzxue.com/api/student/delete
参数:
token=权限码 sids=["139", "392", "193", "932"] //学员的ID列表
参数说明:
- token每个账户唯一对应的验证码,string类型,该值可联系好智学获取
- sids 表示要删除的学员的ID列表
该接口返回成功
{
"status": "ok" //成功返回 ok,失败返回 error
}
移动学员到组¶
使用该接口移动一个或多个学员到一个或多个组。 接口如下所示:
POST https://www.hzxue.com/api/student/move
参数:
code=权限码
mvStuInfo={
"gids": [22,33], //如果gids里有多个值,则表示把学员添加到这些组(PS 一个学员允许同时存在多个组)
"sids": [2213,3910] //学员ID,学员id
"action": "addto|moveto" //操作, addto表示添加到组,这个时候一个学员可能存在多个组, moveto表示移动到组,这个时候学员只存在一个组。如果action值为moveto,则gids只能为一个,如果有多个gid, 只取第一个
}
参数说明:
- token每个账户唯一对应的验证码,string类型,该值可联系好智学获取
- mvStuInfo 表示要移动的数据信息
该接口返回成功添加的学员sid
{
"status": "ok", //成功返回 ok,失败返回 error
"success": [1,2], //表示成功的学员的sid或登录值
"fail": [3,4,5] //fail表示失败的学员sid或登录值
}
失败则返回:
{
"status": "error", //成功返回 ok,失败返回 error
"error": "无效的sid" //error为失败的错误信息
}
修改学员信息
通过该接口,可以修改一个或多个学员的信息
接口如下所示
POST https://www.hzxue.com/api/student/update
参数:
token=权限码
stuInfo=[ //学员数组,每个元素对象代表一个学员
{ //代表一个学员信息对象
"sid": 11, //学员id,id和登录值不能同时为空,必须填写一个
"loginValue":"小明" //学员登录值,id和登录值不能同时为空,必须填写一个
"fields": [ //学员信息
{
"sFid": 1, // 学员字段id,int类型,该值可通过"获取学员信息字段"API获取,如"手机"字段id为4, 姓名字段为1
"value":"王二" //学员字段的值,如sFid的值为1,这里则填写姓名
},
]
},
]
参数说明:
- token 每个账户唯一对应的验证码,string类型,该值可联系好智学获取
- stuInfo 表示要更新的学员信息, sid表示学员ID, loginValue表示
学员登录值, fields表示学员的字段信息
该接口返回成功修改的学员sid
{
"status": "ok", //成功返回 ok,失败返回 error
"success": [1,2], //表示成功的学员id或登录值
"fail": [3,4,5] //fail表示失败的学员id或登录值
}
字段管理¶
获取学员字段信息, 接口如下:
GET https://www.hzxue.com/api/student/fields
请求数据
token=权限码
- token 每个账户唯一对应的验证码,string类型,该值可联系好智学获取
返回数据:
[
{
"sFid":1,// 字段id,int类型
"label": "姓名", //字段标题, string类型
"isLoginField": false, //是否为登录字段,只能存在一个登录字段,不存在或等于false为普通字段,boolean类型
}
]
正常返回的数据如下:
[
{
"sFid": 1,
"label": "姓名"
},
{
"sFid": 2,
"label": "性别"
},
{
"sFid": 4,
"label": "手机"
},
{
"sFid": 5,
"label": "身份证"
},
{
"sFid": 10,
"label": "密码"
},
//以上字段为系统默认字段,实际可能存在更多字段,请以实际获取的对象为准
...
]
字段的添加和修改请到系统的学员管理中处理