From 3a506ec80c68e8c8b0bcc576be32e5880273323d Mon Sep 17 00:00:00 2001 From: zhengjl Date: Sun, 26 Jun 2022 15:09:23 +0000 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=20'=E5=B0=8F=E7=A8=8B?= =?UTF-8?q?=E5=BA=8F=E6=8E=A5=E5=8F=A3=E6=96=87=E6=A1=A3.md'?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 小程序接口文档.md | 392 +++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 384 insertions(+), 8 deletions(-) diff --git a/小程序接口文档.md b/小程序接口文档.md index 91be1a6..1bda429 100644 --- a/小程序接口文档.md +++ b/小程序接口文档.md @@ -1,5 +1,4 @@ - -## 发起出差申请 +## /发起出差申请 ```text 暂无描述 ``` @@ -404,7 +403,7 @@ data.pages | 1 | Number | > 已完成 #### 接口URL -> http://localhost:9999/act/personalCenter/taskDoneList?current=1&size=100&category= +> http://localhost:9999/act/personalCenter/taskList?current=1&size=100&category= #### 请求方式 > GET @@ -962,7 +961,7 @@ data.pages | 1 | Number | > 已完成 #### 接口URL -> /act/task/view/:id +> /act/personalCenter/progress_view/:id #### 请求方式 > GET @@ -973,7 +972,7 @@ data.pages | 1 | Number | #### 路径变量 参数名 | 示例值 | 参数描述 --- | --- | --- -id | - | 任务id +id | - | 实列id #### 预执行脚本 ```javascript 暂无预执行脚本 @@ -1209,7 +1208,14 @@ data.persistentState.deleteReason | - | Object | "outOfOfficeAddress": "", "handoverPerson": "", "handoverPersonPhone": "", - "handoverPersonPost": "" + "handoverPersonPost": "", + "fileList":[ + { + "fileName":"文件名", + "original":"文件原始名称", + "size":"文件大小" + } + ] } ``` 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 @@ -1224,6 +1230,10 @@ outOfOfficeAddress | - | String | 是 | 外出地址 handoverPerson | - | String | 是 | 交接人 handoverPersonPhone | - | String | 是 | 交接人电话 handoverPersonPost | - | String | 是 | 交接人职务 +fileList | - | Object | 是 | - +fileList.fileName | 文件名 | String | 是 | 文件名 +fileList.original | 文件原始名称 | String | 是 | 文件原始名称 +fileList.size | 文件大小 | String | 是 | 文件大小 #### 预执行脚本 ```javascript 暂无预执行脚本 @@ -1274,7 +1284,14 @@ success | - | - | 成功响应 "applyReason": "", "destination": "", "ticketAmount": "", - "remarks": "" + "remarks": "", + "fileList":[ + { + "fileName":"文件名", + "original":"文件原始名称", + "size":"文件大小" + } + ] } ``` 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 @@ -1284,6 +1301,10 @@ applyReason | - | String | 是 | 申请理由 destination | - | String | 是 | 目的地 ticketAmount | - | Double | 是 | 机票金额 remarks | - | String | 是 | 备注 +fileList | - | Object | 是 | - +fileList.fileName | 文件名 | String | 是 | 文件名 +fileList.original | 文件原始名称 | String | 是 | 文件原始名称 +fileList.size | 文件大小 | String | 是 | 文件大小 #### 预执行脚本 ```javascript 暂无预执行脚本 @@ -1723,4 +1744,359 @@ data.fromData.createTime | - | Object | data.fromData.tenantId | - | Object | data.fromData.remarks | - | Object | 备注 data.fromData.accommodationFee | 3 | Number | -data.fromData.status | 1 | Number | 申请审批状态 \ No newline at end of file +data.fromData.status | 1 | Number | 申请审批状态 +## /获取个人部门岗位信息 +```text +暂无描述 +``` +#### 接口状态 +> 已完成 + +#### 接口URL +> /oa/public/userInfo + +#### 请求方式 +> GET + +#### Content-Type +> form-data + +#### 预执行脚本 +```javascript +暂无预执行脚本 +``` +#### 后执行脚本 +```javascript +暂无后执行脚本 +``` +#### 成功响应示例 +```javascript +{ + "data":{ + "username":"zhengjl", + "name":"姓名", + "deptName":"部门名称", + "post":"岗位名称" + } +} +``` +参数名 | 示例值 | 参数类型 | 参数描述 +--- | --- | --- | --- +data | - | Object | 返回数据 +data.username | zhengjl | String | 用户名 +data.name | 姓名 | String | 姓名 +data.deptName | 部门名称 | String | 部门名称 +data.postName | 岗位名称 | String | 岗位名称 +## /文件上传接口 +```text +暂无描述 +``` +#### 接口状态 +> 已完成 + +#### 接口URL +> /admin/sys-file/upload + +#### 请求方式 +> POST + +#### Content-Type +> form-data + +#### 请求Body参数 +参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 +--- | --- | --- | --- | --- +file | - | Text | 是 | 文件流 +#### 预执行脚本 +```javascript +暂无预执行脚本 +``` +#### 后执行脚本 +```javascript +暂无后执行脚本 +``` +#### 成功响应示例 +```javascript +{ + "code": 0, + "msg": null, + "data": { + "bucketName": "armycloud", + "fileName": "282a39aae68d4c7e8a3e316a146fe69f.0", + "url": "/admin/sys-file/armycloud/282a39aae68d4c7e8a3e316a146fe69f.0" + } +} +``` +参数名 | 示例值 | 参数类型 | 参数描述 +--- | --- | --- | --- +code | - | Number | +msg | - | Object | 返回文字描述 +data | - | Object | 返回数据 +data.bucketName | armycloud | String | 空间 +data.fileName | 282a39aae68d4c7e8a3e316a146fe69f.0 | String | 文件名 +data.url | /admin/sys-file/armycloud/282a39aae68d4c7e8a3e316a146fe69f.0 | String | +## /文件下载 +```text +暂无描述 +``` +#### 接口状态 +> 已完成 + +#### 接口URL +> admin/sys-file/armycloud/:fileName + +#### 请求方式 +> GET + +#### Content-Type +> form-data + +#### 路径变量 +参数名 | 示例值 | 参数描述 +--- | --- | --- +fileName | - | 文件名 +#### 预执行脚本 +```javascript +暂无预执行脚本 +``` +#### 后执行脚本 +```javascript +暂无后执行脚本 +``` +#### 成功响应示例 +```javascript +文件流 +``` +## /获取请假类型 +```text +暂无描述 +``` +#### 接口状态 +> 已完成 + +#### 接口URL +> /oa/personnelvacationtype/list + +#### 请求方式 +> GET + +#### Content-Type +> form-data + +#### 预执行脚本 +```javascript +暂无预执行脚本 +``` +#### 后执行脚本 +```javascript +暂无后执行脚本 +``` +#### 成功响应示例 +```javascript +{ + "data":[ + { + "id":"", + "name":"", + "remarks":"" + } + ] +} +``` +参数名 | 示例值 | 参数类型 | 参数描述 +--- | --- | --- | --- +data | - | Object | 返回数据 +data.id | - | Object | 类型id +data.name | - | Object | 请假类型名称 +data.remarks | - | Object | 备注 +## /请假申请 +```text +暂无描述 +``` +#### 接口状态 +> 已完成 + +#### 接口URL +> /oa/processManagement/leaveApply + +#### 请求方式 +> POST + +#### Content-Type +> json + +#### 请求Body参数 +```javascript +{ + "typeId":"", + "startDate":"", + "endDate":"", + "days":"", + "reasonForLeave":"", + "vacationPlace":"", + "fileList":[ + { + "fileName":"文件名", + "original":"文件原始名称", + "size":"文件大小" + } + ] +} +``` +参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 +--- | --- | --- | --- | --- +typeId | - | Object | 是 | 请假类型 +startDate | - | Date | 是 | 开始时间 yyyy-MM-dd +endDate | - | Date | 是 | 截止时间 yyyy-MM-dd +days | - | Number | 是 | 请假天数 +reasonForLeave | - | Object | 是 | 请假事由 +vacationPlace | - | Object | 是 | 休假地点 +fileList | - | Array | 是 | - +fileList.fileName | 文件名 | String | 是 | 文件名 +fileList.original | 文件原始名称 | String | 是 | 文件原始名称 +fileList.size | 文件大小 | String | 是 | 文件大小 +#### 预执行脚本 +```javascript +暂无预执行脚本 +``` +#### 后执行脚本 +```javascript +暂无后执行脚本 +``` +#### 成功响应示例 +```javascript +{ + "data":"", + "code":0 +} +``` +参数名 | 示例值 | 参数类型 | 参数描述 +--- | --- | --- | --- +data | - | Object | 返回数据 +code | - | Number | +## /查询用户假期信息 +```text +放回map key 对应请假类型id value 天数 +``` +#### 接口状态 +> 已完成 + +#### 接口URL +> /oa/oapersonnelfiles/vacationInfo + +#### 请求方式 +> GET + +#### Content-Type +> form-data + +#### 预执行脚本 +```javascript +暂无预执行脚本 +``` +#### 后执行脚本 +```javascript +暂无后执行脚本 +``` +#### 成功响应示例 +```javascript +{ + "data":{ + "typeId":"假期天数" + } +} +``` +## /获取打卡信息 +```text +暂无描述 +``` +#### 接口状态 +> 已完成 + +#### 接口URL +> /oa/punchinrecord/info + +#### 请求方式 +> GET + +#### Content-Type +> form-data + +#### 预执行脚本 +```javascript +暂无预执行脚本 +``` +#### 后执行脚本 +```javascript +暂无后执行脚本 +``` +#### 成功响应示例 +```javascript +{ + "data":{ + "id":"", + "name":"", + "goToWorkTime":"", + "closingTime":"", + "userGoToWorkTime":"", + "userClosingTime":"", + "weekdays":"" + } +} +``` +参数名 | 示例值 | 参数类型 | 参数描述 +--- | --- | --- | --- +data | - | Object | 返回数据 +data.id | - | Object | 考勤组id +data.name | - | Object | 考勤组名称 +data.goToWorkTime | - | Object | 上班时间 +data.closingTime | - | Object | 下班时间 +data.userGoToWorkTime | - | Object | 用户上班打卡时间 +data.userClosingTime | - | Object | 用户下班打卡时间 +data.weekdays | - | Object | 是否为工作日 +## /打卡 +```text +暂无描述 +``` +#### 接口状态 +> 已完成 + +#### 接口URL +> /oa/punchinrecord/punchTheClock + +#### 请求方式 +> POST + +#### Content-Type +> json + +#### 请求Body参数 +```javascript +{ + "address":"", + "longitudeAndLatitude":"" +} +``` +参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 +--- | --- | --- | --- | --- +address | - | Object | 是 | 地址 +longitudeAndLatitude | - | Object | 是 | 经纬度 +#### 预执行脚本 +```javascript +暂无预执行脚本 +``` +#### 后执行脚本 +```javascript +暂无后执行脚本 +``` +#### 成功响应示例 +```javascript +{ + "data":"success", + "code":0 +} +``` +参数名 | 示例值 | 参数类型 | 参数描述 +--- | --- | --- | --- +data | success | String | 返回数据 +code | - | Number | 错误标识 \ No newline at end of file