patrol-web_1.0.1.api 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589
  1. /**
  2. * @api {get} /v1/home/visitor 06.查询当前机房访客人员
  3. * @apiName 查询当前机房访客人员
  4. * @apiGroup 主页
  5. * @apiVersion 1.0.1
  6. * @apiHeader {String = application/x-www-form-urlencoded} Content-Type = application/x-www-form-urlencoded
  7. * @apiHeader {String} Authorization = eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3V1aWQiOjMzODkzNTc0MDMzNjk0NzIwLCJuYmYiOjE2NDcxMDMzMjV9.zkk2igTRJMx15TPwlpVRa63sV11YHFgAqPZpnp9hGEU 授权信息
  8. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  9. * @apiQuery { Integer } [ page = 1 ] 页码
  10. * @apiQuery { Integer } [ size = 10 ] 页大小
  11. * @apiSuccess { Object } data 数据
  12. * @apiSuccess { Long } data.total 数据总数
  13. * @apiSuccess { Object[] } data.list 数据列表
  14. * @apiSuccess { Long } data.list.id id主键
  15. * @apiSuccess { String } data.list.openid 用户openid
  16. * @apiSuccess { Integer } data.list.number 编号,年+4位编号
  17. * @apiSuccess { String } data.list.username 访客姓名
  18. * @apiSuccess { String } data.list.userPhone 访客手机号
  19. * @apiSuccess { String } data.list.company 访客公司
  20. * @apiSuccess { Integer } data.list.duration 访问时长(小时)
  21. * @apiSuccess { String } data.list.itineraryCode 行程码
  22. * @apiSuccess { String } data.list.healthCode 健康码
  23. * @apiSuccess { Boolean } data.list.highRisk 是否高风险
  24. * @apiSuccess { String } data.list.reason 事由
  25. * @apiSuccess { Integer } data.list.status 审核状态 1:未审核 2:通过 3:拒绝
  26. * @apiSuccess { Date } data.list.entryTime 审批、进入时间
  27. * @apiSuccess { Long } data.list.operatingUserId 操作用户id
  28. * @apiSuccess { String } data.list.operatingUsername 操作用户姓名
  29. * @apiSuccess { Date } data.list.leaveTime 离开时间
  30. * @apiSuccess { String } data.list.remark 出场备注
  31. * @apiSuccess { Date } data.list.createTime 创建时间
  32. * @apiSuccess { String } data.list.information 审核资料
  33. * @apiSuccess { String } message 信息
  34. * @apiSuccess { Integer } code 状态码
  35. * @apiSuccessExample Response
  36. *
  37. * {"data":{"total":1, "list":[{"id":1, "openid":"", "number":1, "username":"", "userPhone":"", "company":"", "duration":1, "itineraryCode":"", "healthCode":"", "highRisk":true, "reason":"", "status":1, "entryTime":1651943027139, "operatingUserId":1, "operatingUsername":"", "leaveTime":1651943027139, "remark":"", "createTime":1651943027139, "information":""}]}, "message":"", "code":1}
  38. */
  39. /**
  40. * @api {post} /v1/patrol/plan/add 01.添加巡检计划
  41. * @apiName 添加巡检计划
  42. * @apiGroup 巡检计划-巡检计划查询
  43. * @apiVersion 1.0.1
  44. * @apiPermission 【/v1/patrol/plan/add#POST】
  45. * @apiHeader {String = application/json} Content-Type = application/json
  46. * @apiHeader {String} Authorization = eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3V1aWQiOjMzODkzNTc0MDMzNjk0NzIwLCJuYmYiOjE2NDcxMDMzMjV9.zkk2igTRJMx15TPwlpVRa63sV11YHFgAqPZpnp9hGEU 授权信息
  47. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  48. * @apiBody { Long } routeId 检查路线id
  49. * @apiBody { String } name 名称
  50. * @apiBody { Integer } type 类型 1日计划、2周计划、3月计划
  51. * @apiBody { Integer } runModel 执行模式 1其中一人、2每人分别
  52. * @apiBody { Date } beginDate 计划执行开始日期
  53. * @apiBody { Date } [ endDate ] 计划执行结束日期,空代表永不结束
  54. * @apiBody { Date } beginTime 任务执行开始时间
  55. * @apiBody { Date } endTime 任务执行结束时间
  56. * @apiBody { String } [ weeks ] 周计划 [1-7]
  57. * @apiBody { String } [ months ] 月计划 [1-31]
  58. * @apiBody { String } [ remark ] 备注
  59. * @apiBody { Long[] { 1-2147483647 } } executors 执行人列表
  60. * @apiSuccess { Object } data 数据
  61. * @apiSuccess { Long } data.id id 主键
  62. * @apiSuccess { Long } data.routeId 路线id
  63. * @apiSuccess { Long } data.userId 创建人id
  64. * @apiSuccess { String } data.number 编号
  65. * @apiSuccess { String } data.name 名称
  66. * @apiSuccess { Boolean } data.disabled 是否禁用
  67. * @apiSuccess { Integer } data.type 类型 1日计划、2周计划、3月计划
  68. * @apiSuccess { Integer } data.runModel 执行模式 1其中一人、2每人分别
  69. * @apiSuccess { Date } data.beginDate 计划执行开始日期
  70. * @apiSuccess { Date } data.endDate 计划执行结束日期,空代表永不结束
  71. * @apiSuccess { Date } data.beginTime 任务执行开始时间
  72. * @apiSuccess { Date } data.endTime 任务执行结束时间
  73. * @apiSuccess { String } data.weeks 周计划 [1-7]
  74. * @apiSuccess { String } data.months 月计划 [1-31]
  75. * @apiSuccess { String } data.remark 备注
  76. * @apiSuccess { String } message 信息
  77. * @apiSuccess { Integer } code 状态码
  78. * @apiSuccessExample Response
  79. *
  80. * {"data":{"id":1, "routeId":1, "userId":1, "number":"", "name":"", "disabled":true, "type":1, "runModel":1, "beginDate":1651943027139, "endDate":1651943027139, "beginTime":1651943027139, "endTime":1651943027139, "weeks":"", "months":"", "remark":""}, "message":"", "code":1}
  81. */
  82. /**
  83. * @api {put} /v1/patrol/plan/update 02.更新巡检计划
  84. * @apiName 更新巡检计划
  85. * @apiGroup 巡检计划-巡检计划查询
  86. * @apiVersion 1.0.1
  87. * @apiPermission 【/v1/patrol/plan/update#PUT】
  88. * @apiHeader {String = application/json} Content-Type = application/json
  89. * @apiHeader {String} Authorization = eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3V1aWQiOjMzODkzNTc0MDMzNjk0NzIwLCJuYmYiOjE2NDcxMDMzMjV9.zkk2igTRJMx15TPwlpVRa63sV11YHFgAqPZpnp9hGEU 授权信息
  90. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  91. * @apiBody { Long } id id 主键
  92. * @apiBody { Long } routeId 检查路线id
  93. * @apiBody { String } name 名称
  94. * @apiBody { Integer } type 类型 1日计划、2周计划、3月计划
  95. * @apiBody { Integer } runModel 执行模式 1其中一人、2每人分别
  96. * @apiBody { Date } beginDate 计划执行开始日期
  97. * @apiBody { Date } [ endDate ] 计划执行结束日期,空代表永不结束
  98. * @apiBody { Date } beginTime 任务执行开始时间
  99. * @apiBody { Date } endTime 任务执行结束时间
  100. * @apiBody { String } [ weeks ] 周计划 [1-7]
  101. * @apiBody { String } [ months ] 月计划 [1-31]
  102. * @apiBody { String } [ remark ] 备注
  103. * @apiBody { Long[] { 1-2147483647 } } executors 执行人列表
  104. * @apiSuccess { Object } data 数据
  105. * @apiSuccess { Long } data.id id 主键
  106. * @apiSuccess { Long } data.routeId 路线id
  107. * @apiSuccess { Long } data.userId 创建人id
  108. * @apiSuccess { String } data.number 编号
  109. * @apiSuccess { String } data.name 名称
  110. * @apiSuccess { Boolean } data.disabled 是否禁用
  111. * @apiSuccess { Integer } data.type 类型 1日计划、2周计划、3月计划
  112. * @apiSuccess { Integer } data.runModel 执行模式 1其中一人、2每人分别
  113. * @apiSuccess { Date } data.beginDate 计划执行开始日期
  114. * @apiSuccess { Date } data.endDate 计划执行结束日期,空代表永不结束
  115. * @apiSuccess { Date } data.beginTime 任务执行开始时间
  116. * @apiSuccess { Date } data.endTime 任务执行结束时间
  117. * @apiSuccess { String } data.weeks 周计划 [1-7]
  118. * @apiSuccess { String } data.months 月计划 [1-31]
  119. * @apiSuccess { String } data.remark 备注
  120. * @apiSuccess { String } message 信息
  121. * @apiSuccess { Integer } code 状态码
  122. * @apiSuccessExample Response
  123. *
  124. * {"data":{"id":1, "routeId":1, "userId":1, "number":"", "name":"", "disabled":true, "type":1, "runModel":1, "beginDate":1651943027139, "endDate":1651943027139, "beginTime":1651943027139, "endTime":1651943027139, "weeks":"", "months":"", "remark":""}, "message":"", "code":1}
  125. */
  126. /**
  127. * @api {get} /v1/patrol/task/record/list/room 01.分页查询房间巡检记录
  128. * @apiName 分页查询房间巡检记录
  129. * @apiGroup 巡检任务-巡检任务记录
  130. * @apiVersion 1.0.1
  131. * @apiHeader {String = application/x-www-form-urlencoded} Content-Type = application/x-www-form-urlencoded
  132. * @apiHeader {String} Authorization = eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3V1aWQiOjMzODkzNTc0MDMzNjk0NzIwLCJuYmYiOjE2NDcxMDMzMjV9.zkk2igTRJMx15TPwlpVRa63sV11YHFgAqPZpnp9hGEU 授权信息
  133. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  134. * @apiQuery { String } [ number ] 任务编号
  135. * @apiQuery { String } [ taskName ] 任务名称
  136. * @apiQuery { Integer } [ type ] 类型 1日计划、2周计划、3月计划
  137. * @apiQuery { Boolean } [ oneself ] 是否是本人完成
  138. * @apiQuery { String } [ username ] 执行用户名
  139. * @apiQuery { String } [ buildingName ] 楼栋名称
  140. * @apiQuery { String } [ floorName ] 楼层名称
  141. * @apiQuery { String } [ roomName ] 房间名称
  142. * @apiQuery { String } [ roomNumber ] 房间编号
  143. * @apiQuery { Date } [ beginTimeStart ] 任务开始时间 开始时间
  144. * @apiQuery { Date } [ beginTimeEnd ] 任务开始时间 结束时间
  145. * @apiQuery { Integer } [ page = 1 ] 页码
  146. * @apiQuery { Integer } [ size = 10 ] 页大小
  147. * @apiQuery { String { ^[-+][\w]+ } } [ order = -id ]
  148. * @apiSuccess { Object } data 数据
  149. * @apiSuccess { Long } data.total 数据总数
  150. * @apiSuccess { Object[] } data.list 数据列表
  151. * @apiSuccess { Long } data.list.id 任务id
  152. * @apiSuccess { String } data.list.name 任务名称
  153. * @apiSuccess { Integer } data.list.type 任务类型
  154. * @apiSuccess { String } data.list.buildingName 楼栋名称
  155. * @apiSuccess { String } data.list.floorName 楼层名称
  156. * @apiSuccess { Long } data.list.roomId 房间id
  157. * @apiSuccess { String } data.list.roomName 房间名称
  158. * @apiSuccess { String } data.list.roomNumber 房间编号
  159. * @apiSuccess { Long } data.list.userId 执行用户id
  160. * @apiSuccess { String } data.list.username 执行用户名
  161. * @apiSuccess { Date } data.list.beginTime 巡检时间
  162. * @apiSuccess { Date } data.list.endTime 结束时间
  163. * @apiSuccess { Boolean } data.list.completed 是否完成
  164. * @apiSuccess { Boolean } data.list.oneself 是否是本人完成
  165. * @apiSuccess { Boolean } data.list.qualified 是否合格
  166. * @apiSuccess { String } message 信息
  167. * @apiSuccess { Integer } code 状态码
  168. * @apiSuccessExample Response
  169. *
  170. * {"data":{"total":1, "list":[{"id":1, "name":"", "type":1, "buildingName":"", "floorName":"", "roomId":1, "roomName":"", "roomNumber":"", "userId":1, "username":"", "beginTime":1651943027139, "endTime":1651943027139, "completed":true, "oneself":true, "qualified":true}]}, "message":"", "code":1}
  171. */
  172. /**
  173. * @api {get} /v1/patrol/task/record/query/room 02.查询房间巡检记录详情
  174. * @apiName 查询房间巡检记录详情
  175. * @apiGroup 巡检任务-巡检任务记录
  176. * @apiVersion 1.0.1
  177. * @apiHeader {String = application/x-www-form-urlencoded} Content-Type = application/x-www-form-urlencoded
  178. * @apiHeader {String} Authorization = eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3V1aWQiOjMzODkzNTc0MDMzNjk0NzIwLCJuYmYiOjE2NDcxMDMzMjV9.zkk2igTRJMx15TPwlpVRa63sV11YHFgAqPZpnp9hGEU 授权信息
  179. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  180. * @apiQuery { Long } taskId 巡检任务id
  181. * @apiQuery { Long } roomId 房间id
  182. * @apiQuery { Long } userId 巡检人员id
  183. * @apiSuccess { Object } data 数据
  184. * @apiSuccess { String } data.taskName 任务名称
  185. * @apiSuccess { String } data.number 任务编号
  186. * @apiSuccess { Integer } data.type 任务类型
  187. * @apiSuccess { String } data.routeName 所属路线
  188. * @apiSuccess { String } data.roomName 房间名称
  189. * @apiSuccess { String } data.roomNumber 房间编号
  190. * @apiSuccess { String } data.floorName 楼层名称
  191. * @apiSuccess { String } data.buildingName 楼栋名称
  192. * @apiSuccess { String } data.name 巡检任务名称
  193. * @apiSuccess { Date } data.beginTime 任务开始时间
  194. * @apiSuccess { Date } data.endTime 任务结束时间
  195. * @apiSuccess { Date } data.updateTime 巡检时间
  196. * @apiSuccess { String } data.username 巡检人员
  197. * @apiSuccess { Integer } data.status 状态 1未开始、2进行中、3正常完成、4超时漏检、5超时完成
  198. * @apiSuccess { Boolean } data.completed 是否完成
  199. * @apiSuccess { Boolean } data.oneself 是否是本人完成
  200. * @apiSuccess { Boolean } data.qualified 是否合格
  201. * @apiSuccess { Integer } data.score 评分
  202. * @apiSuccess { Object[] } data.checkItems 检查项列表
  203. * @apiSuccess { Integer } data.checkItems.checkItemType 检查项类别 1选择、2数字、3文本、4拍照
  204. * @apiSuccess { String } data.checkItems.checkItemName 检查项名称
  205. * @apiSuccess { String } data.checkItems.checkItem 检查项
  206. * @apiSuccess { Integer } data.checkItems.score 得分
  207. * @apiSuccess { Integer } data.checkItems.scoreTotal 合格总分数
  208. * @apiSuccess { Boolean } data.checkItems.qualified 是否合格
  209. * @apiSuccess { String } data.checkItems.value 用户输入值
  210. * @apiSuccess { Object[] } data.devices 设备列表
  211. * @apiSuccess { String } data.devices.deviceName 设备名称
  212. * @apiSuccess { Object[] } data.devices.checkItems 检查项列表
  213. * @apiSuccess { Integer } data.devices.checkItems.checkItemType 检查项类别 1选择、2数字、3文本、4拍照
  214. * @apiSuccess { String } data.devices.checkItems.checkItemName 检查项名称
  215. * @apiSuccess { String } data.devices.checkItems.checkItem 检查项
  216. * @apiSuccess { Integer } data.devices.checkItems.score 得分
  217. * @apiSuccess { Integer } data.devices.checkItems.scoreTotal 合格总分数
  218. * @apiSuccess { Boolean } data.devices.checkItems.qualified 是否合格
  219. * @apiSuccess { String } data.devices.checkItems.value 用户输入值
  220. * @apiSuccess { String } message 信息
  221. * @apiSuccess { Integer } code 状态码
  222. * @apiSuccessExample Response
  223. *
  224. * {"data":{"taskName":"", "number":"", "type":1, "routeName":"", "roomName":"", "roomNumber":"", "floorName":"", "buildingName":"", "name":"", "beginTime":1651943027139, "endTime":1651943027139, "updateTime":1651943027139, "username":"", "status":1, "completed":true, "oneself":true, "qualified":true, "score":1, "checkItems":[{"checkItemType":1, "checkItemName":"", "checkItem":"", "score":1, "scoreTotal":1, "qualified":true, "value":""}], "devices":[{"deviceName":"", "checkItems":[{"checkItemType":1, "checkItemName":"", "checkItem":"", "score":1, "scoreTotal":1, "qualified":true, "value":""}]}]}, "message":"", "code":1}
  225. */
  226. /**
  227. * @api {delete} /v1/temporary/task/feedback/delete/:id 01.删除临时任务反馈
  228. * @apiName 删除临时任务反馈
  229. * @apiGroup 临时任务-临时任务反馈
  230. * @apiVersion 1.0.1
  231. * @apiPermission 【/v1/temporary/task/feedback/delete/{id}#DELETE】
  232. * @apiHeader {String = application/x-www-form-urlencoded} Content-Type = application/x-www-form-urlencoded
  233. * @apiHeader {String} Authorization = eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3V1aWQiOjMzODkzNTc0MDMzNjk0NzIwLCJuYmYiOjE2NDcxMDMzMjV9.zkk2igTRJMx15TPwlpVRa63sV11YHFgAqPZpnp9hGEU 授权信息
  234. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  235. * @apiParam { Long } id 临时任务反馈id
  236. * @apiQuery { Long } taskId 临时任务id
  237. * @apiSuccess { Boolean } data 数据
  238. * @apiSuccess { String } message 信息
  239. * @apiSuccess { Integer } code 状态码
  240. * @apiSuccessExample Response
  241. *
  242. * {"data":true, "message":"", "code":1}
  243. */
  244. /**
  245. * @api {delete} /v1/temporary/task/feedback/delete 02.删除多条临时任务反馈
  246. * @apiName 删除多条临时任务反馈
  247. * @apiGroup 临时任务-临时任务反馈
  248. * @apiVersion 1.0.1
  249. * @apiPermission 【/v1/temporary/task/feedback/delete#DELETE】
  250. * @apiHeader {String = application/x-www-form-urlencoded} Content-Type = application/x-www-form-urlencoded
  251. * @apiHeader {String} Authorization = eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3V1aWQiOjMzODkzNTc0MDMzNjk0NzIwLCJuYmYiOjE2NDcxMDMzMjV9.zkk2igTRJMx15TPwlpVRa63sV11YHFgAqPZpnp9hGEU 授权信息
  252. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  253. * @apiQuery { Long[] { 1-2147483647 } } ids 临时任务反馈id数组
  254. * @apiQuery { Long } taskId 临时任务id
  255. * @apiSuccess { Boolean } data 数据
  256. * @apiSuccess { String } message 信息
  257. * @apiSuccess { Integer } code 状态码
  258. * @apiSuccessExample Response
  259. *
  260. * {"data":true, "message":"", "code":1}
  261. */
  262. /**
  263. * @api {put} /v1/visitor/regulation/update 01.保存制度
  264. * @apiName 保存制度
  265. * @apiGroup 访客管理-制度管理
  266. * @apiVersion 1.0.1
  267. * @apiPermission 【/v1/visitor/regulation/update#PUT】
  268. * @apiHeader {String = application/json} Content-Type = application/json
  269. * @apiHeader {String} Authorization = eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3V1aWQiOjMzODkzNTc0MDMzNjk0NzIwLCJuYmYiOjE2NDcxMDMzMjV9.zkk2igTRJMx15TPwlpVRa63sV11YHFgAqPZpnp9hGEU 授权信息
  270. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  271. * @apiBody { String } content 内容
  272. * @apiSuccess { Object } data 数据
  273. * @apiSuccess { Long } data.id id主键
  274. * @apiSuccess { Long } data.userId 编辑用户id
  275. * @apiSuccess { String } data.username 编辑用户名称
  276. * @apiSuccess { Date } data.createTime 创建时间
  277. * @apiSuccess { Date } data.updateTime 更新时间
  278. * @apiSuccess { String } data.content 内容
  279. * @apiSuccess { String } message 信息
  280. * @apiSuccess { Integer } code 状态码
  281. * @apiSuccessExample Response
  282. *
  283. * {"data":{"id":1, "userId":1, "username":"", "createTime":1651943027139, "updateTime":1651943027139, "content":""}, "message":"", "code":1}
  284. */
  285. /**
  286. * @api {get} /v1/visitor/regulation/query 02.查询制度
  287. * @apiName 查询制度
  288. * @apiGroup 访客管理-制度管理
  289. * @apiVersion 1.0.1
  290. * @apiPermission 【/v1/visitor/regulation/query#GET】
  291. * @apiHeader {String = application/x-www-form-urlencoded} Content-Type = application/x-www-form-urlencoded
  292. * @apiHeader {String} Authorization = eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3V1aWQiOjMzODkzNTc0MDMzNjk0NzIwLCJuYmYiOjE2NDcxMDMzMjV9.zkk2igTRJMx15TPwlpVRa63sV11YHFgAqPZpnp9hGEU 授权信息
  293. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  294. * @apiSuccess { Object } data 数据
  295. * @apiSuccess { Long } data.id id主键
  296. * @apiSuccess { Long } data.userId 编辑用户id
  297. * @apiSuccess { String } data.username 编辑用户名称
  298. * @apiSuccess { Date } data.createTime 创建时间
  299. * @apiSuccess { Date } data.updateTime 更新时间
  300. * @apiSuccess { String } data.content 内容
  301. * @apiSuccess { String } message 信息
  302. * @apiSuccess { Integer } code 状态码
  303. * @apiSuccessExample Response
  304. *
  305. * {"data":{"id":1, "userId":1, "username":"", "createTime":1651943027139, "updateTime":1651943027139, "content":""}, "message":"", "code":1}
  306. */
  307. /**
  308. * @api {put} /v1/visitor/audit/update 01.更新访客审批
  309. * @apiName 更新访客审批
  310. * @apiGroup 访客管理-访客审批
  311. * @apiVersion 1.0.1
  312. * @apiPermission 【/v1/visitor/audit/update#PUT】
  313. * @apiHeader {String = application/json} Content-Type = application/json
  314. * @apiHeader {String} Authorization = eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3V1aWQiOjMzODkzNTc0MDMzNjk0NzIwLCJuYmYiOjE2NDcxMDMzMjV9.zkk2igTRJMx15TPwlpVRa63sV11YHFgAqPZpnp9hGEU 授权信息
  315. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  316. * @apiBody { Long } id id主键
  317. * @apiBody { Integer } status 审核状态 2:通过 3:拒绝
  318. * @apiSuccess { Object } data 数据
  319. * @apiSuccess { Long } data.id id主键
  320. * @apiSuccess { String } data.openid 用户openid
  321. * @apiSuccess { Integer } data.number 编号,年+4位编号
  322. * @apiSuccess { String } data.username 访客姓名
  323. * @apiSuccess { String } data.userPhone 访客手机号
  324. * @apiSuccess { String } data.company 访客公司
  325. * @apiSuccess { Integer } data.duration 访问时长(小时)
  326. * @apiSuccess { String } data.itineraryCode 行程码
  327. * @apiSuccess { String } data.healthCode 健康码
  328. * @apiSuccess { Boolean } data.highRisk 是否高风险
  329. * @apiSuccess { String } data.reason 事由
  330. * @apiSuccess { Integer } data.status 审核状态 1:未审核 2:通过 3:拒绝
  331. * @apiSuccess { Date } data.entryTime 审批、进入时间
  332. * @apiSuccess { Long } data.operatingUserId 操作用户id
  333. * @apiSuccess { String } data.operatingUsername 操作用户姓名
  334. * @apiSuccess { Date } data.leaveTime 离开时间
  335. * @apiSuccess { String } data.remark 出场备注
  336. * @apiSuccess { Date } data.createTime 创建时间
  337. * @apiSuccess { String } data.information 审核资料
  338. * @apiSuccess { String } message 信息
  339. * @apiSuccess { Integer } code 状态码
  340. * @apiSuccessExample Response
  341. *
  342. * {"data":{"id":1, "openid":"", "number":1, "username":"", "userPhone":"", "company":"", "duration":1, "itineraryCode":"", "healthCode":"", "highRisk":true, "reason":"", "status":1, "entryTime":1651943027139, "operatingUserId":1, "operatingUsername":"", "leaveTime":1651943027139, "remark":"", "createTime":1651943027139, "information":""}, "message":"", "code":1}
  343. */
  344. /**
  345. * @api {get} /v1/visitor/audit/list 02.分页查询访客审批
  346. * @apiName 分页查询访客审批
  347. * @apiGroup 访客管理-访客审批
  348. * @apiVersion 1.0.1
  349. * @apiPermission 【/v1/visitor/audit/list#GET】
  350. * @apiHeader {String = application/x-www-form-urlencoded} Content-Type = application/x-www-form-urlencoded
  351. * @apiHeader {String} Authorization = eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3V1aWQiOjMzODkzNTc0MDMzNjk0NzIwLCJuYmYiOjE2NDcxMDMzMjV9.zkk2igTRJMx15TPwlpVRa63sV11YHFgAqPZpnp9hGEU 授权信息
  352. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  353. * @apiQuery { String } [ username ] 访客姓名
  354. * @apiQuery { String } [ userPhone ] 访客手机号
  355. * @apiQuery { String } [ company ] 访客公司
  356. * @apiQuery { Boolean } [ highRisk ] 是否高风险
  357. * @apiQuery { Integer } [ status ] 审核状态 1:未审核 2:通过 3:拒绝
  358. * @apiQuery { String } [ operatingUsername ] 操作人姓名
  359. * @apiQuery { Date } [ entryTimeStart ] 审批、进入时间 开始时间
  360. * @apiQuery { Date } [ entryTimeEnd ] 审批、进入时间 结束时间
  361. * @apiQuery { Date } [ leaveTimeStart ] 离开时间 开始时间
  362. * @apiQuery { Date } [ leaveTimeEnd ] 离开时间 结束时间
  363. * @apiQuery { Date } [ createTimeStart ] 创建时间 开始时间
  364. * @apiQuery { Date } [ createTimeEnd ] 创建时间 结束时间
  365. * @apiQuery { Integer } [ page = 1 ] 页码
  366. * @apiQuery { Integer } [ size = 10 ] 页大小
  367. * @apiQuery { String { ^[-+][\w]+ } } [ order = -id ] 排序规则(默认ID倒序),排序字段前加:+表示正序 -表示倒序
  368. * @apiSuccess { Object } data 数据
  369. * @apiSuccess { Long } data.total 数据总数
  370. * @apiSuccess { Object[] } data.list 数据列表
  371. * @apiSuccess { Long } data.list.id id主键
  372. * @apiSuccess { String } data.list.openid 用户openid
  373. * @apiSuccess { Integer } data.list.number 编号,年+4位编号
  374. * @apiSuccess { String } data.list.username 访客姓名
  375. * @apiSuccess { String } data.list.userPhone 访客手机号
  376. * @apiSuccess { String } data.list.company 访客公司
  377. * @apiSuccess { Integer } data.list.duration 访问时长(小时)
  378. * @apiSuccess { String } data.list.itineraryCode 行程码
  379. * @apiSuccess { String } data.list.healthCode 健康码
  380. * @apiSuccess { Boolean } data.list.highRisk 是否高风险
  381. * @apiSuccess { String } data.list.reason 事由
  382. * @apiSuccess { Integer } data.list.status 审核状态 1:未审核 2:通过 3:拒绝
  383. * @apiSuccess { Date } data.list.entryTime 审批、进入时间
  384. * @apiSuccess { Long } data.list.operatingUserId 操作用户id
  385. * @apiSuccess { String } data.list.operatingUsername 操作用户姓名
  386. * @apiSuccess { Date } data.list.leaveTime 离开时间
  387. * @apiSuccess { String } data.list.remark 出场备注
  388. * @apiSuccess { Date } data.list.createTime 创建时间
  389. * @apiSuccess { String } data.list.information 审核资料
  390. * @apiSuccess { Long } data.list.backupId 备案id
  391. * @apiSuccess { Boolean } data.list.backupValid 备案是否有效
  392. * @apiSuccess { String } message 信息
  393. * @apiSuccess { Integer } code 状态码
  394. * @apiSuccessExample Response
  395. *
  396. * {"data":{"total":1, "list":[{"id":1, "openid":"", "number":1, "username":"", "userPhone":"", "company":"", "duration":1, "itineraryCode":"", "healthCode":"", "highRisk":true, "reason":"", "status":1, "entryTime":1651943027139, "operatingUserId":1, "operatingUsername":"", "leaveTime":1651943027139, "remark":"", "createTime":1651943027139, "information":"", "backupId":1, "backupValid":true}]}, "message":"", "code":1}
  397. */
  398. /**
  399. * @api {post} /v1/visitor/backup/add 01.添加备案
  400. * @apiName 添加备案
  401. * @apiGroup 访客管理-备案管理
  402. * @apiVersion 1.0.1
  403. * @apiPermission 【/v1/visitor/backup/add#POST】
  404. * @apiHeader {String = application/json} Content-Type = application/json
  405. * @apiHeader {String} Authorization = eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3V1aWQiOjMzODkzNTc0MDMzNjk0NzIwLCJuYmYiOjE2NDcxMDMzMjV9.zkk2igTRJMx15TPwlpVRa63sV11YHFgAqPZpnp9hGEU 授权信息
  406. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  407. * @apiBody { String } username 访客姓名
  408. * @apiBody { String } userPhone 访客手机号
  409. * @apiBody { Integer } gender 性别 1:男 2:女
  410. * @apiBody { String } idcard 身份证号
  411. * @apiBody { String } idcardImage 身份证照片
  412. * @apiBody { Date } validTime 有效截止时间
  413. * @apiBody { String } company 访客公司
  414. * @apiBody { String } [ remark ] 备注
  415. * @apiSuccess { Object } data 数据
  416. * @apiSuccess { Long } data.id id主键
  417. * @apiSuccess { Long } data.operatingUserId 操作用户id
  418. * @apiSuccess { String } data.operatingUsername 操作用户姓名
  419. * @apiSuccess { String } data.username 访客姓名
  420. * @apiSuccess { String } data.userPhone 访客手机号
  421. * @apiSuccess { Integer } data.gender 性别 1:男 2:女
  422. * @apiSuccess { String } data.idcard 身份证号
  423. * @apiSuccess { String } data.idcardImage 身份证照片
  424. * @apiSuccess { Date } data.validTime 有效截止时间
  425. * @apiSuccess { String } data.company 访客公司
  426. * @apiSuccess { String } data.remark 备注
  427. * @apiSuccess { Date } data.createTime 创建时间
  428. * @apiSuccess { Date } data.updateTime 更新时间
  429. * @apiSuccess { String } message 信息
  430. * @apiSuccess { Integer } code 状态码
  431. * @apiSuccessExample Response
  432. *
  433. * {"data":{"id":1, "operatingUserId":1, "operatingUsername":"", "username":"", "userPhone":"", "gender":1, "idcard":"", "idcardImage":"", "validTime":1651943027139, "company":"", "remark":"", "createTime":1651943027139, "updateTime":1651943027139}, "message":"", "code":1}
  434. */
  435. /**
  436. * @api {put} /v1/visitor/backup/update 02.更新备案
  437. * @apiName 更新备案
  438. * @apiGroup 访客管理-备案管理
  439. * @apiVersion 1.0.1
  440. * @apiPermission 【/v1/visitor/backup/update#PUT】
  441. * @apiHeader {String = application/json} Content-Type = application/json
  442. * @apiHeader {String} Authorization = eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3V1aWQiOjMzODkzNTc0MDMzNjk0NzIwLCJuYmYiOjE2NDcxMDMzMjV9.zkk2igTRJMx15TPwlpVRa63sV11YHFgAqPZpnp9hGEU 授权信息
  443. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  444. * @apiBody { Long } id id主键
  445. * @apiBody { String } username 访客姓名
  446. * @apiBody { String } userPhone 访客手机号
  447. * @apiBody { Integer } gender 性别 1:男 2:女
  448. * @apiBody { String } idcard 身份证号
  449. * @apiBody { String } idcardImage 身份证照片
  450. * @apiBody { Date } validTime 有效截止时间
  451. * @apiBody { String } company 访客公司
  452. * @apiBody { String } [ remark ] 备注
  453. * @apiSuccess { Object } data 数据
  454. * @apiSuccess { Long } data.id id主键
  455. * @apiSuccess { Long } data.operatingUserId 操作用户id
  456. * @apiSuccess { String } data.operatingUsername 操作用户姓名
  457. * @apiSuccess { String } data.username 访客姓名
  458. * @apiSuccess { String } data.userPhone 访客手机号
  459. * @apiSuccess { Integer } data.gender 性别 1:男 2:女
  460. * @apiSuccess { String } data.idcard 身份证号
  461. * @apiSuccess { String } data.idcardImage 身份证照片
  462. * @apiSuccess { Date } data.validTime 有效截止时间
  463. * @apiSuccess { String } data.company 访客公司
  464. * @apiSuccess { String } data.remark 备注
  465. * @apiSuccess { Date } data.createTime 创建时间
  466. * @apiSuccess { Date } data.updateTime 更新时间
  467. * @apiSuccess { String } message 信息
  468. * @apiSuccess { Integer } code 状态码
  469. * @apiSuccessExample Response
  470. *
  471. * {"data":{"id":1, "operatingUserId":1, "operatingUsername":"", "username":"", "userPhone":"", "gender":1, "idcard":"", "idcardImage":"", "validTime":1651943027139, "company":"", "remark":"", "createTime":1651943027139, "updateTime":1651943027139}, "message":"", "code":1}
  472. */
  473. /**
  474. * @api {delete} /v1/visitor/backup/delete/:id 03.删除备案
  475. * @apiName 删除备案
  476. * @apiGroup 访客管理-备案管理
  477. * @apiVersion 1.0.1
  478. * @apiPermission 【/v1/visitor/backup/delete/{id}#DELETE】
  479. * @apiHeader {String = application/x-www-form-urlencoded} Content-Type = application/x-www-form-urlencoded
  480. * @apiHeader {String} Authorization = eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3V1aWQiOjMzODkzNTc0MDMzNjk0NzIwLCJuYmYiOjE2NDcxMDMzMjV9.zkk2igTRJMx15TPwlpVRa63sV11YHFgAqPZpnp9hGEU 授权信息
  481. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  482. * @apiParam { Long } id 备案id
  483. * @apiSuccess { Boolean } data 数据
  484. * @apiSuccess { String } message 信息
  485. * @apiSuccess { Integer } code 状态码
  486. * @apiSuccessExample Response
  487. *
  488. * {"data":true, "message":"", "code":1}
  489. */
  490. /**
  491. * @api {delete} /v1/visitor/backup/delete 04.删除多条备案
  492. * @apiName 删除多条备案
  493. * @apiGroup 访客管理-备案管理
  494. * @apiVersion 1.0.1
  495. * @apiPermission 【/v1/visitor/backup/delete#DELETE】
  496. * @apiHeader {String = application/x-www-form-urlencoded} Content-Type = application/x-www-form-urlencoded
  497. * @apiHeader {String} Authorization = eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3V1aWQiOjMzODkzNTc0MDMzNjk0NzIwLCJuYmYiOjE2NDcxMDMzMjV9.zkk2igTRJMx15TPwlpVRa63sV11YHFgAqPZpnp9hGEU 授权信息
  498. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  499. * @apiQuery { Long[] { 1-2147483647 } } ids 备案id数组
  500. * @apiSuccess { Boolean } data 数据
  501. * @apiSuccess { String } message 信息
  502. * @apiSuccess { Integer } code 状态码
  503. * @apiSuccessExample Response
  504. *
  505. * {"data":true, "message":"", "code":1}
  506. */
  507. /**
  508. * @api {get} /v1/visitor/backup/query/:id 05.查询备案
  509. * @apiName 查询备案
  510. * @apiGroup 访客管理-备案管理
  511. * @apiVersion 1.0.1
  512. * @apiPermission 【/v1/visitor/backup/query/{id}#GET】
  513. * @apiHeader {String = application/x-www-form-urlencoded} Content-Type = application/x-www-form-urlencoded
  514. * @apiHeader {String} Authorization = eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3V1aWQiOjMzODkzNTc0MDMzNjk0NzIwLCJuYmYiOjE2NDcxMDMzMjV9.zkk2igTRJMx15TPwlpVRa63sV11YHFgAqPZpnp9hGEU 授权信息
  515. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  516. * @apiParam { Long } id 备案id
  517. * @apiSuccess { Object } data 数据
  518. * @apiSuccess { Long } data.id id主键
  519. * @apiSuccess { Long } data.operatingUserId 操作用户id
  520. * @apiSuccess { String } data.operatingUsername 操作用户姓名
  521. * @apiSuccess { String } data.username 访客姓名
  522. * @apiSuccess { String } data.userPhone 访客手机号
  523. * @apiSuccess { Integer } data.gender 性别 1:男 2:女
  524. * @apiSuccess { String } data.idcard 身份证号
  525. * @apiSuccess { String } data.idcardImage 身份证照片
  526. * @apiSuccess { Date } data.validTime 有效截止时间
  527. * @apiSuccess { String } data.company 访客公司
  528. * @apiSuccess { String } data.remark 备注
  529. * @apiSuccess { Date } data.createTime 创建时间
  530. * @apiSuccess { Date } data.updateTime 更新时间
  531. * @apiSuccess { String } message 信息
  532. * @apiSuccess { Integer } code 状态码
  533. * @apiSuccessExample Response
  534. *
  535. * {"data":{"id":1, "operatingUserId":1, "operatingUsername":"", "username":"", "userPhone":"", "gender":1, "idcard":"", "idcardImage":"", "validTime":1651943027139, "company":"", "remark":"", "createTime":1651943027139, "updateTime":1651943027139}, "message":"", "code":1}
  536. */
  537. /**
  538. * @api {post} /v1/system/user/login 04.登录
  539. * @apiName 登录
  540. * @apiGroup 系统设置-用户管理
  541. * @apiVersion 1.0.1
  542. * @apiHeader {String = application/json} Content-Type = application/json
  543. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  544. * @apiBody { String } username 用户名
  545. * @apiBody { String } password 用户密码(md5加密)
  546. * @apiSuccess { Object } data 数据
  547. * @apiSuccess { Long } data.id 用户id
  548. * @apiSuccess { String } data.username 用户名称
  549. * @apiSuccess { String } data.telephone 手机号
  550. * @apiSuccess { String } data.token 授权信息
  551. * @apiSuccess { String[] } data.permissions 权限列表
  552. * @apiSuccess { String } message 信息
  553. * @apiSuccess { Integer } code 状态码
  554. * @apiSuccessExample Response
  555. *
  556. * {"data":{"id":1, "username":"", "telephone":"", "token":"", "permissions":[""]}, "message":"", "code":1}
  557. */
  558. /**
  559. * @api {get} /v1/doc/api 01.接口文档
  560. * @apiName 接口文档
  561. * @apiGroup 文档
  562. * @apiVersion 1.0.1
  563. * @apiPermission 【/v1/doc/api#GET】
  564. * @apiHeader {String = application/x-www-form-urlencoded} Content-Type = application/x-www-form-urlencoded
  565. * @apiHeader {String} Authorization = eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3V1aWQiOjMzODkzNTc0MDMzNjk0NzIwLCJuYmYiOjE2NDcxMDMzMjV9.zkk2igTRJMx15TPwlpVRa63sV11YHFgAqPZpnp9hGEU 授权信息
  566. * @apiHeader {String = zh-CN,en-US} accept-language = zh-CN
  567. * @apiSuccess { String } / 接口文档
  568. * @apiSuccessExample Response
  569. *
  570. * ""
  571. */