# 用餐申请单作废接口

# 1.概述

调用【用餐申请单作废】接口，可以将已经同步给美团企业版的申请单作废。

# 2.接口基本信息

名称	描述
请求方式	POST
调用地址	测试环境：https://waimai-openapi.apigw.test.meituan.com/api/sqt/open/repast/applyCancel 正式环境：https://bep-openapi.meituan.com/api/sqt/open/repast/applyCancel
调用方	客户平台
响应方	美团企业版
响应超时时间	3秒
调用限频	每分钟访问不超过100次，每天累计访问不超过100000次

# 2.1.请求体

名称	类型	是否必填	示例	说明
accessKey	String	是		美团企业版分配给客户的接入秘钥
content	String	是	UgxoCGPQIzoP	请求体内容，将请求参数JSON序列化后进行加密的结果值，参照：签名实例

# content加密前数据结构

名称	类型	是否必填	示例	说明
ts	Long	是	1617085650321	13位时间戳。若请求发起时间与平台接受请求时间相差大于10分钟，平台将直接拒绝本次请求
entId	Long	是	46574	企业ID
externalApplyList	List<ExternalApplyInfo>	是	见ExternalApplyInfo	外部申请单列表，单次最多作废10单

ExternalApplyInfo字段说明

名称	类型	是否必填	示例	说明
sceneType	Integer	是		用餐场景，1：商务宴请；4：工作餐；5：团建用餐
externalApplyNo	String	是		外部用餐申请单号

# 2.2.响应参数

名称	类型	是否必填	示例	说明
traceId	String	是	56a0af18ae30a168d4006c7c	日志查询ID，用于排查问题
status	Integer	是	0	接口响应编码，返回0为同步成功，返回其他则有报错，编码枚举值和解决方案详见第四章
msg	String	否		错误描述信息
data	String	是	UgxoCGPQIzoP	响应数据，将响应参数JSON序列化后进行加密的结果值，解密秘钥使用secretKey参数

# data解密后数据结构

类型	是否必填	示例	说明
List<ApplyCancelResult>	是	见ApplyCancelResult	作废申请单结果列表

# ApplyCancelResult字段说明

ApplyCancelResult字段说明

名称	类型	是否必填	示例	说明
result	Integer	是	0	接口响应编码，返回0为同步成功，返回其他则有报错，编码枚举值和解决方案详见第四章
itemMsg	String	是	成功	同步结果信息描述
externalApplyNo	String	是	39WNRUYJC1Z6	外部用餐申请单号

# 3.示例

# 3.1.请求示例

# 3.1.1.请求示例

{
  "accessKey": "B3KSWLDSKSKDMJ",
  "content": "UgxoCGPQIzoP"
}

# 3.1.2.请求参数content解析

{
  "ts": 1617085650321,
  "entId": 100991,
  "externalApplyList": [
    {
      "sceneType": 1,
      "externalApplyNo": "5N91SJQPUPZ5"
    }
  ]
}

# 3.2.响应示例

# 3.2.1.响应结果

{
  "traceId": "56a0af18ae30a168d4006c7c",
  "status": 0,
  "msg": "处理成功",
  "data": "UgJn07uNgW7S7fJK0R0xVbaLxoCGPQIzoP-_K4Hmp4RduGszhm2mbUs2toZhCtXKP5JGXVTZ9kGts2Wx3IJQCd90ptMoJTDB0vu7mkedEr4KZCvZn77EZLssMC5SpXilmQ-5RXHzvMIT0ASH-IXepTP_O16U37QqCkEb5L1WLy4"
}

# 3.2.2.响应参数data解析

[
  {
    "externalApplyNo": "xxxxxx21",
    "result": 0,
    "itemMsg": "处理成功"
  }
]

# 4.错误码

# 4.1.status错误码

错误码	错误描述	解决方案
10010002	企业已停止合作，请联系客户经理进行确认	将接口调用的entId参数给到客户经理，由客户经理确认企业状态是否在合作中
10010003	content不合法	详细阅读content参数加密说明（签名实例），确认content加密方式和content解密前传参是否正确
10010004	ts缺失或ts时间已过期	确认ts是否传值并为13位时间戳，如果正确传值，则确认请求发起时间与美团企业版接受请求的时间差是否超过10分钟
10010005	entId不能为空	entId参数不可为空，如果未拿到entId参数，可以咨询客户经理获取
20010001	accessKey不合法	检查accessKey是否为客户经理给到的值，如果accessKey值正确，确认调用环境是否和accessKey一致，如使用测试环境的accessKey调用线上的接口
20010002	请求path不合法	检查接口调用地址是否正确，如是否有非法字符
20010003	鉴权失败，无接口访问权限	将接口调用地址给到客户经理，由客户经理检查接口权限是否开通并保存成功
20010004	越权访问，无法访问该企业数据，请检查entId的正确性	检查accessKey和entId两个参数的对应关系是否正确
30010001	访问频率过高	请确认接口访问频率，每个接口默认调用限频为每分钟不超过100次，超出调用频率会调用此错误
30010002	访问次数超过配额	请确认接口的累计访问次数，每个接口的默认累计调用量为10w次，超出限额则会报错
10170001	参数校验不通过，必填参数为空	请查看响应结果中的msg信息，根据提示进行调整，必传字段不可传空值
10170002	入参数据校验不通过	请查看响应结果中的msg信息，根据提示确认字段是否正确传值，如sceneType枚举值错误等
40175000	未知错误，请联系美团侧研发	请提供响应结果中的traceId参数，联系客户经理进行排查
40175001	部分处理成功	请查看响应结果中的result和itemMsg信息，根据解决方案进行调整

# 4.2.result错误码

错误码	错误描述	解决方案
10170003	无效单据	请检查externalApplyNo字段传参，确认传入单号的真实性和有效性

# 5.代码实例

依赖SDK包地址：SDK下载地址

import com.google.common.collect.Lists;
import com.meituan.sqt.client.SqtClient;
import com.meituan.sqt.constant.CommonConstants;
import com.meituan.sqt.enums.ResponseStatusEnum;
import com.meituan.sqt.exception.MtSqtException;
import com.meituan.sqt.request.in.apply.RepastApplyCancelRequest;
import com.meituan.sqt.response.in.BaseApiResponse;
import com.meituan.sqt.response.in.apply.RepastApplyCancelResultItem;

import java.util.List;

public class RepastApplyCancelDemo {

    private static final String invokeUrl = "https://waimai-openapi.apigw.test.meituan.com/api/sqt/open/repast/applyCancel";

    private static SqtClient sqtClient = null;

    static {
        // 初始化SqtClient，只需要初始化一次即可
        // entId，accessKey，secretKey需要根据不同环境动态的设置获取
        sqtClient = new SqtClient.Builder()
                .setEntId(CommonConstants.entId)
                .setAccessKey(CommonConstants.accessKey)
                .setSecretKey(CommonConstants.secretKey)
                .build();
    }

    public static void main(String[] args) throws MtSqtException {
        // 构建请求对象
        RepastApplyCancelRequest repastApplyCancelRequest = new RepastApplyCancelRequest();
        repastApplyCancelRequest.setTs(System.currentTimeMillis());
        repastApplyCancelRequest.setEntId(sqtClient.getEntId());
        RepastApplyCancelRequest.CancelOutRepastApply cancelOutRepastApply = new RepastApplyCancelRequest.CancelOutRepastApply();
        cancelOutRepastApply.setSceneType(1);
        cancelOutRepastApply.setExternalApplyNo("test-1233333");
        repastApplyCancelRequest.setExternalApplyList(Lists.newArrayList(cancelOutRepastApply));
        // API调用
        // 注意：超时时间默认以请求对象中注解ApiMeta上设置的为准，也可以自定义传递对应的超时时间
        BaseApiResponse<List<RepastApplyCancelResultItem>> response = sqtClient.invokeApi(invokeUrl, repastApplyCancelRequest, null, null);
        // 响应结果为空处理
        if (response == null) {
            // 处理响应结果为空情况
            // ...

        }
        // 获取结果
        if(ResponseStatusEnum.SUCCESS.getCode().intValue() == response.getStatus()) {
            // 成功
            List<RepastApplyCancelResultItem> resultItemList = response.getRealData();
            // 处理业务逻辑
            // ...
        } else {
            // 处理失败场景
            handleRespFailResult(response);
        }
    }

    private static void handleRespFailResult(BaseApiResponse<List<RepastApplyCancelResultItem>> response) {
        // 访问频率过高
        if (ResponseStatusEnum.HIGH_FREQUENCY_ACCESS.getCode().intValue() == response.getStatus()) {
            // 解决方案参照：https://h5.dianping.com/app/bep-docs/open-platform-doc/guide/rate_limiting.html
        }
        // 访问次数超过配额
        if (ResponseStatusEnum.EXCEED_ACCESS_NUMBER.getCode().intValue() == response.getStatus()) {
            // 解决方案参照：https://h5.dianping.com/app/bep-docs/open-platform-doc/guide/rate_limiting.html
        }
        // 其它失败场景

    }
}

# 6.版本记录

版本号	版本日期	更新内容
v1.0	2023-02-02	新增用餐申请撤销接口

← 用餐申请单同步出差申请单同步 →