# API 接口文档

- **文档版本**：v1.0.0
- **最后更新**：2026-2-24

---

## 1. 概述

### 1.1 目标
- 第三方接口文档：智能大屏系统与第三方系统数据交互接口文档。

---

## 2. 通用约定

### 2.1 数据格式
- **请求/响应格式**：`application/json; charset=utf-8`
- **字符集**：UTF-8

### 2.2 通用 Header
| Header | 必填 | 示例 | 说明 |
|---|---:|---|---|

### 2.4 通用响应结构

```json
{
  "code": 200,
  "message": "success",
  "data": {}
}
```

---

## 3. WCS接口

### 3.1 WCS站点信息同步

- **API URL(WCS实际提供为准)**：`/openapi/stationStatus`
- **请求/响应格式**：`application/json; charset=utf-8`
- **字符集**：UTF-8
- **请求方式**: POST

#### 3.1.1 Header
| Header | 必填 | 示例 | 说明 |
|---|---:|---|---|

#### 3.1.2 Body
| Body | 必填 | 类型    | 示例            | 说明          |
|------|---:|-------|---------------|-------------|
|stationIds|  是 | int[] | [100,101,102] | 需要查询的站点编号列表 |

#### 3.1.3 响应字段
| 字段         | 类型   | 示例   | 说明     |
|------------|------|------|--------|
| stationIds | int  | 100  | 站点编号   |
| autoing    | bool | true | 自动     |
| loading    | bool | true | 有物     |
| error      | int  | 0    | 错误码    |
| errorMsg | str  |   | 错误信息   |
| systemWarning | str  |   | 系统报警信息 |
| superTaskNo | str  |   | WMS任务号 |

### 3.1.4 响应JSON
```json
{
  "msg" : "操作成功",
  "code" : 200,
  "data" : [ {
    "stationId" : 1152,
    "autoing" : true,
    "loading" : false,
    "error" : 0,
    "errorMsg" : null,
    "systemWarning" : null,
    "superTaskNo" : "0"
  }, {
    "stationId" : 1157,
    "autoing" : true,
    "loading" : true,
    "error" : 0,
    "errorMsg" : null,
    "systemWarning" : null,
    "superTaskNo" : "0"
  }]
}
```
### 3.2 WMS任务查询接口

- **API URL(WCS实际提供为准)**：`/open/asrs/queryTask`
- **请求/响应格式**：`application/json; charset=utf-8`
- **字符集**：UTF-8
- **请求方式**: POST

#### 3.2.1 Header
| Header | 必填 | 示例 | 说明 |
|---|---:|---|---|

#### 3.2.2 Body
| Body | 必填 | 类型  | 示例   | 说明  |
|------|---:|-----|------|-----|
|barcode|  是 | str | 1234 | 托盘码 |

#### 3.2.3 响应字段
| 字段         | 类型     | 示例   | 说明                                                                          |
|------------|--------|------|-----------------------------------------------------------------------------|
| matnr | str    |   | 物料号                                                                         |
| maktx    | str    |  | 物料名称                                                                        |
| batch    | str    |  | 批次号                                                                         |
| specs      | str    |     | 规格                                                                          |
| anfme | double |   | 数量                                                                          |
| ioType | int    |   | 任务类型：<br/>1、入库<br/>53、拣料回库<br/>57、盘点回库<br/>101、出库<br/>103、拣料出库<br/>107、盘点出库 |

### 3.2.4 响应JSON
```json
{
  "msg" : "操作成功",
  "code" : 200,
  "data" : {
    "wrkDetls" : [ {
      "anfme" : 100.0,
      "matnr" : "50001LR-71",
      "maktx" : "气泡袋",
      "batch" : null,
      "specs" : "50001LR-71"
    } ],
    "ioType": 1
  }
}
```

### 3.3 WMS入库任务查询接口

- **API URL(WCS实际提供为准)**：`/open/asrs/queryComb`
- **请求/响应格式**：`application/json; charset=utf-8`
- **字符集**：UTF-8
- **请求方式**: POST

#### 3.3.1 Header
| Header | 必填 | 示例 | 说明 |
|---|---:|---|---|

#### 3.3.2 Body
| Body | 必填 | 类型  | 示例   | 说明  |
|------|---:|-----|------|-----|
|barcode|  是 | str | 1234 | 托盘码 |

#### 3.3.3 响应字段
| 字段         | 类型     | 示例   | 说明   |
|------------|--------|------|------|
| matnr | str    |   | 物料号  |
| maktx    | str    |  | 物料名称 |
| batch    | str    |  | 批次号  |
| specs      | str    |     | 规格   |
| anfme | double |   | 数量   |

### 3.3.4 响应JSON
```json
{
  "msg" : "操作成功",
  "code" : 200,
  "data" : {
    "combDetls" : [ {
      "anfme" : 100.0,
      "matnr" : "50001LR-71",
      "maktx" : "气泡袋",
      "batch" : null,
      "specs" : "50001LR-71"
    } ]
  }
}
```

### 3.4 WMS库存数据查询

- **API URL(WCS实际提供为准)**：`/open/asrs/queryLoc`
- **请求/响应格式**：`application/json; charset=utf-8`
- **字符集**：UTF-8
- **请求方式**: GET

#### 3.4.1 Header
| Header | 必填 | 示例 | 说明 |
|---|---:|---|---|

#### 3.4.2 Body
| Body | 必填 | 类型  | 示例   | 说明  |
|------|---:|-----|------|-----|

#### 3.4.3 响应字段
| 字段         | 类型     | 示例   | 说明   |
|------------|--------|------|------|
| emptyCount | int    |   | 空库位数量  |
| disableCount    | int    |  | 禁用库位数量 |
| total    | int    |  | 总库位数量 |
| stockCount    | int    |  | 在库位数量 |
| usedPr    | double |  | 库位使用率 |
| used    | int    |  | 库位使用数量 |
| pie    | list   |  | 饼图数据 |

### 3.4.4 响应JSON
```json
{
  "msg" : "操作成功",
  "code" : 200,
  "data" : {
    "emptyCount" : 52994,
    "total" : 53130,
    "usedPr" : 0.3,
    "disableCount" : 0,
    "used" : 136,
    "pie" : [ {
      "name" : "在库",
      "value" : 122
    }, {
      "name" : "空",
      "value" : 52994
    }, {
      "name" : "使用",
      "value" : 14
    }, {
      "name" : "禁用",
      "value" : 0
    } ],
    "stockCount" : 122
  }
}
```

### 3.5 WMS入出库折线图

- **API URL(WCS实际提供为准)**：`/open/asrs/line/charts`
- **请求/响应格式**：`application/json; charset=utf-8`
- **字符集**：UTF-8
- **请求方式**: GET

#### 3.5.1 Header
| Header | 必填 | 示例 | 说明 |
|---|---:|---|---|

#### 3.5.2 Body
| Body | 必填 | 类型  | 示例   | 说明  |
|------|---:|-----|------|-----|

#### 3.5.3 响应字段
| 字段         | 类型     | 示例   | 说明   |
|------------|--------|------|------|

### 3.5.4 响应JSON
```json
{
  "msg" : "操作成功",
  "code" : 200,
  "data" : {
    "rows" : [ {
      "name" : "入库数量",
      "data" : [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 198 ]
    }, {
      "name" : "出库数量",
      "data" : [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ]
    } ]
  }
}
```

### 3.6 WMS库存数据统计

- **API URL(WCS实际提供为准)**：`/open/asrs/locDetl/statistics`
- **请求/响应格式**：`application/json; charset=utf-8`
- **字符集**：UTF-8
- **请求方式**: GET

#### 3.6.1 Header
| Header | 必填 | 示例 | 说明 |
|---|---:|---|---|

#### 3.6.2 Body
| Body | 必填 | 类型  | 示例   | 说明  |
|------|---:|-----|------|-----|

#### 3.6.3 响应字段
| 字段         | 类型     | 示例   | 说明   |
|------------|--------|------|------|

### 3.6.4 响应JSON
```json
{
  "msg" : "操作成功",
  "code" : 200,
  "data" : {
    "records" : [ {
      "anfme" : 19500.0,
      "matnr" : "50001LR-71",
      "maktx" : "气泡袋",
      "batch" : null,
      "specs" : "50001LR-71"
    } ]
  }
}
```