Skip to content
GitLab

原始数据查询 · Changes

Page history
Update 原始数据查询 authored by 唐宇's avatar 唐宇
Show whitespace changes
Inline Side-by-side
原始数据查询.md
View page @ 858bd00a
......@@ -30,7 +30,7 @@
返回值类型：
JSON数组，数组中每个元素表示下一级的子团体或学生id。数组中元素的数据结构可参考 [团体/学生信息](附录#团体/学生信息数据结构)。
JSON数组，数组中每个元素表示下一级的子团体或学生id。数组中元素的数据结构可参考 [团体/学生信息](附录#团体学生信息数据结构)。
# 查询课程包含的学习内容id列表
......@@ -77,8 +77,322 @@ JSON数组，数组中每个元素表示下一级的子团体或学生id。数
查询参数：
| 参数名 | 参数类型 | 参数含义 |
|-----|--------|---------|
| id | String | 课程或竞赛id |
返回值类型：
Map<String, List<ActivityResult>>对应的JSON，表示不同学习内容类型及相应的学习内容详细信息。ActivityResult的数据结构可参考4.3学习内容。
返回值包含了表示所含学习内容类型及相应的内容，其中学习内容类型可参考4.3.1节，相应学习内容的数据结构可参考4.3节。下面是一个返回值实例的缩略内容（此处仅展示data属性内容）。
```
{
"forum": [
{
"id": "7000",
"name": "答疑论坛"
}
],
"experiment": [
…
],
"homework": [
…
],
"experiment_homework": [
…
],
"homework_question": [
…
]
}
```
# 查询指定学习内容的详细信息
根据学习内容类型及ID查询详细的学习内容，如查询作业或考试包含哪些题目。
查询接口名：/query/activity/detail
查询参数：
| 参数名 | 参数类型 | 参数含义 |
|-------|---------------------------|-------------|
| param | Map<String, List<String>> | 指定内容类型及相应id |
返回值相关信息可参考[查询课程包含的学习内容详细情况]（#查询课程包含的学习内容详细情况）。若返回的学习内容个数小于查询参数里的查询个数，说明部分要查询的学习内容为空。
# 查询某作业题目指定学生集合的完成情况
查询接口名：/query/homework_question/detail
查询参数：
| 参数名 | 参数类型 | 参数含义 |
|----------|--------------|---------------------------------|
| id | String | 题目id |
| students | List<String> | 学生id（若为空则表示所有学生） |
| type | int | 查询类型（选填），详情可查看4.1学习活动与查询类型的对应关系 |
返回值类型：
Map<String, List<StatementResult>> 对应的JSON，表示学生及相应的题目完成情况。StatementResult的数据结构可参考4.4学习内容完成情况。
# 查询某竞赛题目指定学生集合的完成情况
查询接口名：/query/exam_question/detail
查询参数：
| 参数名 | 参数类型 | 参数含义 |
|----------|--------------|---------------------------------|
| id | String | 试题id |
| students | List<String> | 学生id（若为空则表示所有学生） |
| type | int | 查询类型（选填），详情可查看4.1学习活动与查询类型的对应关系 |
返回值类型：
Map<String, List<StatementResult>> 对应的JSON，表示学生及相应的题目完成情况。StatementResult的数据结构可参考4.4学习内容完成情况。
# 查询某作业指定学生集合的完成情况
查询接口名：/query/homework/detail
查询参数：
| 参数名 | 参数类型 | 参数含义 |
|----------|--------------|---------------------------------|
| id | String | 作业id |
| students | List<String> | 学生id（若为空则表示所有学生） |
| type | int | 查询类型（选填），详情可查看4.1学习活动与查询类型的对应关系 |
返回值类型：
Map<String, List<StatementResult>> 对应的JSON，表示学生及相应的作业完成情况。StatementResult的数据结构可参考4.4学习内容完成情况。
# 查询某竞赛指定学生集合的完成情况
查询接口名：/query/competition/detail
参数及返回值类型与[查询某作业指定学生集合的完成情况](#查询某作业指定学生集合的完成情况)的一致，也可直接使用[查询某作业指定学生集合的完成情况](#查询某作业指定学生集合的完成情况)查询作业的接口来查询竞赛的完成情况。
# 查询某场考试指定学生集合的完成情况
查询接口名：/query/exam/detail
查询参数：
| 参数名 | 参数类型 | 参数含义 |
|----------|--------------|---------------------------------|
| id | String | 考试id |
| students | List<String> | 学生id（若为空则表示所有学生） |
| type | int | 查询类型（选填），详情可查看4.1学习活动与查询类型的对应关系 |
返回值类型：
Map<String, List<StatementResult>> 对应的JSON，表示学生及相应考试完成情况。StatementResult的数据结构可参考4.4学习内容完成情况。
# 查询某在线实验步骤指定学生集合的完成情况
查询接口名：/query/experiment_procedure/detail
查询参数：
| 参数名 | 参数类型 | 参数含义 |
|----------|--------------|---------------------------------|
| id | String | 实验步骤id |
| students | List<String> | 学生id（若为空则表示所有学生） |
| type | int | 查询类型（选填），详情可查看4.1学习活动与查询类型的对应关系 |
返回值类型：
Map<String, List<StatementResult>> 对应的JSON，表示学生及相应实验完成情况。StatementResult的数据结构可参考4.4学习内容完成情况。
# 查询某在线实验指定学生集合的完成情况
查询接口名：/query/experiment/detail
查询参数：
| 参数名 | 参数类型 | 参数含义 |
|----------|--------------|---------------------------------|
| id | String | 实验id |
| students | List<String> | 学生id（若为空则表示所有学生） |
| type | int | 查询类型（选填），详情可查看4.1学习活动与查询类型的对应关系 |
返回值类型：
Map<String, List<StatementResult>> 对应的JSON，表示学生及相应实验完成情况。StatementResult的数据结构可参考4.4学习内容完成情况。
# 查询某在线实验作业指定学生集合的完成情况
查询接口名：/query/experiment_homework/detail
查询参数：
| 参数名 | 参数类型 | 参数含义 |
|----------|--------------|---------------------------------|
| id | String | 实验作业id |
| students | List<String> | 学生id（若为空则表示所有学生） |
| type | int | 查询类型（选填），详情可查看4.1学习活动与查询类型的对应关系 |
返回值类型：
Map<String, List<StatementResult>> 对应的JSON，表示学生及相应实验作业完成情况。StatementResult的数据结构可参考4.4学习内容完成情况。
# 查询某在线课堂视频指定学生的观看情况
查询接口名：/query/mooc_video/detail
查询参数：
| 参数名 | 参数类型 | 参数含义 |
|----------|--------------|---------------------------------|
| id | String | 在线课堂视频id |
| students | List<String> | 学生id（若为空则表示所有学生） |
| type | int | 查询类型（选填），详情可查看4.1学习活动与查询类型的对应关系 |
返回值类型：
Map<String, List<StatementResult>> 对应的JSON，表示学生及相应视频观看情况。StatementResult的数据结构可参考4.4学习内容完成情况。
# 查询某论坛主题指定学生集合的发帖情况
查询接口名：/query/forum_topic/detail
查询参数：
| 参数名 | 参数类型 | 参数含义 |
|----------|--------------|---------------------------------|
| id | String | 论坛id |
| students | List<String> | 学生id（若为空则表示所有学生） |
| type | int | 查询类型（选填），详情可查看4.1学习活动与查询类型的对应关系 |
返回值类型：
Map<String, List<StatementResult>> 对应的JSON，表示学生及相应论坛主题下发帖情况。StatementResult的数据结构可参考4.4学习内容完成情况。
# 查询某论坛指定学生集合的发帖情况
查询接口名：/query/forum/detail
查询参数：
| 参数名 | 参数类型 | 参数含义 |
|----------|--------------|---------------------------------|
| id | String | 论坛id |
| students | List<String> | 学生id（若为空则表示所有学生） |
| type | int | 查询类型（选填），详情可查看4.1学习活动与查询类型的对应关系 |
返回值类型：
Map<String, List<StatementResult>> 对应的JSON，表示学生及相应论坛发帖情况。StatementResult的数据结构可参考4.4学习内容完成情况。
# 查询某科研项目指定学生集合的使用情况
查询接口名：/query/research_project/detail
查询参数：
| 参数名 | 参数类型 | 参数含义 |
|----------|--------------|---------------------------------|
| id | String | 科研项目id |
| students | List<String> | 学生id（若为空则表示所有学生） |
| type | int | 查询类型（选填），详情可查看4.1学习活动与查询类型的对应关系 |
返回值类型：
Map<String, List<StatementResult>> 对应的JSON，表示学生及相应科研项目情况。StatementResult的数据结构可参考4.4学习内容完成情况。
# 查询指定学生集合某Git仓库代码提交情况
查询接口名：/query/git_repository/detail
查询参数：
| 参数名 | 参数类型 | 参数含义 |
|----------|--------------|---------------------------------|
| id | String | Git 仓库id |
| students | List<String> | 学生id（若为空则表示所有学生） |
| type | int | 查询类型（选填），详情可查看4.1学习活动与查询类型的对应关系 |
返回值类型：
Map<String, List<StatementResult>> 对应的JSON，表示学生及相应git项目代码提交情况。StatementResult的数据结构可参考4.4学习内容完成情况。
# 查询指定学生集合Git代码提交情况
查询接口名：/query/git_commit/detail
查询参数：
| 参数名 | 参数类型 | 参数含义 |
|----------|--------------|---------------------------------|
| id | String | Git commit标识 |
| students | List<String> | 学生id（若为空则表示所有学生） |
| type | int | 查询类型（选填），详情可查看4.1学习活动与查询类型的对应关系 |
返回值类型：
Map<String, List<StatementResult>> 对应的JSON，表示学生及相应git项目代码提交情况。StatementResult的数据结构可参考4.4学习内容完成情况。
# 查询指定学生集合的毕设完成情况
查询接口名：/query/graduation/detail
查询参数：
| 参数名 | 参数类型 | 参数含义 |
|----------|--------------|---------------------------------|
| id | String | 毕设标识 |
| students | List<String> | 学生id（若为空则表示所有学生） |
| type | int | 查询类型（选填），详情可查看4.1学习活动与查询类型的对应关系 |
返回值类型：
Map<String, List<StatementResult>> 对应的JSON，表示学生及相应毕设完成情况。StatementResult的数据结构可参考4.4学习内容完成情况。
# 查询指定学习内容集合里指定学生集合的完成情况
查询接口名：/query/activity_student/detail
查询参数：
| 参数名 | 参数类型 | 参数含义 |
|------------|--------------|---------------------------------|
| activities | List<String> | 学习内容的id集合 |
| students | List<String> | 学生id（若为空则表示所有学生） |
| type | int | 查询类型（选填），详情可查看4.1学习活动与查询类型的对应关系 |
返回值类型：
Map<String, Map<String, List<StatementResult>>> 对应的JSON，表示指定的每个学习活动中，某个学生的完成情况。StatementResult的数据结构可参考4.4学习内容完成情况。
# 学生附件下载
查询接口名：/attachment/download
查询参数：
| 参数名 | 参数类型 | 参数含义 |
|----------|--------|--------|
| id | String | |
| filename | String | 文件名 |
| checksum | String | 文件的校验和 |
返回值类型：
- 若权限验证失败：Authentication failed!
- 若文件不存在：File does not exist!
- 若服务器端处理出错：Internal error
- 若文件存在：
响应头：
Content-Disposition: attachment;fileName=${文件名}
Content-Length: ${文件大小}
Content-Type: application/octet-stream;charset=utf-8
响应内容则为文件内容
......