数码作废接口（特殊定制，非通用接口）

# 数码作废接口 `非公开`

## 支持场景

> 一次提交一个码用于单码作废，一次提交多个码用于批量作废。每次请求最多提交 1000 个码。

## API描述

> 对请求中数码作废，支持批量。

## 请求流程

> 1. 在超8平台申请第三方应用的 Access Key 和密钥。
> 2. 申请 Access Token。操作步骤见 [获取 AccessToken](https://developers.yesno.com.cn/doc/57/)。
> 3. 携带 Access Token 调用开放接口。调用流程见 [接入指南](https://developers.yesno.com.cn/doc/56/)。

## 请求信息

| 协议 | HTTPS |
|---|---|
| 请求方法 | POST |
| 请求路径 | /base/app/v1/open/digit/code/obsolete |

## header头

请求头字段见 [通用请求头](https://developers.yesno.com.cn/doc/56/)。

请求体使用 UTF-8 JSON，Content-Type 为 application/json。

## 传入参数

| 参数名称 | 是否必填 | 参数类型 | 参数说明 |
|---|---|---|---|
| digits | 是 | List&lt;String&gt; | 待作废码值集合。JSON 中为字符串数组，长度 1～1000，每个码值非空 |

## 返回消息体

<table>
  <tr><td>名称</td><td>类型</td><td>是否必须</td><td>默认值</td><td>备注</td><td>其他信息</td></tr>
  <tr><td>message</td><td>string</td><td>必须</td><td></td><td>响应说明</td><td></td></tr>
  <tr><td>code</td><td>integer</td><td>必须</td><td></td><td>200 表示批次结果已返回</td><td>format: int32</td></tr>
  <tr><td>data</td><td>object</td><td>必须</td><td></td><td>批次结果</td><td></td></tr>
  <tr><td colspan="6">
    <table>
      <tr><td>results</td><td>object[]</td><td>必须</td><td></td><td>逐码结果</td><td>Java 对应结果对象列表</td></tr>
      <tr><td colspan="6">
        <table>
          <tr><td>code</td><td>string</td><td>必须</td><td></td><td>本条结果对应的码值</td><td></td></tr>
          <tr><td>status</td><td>string</td><td>必须</td><td></td><td>SUCCESS 已确认作废，FAILED 作废失败</td><td></td></tr>
        </table>
      </td></tr>
    </table>
  </td></tr>
</table>

## 请求示例
```http
POST {URL}/digit/order/v1/open/code/obsolete
Content-Type: application/json

{
  "digits": ["CODE001", "CODE002"]
}
```

## 出参示例

```json
{
  "message": "处理完成",
  "code": 200,
  "data": {
    "results": [
      { "code": "CODE001", "status": "SUCCESS" },
      { "code": "CODE002", "status": "FAILED" }
    ]
  }
}
```

## HTTP 状态码说明

| 返回码 | 描述 |
|---|---|
| 200 | 返回逐码结果，可能部分成功 |
| 21100001 | 参数错误 |
| 21100004 | 数码为空 |
| 21100005 | 解码失败 |
| 21100098 | 数码个数不能超过 1000 |
| 21100026 | 系统异常或数据库提交结果无法确认 |