[关闭]
@xuduochoua 2016-12-21T01:37:00.000000Z 字数 6900 阅读 1883

两个责任接口文档

2016年12月14日
廉政 接口文档

说明

  1. base_url:http://ip:port/api, 一个请求的组成应是base_url + 接口地址 +参数
  2. 暂时不考虑token等验证
  3. 理应所有的请求为post
  4. 本项目返回的数据类型为json，形如
  1. {
  2.     code:0,//0表示成功
  3.     message:'这是不成功的提示信息',
  4.     data:....
  5. }

一、系统相关

1、登陆

接口地址
POST /login
路径参数
无
请求参数

参数 数据类型 必填 参数说明
username String 用户名
password String 密码

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:{//暂时是举个栗子, 登陆成功应返回用户信息 和 工作台信息
  5.         user:{
  6.              id:12,//用户id
  7.              username:'test',
  8.              deptId:32,
  9.              deptName:'经开区'
  10.         },
  11.         workbench:{//工作台待办事项
  12.             num1:10,//待签收
  13.             num2:20，//待填报
  14.             num3:30//待初审
  15.             num4:10//待终审
  16.         }
  18.     }
  20. }

二、签收填报

2、主题签收列表

接口地址
POST /theme
路径参数
无
请求参数

参数 数据类型 必填 参数说明
id int 用户id//此处未加token 凑合着先传入用户id吧

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:[
  5.         {
  6.             id:10,主题id
  7.             name:"镇纪委落实党风廉政建设监督责任",//主题名称
  8.             type:1,//主题包类型 1-xx 2-yy
  9.             status:0,//签收状态 0 -未签收 1-已签收
  10.             year：2016,//主题年度
  11.             score:20//分值
  12.         },
  13.         ...
  14.     ]
  16. }

3、主题签收

接口地址
POST /theme/sign
路径参数
无
请求参数

参数 数据类型 必填 参数说明
userId int 用户id
id int 主题id

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:null
  6. }

4、主题包详情

接口地址
GET /theme/{id}
路径参数
id：主题包id
请求参数

无

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data: {
  5.             id:10,主题id
  6.             name:"镇纪委落实党风廉政建设监督责任",//主题名称
  7.             type:1,//主题包类型 1-xx 2-yy
  8.             status:0,//签收状态 0 -未签收 1-已签收
  9.             year：2016,//主题年度
  10.             score:20//分值
  11.             norms:{//清单列表
  12.                 //.....
  13.             }
  14.     }
  15. }

5、清单填报

接口地址
POST /theme/norm/{id}
路径参数
id : 清单id

请求参数

参数 数据类型 必填 参数说明
id int 用户id
title String 填报标题
title2 String 填报副标题
content String 填报正文
attachmentIds String 附件id 上传附件之后返回的id，形如1,2,3

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data: {//成功则此处返回此清单的填报想去
  5.     }
  6. }

6、查看清单填报详情

接口地址
GET /theme/norm/{id}
路径参数
id：清单id
请求参数
参数|数据类型|必填|参数说明
---|-------|----|-----
无

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data: {
  5.             id:10,清单id
  6.             name:"开展农村基层党员",//清单名称
  7.             year：2016,//主题年度
  8.             score:20//分值
  9.             attachments:[{//附件列表
  10.                 //.....
  11.             },...],
  12.             content:{...},//填报正文内容
  13.             views:{}//初审终审意见
  17.     }
  18. }

三、初审终审

7、初审列表

接口地址
GET /verify
路径参数
无
请求参数

参数 数据类型 必填 参数说明
name String 主题包名称
status int 状态
deptName String 执行部门名称

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data: {
  5.             id:10,//主题id
  6.             name:"建设监督责任检查考核指标",//主题名称
  7.             .....
  8.     }
  9. }

8、清单初审

接口地址
POST /verify/{id}
路径参数
id ： 清单id
请求参数

参数 数据类型 必填 参数说明
suggestion String 初审意见
score int 分数
status int 是否通过

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data: null
  5. }

9、清单初审撤回

接口地址
POST /verify/back/{id}
路径参数
id ： 清单id
请求参数
参数|数据类型|必填|参数说明
---|-------|----|-----
无

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data: null
  5. }

10、终审列表

接口地址
GET /reverify
路径参数
无
请求参数

参数 数据类型 必填 参数说明
name String 主题包名称
status int 状态
deptName String 执行部门名称

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data: {
  5.             id:10,//主题id
  6.             name:"建设监督责任检查考核指标",//主题名称
  7.             .....
  8.     }
  9. }

11、清单终审

接口地址
POST /reverify/{id}
路径参数
id ： 清单id
请求参数

参数 数据类型 必填 参数说明
suggestion String 终审意见
score int 分数
status int 是否通过

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data: null
  5. }

12、清单终审撤回

接口地址
POST /reverify/back/{id}
路径参数
id ： 清单id
请求参数

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data: null
  5. }

四、催办督办

12 待催办督办主题列表

接口地址
GET /reminders
路径参数
无
请求参数

参数 数据类型 必填 参数说明
userId int 当前用户id

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:[
  5.         {
  6.             id:10,
  7.             name:"主题名称",
  8.           ...
  9.         }
  10.     ]
  11. }

13 催办督办列表

接口地址
GET /reminder/mine
路径参数
无
请求参数

参数 数据类型 必填 参数说明
userId int 当前用户id
type int 0-已发出的 1-已接受的 默认 0

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:[
  5.         {
  6.             id:10,
  7.             type:2//催办||督办
  8.             title:"赶紧办理",
  9.             reDeptName:"县林业局纪委",
  10.             normName:"开会议专题研究党风廉政建设工作（不含案件分析会）"
  11.             sendtime:"2016-11-11",
  12.             status:1,
  13.             ...
  14.         }
  15.     ]
  16. }

14 催办督办详情

接口地址
GET /reminder/mine/{id}
路径参数
id：催办督办id
请求参数

参数 数据类型 必填 参数说明
type int 1-催办 2-督办

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:[
  5.         {
  6.             id:10,
  7.             type:2//催办||督办
  8.             title:"赶紧办理",
  9.             reDeptName:"县林业局纪委",
  10.             normName:"开会议专题研究党风廉政建设工作（不含案件分析会）"
  11.             sendtime:"2016-11-11",
  12.             status:1,
  13.             ...
  14.         }
  15.     ]
  16. }

15 发出催办督办

接口地址
POST /reminder/{id}/send
路径参数
id：主题id
请求参数

参数 数据类型 必填 参数说明
userId int 用户id
type int 1-催办 2-督办
content String 内容

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:null
  5. }

16 接收催办督办

接口地址
POST /reminder/{id}/accept
路径参数
id：催办督办id
请求参数

参数 数据类型 必填 参数说明
userId int 用户id

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:null
  5. }

五、预警信息

17 预警列表

接口地址
GET /warning
路径参数
无
请求参数

参数 数据类型 必填 参数说明
userId int 当前用户id

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:[
  5.         {
  6.             id:10,
  7.             level:2,
  8.             opt:"填报",
  9.             desc:"索排查活动(6)超过完成截止时间6天未填报",
  10.             detpName:"惠阳区纪委"
  11.             time:"2016-11-11",
  12.             status:1,
  13.             score:10
  14.             ...
  15.         }
  16.     ]
  17. }

六、通知公告

18 通知公告列表

接口地址
GET /notice
路径参数
无
请求参数
无
响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:[
  5.         {
  6.             id:10,
  7.             status0,
  8.             title:"关于修改考核指标的说明"，
  9.             createTime:"2016-12-12"
  10.         }
  11.     ]
  12. }

19、通知公告详情

接口地址
GET /notice/{id}
路径参数
id:公告id
请求参数
无
响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:[
  5.         {
  6.             id:10,
  7.             status0,
  8.             title:"关于修改考核指标的说明"，
  9.             createTime:"2016-12-12"，
  10.             content:"内容"
  11.         }
  12.     ]
  13. }

20、上传附件

接口地址
POST /upfile
路径参数
无
请求参数

参数 数据类型 必填 参数说明
userId int 当前用户id
normId int 清单id
upfile File 附件
type int 类型
desc String 描述

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:10//附件id

七、综合查询

21 查询履责部门覆盖情况

接口地址
GET /query/dept
路径参数
无
请求参数

参数 数据类型 必填 参数说明
userId int 当前用户id

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:[
  5.         {
  6.             id:10,
  7.             ....
  8.         }
  9.     ]
  10. }

22 查询履责部门领导的责任层级

接口地址
GET /query/leader
路径参数
无
请求参数

参数 数据类型 必填 参数说明
userId int 当前用户id

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:[
  5.         {
  6.             id:10,
  7.             ....
  8.         }
  9.     ]
  10. }

23 清单库责任清单数据查询

接口地址
GET /query/norm
路径参数
无
请求参数

参数 数据类型 必填 参数说明
userId int 当前用户id

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:[
  5.         {
  6.             id:10,
  7.             ....
  8.         }
  9.     ]
  10. }

24 查询“两个责任”工作部署情况

接口地址
GET /query/theme
路径参数
无
请求参数

参数 数据类型 必填 参数说明
userId int 当前用户id

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:[
  5.         {
  6.             id:10,
  7.             ....
  8.         }
  9.     ]
  10. }

25 查询履责部门“两个责任”工作受理情况

接口地址
GET /query/accept
路径参数
无
请求参数

参数 数据类型 必填 参数说明
userId int 当前用户id

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:[
  5.         {
  6.             id:10,
  7.             ....
  8.         }
  9.     ]
  10. }

26 查询履责部门清单填报情况

接口地址
GET /query/fill
路径参数
无
请求参数

参数 数据类型 必填 参数说明
userId int 当前用户id

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:[
  5.         {
  6.             id:10,
  7.             ....
  8.         }
  9.     ]
  10. }

27 查询履责部门清单前置监督执行情况

接口地址
GET /query/execute
路径参数
无
请求参数

参数 数据类型 必填 参数说明
userId int 当前用户id

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:[
  5.         {
  6.             id:10,
  7.             ....
  8.         }
  9.     ]
  10. }

28 查询履责部门清单执行终审监督情况

接口地址
GET /query/reverify
路径参数
无
请求参数

参数 数据类型 必填 参数说明
userId int 当前用户id

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:[
  5.         {
  6.             id:10,
  7.             ....
  8.         }
  9.     ]
  10. }

29 查询履责部门清单执行过程中清单预警情况

接口地址
GET /query/warning
路径参数
无
请求参数

参数 数据类型 必填 参数说明
userId int 当前用户id

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:[
  5.         {
  6.             id:10,
  7.             ....
  8.         }
  9.     ]
  10. }

30 查询履责部门落实“两个责任”工作督办请况

接口地址
GET /query/supervise
路径参数
无
请求参数

参数 数据类型 必填 参数说明
userId int 当前用户id

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:[
  5.         {
  6.             id:10,
  7.             ....
  8.         }
  9.     ]
  10. }

31 查询履责部门“两个责任”工作考核情况

接口地址
GET /query/examine
路径参数
无
请求参数

参数 数据类型 必填 参数说明
userId int 当前用户id

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:[
  5.         {
  6.             id:10,
  7.             ....
  8.         }
  9.     ]
  10. }

32 查询履责部门问责追究情况

接口地址
GET /query/investigate
路径参数
无
请求参数

参数 数据类型 必填 参数说明
userId int 当前用户id

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:[
  5.         {
  6.             id:10,
  7.             ....
  8.         }
  9.     ]
  10. }

八、汇总统计

33 履责部门单一清单完结情况比较统计

接口地址
GET /statistics/norm
路径参数
无
请求参数

参数 数据类型 必填 参数说明
userId int 当前用户id

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:[
  5.         {
  6.             id:10,
  7.             ....
  8.         }
  9.     ]
  10. }

34 履责部门单一主题包得分情况对比统计

接口地址
GET /statistics/theme/single
路径参数
无
请求参数

参数 数据类型 必填 参数说明
userId int 当前用户id

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:[
  5.         {
  6.             id:10,
  7.             ....
  8.         }
  9.     ]
  10. }

35 履责部门多个主题包合并考核统计

接口地址
GET /statistics/theme/multiple
路径参数
无
请求参数

参数 数据类型 必填 参数说明
userId int 当前用户id

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:[
  5.         {
  6.             id:10,
  7.             ....
  8.         }
  9.     ]
  10. }

36 不同单一主题包同一级别实时得分统计

接口地址
GET /statistics/theme/level
路径参数
无
请求参数

参数 数据类型 必填 参数说明
userId int 当前用户id

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:[
  5.         {
  6.             id:10,
  7.             ....
  8.         }
  9.     ]
  10. }

36 日常报表统计

接口地址
GET /statistics/daily
路径参数
无
请求参数

参数 数据类型 必填 参数说明
userId int 当前用户id

响应结果

  1. {
  2.     code: 0, //0 - 接口调用成功，其他值表示失败
  3.     message: "",
  4.     data:[
  5.         {
  6.             id:10,
  7.             ....
  8.         }
  9.     ]
  10. }
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注