文档说明
文档目的
> 本系统说明书的编写目的,是为了让开发人员充分了解在与本WCS系统交互时需要提供的API接口。
相关约定
协议约定
> 在没特殊约定的情况下,接口统一采用Http请求的方式进行交互。
请求方式
> POST appliaction/json
编码约定
> UTF-8编码
库位约定
> L020202 表示 第二排第二列第二层
WCS公共响应参数
字段 | 类型 | 长度 | 必填 | 描述 |
---|---|---|---|---|
respCode | int | - | 是 | 状态码 |
respMsg | string | - | 否 | 业务返回码描述 |
data | object / array | - | 否 | 具体参考文档描述 |
响应示例
{
"respCode": 0, /* 0-成功,1-失败 */
"respMsg": "",
"data": "{}或[]",
}
上位机公共响应参数
字段 | 类型 | 长度 | 必填 | 描述 |
---|---|---|---|---|
code | int | - | 是 | 状态码 |
msg | string | - | 否 | 业务返回码描述 |
data | object | - | 否 | 具体参考文档描述 |
success | boolean | - | 是 | 是否成功 |
状态码 | 说明 |
---|---|
200 | OK |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
响应示例
{
"code": 200,
"data": {},
"msg": "",
"success": true
}
备注
- 更多返回错误代码上位机可以自行添加,但务必返回对应的msg描述信息