Merge branch 'hotfix/基础接口文档调整'

12 months ago · 0266c1dc7a
16 changed files with 37 additions and 51 deletions
--- a/wms/供应商/修改供应商.md
+++ b/wms/供应商/修改供应商.md
@ -17,10 +17,9 @@ __请求参数__
 | 参数名 | 类型 | 必填 | 说明 |
 | :-- | :-- | :-- | :-- |
 | profile | String | 是 | 厂区|
-| key | string | 是 | |
 | code | string | 是 | 供应商编码 |
 | name | string | 是 | 供应商名称 |
-| status | string | 是 | 状态是否开启 |
+| status | string | 是 | 状态 1：开启 0：不开启 |
 | country | string | 否 | 国家 |
 | region | string | 否 | 省市 |

@ -29,7 +28,6 @@ __请求示例：__
 {
 "data":{
        "profile": "测试",
-        "key":"d2d0916d46cc497e83e69ea9e307a92c",
        "code":"wndSupplier",
        "name":"天天好集团aaa",
        "status": 0,
--- a/wms/供应商/删除供应商.md
+++ b/wms/供应商/删除供应商.md
@ -17,15 +17,13 @@ __请求参数__
 | 参数名 | 类型 | 必填 | 说明 |
 | :-- | :-- | :-- | :-- |
 | profile | String | 是 | 厂区|
-| key | string | 是 | 列表记录key |
-| code | string | 否 | 编码 |
+| code | string | 是 | 供应商编码 |

 __请求示例：__  
 ```
 {
  "data":{
 		"profile": "测试",
-	"key": "",
 		"code": "",
  }
 }
--- a/wms/供应商/新增供应商.md
+++ b/wms/供应商/新增供应商.md
@ -19,7 +19,7 @@ __请求参数__
 | profile | String | 是 | 厂区|
 | code | string | 是 | 供应商编码 |
 | name | string | 是 | 供应商名称 |
-| status | string | 是 | 状态是否开启 |
+| status | string | 是 | 状态 1：开启 0：不开启 |
 | country | string | 否 | 国家 |
 | region | string | 否 | 省市 |

--- a/wms/供应商/获取供应商详情.md
+++ b/wms/供应商/获取供应商详情.md
@ -17,15 +17,13 @@ __请求参数__
 | 参数名 | 类型 | 必填 | 说明 |
 | :-- | :-- | :-- | :-- |
 | profile | string | 是 | 厂区|
-| key | string | 否 | |
-| code | string | 否 | 编码 | 
+| code | string | 是 | 供应商编码 | 

 __请求示例：__  
 ```
 {
  "data":{ 
 		"profile": "测试",
-	"key" : "",
 		"code": "GYS001",
  }
 }
--- a/wms/员工/修改员工.md
+++ b/wms/员工/修改员工.md
@ -18,19 +18,17 @@ __请求参数__
 | :-- | :-- | :-- | :-- |
 | profile | String | 是 | 厂区|
 | userName | string | 是 | 用户登录名 |
-| key | string | 是 | 记录主键 |
 | password | string | 是 | 密码 |
 | name | string | 是 | 员工姓名 |
 | departmentCode | string | 否 | 部门编码 |
 | erpCode | string | 否 | ERP员工编号 |
-| status | int | 是 | 状态 |
+| status | int | 是 | 状态 1：启用 0：不启用|

 __请求示例：__  
 ```
 {
  "data":{
        "profile":"测试",
-        "key": "5fd5de9e9d48417881aa457be6500bcb",
        "userName":"zhangyz",
        "password":"123456",
        "name":"非凡",
--- a/wms/员工/删除员工.md
+++ b/wms/员工/删除员工.md
@ -17,14 +17,14 @@ __请求参数__
 | 参数名 | 类型 | 必填 | 说明 |
 | :-- | :-- | :-- | :-- |
 | profile | String | 是 | 厂区|
-| keyWord | string | 是 | 记录主键 |
+| userName | string | 是 | 登录用户名 |

 __请求示例：__  
 ```
 {
  "data":{
    "profile": "测试",
-    "keyWord":"5fd5de9e9d48417881aa457be6500bcb",
+    "userName":"",
  }
 }
 ````
--- a/wms/员工/新增员工.md
+++ b/wms/员工/新增员工.md
@ -22,7 +22,7 @@ __请求参数__
 | name | string | 是 | 员工姓名 |
 | departmentCode | string | 否 | 部门编码 |
 | erpCode | string | 否 | ERP员工编号 |
-| status | int | 是 | 状态 |
+| status | int | 是 | 状态 1：启用 0：不启用 |

 __请求示例：__  
 ```
--- a/wms/员工/获取员工详情.md
+++ b/wms/员工/获取员工详情.md
@ -17,14 +17,14 @@ __请求参数__
 | 参数名 | 类型 | 必填 | 说明 |
 | :-- | :-- | :-- | :-- |
 | profile | String | 是 | 厂区|
-| keyWord | string | 是 | 记录主键 |
+| userName | string | 是 | 登录用户名 |

 __请求示例：__  
 ```
 {
  "data":{
    "profile": "测试",
-	"keyWord":"5fd5de9e9d48417881aa457be6500bcb",
+	"userName":"",
  }
 }
 ````
--- a/wms/客户/修改客户.md
+++ b/wms/客户/修改客户.md
@ -19,9 +19,8 @@ __请求参数__
 | profile | String | 是 | 厂区|
 | code | String | 是 | 客户编码|
 | name | String | 是 | 客户名称|
-| key | String | 是| |
 | country | String | 否 | 国家|
-| region | String | 是 | 省市|
+| region | String | 否 | 省市|
 | status | int | 是 | 状态 1：启用 0：不启用|

 __请求示例：__  
@ -34,7 +33,6 @@ __请求示例：__
        "country":"china",
        "region":"shanghai",
        "status":0,
-        "key":"45960622d4a54c69b2e26a840056ff48"
  }
 }
 ````
--- a/wms/客户/删除客户.md
+++ b/wms/客户/删除客户.md
@ -17,15 +17,13 @@ __请求参数__
 | 参数名 | 类型 | 必填 | 说明 |
 | :-- | :-- | :-- | :-- |
 | profile | String | 是 | 厂区|
-| key | string | 是 | |
-| code | string | 否(优先按key删除) | |
+| code | string | 是 | 客户编码 |

 __请求示例：__  
 ```
 {
  "data":{
    "profile": "测试",
-	"key": "2fadc517f26446069930ecb8a3f59356",
    "code" : "code001"
  }
 }
--- a/wms/客户/新增客户.md
+++ b/wms/客户/新增客户.md
@ -20,7 +20,7 @@ __请求参数__
 | code | String | 是 | 客户编码|
 | name | String | 是 | 客户名称|
 | country | String | 否 | 国家|
-| region | String | 是 | 省市|
+| region | String | 否 | 省市|
 | status | int | 是 | 状态 1：启用 0：不启用|

 __请求示例：__  
--- a/wms/客户/获取客户详情.md
+++ b/wms/客户/获取客户详情.md
@ -17,8 +17,7 @@ __请求参数__
 | 参数名 | 类型 | 必填 | 说明 |
 | :-- | :-- | :-- | :-- |
 | profile | String | 是 | 厂区|
-| code | string | | |
-| key | string | | |
+| code | string | 是 | 客户编码 |

 __请求示例：__  
 ```
@ -26,7 +25,6 @@ __请求示例：__
  "data":{
 	"profile":"测试",
 	"code":"wnC1",
-        "key": "",
  }
 }
 ````
--- a/wms/部门/修改部门.md
+++ b/wms/部门/修改部门.md
@ -17,18 +17,16 @@ __请求参数__
 | 参数名 | 类型 | 必填 | 说明 |
 | :-- | :-- | :-- | :-- |
 | profile | String | 是 | 厂区|
-| key | string | 是 | |
 | code | string | 是 | 部门编码 |
 | name | string | 是 | 部门名称 |
-| status | int | 是 | 状态 |
-| parentCode | string | 是 | 上级部门 |
+| status | int | 是 | 状态 1：启用 0：不启用 |
+| parentCode | string | 否 | 上级部门 |

 __请求示例：__  
 ```
 {
  "data":{
    "profile":"测试",
-    "key":"c1f3202cc1ac4a9baa0ea48813e44635",
    "code": "woniuDep",
    "name":"测试部门",
    "status": 1,
--- a/wms/部门/新增部门.md
+++ b/wms/部门/新增部门.md
@ -19,8 +19,8 @@ __请求参数__
 | profile | String | 是 | 厂区|
 | code | string | 是 | 部门编码 |
 | name | string | 是 | 部门名称 |
-| status | int | 是 | 状态 |
-| parentCode | string | 是 | 上级部门 |
+| status | int | 是 | 状态 1：启用 0：不启用 |
+| parentCode | string | 否 | 上级部门 |


 __请求示例：__  
--- a/wms/部门/部门列表.md
+++ b/wms/部门/部门列表.md
@ -52,14 +52,16 @@ __data:__
 				"code": "100008",
 				"name": "财务管理部",
 				"createTime": "2022-09-30 08:54:01",
-				"status": 0
+				"status": 0，
+				"parentCode":"",
 			},
 			{
 				"key": "e7ed256eb16343b29f1d2c542fbea7ca",
 				"code": "100009",
 				"name": "电站业务部",
 				"createTime": "2022-09-30 08:54:02",
-				"status": 0
+				"status": 0，
+				"parentCode":"",
 			}
 		]
  }
--- a/wms/部门/部门详情.md
+++ b/wms/部门/部门详情.md
@ -17,14 +17,14 @@ __请求参数__
 | 参数名 | 类型 | 必填 | 说明 |
 | :-- | :-- | :-- | :-- |
 | profile | String | 是 | 厂区|
-| keyWord | string | 是 | 部门编码 |
+| code | string | 是 | 部门编码 |

 __请求示例：__  
 ```
 {
  "data":{
    "profile": "测试",
-    "keyWord" :"woniuDep",
+    "code" :"woniuDep",
  }
 }
 ````