注: 所有接口只针对企业会员提供,非企业会员无法调用
同步学员数据可以方便的在系统之间进行学员数据交换,避免手动可能出现的错误;自动同步及时快捷,即可以同步学员信息也可以同步学员的组织结构。
添加分组
添加考生分组的接口如下:
POST https://www.hzxue.com/api/group/new
参数:
token=权限码&title=组标题&parentGid=0
参数说明
- token 每个账户唯一对应的验证码,string类型,该值可联系好智学获取
- title 组的标题
- parentGid 父组的ID, 如果为0表示创建的是根分组, 如果大于0,表示创建该组下的一个子组
如果操作成功,则返回
{ "status": "ok", //ok表示成功, error表示错误 "gid": 1931 //gid表示新创建的组的ID }
如果操作失败,则返回
{ "status": "error", "error": "标题不能为空" //创建出错时的错误信息 }
编辑组
该接口用于编辑现有组的名称,接口如下:
POST https://www.hzxue.com/api/group/rename
参数:
token=权限码&title=组标题&gid=0
参数说明
- token 每个账户唯一对应的验证码,string类型,该值可联系好智学获取
- title 组的新标题
- gid 要修改组的ID, 要求大于0
如果操作成功,则返回
{ "status": "ok", //ok表示成功, error表示错误 "gid": 1931, //gid表示组的ID "oldTitle": "数学1" //表示原组的标题 }
如果操作失败,则返回
{ "status": "error", "error": "标题不能为空" //创建出错时的错误信息 }
删除组
该接口用于删除某一个组,接口如下:
POST https://www.hzxue.com/api/group/delete
参数:
token =权限码&gid=231
参数说明
- token 每个账户唯一对应的验证码,string类型,该值可联系好智学获取
- gid 要被删除的组的ID, 要求大于0
如果操作成功,则返回
{ "status": "ok", //ok表示成功, error表示错误 }
如果操作失败,则返回
{ "status": "error", "error": "不正确的组ID, 请确认是否有权限修改该组的信息" //创建出错时的错误信息 }
移动组
移动组用于把一个组移动成另一个组的子组, 接口如下
POST https://www.hzxue.com/api/group/move
参数:
token=权限码&gid=112&mvToGid=23
参数说明
- token 每个账户唯一对应的验证码,string类型,该值可联系好智学获取
- gid 要被移动的组的ID, 要求大于0
- mvToGid 要移动到的组ID
如果操作成功,则返回
{ "status": "ok", //ok表示成功, error表示错误 }
表示已经把 gid 移动到 mvToGid 下并成为其的一个子组了
如果操作失败,则返回
{ "status": "error", "error": "不正确的组ID, 请确认是否有权限修改该组的信息" //创建出错时的错误信息 }
获取组列表
返回某一组(或所有组)下所有子组信息, 接口如下
GET https://www.hzxue.com/api/group/list
参数:
token =权限码&gid=112
token=权限码&gid=112
参数说明
- token每个账户唯一对应的验证码,string类型,该值可联系好智学获取
- gid 可选参数, 如果设置了该参数,则列出的是该组下的所有子组的信息。如果gid为0或者没有设置,则表示列出所有根路径下的组数据
如果操作成功,则返回
{ "status": "ok", //ok表示成功, error表示错误, "data": [ { "gid": 1312, //组ID "title": "组标题", //组的标题 }, { "gid": 1332, //组ID "title": "组标题", //组的标题 } ... ] }
如果操作失败,则返回
{ "status": "error", "error": "不正确的组ID, 请确认是否有权限修改该组的信息" //创建出错时的错误信息 }