xunjian_houtai/applications/patrol/patrol-app/api/patrol-app_1.0.1.api

/**
 * @api {post} /v1/system/user/login 01.登录
 * @apiName 登录
 * @apiGroup 用户
 * @apiHeader {String =  application/json} Content-Type = application/json
 * @apiHeader {String = zh-CN,en-US } accept-language = zh-CN
 * @apiVersion 1.0.1
 * @apiBody { String } username 用户名
 * @apiBody { String } password 用户密码(md5加密)
 * @apiSuccess { Object } data 数据
 * @apiSuccess { Long } data.id 用户id
 * @apiSuccess { String } data.username 用户名称
 * @apiSuccess { String } data.telephone 手机号
 * @apiSuccess { String } data.deptName 用户部门
 * @apiSuccess { String } data.token 授权信息
 * @apiSuccess { String } message 信息
 * @apiSuccess { Integer } code 状态码
 * @apiSuccessExample Response
 *
 * {"data":{"id":1, "username":"", "telephone":"", "deptName":"", "token":""}, "message":"", "code":1}
 */

/**
 * @api {get} /v1/patrol/task/list 01.巡检计划
 * @apiName 巡检计划
 * @apiGroup 巡检任务
 * @apiHeader {String =  application/x-www-form-urlencoded} Content-Type = application/x-www-form-urlencoded
 * @apiHeader {String = zh-CN,en-US } accept-language = zh-CN
 * @apiHeader {String} Authorization 授权信息
 * @apiVersion 1.0.1
 * @apiQuery { Integer } [ status ] 检查状态 1未开始、2进行中、3正常完成、4超时漏检、5超时完成
 * @apiQuery { Date } [ beginTimeStart ] 任务执行开始时间 开始时间
 * @apiQuery { Date } [ beginTimeEnd ] 任务执行开始时间 结束时间
 * @apiQuery { Integer } [ page = 1 ] 页码
 * @apiQuery { Integer } [ size = 10 ] 页大小
 * @apiQuery { String { ^[-+][\w]+ } } [ order = -id ] 排序规则(默认ID倒序)，排序字段前加：+表示正序 -表示倒序
 * @apiSuccess { Object } data 数据
 * @apiSuccess { Long } data.total 数据总数
 * @apiSuccess { Object[] } data.list 数据列表
 * @apiSuccess { Long } data.list.id id 主键
 * @apiSuccess { String } data.list.name 名称
 * @apiSuccess { Date } data.list.beginTime 任务执行开始时间
 * @apiSuccess { Date } data.list.endTime 任务执行结束时间
 * @apiSuccess { Integer } data.list.status 状态 1未开始、2进行中、3正常完成、4超时漏检、5超时完成
 * @apiSuccess { Integer } data.list.total 计划巡检房间数
 * @apiSuccess { Integer } data.list.completed 已经完成房间数
 * @apiSuccess { Float } data.list.completionRate 完成率
 * @apiSuccess { String } message 信息
 * @apiSuccess { Integer } code 状态码
 * @apiSuccessExample Response
 *
 * {"data":{"total":1, "list":[{"id":1, "name":"", "beginTime":1651827836584, "endTime":1651827836584, "status":1, "total":1, "completed":1, "completionRate":1.0}]}, "message":"", "code":1}
 * {"data":{"total":1, "list":[{"id":1, "name":"", "beginTime":1651835636006, "endTime":1651835636006, "status":1, "total":1, "completed":1, "completionRate":1.0}]}, "message":"", "code":1}
 */

/**
 * @api {get} /v1/patrol/task/list/room 02.选择计划
 * @apiName 选择计划
 * @apiGroup 巡检任务
 * @apiHeader {String =  application/x-www-form-urlencoded} Content-Type = application/x-www-form-urlencoded
 * @apiHeader {String = zh-CN,en-US } accept-language = zh-CN
 * @apiHeader {String} Authorization 授权信息
 * @apiVersion 1.0.1
 * @apiQuery { Long } roomId 房间id
 * @apiSuccess { Object[] } data 数据
 * @apiSuccess { Long } data.id id 主键
 * @apiSuccess { String } data.name 名称
 * @apiSuccess { Date } data.beginTime 任务执行开始时间
 * @apiSuccess { Date } data.endTime 任务执行结束时间
 * @apiSuccess { Integer } data.status 状态 1未开始、2进行中、3正常完成、4超时漏检、5超时完成
 * @apiSuccess { Integer } data.total 计划巡检房间数
 * @apiSuccess { Integer } data.completed 已经完成房间数
 * @apiSuccess { Float } data.completionRate 完成率
 * @apiSuccess { String } message 信息
 * @apiSuccess { Integer } code 状态码
 * @apiSuccessExample Response
 *
 * {"data":[{"id":1, "name":"", "beginTime":1651827836584, "endTime":1651827836584, "status":1, "total":1, "completed":1, "completionRate":1.0}], "message":"", "code":1}
 * {"data":[{"id":1, "name":"", "beginTime":1651835636006, "endTime":1651835636006, "status":1, "total":1, "completed":1, "completionRate":1.0}], "message":"", "code":1}
 */

/**
 * @api {get} /v1/patrol/task/query/rate/:id 03.巡检进度
 * @apiName 巡检进度
 * @apiGroup 巡检任务
 * @apiHeader {String =  application/x-www-form-urlencoded} Content-Type = application/x-www-form-urlencoded
 * @apiHeader {String = zh-CN,en-US } accept-language = zh-CN
 * @apiHeader {String} Authorization 授权信息
 * @apiVersion 1.0.1
 * @apiParam { Long } id 巡检任务id
 * @apiSuccess { Object } data 数据
 * @apiSuccess { Long } data.id id 主键
 * @apiSuccess { String } data.name 名称
 * @apiSuccess { Date } data.beginTime 任务执行开始时间
 * @apiSuccess { Date } data.endTime 任务执行结束时间
 * @apiSuccess { Integer } data.total 计划巡检房间数
 * @apiSuccess { Integer } data.completed 已经完成房间数
 * @apiSuccess { Float } data.completionRate 完成率
 * @apiSuccess { Object[] } data.rooms 房间列表
 * @apiSuccess { Long } data.rooms.id 房间id
 * @apiSuccess { String } data.rooms.name 房间名称
 * @apiSuccess { String } data.rooms.number 房间编号
 * @apiSuccess { Boolean } data.rooms.qualified 是否合格
 * @apiSuccess { Boolean } data.rooms.completed 是否已巡检
 * @apiSuccess { String } message 信息
 * @apiSuccess { Integer } code 状态码
 * @apiSuccessExample Response
 *
 * {"data":{"id":1, "name":"", "beginTime":1651827836584, "endTime":1651827836584, "total":1, "completed":1, "completionRate":1.0, "rooms":[{"id":1, "name":"", "number":"", "qualified":true, "completed":true}]}, "message":"", "code":1}
 * {"data":{"id":1, "name":"", "beginTime":1651835636006, "endTime":1651835636006, "total":1, "completed":1, "completionRate":1.0, "rooms":[{"id":1, "name":"", "number":"", "qualified":true, "completed":true}]}, "message":"", "code":1}
 */

/**
 * @api {get} /v1/visitor/regulation/query 01.查询制度
 * @apiName 查询制度
 * @apiGroup 制度管理
 * @apiHeader {String =  application/x-www-form-urlencoded} Content-Type = application/x-www-form-urlencoded
 * @apiHeader {String = zh-CN,en-US } accept-language = zh-CN
 * @apiVersion 1.0.1
 * @apiSuccess { Object } data 数据
 * @apiSuccess { Long } data.id id主键
 * @apiSuccess { Long } data.userId 编辑用户id
 * @apiSuccess { String } data.username 编辑用户名称
 * @apiSuccess { Date } data.createTime 创建时间
 * @apiSuccess { Date } data.updateTime 更新时间
 * @apiSuccess { String } data.content 内容
 * @apiSuccess { String } message 信息
 * @apiSuccess { Integer } code 状态码
 * @apiSuccessExample Response
 *
 * {"data":{"id":1, "userId":1, "username":"", "createTime":1651827836584, "updateTime":1651827836584, "content":""}, "message":"", "code":1}
 * {"data":{"id":1, "userId":1, "username":"", "createTime":1651835636007, "updateTime":1651835636007, "content":""}, "message":"", "code":1}
 */

/**
 * @api {post} /v1/visitor/audit/add 01.进入登记
 * @apiName 进入登记
 * @apiGroup 访客审批
 * @apiHeader {String =  application/json} Content-Type = application/json
 * @apiHeader {String = zh-CN,en-US } accept-language = zh-CN
 * @apiVersion 1.0.1
 * @apiBody { String } openid 用户openid
 * @apiBody { String } username 访客姓名
 * @apiBody { String } userPhone 访客手机号
 * @apiBody { String } company 访客公司
 * @apiBody { Integer } duration 访问时长（小时）
 * @apiBody { String } [ itineraryCode ] 行程码
 * @apiBody { String } [ healthCode ] 健康码
 * @apiBody { Boolean } [ highRisk ] 是否高风险
 * @apiBody { String } reason 事由
 * @apiBody { String } [ information ] 审核资料
 * @apiSuccess { Boolean } data 数据
 * @apiSuccess { String } message 信息
 * @apiSuccess { Integer } code 状态码
 * @apiSuccessExample Response
 *
 * {"data":true, "message":"", "code":1}
 */

/**
 * @api {get} /v1/visitor/audit/query/:openid 02.查询进入记录
 * @apiName 查询进入记录
 * @apiGroup 访客审批
 * @apiHeader {String =  application/x-www-form-urlencoded} Content-Type = application/x-www-form-urlencoded
 * @apiHeader {String = zh-CN,en-US } accept-language = zh-CN
 * @apiVersion 1.0.1
 * @apiParam { String } openid 用户openid
 * @apiSuccess { Object } data 数据
 * @apiSuccess { Long } data.id id主键
 * @apiSuccess { String } data.openid 用户openid
 * @apiSuccess { String } data.username 访客姓名
 * @apiSuccess { String } data.userPhone 访客手机号
 * @apiSuccess { String } data.company 访客公司
 * @apiSuccess { Date } data.entryTime 进入时间
 * @apiSuccess { String } data.reason 事由
 * @apiSuccess { String } message 信息
 * @apiSuccess { Integer } code 状态码
 * @apiSuccessExample Response
 *
 * {"data":{"id":1, "openid":"", "username":"", "userPhone":"", "company":"", "entryTime":1651827836584, "reason":""}, "message":"", "code":1}
 * {"data":{"id":1, "openid":"", "username":"", "userPhone":"", "company":"", "entryTime":1651835636007, "reason":""}, "message":"", "code":1}
 */

/**
 * @api {put} /v1/visitor/audit/update 03.出场核销
 * @apiName 出场核销
 * @apiGroup 访客审批
 * @apiHeader {String =  application/json} Content-Type = application/json
 * @apiHeader {String = zh-CN,en-US } accept-language = zh-CN
 * @apiVersion 1.0.1
 * @apiBody { Long } id 入场记录id
 * @apiBody { String } [ remark ] 出场备注
 * @apiSuccess { Boolean } data 数据
 * @apiSuccess { String } message 信息
 * @apiSuccess { Integer } code 状态码
 * @apiSuccessExample Response
 *
 * {"data":true, "message":"", "code":1}
 */