patrol-app_1.0.2.api 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299
  1. /**
  2. * @api {post} /v1/temporary/task/add 01.添加临时任务
  3. * @apiName 添加临时任务
  4. * @apiGroup 临时任务
  5. * @apiVersion 1.0.2
  6. * @apiHeader {String = application/json} Content-Type = application/json
  7. * @apiHeader {String} Authorization = eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3V1aWQiOjQzMTI2MzMxODcxMjE5NzEyLCJuYmYiOjE2NDkzMDQ1ODZ9.FvG8hY0R6D9lO1t4GR1bDhQVayGU5gHVCcy0SIX1r0c 授权信息
  8. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  9. * @apiBody { String { 0..255 } } title 任务标题
  10. * @apiBody { Long } roomId 房间id
  11. * @apiBody { String } belongSystem 所属系统
  12. * @apiBody { Integer } type 任务类型 1:一般任务 2: 较急任务 3:紧急任务
  13. * @apiBody { String { 0..255 } } content 任务内容
  14. * @apiBody { Long[] } executors 执行人列表
  15. * @apiBody { Date } finishTime 完成时间
  16. * @apiBody { String } [ images ] 任务图片
  17. * @apiSuccess { Object } data 数据
  18. * @apiSuccess { Long } data.id 任务id
  19. * @apiSuccess { Long } data.roomId 房间id
  20. * @apiSuccess { String } data.belongSystem 所属系统
  21. * @apiSuccess { String } data.title 任务标题
  22. * @apiSuccess { Integer } data.type 任务类型 1:般任务 2:较急任务 3:紧急任务
  23. * @apiSuccess { String } data.content 任务内容
  24. * @apiSuccess { Long } data.userId 任务创建用户id
  25. * @apiSuccess { Integer } data.status 任务状态 1:正在处理 2:已经完成 3:已经取消 4:超时任务
  26. * @apiSuccess { Integer } data.auditStatus 审核状态 1:未提交 2:待审核 3:不通过
  27. * @apiSuccess { String } data.remark 审核备注
  28. * @apiSuccess { Integer } data.feedbackTotal 任务反馈数量
  29. * @apiSuccess { Date } data.publishTime 任务发布时间
  30. * @apiSuccess { Date } data.finishTime 任务完成时间
  31. * @apiSuccess { String } data.images 任务图片
  32. * @apiSuccess { String } message 信息
  33. * @apiSuccess { Integer } code 状态码
  34. * @apiSuccessExample Response
  35. *
  36. * {"data":{"id":1, "roomId":1, "belongSystem":"", "title":"", "type":1, "content":"", "userId":1, "status":1, "auditStatus":1, "remark":"", "feedbackTotal":1, "publishTime":1653458692071, "finishTime":1653458692071, "images":""}, "message":"", "code":1}
  37. */
  38. /**
  39. * @api {put} /v1/temporary/task/update 02.更新临时任务
  40. * @apiName 更新临时任务
  41. * @apiGroup 临时任务
  42. * @apiVersion 1.0.2
  43. * @apiHeader {String = application/json} Content-Type = application/json
  44. * @apiHeader {String} Authorization = eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3V1aWQiOjQzMTI2MzMxODcxMjE5NzEyLCJuYmYiOjE2NDkzMDQ1ODZ9.FvG8hY0R6D9lO1t4GR1bDhQVayGU5gHVCcy0SIX1r0c 授权信息
  45. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  46. * @apiBody { Long } id id 主键
  47. * @apiBody { Integer } status 任务状态 1:完成 2:取消 3:不通过
  48. * @apiBody { String } [ remake ] 审核备注
  49. * @apiSuccess { Object } data 数据
  50. * @apiSuccess { Long } data.id 任务id
  51. * @apiSuccess { Long } data.roomId 房间id
  52. * @apiSuccess { String } data.belongSystem 所属系统
  53. * @apiSuccess { String } data.title 任务标题
  54. * @apiSuccess { Integer } data.type 任务类型 1:般任务 2:较急任务 3:紧急任务
  55. * @apiSuccess { String } data.content 任务内容
  56. * @apiSuccess { Long } data.userId 任务创建用户id
  57. * @apiSuccess { Integer } data.status 任务状态 1:正在处理 2:已经完成 3:已经取消 4:超时任务
  58. * @apiSuccess { Integer } data.auditStatus 审核状态 1:未提交 2:待审核 3:不通过
  59. * @apiSuccess { String } data.remark 审核备注
  60. * @apiSuccess { Integer } data.feedbackTotal 任务反馈数量
  61. * @apiSuccess { Date } data.publishTime 任务发布时间
  62. * @apiSuccess { Date } data.finishTime 任务完成时间
  63. * @apiSuccess { String } data.images 任务图片
  64. * @apiSuccess { String } message 信息
  65. * @apiSuccess { Integer } code 状态码
  66. * @apiSuccessExample Response
  67. *
  68. * {"data":{"id":1, "roomId":1, "belongSystem":"", "title":"", "type":1, "content":"", "userId":1, "status":1, "auditStatus":1, "remark":"", "feedbackTotal":1, "publishTime":1653458692071, "finishTime":1653458692071, "images":""}, "message":"", "code":1}
  69. */
  70. /**
  71. * @api {get} /v1/temporary/task/list 03.分页查询临时任务
  72. * @apiName 分页查询临时任务
  73. * @apiGroup 临时任务
  74. * @apiVersion 1.0.2
  75. * @apiHeader {String = application/x-www-form-urlencoded} Content-Type = application/x-www-form-urlencoded
  76. * @apiHeader {String} Authorization = eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3V1aWQiOjQzMTI2MzMxODcxMjE5NzEyLCJuYmYiOjE2NDkzMDQ1ODZ9.FvG8hY0R6D9lO1t4GR1bDhQVayGU5gHVCcy0SIX1r0c 授权信息
  77. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  78. * @apiQuery { String } [ title ] 任务标题
  79. * @apiQuery { Integer } [ type ] 任务类型 1:一般任务 2: 较急任务 3:紧急任务
  80. * @apiQuery { Integer } [ status ] 任务状态 1:正在处理 2:已经完成 3:已经取消 4:超时任务
  81. * @apiQuery { Integer } [ auditStatus ] 审核状态 1:未提交 2:待审核 3:不通过
  82. * @apiQuery { String } [ content ] 任务内容
  83. * @apiQuery { String } [ username ] 发起人名称
  84. * @apiQuery { String } [ executor ] 执行人名称
  85. * @apiQuery { Date } [ startTime ] 开始日期
  86. * @apiQuery { Date } [ endTime ] 结束日期
  87. * @apiQuery { Integer } [ page = 1 ] 页码
  88. * @apiQuery { Integer } [ size = 10 ] 页大小
  89. * @apiQuery { String { ^[-+][\w]+ } } [ order = -id ] 排序规则(默认ID倒序),排序字段前加:+表示正序 -表示倒序
  90. * @apiSuccess { Object } data 数据
  91. * @apiSuccess { Long } data.total 数据总数
  92. * @apiSuccess { Object[] } data.list 数据列表
  93. * @apiSuccess { Long } data.list.id 任务id
  94. * @apiSuccess { Long } data.list.roomId 房间id
  95. * @apiSuccess { String } data.list.roomName 房间名称
  96. * @apiSuccess { String } data.list.belongSystem 所属系统
  97. * @apiSuccess { String } data.list.title 任务标题
  98. * @apiSuccess { Integer } data.list.type 任务类型 1:一般任务 2: 较急任务 3:紧急任务
  99. * @apiSuccess { String } data.list.username 发起人姓名
  100. * @apiSuccess { Integer } data.list.status 任务状态 1:正在处理 2:已经完成 3:已经取消 4:超时任务
  101. * @apiSuccess { Integer } data.list.auditStatus 审核状态 1:未提交 2:待审核 3:不通过
  102. * @apiSuccess { String } data.list.remark 审核备注
  103. * @apiSuccess { String } data.list.content 任务内容
  104. * @apiSuccess { Integer } data.list.feedbackTotal 执行反馈次数
  105. * @apiSuccess { Date } data.list.publishTime 发布时间
  106. * @apiSuccess { Date } data.list.finishTime 完成时间
  107. * @apiSuccess { String } data.list.images 任务图片
  108. * @apiSuccess { String[] } data.list.executors 执行人
  109. * @apiSuccess { String } message 信息
  110. * @apiSuccess { Integer } code 状态码
  111. * @apiSuccessExample Response
  112. *
  113. * {"data":{"total":1, "list":[{"id":1, "roomId":1, "roomName":"", "belongSystem":"", "title":"", "type":1, "username":"", "status":1, "auditStatus":1, "remark":"", "content":"", "feedbackTotal":1, "publishTime":1653458692071, "finishTime":1653458692071, "images":"", "executors":[""]}]}, "message":"", "code":1}
  114. */
  115. /**
  116. * @api {get} /v1/temporary/task/list/receive 05.我收到的临时任务列表
  117. * @apiName 我收到的临时任务列表
  118. * @apiGroup 临时任务
  119. * @apiVersion 1.0.2
  120. * @apiHeader {String = application/x-www-form-urlencoded} Content-Type = application/x-www-form-urlencoded
  121. * @apiHeader {String} Authorization = eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3V1aWQiOjQzMTI2MzMxODcxMjE5NzEyLCJuYmYiOjE2NDkzMDQ1ODZ9.FvG8hY0R6D9lO1t4GR1bDhQVayGU5gHVCcy0SIX1r0c 授权信息
  122. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  123. * @apiQuery { Integer } status 任务状态 1:正在处理 2:已经完成 3:已经取消 4:超时任务
  124. * @apiQuery { Integer } [ page = 1 ]
  125. * @apiQuery { Integer } [ size = 10 ]
  126. * @apiQuery { String { ^[-+][\w]+ } } [ order = -id ]
  127. * @apiSuccess { Object } data 数据
  128. * @apiSuccess { Long } data.total 数据总数
  129. * @apiSuccess { Object[] } data.list 数据列表
  130. * @apiSuccess { Long } data.list.id 任务id
  131. * @apiSuccess { Long } data.list.roomId 房间id
  132. * @apiSuccess { String } data.list.roomName 房间名称
  133. * @apiSuccess { String } data.list.belongSystem 所属系统
  134. * @apiSuccess { String } data.list.title 任务标题
  135. * @apiSuccess { Integer } data.list.type 任务类型 1:一般任务 2: 较急任务 3:紧急任务
  136. * @apiSuccess { String } data.list.username 发起人姓名
  137. * @apiSuccess { Integer } data.list.status 任务状态 1:正在处理 2:已经完成 3:已经取消 4:超时任务
  138. * @apiSuccess { Integer } data.list.auditStatus 审核状态 1:未提交 2:待审核 3:不通过
  139. * @apiSuccess { String } data.list.remark 审核备注
  140. * @apiSuccess { String } data.list.content 任务内容
  141. * @apiSuccess { Integer } data.list.feedbackTotal 执行反馈次数
  142. * @apiSuccess { Date } data.list.publishTime 发布时间
  143. * @apiSuccess { Date } data.list.finishTime 完成时间
  144. * @apiSuccess { String } data.list.images 任务图片
  145. * @apiSuccess { String[] } data.list.executors 执行人
  146. * @apiSuccess { String } message 信息
  147. * @apiSuccess { Integer } code 状态码
  148. * @apiSuccessExample Response
  149. *
  150. * {"data":{"total":1, "list":[{"id":1, "roomId":1, "roomName":"", "belongSystem":"", "title":"", "type":1, "username":"", "status":1, "auditStatus":1, "remark":"", "content":"", "feedbackTotal":1, "publishTime":1653458692071, "finishTime":1653458692071, "images":"", "executors":[""]}]}, "message":"", "code":1}
  151. */
  152. /**
  153. * @api {get} /v1/temporary/task/list/publish 07.我发出的任务列表
  154. * @apiName 我发出的任务列表
  155. * @apiGroup 临时任务
  156. * @apiVersion 1.0.2
  157. * @apiHeader {String = application/x-www-form-urlencoded} Content-Type = application/x-www-form-urlencoded
  158. * @apiHeader {String} Authorization = eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3V1aWQiOjQzMTI2MzMxODcxMjE5NzEyLCJuYmYiOjE2NDkzMDQ1ODZ9.FvG8hY0R6D9lO1t4GR1bDhQVayGU5gHVCcy0SIX1r0c 授权信息
  159. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  160. * @apiQuery { Integer } status 任务状态 1:正在处理 2:已经完成 3:已经取消 4:超时任务
  161. * @apiQuery { Integer } [ page = 1 ]
  162. * @apiQuery { Integer } [ size = 10 ]
  163. * @apiQuery { String { ^[-+][\w]+ } } [ order = -id ]
  164. * @apiSuccess { Object } data 数据
  165. * @apiSuccess { Long } data.total 数据总数
  166. * @apiSuccess { Object[] } data.list 数据列表
  167. * @apiSuccess { Long } data.list.id 任务id
  168. * @apiSuccess { Long } data.list.roomId 房间id
  169. * @apiSuccess { String } data.list.roomName 房间名称
  170. * @apiSuccess { String } data.list.belongSystem 所属系统
  171. * @apiSuccess { String } data.list.title 任务标题
  172. * @apiSuccess { Integer } data.list.type 任务类型 1:一般任务 2: 较急任务 3:紧急任务
  173. * @apiSuccess { String } data.list.username 发起人姓名
  174. * @apiSuccess { Integer } data.list.status 任务状态 1:正在处理 2:已经完成 3:已经取消 4:超时任务
  175. * @apiSuccess { Integer } data.list.auditStatus 审核状态 1:未提交 2:待审核 3:不通过
  176. * @apiSuccess { String } data.list.remark 审核备注
  177. * @apiSuccess { String } data.list.content 任务内容
  178. * @apiSuccess { Integer } data.list.feedbackTotal 执行反馈次数
  179. * @apiSuccess { Date } data.list.publishTime 发布时间
  180. * @apiSuccess { Date } data.list.finishTime 完成时间
  181. * @apiSuccess { String } data.list.images 任务图片
  182. * @apiSuccess { String[] } data.list.executors 执行人
  183. * @apiSuccess { String } message 信息
  184. * @apiSuccess { Integer } code 状态码
  185. * @apiSuccessExample Response
  186. *
  187. * {"data":{"total":1, "list":[{"id":1, "roomId":1, "roomName":"", "belongSystem":"", "title":"", "type":1, "username":"", "status":1, "auditStatus":1, "remark":"", "content":"", "feedbackTotal":1, "publishTime":1653458692071, "finishTime":1653458692072, "images":"", "executors":[""]}]}, "message":"", "code":1}
  188. */
  189. /**
  190. * @api {get} /v1/temporary/task/query/newest 08.我收到的最新的一条任务
  191. * @apiName 我收到的最新的一条任务
  192. * @apiGroup 临时任务
  193. * @apiVersion 1.0.2
  194. * @apiHeader {String = application/x-www-form-urlencoded} Content-Type = application/x-www-form-urlencoded
  195. * @apiHeader {String} Authorization = eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3V1aWQiOjQzMTI2MzMxODcxMjE5NzEyLCJuYmYiOjE2NDkzMDQ1ODZ9.FvG8hY0R6D9lO1t4GR1bDhQVayGU5gHVCcy0SIX1r0c 授权信息
  196. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  197. * @apiQuery { Integer } [ status ] 任务状态 1:正在处理 2:已经完成 3:已经取消 4:超时任务 不传时查询所有任务
  198. * @apiSuccess { Object } data 数据
  199. * @apiSuccess { Long } data.id 任务id
  200. * @apiSuccess { Long } data.roomId 房间id
  201. * @apiSuccess { String } data.roomName 房间名称
  202. * @apiSuccess { String } data.belongSystem 所属系统
  203. * @apiSuccess { String } data.title 任务标题
  204. * @apiSuccess { Integer } data.type 任务类型 1:一般任务 2: 较急任务 3:紧急任务
  205. * @apiSuccess { String } data.username 发起人姓名
  206. * @apiSuccess { Integer } data.status 任务状态 1:正在处理 2:已经完成 3:已经取消 4:超时任务
  207. * @apiSuccess { Integer } data.auditStatus 审核状态 1:未提交 2:待审核 3:不通过
  208. * @apiSuccess { String } data.remark 审核备注
  209. * @apiSuccess { String } data.content 任务内容
  210. * @apiSuccess { Integer } data.feedbackTotal 执行反馈次数
  211. * @apiSuccess { Date } data.publishTime 发布时间
  212. * @apiSuccess { Date } data.finishTime 完成时间
  213. * @apiSuccess { String } data.images 任务图片
  214. * @apiSuccess { String[] } data.executors 执行人
  215. * @apiSuccess { String } message 信息
  216. * @apiSuccess { Integer } code 状态码
  217. * @apiSuccessExample Response
  218. *
  219. * {"data":{"id":1, "roomId":1, "roomName":"", "belongSystem":"", "title":"", "type":1, "username":"", "status":1, "auditStatus":1, "remark":"", "content":"", "feedbackTotal":1, "publishTime":1653458692072, "finishTime":1653458692072, "images":"", "executors":[""]}, "message":"", "code":1}
  220. */
  221. /**
  222. * @api {get} /v1/patrol/task/list/record 09.巡检记录
  223. * @apiName 巡检记录
  224. * @apiGroup 巡检任务
  225. * @apiVersion 1.0.2
  226. * @apiHeader {String = application/x-www-form-urlencoded} Content-Type = application/x-www-form-urlencoded
  227. * @apiHeader {String} Authorization = eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3V1aWQiOjQzMTI2MzMxODcxMjE5NzEyLCJuYmYiOjE2NDkzMDQ1ODZ9.FvG8hY0R6D9lO1t4GR1bDhQVayGU5gHVCcy0SIX1r0c 授权信息
  228. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  229. * @apiQuery { Boolean } [ qualified ] 是否合格
  230. * @apiQuery { String } [ keyword ] 执行用户名、任务名称、房间名称
  231. * @apiQuery { Date } [ beginTimeStart ] 任务执行开始时间 开始时间
  232. * @apiQuery { Date } [ beginTimeEnd ] 任务执行开始时间 结束时间
  233. * @apiQuery { Integer } [ page = 1 ] 页码
  234. * @apiQuery { Integer } [ size = 10 ] 页大小
  235. * @apiQuery { String { ^[-+][\w]+ } } [ order = -id ] 排序规则(默认ID倒序),排序字段前加:+表示正序 -表示倒序
  236. * @apiSuccess { Object } data 数据
  237. * @apiSuccess { Long } data.total 数据总数
  238. * @apiSuccess { Object[] } data.list 数据列表
  239. * @apiSuccess { Long } data.list.id 任务id
  240. * @apiSuccess { String } data.list.name 任务名称
  241. * @apiSuccess { Long } data.list.roomId 房间id
  242. * @apiSuccess { String } data.list.roomName 房间名称
  243. * @apiSuccess { Date } data.list.time 巡检时间
  244. * @apiSuccess { String } data.list.username 巡检人员
  245. * @apiSuccess { String } message 信息
  246. * @apiSuccess { Integer } code 状态码
  247. * @apiSuccessExample Response
  248. *
  249. * {"data":{"total":1, "list":[{"id":1, "name":"", "roomId":1, "roomName":"", "time":1653458692072, "username":""}]}, "message":"", "code":1}
  250. */
  251. /**
  252. * @api {post} /v1/visitor/audit/add 01.进入登记
  253. * @apiName 进入登记
  254. * @apiGroup 访客审批
  255. * @apiVersion 1.0.2
  256. * @apiHeader {String = application/json} Content-Type = application/json
  257. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  258. * @apiBody { String } openid 用户openid
  259. * @apiBody { String } username 访客姓名
  260. * @apiBody { String { ^1[345789][0-9]\d{8}$ } } userPhone 访客手机号
  261. * @apiBody { String } company 访客公司
  262. * @apiBody { Integer } duration 访问时长(小时)
  263. * @apiBody { String } [ itineraryCode ] 行程码
  264. * @apiBody { String } [ healthCode ] 健康码
  265. * @apiBody { Boolean } [ highRisk ] 是否高风险
  266. * @apiBody { String } reason 事由
  267. * @apiBody { String } [ information ] 审核资料
  268. * @apiSuccess { String } data 数据
  269. * @apiSuccess { String } message 信息
  270. * @apiSuccess { Integer } code 状态码
  271. * @apiSuccessExample Response
  272. *
  273. * {"data":"", "message":"", "code":1}
  274. */
  275. /**
  276. * @api {put} /v1/visitor/audit/update 03.出场核销
  277. * @apiName 出场核销
  278. * @apiGroup 访客审批
  279. * @apiVersion 1.0.2
  280. * @apiHeader {String = application/json} Content-Type = application/json
  281. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  282. * @apiBody { Long } id 入场记录id
  283. * @apiBody { String } [ remark ] 出场备注
  284. * @apiSuccess { String } data 数据
  285. * @apiSuccess { String } message 信息
  286. * @apiSuccess { Integer } code 状态码
  287. * @apiSuccessExample Response
  288. *
  289. * {"data":"", "message":"", "code":1}
  290. */