基础相关

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

提示消息

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

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

登录

登录进入：login/in

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

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data.userId	Integer	用户ID
data.userName	String	用户名称
data.role	Integer	角色（ADMIN：管理员；EXAM_USER：考试用户；SUB_ADMIN：子管理员；MARK_USER：阅卷用户；TEMP_USER：临时用户）（V5.7.0修改：type->role）
data.accessToken	String	访问令牌
data.refreshToken	String	刷新令牌（V5.7.0新增）
data.avatarFileId	Integer	用户头像（V6.0.0新增）
data.needChangePwd	Boolean	是否需要强制修改密码（启用强制复杂密码且当前密码强度不足时为true，V6.4.0新增）
data.isDefaultPwd	Boolean	是否为默认密码（用于登录页强改密提示，V6.4.0新增）

登录进入：login/temp-in

• 用于临时考试

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

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data.userId	Integer	用户ID
data.userName	String	用户名称
data.role	Integer	角色（ADMIN：管理员；EXAM_USER：考试用户；SUB_ADMIN：子管理员；MARK_USER：阅卷用户；TEMP_USER：临时用户）（V5.7.0修改：type->role）
data.accessToken	String	访问令牌
data.refreshToken	String	刷新令牌（V5.7.0新增）

登录退出：login/out

登录刷新令牌：login/refresh（V6.0.0新增）

请求参数	类型	描述	必填
refreshToken	String (128)	刷新令牌	是

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data.accessToken	String	访问令牌

登录修改密码：login/pwd

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

登录头像：user/avatar

请求参数	类型	描述	必填
avatarFileId	Integer	头像附件ID	是

服务器时间：login/sys-time

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

登录参数：login/parm

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data.sysName	String	系统名称
data.customTitle	String	服务支持标题
data.customContent	String	服务支持内容
data.icp	String	备案信息
data.userRegist	Integer	用户注册（1：是；2：否）
data.fileMaxSize	Long	文件上传最大大小（字节）（V6.3.0新增）
data.demoMode	Boolean	是否演示模式（演示模式下登录页展示演示账号，V6.4.0新增）
data.pwdComplex	Integer	强制复杂密码（1：启用；2：不启用）（V6.4.0新增）

登录logo：login/logo

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

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

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

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

登录注册用户：login/user-regist（V6.0.0新增）

请求参数	类型	描述	必填
name	String (16)	姓名	是
loginName	String (32)	登录账号	是
pwd	String (32)	密码	是
orgCode	String (8)	机构码	是

机构

机构列表：org/listpage

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

请求参数	类型	描述	必填
name	String(16)	名称	否
parentId	Integer	父ID	否
ids	Integer[]	机构IDS（页面过滤用）	否
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	排序
data.list[].userCount	Integer	用户数量（V6.0.0新增）
data.list[].code	String	机构码，用户注册时关联机构，由管理员分配（V6.0.0新增）

机构添加：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)	姓名或机构	否
orgId	Integer	机构ID	否
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[].avatarFileId	Integer	头像附件ID
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

请求参数	类型	描述	必填
ids	Integer[]	主键（V6.0.0更新，id改成ids，支持多id删除）	是

用户获取：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	Integer[]	可管理的考试用户，查询子管理员有效
data.orgIds	Integer[]	可管理的机构，查询子管理员有效

用户密码初始化：user/pwd-init

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

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

用户冻结：user/frozen

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

用户模板：user/template

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

用户导入：user/import

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

注册用户

注册用户列表：registUser/listpage（V6.0.0新增）

请求参数	类型	描述	必填
name	String(16)	登录账号或姓名	否
state	Integer	状态（1：通过；2：拒绝；3：待审核）	否
curPage	Integer	当前第几页	否
pageSize	Integer	每页多少条	否

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data.total	Integer	总行数
data.list[]	Object[]	分页列表
data.list[].id	Integer	主键
data.list[].loginName	String	登录账号
data.list[].name	String	姓名
data.list[].orgId	Integer	机构ID
data.list[].orgName	String	机构名称
data.list[].registTime	Date	注册时间
data.list[].state	Integer	状态（1：通过；2：拒绝；3：待审核）
data.list[].remark	String	审批意见
data.list[].remark	Date	更新时间

注册用户同意：registUser/approve（V6.0.0新增）

请求参数	类型	描述	必填
id	Integer	主键	是
remark	String(64)	审批意见	是

注册用户拒绝：registUser/reject（V6.0.0新增）

请求参数	类型	描述	必填
id	Integer	主键	是
remark	String(64)	审批意见	是

注册用户获取：registUser/get（V6.0.0新增）

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

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data.id	Integer	主键
data.loginName	String	登录账号
data.name	String	姓名
data.orgId	Integer	机构ID
data.registTime	Date	注册时间
data.state	Integer	状态（1：正常；2：冻结；）
data.remark	String	审批意见

数据字典

数据字典列表：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/get

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

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

数据字典列表：dict/index-list

提示消息

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

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data[]	Object[]	数组列表
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/start-task

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

定时任务停止：cron/stop-task

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

定时任务执行一次：cron/run-once-task

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

附件

附件上传：file/upload

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

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

附件下载：file/download

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

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

进度条

进度条获取：progress-bar/get

建议一秒查询一次

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

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

公告

公告列表：bulletin/listpage

请求参数	类型	描述	必填
title	String	标题	否
importance	Integer	重要程度（V6.3.0新增）	否
curPage	Integer	当前第几页	否
pageSize	Integer	每页多少条	否

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data.total	Integer	总行数
data.list[]	Object[]	分页列表
data.list[].id	Integer	主键
data.list[].publishTime	Date	发布时间
data.list[].expireTime	Date	过期时间
data.list[].title	String	标题
data.list[].importance	Integer	重要程度（V6.3.0新增）
data.list[].isTop	Integer	是否置顶（V6.3.0新增）
data.list[].readCount	Integer	已读人数（V6.3.0新增）
data.list[].fileIds	Integer[]	附件ID列表（V6.3.0新增）

公告添加：bulletin/add

请求参数	类型	描述	必填
title	String	标题	是
content	String	内容	是
publishTime	Date	发布时间	是
expireTime	Date	过期时间	是
importance	Integer	重要程度（V6.3.0新增）	否
isTop	Integer	是否置顶（V6.3.0新增）	否
fileIds	Integer[]	附件ID列表（V6.3.0新增）	否

公告修改：bulletin/edit

请求参数	类型	描述	必填
id	Integer	主键	是
title	String	标题	是
content	String	内容	是
publishTime	Date	发布时间	是
expireTime	Date	过期时间	是
importance	Integer	重要程度（V6.3.0新增）	否
isTop	Integer	是否置顶（V6.3.0新增）	否
fileIds	Integer[]	附件ID列表（V6.3.0新增）	否

公告删除：bulletin/del

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

公告获取：bulletin/get

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

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data.id	Integer	主键
data.publishTime	Date	发布时间
data.expireTime	Date	过期时间
data.title	String	标题
data.content	String	内容
data.importance	Integer	重要程度（V6.3.0新增）
data.isTop	Integer	是否置顶（V6.3.0新增）
data.files[]	Object[]	附件数组（V6.3.0新增）
data.files[].id	Integer	附件ID
data.files[].name	String	附件名称

公告用户列表（已读/未读统计）：bulletin/my-bulletin-listpage（V6.3.0新增）

请求参数	类型	描述	必填
bulletinId	Integer	公告ID	否
userName	String	用户姓名	否
state	Integer	状态（1：已读；2：未读）	否
curPage	Integer	当前第几页	否
pageSize	Integer	每页多少条	否

响应参数	类型	描述
code	Integer	响应码
msg	String	响应消息
data.total	Integer	总行数
data.list[]	Object[]	分页列表
data.list[].id	Integer	主键
data.list[].bulletinId	Integer	公告ID
data.list[].publishTime	Date	发布时间
data.list[].title	String	标题
data.list[].importance	Integer	重要程度
data.list[].isTop	Integer	是否置顶
data.list[].state	Integer	状态（1：已读；2：未读）
data.list[].readTime	Date	阅读时间
data.list[].userName	String	用户姓名
data.list[].loginName	String	登录名
data.list[].orgName	String	所属机构名称

系统参数

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

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

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

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

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

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

系统参数密码策略：parm/pwd

请求参数	类型	描述	必填
complex	Integer	强制复杂密码（1：启用；2：不启用）（V6.4.0修改：原密码类型固定/随机调整为强制复杂密码）	是

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

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

系统参数备案：parm/icp

请求参数	类型	描述	必填
icp	String(512)	备案信息	是

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

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

系统参数用户注册设置：parm/user-register（V6.0.0新增）

请求参数	类型	描述	必填
无	无	默认不允许前端自行注册。调用一次开启，在调一次关闭	否

系统参数获取：parm/get

提示消息

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

响应参数	类型	描述
sysName	String	系统名称
fileUploadDir	String	上传目录
dbBakDir	String	上传目录
pwdComplex	Integer	强制复杂密码（1：启用；2：不启用）（V6.4.0修改：原pwdType/pwdValue）
customTitle	String	自定义标题
customContent	String	自定义内容
icp	String	备案信息
mHost	String	移动端主机地址
userRegist	Integer	用户注册（1：是；2：否）

缓存

缓存列表：cache/list

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

缓存刷新：cache/refresh

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

  警告消息

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

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