基础相关

本章节专注于描述基础相关的API，与具体业务逻辑无关。

提示消息

部分接口已实现缓存处理，可不限次数请求，默认空闲两小时失效。

org/get | user/get | parm/get | dict/indexList

登录

登录进入：login/in

请求参数	类型	描述	必填
loginName	String (16)	登录名称	是
pwd	String (2048)	密码	是

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data.accessToken	String	访问令牌
data.userId	Integer	用户ID
data.userName	String	用户名称
data.type	Integer	类型（0：管理员；1：考试用户；2：子管理员；3：阅卷用户；4：临时登录用户）

登录进入：login/noLogin

请求参数	类型	描述	必填
name	String (16)	用户名称	是

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data.accessToken	String	访问令牌
data.userId	Integer	用户ID
data.userName	String	用户名称
data.type	Integer	类型（0：管理员；1：考试用户；2：子管理员；3：阅卷用户；4：临时登录用户）

登录退出：login/out

登录修改密码：login/pwd

请求参数	类型	描述	必填
oldPwd	String	旧密码	是
newPwd	String	新密码	是

服务器时间：login/sysTime

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data	Date	服务器时间

登录参数：login/parm

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data.sysName	String	系统名称
data.customTitle	String	服务支持标题
data.customContent	String	服务支持内容
data.icp	String	备案信息

登录logo：login/logo

响应参数	类型	描述
	Binary	二进制流

登录秘钥：login/encrypt（V5.6.0新增）

请求参数	类型	描述	必填
loginName	String (16)	登录名称	是

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data.publicKey	String	公共密钥
data.nonce	String	伪随机数

机构

机构列表：org/listpage

• 管理员默认查询所有机构，子管理员默认查询自己的机构

请求参数	类型	描述	必填
name	String(16)	名称	否
parentId	Integer	父ID	否
curPage	Integer	当前第几页	否
pageSize	Integer	每页多少条	否

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data.total	Integer	总行数
data.list[]	Object[]	分页列表
data.list[].id	Integer	主键
data.list[].name	String	名称
data.list[].parentId	Integer	父ID
data.list[].parentName	String	父名称
data.list[].no	Integer	排序

机构添加：org/add

请求参数	类型	描述	必填
name	String (16)	名称	是
parentId	Integer	父ID	否
no	Integer	排序	是

机构修改：org/edit

请求参数	类型	描述	必填
id	Integer	主键	是
name	String (16)	名称	是
parentId	Integer	父ID	否
no	Integer	排序	是

机构删除：org/del

请求参数	类型	描述	必填
id	Integer	主键	是

机构获取：org/get

提示消息

已实现缓存处理，可不限次数请求，默认空闲两小时失效。

请求参数	类型	描述	必填
id	Integer	主键	是

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data.id	Integer	主键
data.name	String	名称
data.parentId	Integer	父ID
data.parentName	String	父名称
data.no	Integer	排序

用户

用户列表：user/listpage

• 管理员默认查询所有考试用户，子管理员默认查询自己的考试用户

请求参数	类型	描述	必填
name	String(16)	姓名或机构	否
state	Integer	状态（1：正常；2：冻结；）	否
ids	String(65535)	用户IDS（逗号分割），一般用于指定查询	否
parentId	Integer	子管理员查询自己的阅卷用户有效	否
curPage	Integer	当前第几页	否
pageSize	Integer	每页多少条	否

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data.total	Integer	总行数
data.list[]	Object[]	分页列表
data.list[].id	Integer	主键
data.list[].name	String	名称
data.list[].loginName	String	登录名称
data.list[].orgId	Integer	机构ID
data.list[].orgName	String	机构名称
data.list[].state	Integer	状态（1：正常；2：冻结；）

用户添加：user/add

请求参数	类型	描述	必填
name	String (16)	名称	是
loginName	String (16)	登录账号	是
orgId	Integer	机构ID（默认顶级机构）	否

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data.initPwd	String	初始化密码

用户修改：user/edit

请求参数	类型	描述	必填
id	Integer	主键	是
name	String (16)	名称	是
loginName	String (16)	登录账号	是
orgId	Integer	机构ID	是

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data.initPwd	String	初始化密码（更改loginName时，此字段有效）

用户删除：user/del

请求参数	类型	描述	必填
id	Integer	主键	是

用户获取：user/get

提示消息

已实现缓存处理，可不限次数请求，默认空闲两小时失效。

请求参数	类型	描述	必填
id	Integer	主键	是

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data.id	Integer	主键
data.name	String	名称
data.loginName	String	登录账号
data.orgId	Integer	机构ID
data.orgName	String	机构名称
data.state	Integer	状态（1：正常；2：冻结；）
data.userIds	String	可管理的考试用户，查询子管理员有效

用户密码初始化：user/pwdInit

请求参数	类型	描述	必填
id	Integer	主键	是

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data.initPwd	String	初始化密码

用户冻结：user/frozen

请求参数	类型	描述	必填
id	Integer	主键，如果正常则变更为冻结；如果冻结则变更为正常	是

用户强制退出：user/out

请求参数	类型	描述	必填
id	Integer	主键	是

用户模板：user/template

响应参数	类型	描述
	Binary	二进制流

用户导入：user/import

请求参数	类型	描述	必填
file	File	附件	是

数据字典

数据字典列表：dict/listpage

请求参数	类型	描述	必填
dictIndex	String	索引	否
dictKey	String	键	否
dictValue	String	值	否
curPage	Integer	当前第几页	否
pageSize	Integer	每页多少条	否

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data.total	Integer	总行数
data.list[]	Object[]	分页列表
data.list[].id	Integer	主键
data.list[].dictIndex	String	索引
data.list[].dictKey	String	键
data.list[].dictValue	String	值
data.list[].no	Integer	排序

数据字典添加：dict/add

请求参数	类型	描述	必填
dictIndex	String (32)	索引	是
dictKey	String (32)	键	是
dictValue	String (32)	值	是
no	Integer	排序	是

数据字典修改：dict/edit

请求参数	类型	描述	必填
id	Integer	主键	是
dictIndex	String (32)	索引	是
dictKey	String (32)	键	是
dictValue	String (32)	值	是
no	Integer	排序	是

数据字典删除：dict/del

请求参数	类型	描述	必填
id	Integer	主键	是

数据字典列表：dict/indexList

提示消息

已实现缓存处理，可不限次数请求，默认空闲两小时失效。

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data[]	Object[]	数组列表
data[].id	Integer	主键
data[].dictIndex	String	索引
data[].dictKey	String	键
data[].dictValue	String	值
data[].no	Integer	排序

数据字典获取：dict/get

请求参数	类型	描述	必填
id	Integer	主键	是

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data.id	Integer	主键
data.dictIndex	String	索引
data.dictKey	String	键
data.dictValue	String	值
data.no	Integer	排序

定时任务

定时任务列表：cron/listpage

请求参数	类型	描述	必填
name	String	名称	是
curPage	Integer	当前第几页	否
pageSize	Integer	每页多少条	否

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data.total	Integer	总行数
data.list[]	Object[]	分页列表
data.list[].id	Integer	主键
data.list[].name	String	名称
data.list[].jobClass	String	实现类
data.list[].cron	String	cron表达式
data.list[].state	Integer	状态（1：启动；2：停止；）
data.list[].triggerTimes	Date[]	最近几次触发时间

定时任务添加：cron/add

请求参数	类型	描述	必填
name	String (32)	名称	是
jobClass	String (32)	实现类	是
cron	String (32)	cron表达式	是

定时任务修改：cron/edit

请求参数	类型	描述	必填
id	Integer	主键	是
name	String (32)	名称	是
jobClass	String (32)	实现类	是
cron	String (32)	cron表达式	是

定时任务删除：cron/del

请求参数	类型	描述	必填
id	Integer	主键	是

定时任务获取：cron/get

请求参数	类型	描述	必填
id	Integer	主键	是

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data.id	Integer	主键
data.name	String	名称
data.jobClass	String	实现类
data.cron	String	cron表达式
data.triggerTimes	Date[]	最近几次触发时间
data.state	Integer	状态（1：启动；2：停止；）

定时任务启动：cron/startTask

请求参数	类型	描述	必填
id	Integer	主键	是

定时任务停止：cron/stopTask

请求参数	类型	描述	必填
id	Integer	主键	是

定时任务执行一次：cron/runOnceTask

请求参数	类型	描述	必填
id	Integer	主键	是

附件

附件上传：file/upload

请求参数	类型	描述	必填
files	File	附件	是
uuid	String	唯一识别码，移动端使用。查阅file/getId接口了解详细	否

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data	String[]	附件ID

附件下载：file/download

请求参数	类型	描述	必填
id	Integer	主键	是

响应参数	类型	描述
	Binary	二进制流

进度条

进度条获取：progressBar/get

建议一秒查询一次

请求参数	类型	描述	必填
id	String	进度条ID	是

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data.curNum	Integer	当前数量
data.totalNum	Integer	总数量
data.percent	Integer	百分比

公告栏

公告栏列表：bulletin/listpage

求参数	类型	描述	必填
title	String	标题	否
curPage	Integer	当前第几页	否
pageSize	Integer	每页多少条	否

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data.total	Integer	总行数
data.list[]	Object[]	分页列表
data.list[].id	Integer	主键
data.list[].title	String	标题
data.list[].content	String	内容
data.list[].startTime	Date	开始时间
data.list[].endTime	Date	结束时间

公告栏添加：bulletin/add

请求参数	类型	描述	必填
title	String (32)	标题	是
content	text	内容	是
startTime	Date	开始时间	是
endTime	Date	结束时间	是

公告栏修改：bulletin/edit

请求参数	类型	描述	必填
id	Integer	主键	是
title	String (32)	标题	是
content	text	内容	是
startTime	Date	开始时间	是
endTime	Date	结束时间	是

公告栏删除：bulletin/del

请求参数	类型	描述	必填
id	Integer	主键	是

公告栏列表：bulletin/get

求参数	类型	描述	必填
id	Integer	主键	是

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data.id	Integer	主键
data.title	String	标题
data.content	text	内容
data.startTime	Date	开始时间
data.endTime	Date	结束时间

系统参数

系统参数系统修改：parm/sys

请求参数	类型	描述	必填
name	String (32)	企业名称	是
logoFileId	Integer	企业logo附件ID	否

系统参数上传目录修改：parm/file

请求参数	类型	描述	必填
uploadDir	String（64）	上传目录	是

系统参数数据库备份目录修改：parm/db

请求参数	类型	描述	必填
bakDir	String（64）	上传目录	是

系统参数密码初始化：parm/pwd

请求参数	类型	描述	必填
type	Integer	密码类型（1：随机；2：固定）	是
value	String(32)	密码（type==2有效）	否

系统参数服务支持：parm/support

请求参数	类型	描述	必填
title	String(16)	标题	是
content	String(128)	内容	是

系统参数移动端设置：parm/m

请求参数	类型	描述	必填
host	String(128)	标题	是

系统参数获取：parm/get

提示消息

已实现缓存处理，可不限次数请求，默认空闲两小时失效。

请求参数	类型	描述
entName	String (64)	机构名称
fileUploadDir	String（64）	上传目录
dbBakDir	String（64）	上传目录
pwdType	Integer	密码类型
pwdValue	String（32）	密码
customTitle	String（16）	自定义标题
customContent	String（128）	自定义内容
mHost	String（128）	移动端主机地址

缓存

缓存列表：cache/list

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data.total	Integer	总行数
data.list[]	Object[]	分页列表
data.list[].[key]	String	任意键
data.list[].[value]	String	任意值

缓存刷新：cache/refresh

• 直接在数据库修改用户、考试等信息时，因为做了缓存处理，所以需要刷新数据。

  警告消息

  强烈建议按流程在页面操作，除非你有特殊需要并且熟悉本程序。

请求参数	类型	描述	必填
cacheNames	String[]	缓存名称	是