工程认证平台-毕业要求管理优化 API List

EEAP

• 以下 API 的方法名都是默认的，如果有方法名重复或者其他不恰当的情况，请更换其他适当的方法名，但是请及时反馈更改后的方法名，保持前后台一致；
• 返回数据格式也只是伪代码意义上的一种展示，主要提供一些数据结构上的要求；
• 有些方法系统应该原先就提供了 API，可以参考，修改某个原有方法之前，应当全局搜索一下该函数的被调用处，以免影响了其他的调用处；
• 当前需要的 API暂时这么多，后续有需要还会陆续添加；

1. 获取当前专业年级专业毕业要求列表, 对应查看专业毕业要求页面

• 方法名： get_major_reqs_list()
• 参数： 无
• 返回数据格式：数组中的每个专业毕业要求对象需要按照后台数据库表的排序字段排序后传回

[   
    global_desc: 总的描述,
    major_reqs: {
        毕业要求id,
        毕业要求名称,
    },
    ...
]

2. 获取专业毕业要求详情, 对应点击某个专业毕业要求，查看专业毕业要求详情页面

• 方法名： get_major_req_detail()
• 参数： reqid
• 返回数据格式：指标点数组中的每个指标点对象需要按照后台数据库表的排序字段排序后传回

{
    毕业要求id,
    毕业要求名称,
    毕业要求描述,
    points: [
        指标点id,
        指标点名称,
    ],
    asso_reqs: [
        协会毕业要求id
        ...     
    ]
}

3. 获取指标点详情，对应点击某个指标点，查看指标点下的课程及权重页面

• 方法名： get_target_point_detail()
• 参数： pointid
• 返回数据格式：

{
    指标点id,
    指标点名称,
    指标点描述,
    courses: [
        {
            课程id,
            课程类型,
            课程名称,
            权重,
        },
        ...
    ]
}

4. 获取当前专业年级所有专业毕业要求和指标点的详细信息，对应安排指标点中的编辑页面

• 方法名： get_all_reqs_and_points()
• 参数：
• 返回数据格式：

{
    reqs: [
        {
            专业毕业要求id，
            专业毕业要求名称，
            专业毕业要求描述，
            points: [
                {
                    指标点id，
                    指标点名称，
                    指标点描述，
                }
                ...
            ]
        }
        ...
    ]
}

5. 获取当前专业年级所有的课程列表，考虑到复合课程，即获取的是所有非关联的基本课程和所有复合课程，对应到安排指标点页面

• 方法名： get_courses_brief()
• 参数：
• 返回数据格式：

{
    courses: [
        {
            课程id，
            课程类型，
            课程名称
        }
        ...
    ]
}

6. 获取某个课程下面已经安排指标点的信息，即安排指标点点击某个课程展开的页面

• 方法名： get_course_target_points()
• 参数： courseid, course_type
• 返回数据格式：

{
    课程id，
    课程类型，
    课程名称，
    points：[
        {
            指标点id
        } 
        ...
    ]
}

7. 获取当前专业年级所有基本课程列表，即考核管理下的试卷管理页面和成绩管理页面

• 方法名： get_base_courses_list()
• 参数：
• 返回数据格式：

{
    courses: [
        {
            课程id(id)，
            课程名称(name),
            考核总数(examine_count),
        }
        ...
    ]
}

8. 获取某个课程的试卷详细信息，即考核管理下的试卷管理点击某个课程的展开页面

• 方法名： get_course_testpapers_brief()
• 参数： courseid
• 返回数据格式： 最后一列操作列可以在前端处理

{
    'kps': [
        {
            知识点id,
            知识点名称，
            知识点描述
        }
        ...
    ]
    testpapers: [
        {
            试卷id，
            试卷名称，
            创建教师，
            创建时间，
            状态，
        }
        ...
    ]
}

9. 获取某个试卷的详细信息，即试卷管理下查看或编辑的页面

• 方法名： get_testpaper_detail()
• 参数： testpaperid
• 返回数据格式： 最后一列操作列可以在前端处理

{
    试卷id，
    试卷名称，
    examques：[
        {
            考题id，
            考题序号，
            考题名称，
            考题分数，
            考题描述，
            kps: [
                所有已经选择的知识点id
            ]，
            reqs: [
                {
                    专业毕业要求id，
                    专业毕业要求名称，
                    专业毕业要求描述，
                    points: [
                        {
                            指标点id，
                            指标点名称，
                            指标点描述，
                            权重
                        }
                        ...
                    ]
                },
                ...
            ]
        }
    ]
}

10. 获取某个课程的考核详细信息，即考核管理下的成绩管理点击某个课程的展开页面

• 方法名： get_course_examines_brief()
• 参数： courseid
• 返回数据格式： 最后一列操作列可以在前端处理

{
    'kps': [
        {
            知识点id,
            知识点名称，
            知识点描述
        }
        ...
    ]
    examines: [
        {
            考核id，
            考核名称，
            上传教师，
            上传时间，
            是否补考，
            考核类型，
            学期名称，
            testpapers: [
                {
                    试卷id(id)，
                    试卷名称(name)，
                    创建教师(creator)，
                    创建时间(create_time)，
                },
                ...
            ]
        }
        ...
    ]
}

11. 获取某个考核的详细信息，即成绩管理下查看或编辑的页面

• 方法名： get_examine_detail()
• 参数： examineid
• 返回数据格式： 最后一列操作列可以在前端处理

{
    考核id，
    考核名称，
    考核类型，
    学期，
    examques：[
        {
            考题id，
            考题序号，
            考题名称，
            考题分数，
            考题描述，
            kps: [
                所有已经选择的知识点id
            ]，
            reqs: [
                {
                    专业毕业要求id，
                    专业毕业要求名称，
                    专业毕业要求描述，
                    points: [
                        {
                            指标点id，
                            指标点名称，
                            指标点描述，
                            权重
                        }
                        ...
                    ]
                },
                ...
            ]
        }
    ]
   'majorreqs': {
        number,     //合并单元行数
        id,
        name,
        description,
        points:[
            {
                id,
                name,
                description,
                weight,
                average_score,
                ques_score,
                value
            }
        ]
    }
}

12. 获取当前专业年级下所有的自然班列表，即班级管理页面

• 方法名： get_rawclasses_list()
• 参数：
• 返回数据格式：

{
    rawclasses: [
        {
            班级id，
            班级名称，
            专业名称，
            学年，
            人数，
        }
        ...
    ]
}

13. 获取某个自然班的学生信息以及勾选情况，对应班级管理页面点击某个班级进入的页面

• 方法名： get_rawclass_students()
• 参数： rawclassid
• 返回数据格式：

{
    班级id，
    班级名称，
    students：[
        {
            学号，
            姓名，
            是否参与计算
        }
        ...
    ]
}

14. 获取某个课程下面所有的样本列表，对应样本管理点击某个课程展开的页面

• 方法名： get_course_samples()
• 参数： courseid
• 返回数据格式：

{
    samples: [
        {
            班级id，
            班级名称，
            人数，
            总平均分，
            是否勾线参与计算，
        }
        ...
    ]
}

15. 获取当前专业年级所有协会毕业要求列表，不对应任何页面，仅供前台处理使用

• 方法名： get_asso_reqs()
• 参数：
• 返回数据格式： 这个可以直接对bk2_local_req_assoreq这个表执行select *查询

{
    list: [
        {
            id,
            indexs,
            name,
            description
        }
    ]
}

作者： Tony日期： 2017.4.20