训练内容管理

训练内容列表: /trainGames GET

请求参数

参数名	示列值	类型	必须	说明	默认值
page	1	number	否	当前页数	1
pageSize	10	number	否	每页条数	10
sort	-createdAt	string	否	排序。多个排序字段用,号隔开。sort=-a,b
expand	'trainGameCategory'	string	否	获取指定子资源数据: 'trainGameCategory,creator,trainStats,organizations'。organizations 为入库机构列表(返回 id,name)
attributes	["id", "name"]	array	否	本资源的字段。不定义该字段时返回所有字段；空数组不返回字段
name	舒尔特方格	string	否	训练内容名称(模糊搜索)
trainCode	shulte-grid	string	否	训练编码
trainGameCategoryId	1	number	否	训练内容分类id
status	1	number	否	状态:(0:禁用,1:启用)

返回参数

参数名	示列值	说明
page	1	当前页数
pageSize	10	每页条数
limit	10	同 pageSize
offset	2	起始条数
total	3231	符合条件的总数量
items	[{},{}]	返回数据项(具体字段看训练内容信息)

• items： 训练内容信息

参数名	示列值	说明
id	1	id
organizationId	1	机构id(0:超管创建,即全局共享模板)
trainCode	shulte-grid	训练编码
name	舒尔特方格	训练内容名称
categoryId	1	训练内容分类id
specialRule	{}	专项规则(不同游戏特有配置)
difficultyLevel	1	难度等级:(1:初级,2:中级,3:高级)
introduce	训练介绍	训练介绍
guidance	训练指导	训练指导
coverUrl	https://x	封面图地址
suggestDuration	300	建议训练时长(秒)
creatorId	1	创建人id
status	1	状态:(0:禁用,1:启用)
remark	备注	备注
createdAt	1650160322	创建时间
updatedAt	1650160322	更新时间
trainGameCategory	{}	扩展字段：训练内容分类信息(训练内容分类信息)
creator	{}	扩展字段：创建人信息
trainStats	{}	扩展字段：训练统计信息(trainCount:训练次数,traineeCount:训练人数)

返回示列

HTTP/1.1 200 OK
{
    "items": [
    {
      "id": 1,
      "organizationId": 0,
      "trainCode": "shulte-grid",
      "name": "舒尔特方格",
      "categoryId": 1,
      "status": 1,
      "createdAt": 1650160322,
      "updatedAt": 1650160322,
      "trainGameCategory": { "id": 1, "name": "认知训练" },
      "trainStats": { "trainCount": 120, "traineeCount": 36 }
    },
  ],
  "page": 1,
  "pageSize": 10,
  "limit": 10,
  "offset": 2,
  "total": 15
}

所有训练内容: /listAll/trainGames GET

请求参数

参数名	示列值	类型	必须	说明	默认值
expand	'trainGameCategory'	string	否	获取指定子资源数据: 'trainGameCategory,creator,trainStats,organizations'。organizations 为入库机构列表(返回 id,name)
attributes	["id", "name"]	array	否	本资源的字段。不定义该字段时返回所有字段；空数组不返回字段
name	舒尔特方格	string	否	训练内容名称(模糊搜索)
trainCode	shulte-grid	string	否	训练编码
trainGameCategoryId	1	number	否	训练内容分类id
status	1	number	否	状态:(0:禁用,1:启用)

返回示列

HTTP/1.1 200 OK
[
  { "id": 1, "name": "舒尔特方格", "trainGameCategory": { "id": 1, "name": "认知训练" } }
]

训练内容详情: /trainGames/:id GET

请求参数

参数名	示列值	类型	必须	说明
id	1	number	是	id
expand	'trainGameCategory'	string	否	获取指定子资源数据: 'trainGameCategory,creator,trainStats,organizations'。organizations 为入库机构列表(返回 id,name)
attributes	["id", "name"]	array	否	本资源的字段。不定义该字段时返回所有字段

返回结果: 训练内容信息

返回示列

HTTP/1.1 200 OK
{
  "id": 1,
  "name": "舒尔特方格",
  "trainGameCategory": { "id": 1, "name": "认知训练" },
  "createdAt": 1650160322,
  "updatedAt": 1650160322,
}

新建训练内容: /trainGames POST

请求参数

参数名	示列值	类型	必须	说明	默认值
trainCode	shulte-grid	string	是	训练编码
name	舒尔特方格	string	是	训练内容名称
categoryId	1	number	是	训练内容分类id
specialRule	{}	object	否	专项规则(不同游戏特有配置)
difficultyLevel	1	number	否	难度等级:(1:初级,2:中级,3:高级)	1
introduce	训练介绍	string	否	训练介绍
guidance	训练指导	string	否	训练指导
coverUrl	https://x	string	否	封面图地址
suggestDuration	300	number	否	建议训练时长(秒)
status	1	number	否	状态:(0:禁用,1:启用)	1
remark	备注	string	否	备注

返回结果: 训练内容信息

返回示列

HTTP/1.1 200 OK
{
  "id": 1,
  "name": "舒尔特方格",
  "trainCode": "shulte-grid",
  "status": 1,
  "createdAt": 1650160322,
  "updatedAt": 1650160322,
}

编辑训练内容: /trainGames/:id PUT

请求参数

参数名	示列值	类型	必须	说明	默认值
id	1	number	是	id
trainCode	shulte-grid	string	是	训练编码
name	舒尔特方格	string	是	训练内容名称
categoryId	1	number	是	训练内容分类id
specialRule	{}	object	否	专项规则
difficultyLevel	1	number	否	难度等级
introduce	训练介绍	string	否	训练介绍
guidance	训练指导	string	否	训练指导
coverUrl	https://x	string	否	封面图地址
suggestDuration	300	number	否	建议训练时长(秒)
status	1	number	否	状态:(0:禁用,1:启用)
remark	备注	string	否	备注

返回结果: 训练内容信息

返回示列

HTTP/1.1 200 OK
{
  "id": 1,
  "name": "舒尔特方格",
  "status": 1,
  "createdAt": 1650160322,
  "updatedAt": 1650160322,
}

修改训练内容状态: /trainGames/:id/status PUT

请求参数

参数名	示列值	类型	必须	说明
id	1	number	是	训练内容 id
status	1	number	是	状态:(0:禁用,1:启用)

返回结果: 训练内容信息

返回示列

HTTP/1.1 200 OK
{
  "id": 1,
  "name": "舒尔特方格",
  "status": 1,
  "createdAt": 1650160322,
  "updatedAt": 1650160322,
}

删除训练内容: /trainGames/:id DELETE

请求参数

参数名	示列值	类型	必须	说明
id	1	number	是	训练内容 id

返回示列

HTTP/1.1 200

名称是否重复: /isExist/trainGames GET

请求参数

参数名	示列值	类型	必须	说明
id	1	number	否	训练内容id
name	舒尔特方格	string	否	名称
trainCode	shulte-grid	string	否	训练编码

返回示列

HTTP/1.1 200 OK
{
  "isExist": true,
}

训练内容入库: librarySetting/trainGames POST

请求参数

参数名	示列值	类型	必须	说明
ids	[1]	array	Y	训练内容 id 数组
orgIds	[1,2]	array	Y	组织 id 数组
bulk	true	boolean		是否是批量入库(true:是)

返回示列

HTTP/1.1 200