cn.felord.api

Interface ApprovalApi

public interface ApprovalApi

企业微信审批

Since:

2024 /5/25 14:18

Author:

dax

Method Summary

Modifier and Type	Method and Description
GenericResponse<String>	applyEvent(ApprovalApplyRequest request) Deprecated. 使用未过时接口替代
GenericResponse<String>	applyEvent(ProcessApplyRequest request) 提交审批申请
GenericResponse<String>	createTemplate(ApprovalTempAddRequest template) 创建审批模板
GenericResponse<ApprovalDetail>	getApprovalDetail(ApprovalSpNo spNo) 获取审批申请详情 sp_no
SpNoListResponse	getApprovalInfo(SpNoListRequest request) 批量获取审批单号
GenericResponse<OpenApprovalData>	getOpenApprovalData(ApprovalThirdNo thirdNo) 查询自建应用审批单当前状态
ApprovalTmpDetailResponse	getTemplateDetail(TemplateId templateId) 获取审批模板详情
GenericResponse<List<VacationQuota>>	getUserVacationQuota(UserId userId) 获取成员假期余额
WeComResponse	setOneUserQuota(UserQuotaSettingRequest request) 修改成员假期余额
WeComResponse	updateTemplate(ApprovalTempUpdateRequest template) 更新审批模板

Method Detail

getTemplateDetail

@POST(value="oa/gettemplatedetail")
ApprovalTmpDetailResponse getTemplateDetail(@Body
                                                                                TemplateId templateId)
                                                                         throws WeComException

获取审批模板详情

Parameters:

templateId - the template id

Returns:

the detail

Throws:

WeComException - the weComException

createTemplate

@POST(value="oa/approval/create_template")
GenericResponse<String> createTemplate(@Body
                                                                                  ApprovalTempAddRequest template)
                                                                           throws WeComException

创建审批模板

仅『审批』系统应用、自建应用和代开发自建应用可调用。

Parameters:

template - the template

Returns:

the generic response

Throws:

WeComException - the weComException

updateTemplate

@POST(value="oa/approval/update_template")
WeComResponse updateTemplate(@Body
                                                                        ApprovalTempUpdateRequest template)
                                                                 throws WeComException

更新审批模板

可调用本接口更新审批模板。更新模板后，管理后台及审批应用内将更新原模板的内容，已配置的审批流程和规则不变。

• 仅『审批』系统应用，自建应用和代开发自建应用可调用
• 所有应用都可以通过本接口更新自己的模板
• 『审批』系统应用可以修改管理员手动创建的模板
• 自建应用和代开发自建应用不可通过本接口更新其他应用创建的模板

Parameters:

template - the template

Returns:

the we com response

Throws:

WeComException - the weComException

applyEvent

@POST(value="oa/applyevent")
 @Deprecated
GenericResponse<String> applyEvent(@Body
                                                                             ApprovalApplyRequest request)
                                                                      throws WeComException

Deprecated. 使用未过时接口替代

提交审批申请

暂不支持通过接口提交[打卡补卡][调班]模板审批单

Parameters:

request - the request

Returns:

the generic response

Throws:

WeComException - the weComException

applyEvent

@POST(value="oa/applyevent")
GenericResponse<String> applyEvent(@Body
                                                                ProcessApplyRequest request)
                                                         throws WeComException

提交审批申请

Parameters:

request - the request

Returns:

the generic response

Throws:

WeComException - the we com exception

Since:

1.2.7

getApprovalInfo

@POST(value="oa/getapprovalinfo")
SpNoListResponse getApprovalInfo(@Body
                                                                   SpNoListRequest request)
                                                            throws WeComException

批量获取审批单号

一次拉取调用最多拉取100个审批记录，可以通过多次拉取的方式来满足需求。

1. 接口频率限制 600次/分钟
2. 请求的参数endtime需要大于startime， 起始时间跨度不能超过31天

Parameters:

request - the request

Returns:

the sp no list response

Throws:

WeComException - the weComException

getApprovalDetail

@POST(value="oa/getapprovaldetail")
GenericResponse<ApprovalDetail> getApprovalDetail(@Body
                                                                                      ApprovalSpNo spNo)
                                                                               throws WeComException

获取审批申请详情 sp_no

Parameters:

spNo - the sp no

Returns:

sp no list response

Throws:

WeComException - the weComException

getOpenApprovalData

@POST(value="corp/getopenapprovaldata")
GenericResponse<OpenApprovalData> getOpenApprovalData(@Body
                                                                                              ApprovalThirdNo thirdNo)
                                                                                       throws WeComException

查询自建应用审批单当前状态

Parameters:

thirdNo - the third no thirdNo

Returns:

the generic response

Throws:

WeComException - the weComException

getUserVacationQuota

@POST(value="oa/vacation/getuservacationquota")
GenericResponse<List<VacationQuota>> getUserVacationQuota(@Body
                                                                                                          UserId userId)
                                                                                                   throws WeComException

获取成员假期余额

数据来源为人事助手-假期管理

Parameters:

userId - the user id

Returns:

the user vacation quota

Throws:

WeComException - the weComException

setOneUserQuota

@POST(value="oa/vacation/setoneuserquota")
WeComResponse setOneUserQuota(@Body
                                                                         UserQuotaSettingRequest request)
                                                                  throws WeComException

修改成员假期余额

Parameters:

request - the request

Returns:

the one user quota

Throws:

WeComException - the weComException