目录
党团学系统前后端接口文档
注意:此文档为内部资料,可能被爬虫利用,因此需要严格保密,不要泄露给非项目组成员。
1 登录模块
1.1 注册接口
此接口用于用户注册。
请求
路由示例: http://xxx/reg?name=20192213&pass=besti123456
方法:get
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
name | 字符串 | 学号 | 20192213 |
pass | 字符串 | 密码 | besti123456 |
响应
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
isok | 枚举 | 接口调用的状态码 | 1:成功,0:失败,-1:服务器内部错误 |
1.2 登录接口
此接口用于用户登录,并返回基础用户信息
请求
路由示例: http://xxx/log?name=20192213&pass=besti123456
方法:get
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
name | 字符串 | 学号 | 20192213 |
pass | 字符串 | 密码 | besti123456 |
响应
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
isok | 枚举 | 接口调用的状态码 | 1:成功,0:失败,-1:服务器内部错误 |
token | 字符串 | token | 一串加密码 |
data | 字典 | 用户信息,仅isok的值是1的时候有此字段,其余情况缺省 | 举例如下 |
当isok值为1时,data格式如下:
{
"username":"刘子谦",
"rt_time":"2014-05-04",
"phone":"18801***341",
"avatar_url":"头像链接",
"sfz":"3707*************X",
"status":"枚举类型,可选参数见备注", // 0:团员;1:积极分子;2:发展对象;3:预备党员;4:党员
"add_time":"2022-05-19 10:37"
}
1.3 Besti校园圈单点登录认证接口
此接口用于从Besti校园圈中进入平台
请求
路由示例: http://xxx/log/besti
方法:post
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
name | 字符串 | 学号 | 20192213 |
key | 字符串 | 秘钥 | *** |
响应(与普通登录方式相同)
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
isok | 枚举 | 接口调用的状态码 | 1:成功,0:失败,-1:服务器内部错误 |
token | 字符串 | token | 一串加密码 |
data | 字典 | 用户信息,仅isok的值是1的时候有此字段,其余情况缺省 | 举例如下 |
当isok值为1时,data格式如下:
{
"username":"刘子谦",
"rt_time":"2014-05-04",
"phone":"18801***341",
"avatar_url":"头像链接"
"add_time":"2022-05-19 10:37"
}
2 数据表单录入接口
本模块是核心功能之一,用于客户端、管理员端进行数据录入。
2.1 个人基本信息录入
请求
路由示例: http://xxx/add/base
方法:post
参数:
post的表单数据格式如下
{
"user":"20192213", # 数据录入者信息
"data":{
"name": "刘XX"
"rt_date": "2022-05-23", # 入团时间
"phone": "188010xxxxxx", # 手机号
"sex": "1", # 性别:1男;2女
"id_card":"3~~~520010~~~~~~~" # 身份证号
"avatar_url":"https://asdfsadfsaf" # 头像地址
"hometown":"北京丰台", # 籍贯
"dorm":"育才208"
}
}
响应
响应为一个字典
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
isok | 枚举 | 接口调用的状态码 | 1:成功,0:失败,-1:服务器内部错误 |
2.2 积极分子信息录入
请求
路由示例: http://xxx/add/jjfz
方法:post
参数:
post的表单数据格式如下
{
"user": "20192203", # 数据录入者
"data": {
"sq_date": "2022-05-28", # 入党申请书提交时间
"rec_num": "3", # 推荐的人数
"tot_num": "3", # 总人数
"link_man1": "3", # 联系人1名称
"link_man2": "3", # 联系人2名称
"ty_date": "2022-05-28", # 团支部推优时间
"zy_total": "3", # 专业年级总人数
"zc_score": "3", # 综测排名
"score": "3", # 平均成绩
"low70": "3", # 考试课低于70分门数
"low60": "3", # 考试课低于60分门数
"clean": "0", # 卫生不合格次数
"award_info": "3",# 获奖情况
"work_info": "3", # 任职情况
"activity_info": "3", # 参与活动情况
"volunteer_info": "3", # 志愿服务情况
"illegal_info": "3" # 违规违纪情况
}
}
响应
响应为一个字典
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
isok | 枚举 | 接口调用的状态码 | 1:成功,0:失败,-1:服务器内部错误 |
2.3 发展对象信息录入
请求
路由示例: http://xxx/add/fzdx
方法:post
参数:
post的表单数据格式如下
{
"user": "20192208",
"data": {
"zy_total": "28",
"fzp_rank1": "12",
"fzp_amount1_70": "0",
"fzp_amount1_60": "0",
"fzp_rank2": "0",
"fzp_amount2_70": "0",
"fzp_amount2_60": "0",
"fzp_clean": "0",
"fzp_award": "无",
"fzp_job": "无",
"fzp_activity": "无",
"fzp_volunteer": "无",
"fzp_violation": "无",
"fzp_intro1": "介绍人1",
"fzp_intro2": "介绍人2",
"fzp_vote":"25", // 得票数
"fzp_total":"28" // 参与投票的总人数
}
}
具体字段名含义请查看数据库设计,从本接口开始,前端做到与数据库的字段名统一。
发展对象个人信息表
表名: develop_person
fzp_id 学号fzp_rank1 近一学期综测排名
fzp_amount1_70 近一学期考试课低于70分门数
fzp_amount1_60 近一学期所有课程不及格门数fzp_rank2 近第二学期综测排名
fzp_amount2_70 近第二学期考试课低于70分门数
fzp_amount2_60 近第二学期所有课程不及格门数fzp_award 获奖情况
fzp_job 任职情况
fzp_volunteer 公益活动情况fzp_clean 近一年卫生情况(不合格次数)
fzp_violation 其他违规情况add_time 添加时间,设置默认值为now()
响应
响应为一个字典
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
isok | 枚举 | 接口调用的状态码 | 1:成功,0:失败,-1:服务器内部错误 |
3 单个字段的修改接口
本接口用于修改单个字段的信息
3.1 学生信息修改
本接口支持修改大部分的个人信息
请求
路由示例: http://xxx/change
方法:post
参数:
post的表单数据格式如下
# 把20192213的名字改成:刘子谦
{
"user":"20192213", # 数据录入者信息
"data":{
"key":"name", # 要修改的字段名,比如此处是学生姓名
"value":"刘子谦" # 要修改为的值
}
}
响应
响应为一个字典
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
isok | 枚举 | 接口调用的状态码 | 1:成功,0:失败,-1:服务器内部错误 |
4 管理员端接口
4.1 管理员登录接口
请求
路由示例: http://xxx/admin/login
方法:post
参数:
post的表单数据格式如下
{
"admin":"管理员名",
"password":"管理员密码"
}
响应
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
isok | 枚举 | 接口调用的状态码 | 1:成功,0:失败,-1:服务器内部错误 |
token | 字符串 | token | 一串加密码 |
4.2 学生基本信息
4.2.1 分页获取学生基本信息表接口
此接口支持分页查询,按照学号升序
请求
路由示例: http://xxx/admin/table/userInfo?page=1&istotal=0
方法:get
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
page | int | 页码,默认每页30条数据 | 1 |
istotal | 枚举 | 可以缺省,默认为0,是否获取全部数据 | 0 |
响应
- 当istotal == 0 时:返回当前页的30条数据。
- 当istotal == 1 时:返回全部数据。
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
isok | 枚举 | 接口调用的状态码 | 1:成功,0:失败,-1:服务器内部错误 |
total_num | 整形 | 总共有多少条数据 | 10000 |
data | 列表 | 数据二维列表 | 列表格式见下 |
data举例:
[
# 学号;姓名;性别;手机号;身份证号;宿舍;籍贯;入团时间
["20192213","刘子谦","男","188******41","370********4001X","育才208","山东高密","2014-05-04"],
["20192220","李昱霖","男","188******41","370********4001X","育才208","重庆","2014-05-04"],
]
4.2.2 删除某个学生基本信息的接口
请求
路由示例: http://xxx/admin/table/userInfo/delete?id=20192213
方法:get
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
id | 字符串 | 要删除的学号 | 20192213 |
响应
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
isok | 枚举 | 接口调用的状态码 | 1:成功,0:失败,-1:服务器内部错误 |
4.2.3 修改某个学生基本信息的接口
请求
路由示例: http://xxx/admin/table/userInfo/alter
方法:post
参数:
post的表单数据格式如下
{
"user":"20192213", # 要修改人的信息
"data":{
"name": "刘XX"
"rt_date": "2022-05-23", # 入团时间
"phone": "188010xxxxxx", # 手机号
"sex": "1", # 性别:1男;2女
"id_card":"3~~~520010~~~~~~~", # 身份证号
"hometown":"北京丰台", # 籍贯
"dorm":"育才208"
}
}
响应
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
isok | 枚举 | 接口调用的状态码 | 1:成功,0:失败,-1:服务器内部错误 |
4.3 获取全部信息接口
此接口用于获取学生全部信息,前端将数据导出
请求
路由示例: http://xxx/admin/final
方法:get
参数:
此接口没有入参
响应
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
data | 列表 | 数据二维列表 | 列表格式见下 |
data举例:
[
["学号","姓名", "入团时间","籍贯","宿舍","性别","身份证","联系电话","积极分子批次","联系人1","联系人2","积极分子支委会确定时间","积极分子支部大会确定时间","积极分子公示起始时间","积极分子公示结束时间","积极分子上报党委时间","积极分子党委备案批复时间","积极分子总支委会时间","积极分子批次信息填报时间","发展对象批次","介绍人1","介绍人2","发展对象支委会确定时间","发展对象支部大会确定时间","发展对象公示起始时间","发展对象公示结束时间","发展对象上报党委时间","发展对象党委备案批复时间","发展对象总支委会时间", "集中培训开始时间","集中培训结束时间","发展对象批次信息填报时间","预备党员批次","入党志愿书提交时间","第一次谈话人","第一次谈话时间","第二次谈话人","第二次谈话时间","预备党员转正大会时间","预备党员上报大会时间","预备党员党支部大会讨论时间", "预备党员院党委审批时间","政治生日","预备党员批次信息填报时间","正式党员批次","正式党员批次信息填报时间"]
]
4.4 分组编辑
4.4.1 积极分子组
4.4.1.1 新增积极分子组
请求
路由示例: http://xxx/admin/group/jjfz/add
方法:post
参数:
post的表单数据格式如下
{
"user": "默认管理员",
"data": {
"jjg_zwh_time": "",
"jjg_zbdh_time": "",
"jjg_gs_time1": "",
"jjg_gs_time2": "",
"jjg_sbdw_time": "",
"jjg_dw_time": "",
"jjg_zzwh_time": "",
"student_list": "20192213;20192222" // 需要关联的学号名单,用分号隔开。
}
}
响应
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
isok | 枚举 | 接口调用的状态码 | 1:成功,0:失败,-1:服务器内部错误 |
4.4.1.2 分页获取积极分子组信息表接口
此接口支持分页查询,按照组号升序
请求
路由示例: http://xxx/admin/group/jjfz/info?page=1&istotal=0
方法:get
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
page | int | 页码,默认每页30条数据 | 1 |
istotal | 枚举 | 可以缺省,默认为0,是否获取全部数据 | 0 |
响应
- 当istotal == 0 时:返回当前页的30条数据。
- 当istotal == 1 时:返回全部数据。
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
isok | 枚举 | 接口调用的状态码 | 1:成功,0:失败,-1:服务器内部错误 |
total_num | 整形 | 总共有多少条数据 | 10000 |
data | 列表 | 数据二维列表 | 列表格式见下 |
data举例:
[
# 组号;支委会确定时间;支部大会确定时间;公示开始时间;公示结束时间;上报党委时间;总支委会的时间
["组号", "支委会确定时间", "支部大会确定时间", "公示开始时间", "公示结束时间", "上报党委时间","党委备案批复时间", "总支委会的时间"]
]
4.4.1.3 获取积极分子组成员表接口
此接口支持分页查询,按照组号升序
请求
路由示例: http://xxx/admin/group/jjfz/member?id=1
方法:get
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
id | int | 积极分子组的组号 | 1 |
响应
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
isok | 枚举 | 接口调用的状态码 | 1:成功,0:失败,-1:服务器内部错误 |
data | 列表 | 数据二维列表 | 列表格式见下 |
data举例:
[
# 学号;姓名;手机号;
["20192213","刘子谦","18806662235"]
]
4.4.2 发展对象组
4.4.1.1 新增发展对象组
请求
路由示例: http://xxx/admin/group/fzdx/add
方法:post
参数:
post的表单数据格式如下
{
"user": "默认管理员",
"data": {
"fzg_zwh_time": "",
"fzg_zbdh_time": "",
"fzg_gs_time1": "",
"fzg_gs_time2": "",
"fzg_sbdw_time": "",
"fzg_dw_time": "",
"fzg_zzwh_time": "",
"fzg_jjpxks_time": "",
"fzg_jjpxjs_time": "",
"student_list": "20192213;20192222" // 需要关联的学号名单,用分号隔开。
}
}
响应
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
isok | 枚举 | 接口调用的状态码 | 1:成功,0:失败,-1:服务器内部错误 |
4.4.1.2 分页获取发展对象组信息表接口
此接口支持分页查询,按照组号升序
请求
路由示例: http://xxx/admin/group/fzdx/info?page=1&istotal=0
方法:get
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
page | int | 页码,默认每页30条数据 | 1 |
istotal | 枚举 | 可以缺省,默认为0,是否获取全部数据 | 0 |
响应
- 当istotal == 0 时:返回当前页的30条数据。
- 当istotal == 1 时:返回全部数据。
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
isok | 枚举 | 接口调用的状态码 | 1:成功,0:失败,-1:服务器内部错误 |
total_num | 整形 | 总共有多少条数据 | 10000 |
data | 列表 | 数据二维列表 | 列表格式见下 |
data举例:
[
# 组号;支委会确定时间;支部大会确定时间;公示开始时间;公示结束时间;上报党委时间;党委备案批复时间;总支委会的时间;集中培训开始时间;集中培训结束时间;
["组号", "支委会确定时间", "支部大会确定时间", "公示开始时间", "公示结束时间", "上报党委时间","党委备案批复时间" "总支委会的时间", "集中培训开始时间", "集中培训结束时间"]
]
4.4.1.3 获取发展对象组成员表接口
此接口支持分页查询,按照组号升序
请求
路由示例: http://xxx/admin/group/fzdx/member?id=1
方法:get
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
id | int | 发展对象组的组号 | 1 |
响应
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
isok | 枚举 | 接口调用的状态码 | 1:成功,0:失败,-1:服务器内部错误 |
data | 列表 | 数据二维列表 | 列表格式见下 |
data举例:
[
# 学号;姓名;手机号;
["20192213","刘子谦","18806662235"]
]
4.4.3 预备党员组
4.4.3.1 新增预备党员组
请求
路由示例: http://xxx/admin/group/ybdy/add
方法:post
参数:
post的表单数据格式如下
{
"user": "默认管理员",
"data": {
"ybg_pc": "",
"ybg_zhdh": "",
"ybg_sbdw": "",
"ybg_dzbdh": "",
"ybg_ydwsp": "",
"bir_day":"",
"student_list": "20192213;20192222" // 需要关联的学号名单,用分号隔开。
}
}
响应
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
isok | 枚举 | 接口调用的状态码 | 1:成功,0:失败,-1:服务器内部错误 |
4.4.3.2 分页获取预备党员组信息表接口
此接口支持分页查询,按照组号升序
请求
路由示例: http://xxx/admin/group/ybdy/info?page=1&istotal=0
方法:get
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
page | int | 页码,默认每页30条数据 | 1 |
istotal | 枚举 | 可以缺省,默认为0,是否获取全部数据 | 0 |
响应
- 当istotal == 0 时:返回当前页的30条数据。
- 当istotal == 1 时:返回全部数据。
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
isok | 枚举 | 接口调用的状态码 | 1:成功,0:失败,-1:服务器内部错误 |
total_num | 整形 | 总共有多少条数据 | 10000 |
data | 列表 | 数据二维列表 | 列表格式见下 |
data举例:
[
# 批次;转正大会时间;上报党委时间;党支部大会讨论时间;院党委审批时间;政治生日;
[“批次”,“转正大会时间”,“上报党委时间”,“党支部大会讨论时间”,“院党委审批时间”,“政治生日”]
]
4.4.3.3 获取预备党员组成员表接口
此接口支持分页查询,按照组号升序
请求
路由示例: http://xxx/admin/group/ybdy/member?id=1
方法:get
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
id | int | 预备党员组的组号 | 1 |
响应
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
isok | 枚举 | 接口调用的状态码 | 1:成功,0:失败,-1:服务器内部错误 |
data | 列表 | 数据二维列表 | 列表格式见下 |
data举例:
[
# 学号;姓名;手机号;
["20192213","刘子谦","18806662235"]
]
4.4.4 党员组
4.4.3.1 新增党员组
请求
路由示例: http://xxx/admin/group/zsdy/add
方法:post
参数:
post的表单数据格式如下
{
"user": "默认管理员",
"data": {
"student_list": "20192213;20192222" // 需要关联的学号名单,用分号隔开。
}
}
响应
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
isok | 枚举 | 接口调用的状态码 | 1:成功,0:失败,-1:服务器内部错误 |
4.4.4.2 分页获取党员组信息表接口
此接口支持分页查询,按照组号升序
请求
路由示例: http://xxx/admin/group/zsdy/info?page=1&istotal=0
方法:get
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
page | int | 页码,默认每页30条数据 | 1 |
istotal | 枚举 | 可以缺省,默认为0,是否获取全部数据 | 0 |
响应
- 当istotal == 0 时:返回当前页的30条数据。
- 当istotal == 1 时:返回全部数据。
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
isok | 枚举 | 接口调用的状态码 | 1:成功,0:失败,-1:服务器内部错误 |
total_num | 整形 | 总共有多少条数据 | 10000 |
data | 列表 | 数据二维列表 | 列表格式见下 |
data举例:
[
[“批次”,“添加时间”]
]
4.4.4.3 获取党员组成员表接口
此接口支持分页查询,按照组号升序
请求
路由示例: http://xxx/admin/group/zsdy/member?id=1
方法:get
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
id | int | 党员组的组号 | 1 |
响应
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
isok | 枚举 | 接口调用的状态码 | 1:成功,0:失败,-1:服务器内部错误 |
data | 列表 | 数据二维列表 | 列表格式见下 |
data举例:
[
# 学号;姓名;手机号;
["20192213","刘子谦","18806662235"]
]
5 其他接口
5.1 静态资源获取接口
此接口用于根据type获取静态资源
请求
路由示例: http://xxx/getstatic?type=swiper
方法:get
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
type | 字符串 | 要检索的资源类型 | type |
响应
参数:
字段名 | 格式 | 说明 | 举例 |
---|---|---|---|
isok | 枚举 | 接口调用的状态码 | 1:成功,0:失败,-1:服务器内部错误 |
data | json数组 | 数组内嵌套字典 | 格式如下 |
data格式举例:
[
{
"a":"xxx",
"b": "xxx",
"c": "xxx",
"d": "xxx",
"e": "xxx"
},{
"a":"xxx",
"b": "xxx",
"c": "xxx",
"d": "xxx",
"e": "xxx"
}
]