Browse Source

员工部门文档add

master
张耀宗 12 months ago
parent
commit
c49818068d
  1. 67
      wms/员工/修改员工.md
  2. 55
      wms/员工/删除员工.md
  3. 76
      wms/员工/员工列表.md
  4. 65
      wms/员工/新增员工.md
  5. 64
      wms/员工/获取员工详情.md
  6. 2
      wms/客户/获取客户详情.md
  7. 76
      wms/部门/修改部门.md
  8. 56
      wms/部门/删除部门.md
  9. 75
      wms/部门/新增部门.md
  10. 70
      wms/部门/部门列表.md
  11. 68
      wms/部门/部门详情.md

67
wms/员工/修改员工.md

@ -0,0 +1,67 @@
### 修改员工
此接口用于修改WMS中的员工
此接口需要认证,详情请查看《认证方式》。
---
### 基本信息
方法:POST
URL: http://localhost:8033/open/UpdateWmsUser
---
### 请求
__请求参数__
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | String | 是 | 厂区|
| userName | string | 是 | 用户登录名 |
| key | string | 是 | 记录主键 |
| password | string | 是 | 密码 |
| name | string | 是 | 员工姓名 |
| departmentCode | string | 否 | 部门编码 |
| erpCode | string | 否 | ERP员工编号 |
| status | int | 是 | 状态 |
__请求示例:__
```
{
"data":{
"profile":"测试",
"key": "5fd5de9e9d48417881aa457be6500bcb",
"userName":"zhangyz",
"password":"123456",
"name":"非凡",
"departmentCode":"",
"erpCode":"",
"status":0,
}
}
````
---
### 响应
__响应字段__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
| clock | string | 当前服务器时钟。 |
| status | string | 状态,ok:成功,error:错误,exception:异常 |
| data | object | 成功后返回具体内容 |
__data:__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {}
}
```

55
wms/员工/删除员工.md

@ -0,0 +1,55 @@
### 删除员工
此接口用于删除WMS中的员工
此接口需要认证,详情请查看《认证方式》。
---
### 基本信息
方法:POST
URL: http://localhost:8033/open/DeleteWmsUser
---
### 请求
__请求参数__
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | String | 是 | 厂区|
| keyWord | string | 是 | 记录主键 |
__请求示例:__
```
{
"data":{
"profile": "测试",
"keyWord":"5fd5de9e9d48417881aa457be6500bcb",
}
}
````
---
### 响应
__响应字段__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
| clock | string | 当前服务器时钟。 |
| status | string | 状态,ok:成功,error:错误,exception:异常 |
| data | object | 成功后返回具体内容 |
__data:__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {}
}
```

76
wms/员工/员工列表.md

@ -0,0 +1,76 @@
### 员工列表
此接口用于查询WMS中的员工
此接口需要认证,详情请查看《认证方式》。
---
### 基本信息
方法:POST
URL: http://localhost:8033/open/GetWmsUserList
---
### 请求
__请求参数__
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | String | 是 | 厂区|
__请求示例:__
```
{
"data":{
"profile": "测试",
}
}
````
---
### 响应
__响应字段__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
| clock | string | 当前服务器时钟。 |
| status | string | 状态,ok:成功,error:错误,exception:异常 |
| data | object | 成功后返回具体内容 |
__data:__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {
"records": [
{
"key": "00316a8cb1e14bbb949b681d7058ca08",
"depKey": "0887f0146a2b47579c5dd401e0571545",
"depName": "董事会",
"depCode": "",
"accountName": "lc1772",
"name": "李田田",
"erpCode": "",
"status": 1
},
{
"key": "00316a8cb1e14bbb949b681d7058ca08",
"depKey": "3ebfb86f78e04e738862339863cce837",
"depName": "oa项目组",
"depCode": "",
"accountName": "lc1772",
"name": "李田田",
"erpCode": "",
"status": 1
},
]
}
}
```

65
wms/员工/新增员工.md

@ -0,0 +1,65 @@
### 新增员工
此接口用于向WMS中新增员工
此接口需要认证,详情请查看《认证方式》。
---
### 基本信息
方法:POST
URL: http://localhost:8033/open/AddWmsUser
---
### 请求
__请求参数__
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | String | 是 | 厂区|
| userName | string | 是 | 用户登录名 |
| password | string | 是 | 密码 |
| name | string | 是 | 员工姓名 |
| departmentCode | string | 否 | 部门编码 |
| erpCode | string | 否 | ERP员工编号 |
| status | int | 是 | 状态 |
__请求示例:__
```
{
"data":{
"profile":"测试",
"userName":"zhangyz",
"password":"12345",
"name":"非凡",
"departmentCode":"",
"erpCode":"",
"status":1,
}
}
````
---
### 响应
__响应字段__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
| clock | string | 当前服务器时钟。 |
| status | string | 状态,ok:成功,error:错误,exception:异常 |
| data | object | 成功后返回具体内容 |
__data:__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {}
}
```

64
wms/员工/获取员工详情.md

@ -0,0 +1,64 @@
### 员工详细
此接口用于查询WMS中的员工详细
此接口需要认证,详情请查看《认证方式》。
---
### 基本信息
方法:POST
URL: http://localhost:8033/open/GetWmsUserDetail
---
### 请求
__请求参数__
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | String | 是 | 厂区|
| keyWord | string | 是 | 记录主键 |
__请求示例:__
```
{
"data":{
"profile": "测试",
"keyWord":"5fd5de9e9d48417881aa457be6500bcb",
}
}
````
---
### 响应
__响应字段__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
| clock | string | 当前服务器时钟。 |
| status | string | 状态,ok:成功,error:错误,exception:异常 |
| data | object | 成功后返回具体内容 |
__data:__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {
"key": "5fd5de9e9d48417881aa457be6500bcb",
"depKey": "0887f0146a2b47579c5dd401e0571545",
"depName": "董事会",
"depCode": "",
"accountName": "zhangyz",
"name": "非凡",
"erpCode": "",
"status": 0
}
}
```

2
wms/客户/获取客户详情.md

@ -52,7 +52,7 @@ __data:__
"data": {
"oa_id": "",
"code": "wnC1",
"name": "漏",
"name": "漏",
"status": "0",
"country": "china",
"region": "shanghai",

76
wms/部门/修改部门.md

@ -0,0 +1,76 @@
### 修改部门
此接口用于修改WMS中的部门
此接口需要认证,详情请查看《认证方式》。
---
### 基本信息
方法:POST
URL: http://localhost:8033/open/UpdateWmsDepartment
---
### 请求
__请求参数__
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | String | 是 | 厂区|
| key | string | 是 | |
| code | string | 是 | 部门编码 |
| name | string | 是 | 部门名称 |
| status | int | 是 | 状态 |
| parentCode | string | 是 | 上级部门 |
__请求示例:__
```
{
"data":{
"profile":"测试",
"key":"c1f3202cc1ac4a9baa0ea48813e44635",
"code": "woniuDep",
"name":"测试部门",
"status": 1,
"parentCode":"",
}
}
````
---
### 响应
__响应字段__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
| clock | string | 当前服务器时钟。 |
| status | string | 状态,ok:成功,error:错误,exception:异常 |
| data | object | 成功后返回具体内容 |
__data:__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {
"key": "c1f3202cc1ac4a9baa0ea48813e44635",
"departmentname": "测试部门",
"departmentmark": "测试部门",
"canceled": null,
"departmentcode": "woniuDep",
"id": "woniuDep",
"supdepid": "",
"subcompanyid1": "",
"status": 1,
"created": "2023-12-06 15:15:56.911",
"updated": "2023-12-06 15:26:06.787",
"flag": 1
}
}
```

56
wms/部门/删除部门.md

@ -0,0 +1,56 @@
### 删除部门
此接口用于删除WMS中的部门
此接口需要认证,详情请查看《认证方式》。
---
### 基本信息
方法:POST
URL: http://localhost:8033/open/DeleteWmsDepartment
---
### 请求
__请求参数__
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | String | 是 | 厂区|
| code | string | 是 | 部门编码 |
__请求示例:__
```
{
"data":{
"profile":"测试",
"code":"woniuDep",
}
}
````
---
### 响应
__响应字段__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
| clock | string | 当前服务器时钟。 |
| status | string | 状态,ok:成功,error:错误,exception:异常 |
| data | object | 成功后返回具体内容 |
__data:__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {
}
}
```

75
wms/部门/新增部门.md

@ -0,0 +1,75 @@
### 新增部门
此接口用于新增WMS中的部门
此接口需要认证,详情请查看《认证方式》。
---
### 基本信息
方法:POST
URL: http://localhost:8033/open/AddWmsDepartment
---
### 请求
__请求参数__
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | String | 是 | 厂区|
| code | string | 是 | 部门编码 |
| name | string | 是 | 部门名称 |
| status | int | 是 | 状态 |
| parentCode | string | 是 | 上级部门 |
__请求示例:__
```
{
"data":{
"profile": "测试",
"code": "dep1",
"name":"部门1",
"status": 0,
"parentCode":"",
}
}
````
---
### 响应
__响应字段__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
| clock | string | 当前服务器时钟。 |
| status | string | 状态,ok:成功,error:错误,exception:异常 |
| data | object | 成功后返回具体内容 |
__data:__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {
"key": "c1f3202cc1ac4a9baa0ea48813e44635",
"departmentname": "部门1",
"departmentmark": "部门1",
"canceled": null,
"departmentcode": "dep1",
"id": "dep1",
"supdepid": "",
"subcompanyid1": null,
"status": 1,
"created": "2023-12-06 15:15:56.911",
"updated": "2023-12-06 15:15:56.911",
"flag": 1
}
}
```

70
wms/部门/部门列表.md

@ -0,0 +1,70 @@
### 部门列表
此接口用于查询WMS中的部门
此接口需要认证,详情请查看《认证方式》。
---
### 基本信息
方法:POST
URL: http://localhost:8033/open/GetWmsDepartmentList
---
### 请求
__请求参数__
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | String | 是 | 厂区|
__请求示例:__
```
{
"data":{
"profile": "测试",
}
}
````
---
### 响应
__响应字段__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
| clock | string | 当前服务器时钟。 |
| status | string | 状态,ok:成功,error:错误,exception:异常 |
| data | object | 成功后返回具体内容 |
__data:__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {
"records": [
{
"key": "e84cba30369d4f1c8ade99a6e853ae93",
"code": "100008",
"name": "财务管理部",
"createTime": "2022-09-30 08:54:01",
"status": 0
},
{
"key": "e7ed256eb16343b29f1d2c542fbea7ca",
"code": "100009",
"name": "电站业务部",
"createTime": "2022-09-30 08:54:02",
"status": 0
}
]
}
}
```

68
wms/部门/部门详情.md

@ -0,0 +1,68 @@
### 详情部门
此接口用于查询WMS中的部门详情
此接口需要认证,详情请查看《认证方式》。
---
### 基本信息
方法:POST
URL: http://localhost:8033/open/GetWmsDepartmentDetail
---
### 请求
__请求参数__
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | String | 是 | 厂区|
| keyWord | string | 是 | 部门编码 |
__请求示例:__
```
{
"data":{
"profile": "测试",
"keyWord" :"woniuDep",
}
}
````
---
### 响应
__响应字段__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
| clock | string | 当前服务器时钟。 |
| status | string | 状态,ok:成功,error:错误,exception:异常 |
| data | object | 成功后返回具体内容 |
__data:__
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {
"key": "c1f3202cc1ac4a9baa0ea48813e44635",
"departmentname": "测试部门",
"departmentmark": "测试部门",
"canceled": null,
"departmentcode": "woniuDep",
"id": "woniuDep",
"supdepid": "",
"subcompanyid1": "",
"status": 1,
"created": "2023-12-06 15:15:56.911",
"updated": "2023-12-06 15:26:06.787",
"flag": 1
}
}
```
Loading…
Cancel
Save