# yxb_admin

**Repository Path**: Cendeal/yxb_admin

## Basic Information

- **Project Name**: yxb_admin
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-05-05
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 接口设计文档

#### /yxb/api/v1/admin/login

##### login 登陆接口

##### 方法：POST

##### 请求参数：

| 参数名    | 必选 | 类型    | 描述     |
| --------- | ---- | ------- | -------- |
| res_type  | 否   | integer | 资源类型 |
| user_name | 是   | string  | 用户账号 |
| password  | 是   | string  | 账号密码 |

##### 响应

```javascript
{
    "code":0,
    "msg":"提示信息",
    "data":{}
}
```

#### /yxb/api/v1/admin/department/get

##### List 获取部门列表接口

##### 方法：GET

##### 请求参数：

| 参数名    | 必选 | 类型    | 描述       |
| --------- | ---- | ------- | ---------- |
| res_type  | 否   | integer | 资源类型   |
| page      | 否   | integer | 页码       |
| page_size | 否   | integer | 每页数据量 |

##### 响应

```javascript
{
    "code":0,
    "msg":"提示信息",
    "data":{
        "currentPage":1,
        "totalCount":10,
            "total":100,//总数
        "list":[
            {
            	"deptId":"部门id",
        		"deptName":"部门名称",
        		"deptInfo":"部门简介",
        		"deptManagerId":"负责人id"
            }
            //此处省略9条数据
        ]
    }
}
```

#### /yxb/api/v1/admin/department/getSingle

##### Query 获取单个部门接口

##### 方法：GET

##### 请求参数：

| 参数名   | 必选 | 类型    | 描述     |
| -------- | ---- | ------- | -------- |
| res_type | 否   | integer | 资源类型 |
| dept_id  | 是   | integer | 部门id   |

##### 响应

```javascript
{
    "code":0,
    "msg":"提示信息",
    "data":{
        "deptId":"部门id",
        "deptName":"部门名称",
        "deptInfo":"部门简介",
        "deptManagerId":"负责人id"
    }
}
```

#### /yxb/api/v1/admin/department/add

##### Add 添加部门接口

##### 方法：POST

##### 请求参数：

| 参数名          | 必选 | 类型     | 描述     |
| --------------- | ---- | -------- | -------- |
| res_type        | 否   | integer  | 资源类型 |
| dept_name       | 是   | string   | 部门名称 |
| dept_info       | 否   | string   | 部门简介 |
| dept_manager_id | 否   | interger | 负责人id |

##### 响应

```javascript
{
    "code":0,
    "msg":"提示信息",
    "data":{}
}
```

#### /yxb/api/v1/admin/department/edit

##### Edit 修改部门接口

##### 方法：POST

##### 请求参数：

| 参数名          | 必选 | 类型     | 描述     |
| --------------- | ---- | -------- | -------- |
| res_type        | 否   | integer  | 资源类型 |
| dept_id         | 是   | integer  | 部门id   |
| dept_info       | 否   | string   | 部门简介 |
| dept_manager_id | 否   | interger | 负责人id |
| dept_name       | 否   | string   | 部门名称 |

##### 响应

```javascript
{
    "code":0,
    "msg":"提示信息",
    "data":{}
}
```

#### /yxb/api/v1/admin/department/delete

##### delete 删除部门接口

##### 方法：GET

##### 请求参数：

| 参数名   | 必选 | 类型    | 描述     |
| -------- | ---- | ------- | -------- |
| res_type | 否   | integer | 资源类型 |
| dept_id  | 是   | integer | 部门id   |

##### 响应

```javascript
{
    "code":0,
    "msg":"提示信息",
    "data":{}
}
```

#### /yxb/api/v1/admin/group/get

##### List 获取部门分组列表接口

##### 方法：GET

##### 请求参数：

| 参数名    | 必选 | 类型    | 描述               |
| --------- | ---- | ------- | ------------------ |
| res_type  | 是   | integer | 资源类型           |
| page      | 否   | integer | 页码               |
| page_size | 否   | integer | 每页数据量         |
| dept_id   | 否   | integer | 查看指定部门的分组 |

##### 响应

```javascript
{
    "code":0,
    "msg":"提示信息",
    "data":{
         "currentPage":1,
         "totalCount":10,
                 "total":100,//总数
         "list":[
             {
                  "deptId":"部门id",
                 "deptName":"部门名称",
             	 "groupId":"分组id",
                 "groupName":"分组名称",
                 "grouperId":"组长id"
             }
              //此处省略9条数据
         ]
    }
}
```

#### /yxb/api/v1/admin/group/getSingle

##### Query 获取单个部门的分组列表接口

##### 方法：GET

##### 请求参数：

| 参数名   | 必选 | 类型    | 描述     |
| -------- | ---- | ------- | -------- |
| res_type | 否   | integer | 资源类型 |
| gp_id    | 是   | integer | 分组id   |

##### 响应

```javascript
{
    "code":0,
    "msg":"提示信息",
    "data":{
                 "deptId":"部门id",
                 "deptName":"部门名称",
             	 "groupId":"分组id",
                 "groupName":"分组名称",
                 "grouperId":"组长id"
             }
}
```

#### /yxb/api/v1/admin/group/add

##### Add 添加分组接口

##### 方法：POST

##### 请求参数：

| 参数名     | 必选 | 类型     | 描述     |
| ---------- | ---- | -------- | -------- |
| res_type   | 否   | integer  | 资源类型 |
| dept_id    | 是   | integer  | 部门id   |
| group_name | 是   | string   | 分组名称 |
| grouper_id | 否   | interger | 负责人id |

##### 响应

```javascript
{
    "code":0,
    "msg":"提示信息",
    "data":{}
}
```

#### /yxb/api/v1/admin/group/edit

##### Edit 修改分组接口

##### 方法：POST

##### 请求参数：

| 参数名     | 必选 | 类型     | 描述     |
| ---------- | ---- | -------- | -------- |
| res_type   | 否   | integer  | 资源类型 |
| gp_id      | 是   | integer  | 分组id   |
| gp_name    | 否   | string   | 分组名称 |
| grouper_id | 否   | interger | 负责人id |

##### 响应

```javascript
{
    "code":0,
    "msg":"提示信息",
    "data":{}
}
```

#### /yxb/api/v1/admin/group/delete

##### delete 删除分组接口

##### 方法：GET

##### 请求参数：

| 参数名   | 必选 | 类型    | 描述     |
| -------- | ---- | ------- | -------- |
| res_type | 否   | integer | 资源类型 |
| gp_id    | 是   | integer | 分组id   |

##### 响应

```javascript
{
    "code":0,
    "msg":"提示信息",
    "data":{}
}
```

#### /yxb/api/v1/admin/member/get

##### List 获取员工列表接口

##### 方法：GET

##### 请求参数：

| 参数名    | 必选 | 类型    | 描述                             |
| --------- | ---- | ------- | -------------------------------- |
| res_type  | 否   | integer | 资源类型                         |
| dept_id   | 否   | integer | 查询方式:按部门                  |
| gp_id     | 否   | integer | 查询方式:按部门分组，要求dept_id |
| user_name | 否   | string  | 查询方式:按姓名                  |
| page      | 否   | integer | 页码                             |
| page_size | 否   | integer | 每页数据量                       |

##### 响应

```javascript
{
    "code":0,
    "msg":"提示信息",
    "data":{
        "currentPage":1,
        "totalCount":10,
                "total":100,//总数
        "list":[
            {
                "deptName":"部门",
                "deptId":"部门ID",
                "gpID":"分组ID",
               "gpName":"分组",
                "userId":"员工id",
                "userName":"员工姓名",
                "userBirthday":"员工出生年月",
                "userGender":"性别",
                "userPhone":"手机",
                "userWx":"微信",
                "email":"邮箱",
                "userIdcard":"身份证",
                "userIndate":"入职时间",
                "userAddress":"地址",
                "userState":"状态"
            }
            //此处省略9条数据
        ]
    }
}
```

#### /yxb/api/v1/admin/member/getSingle

##### Query 获取单个员工信息接口

##### 方法：GET

##### 请求参数：

| 参数名   | 必选 | 类型    | 描述     |
| -------- | ---- | ------- | -------- |
| res_type | 否   | integer | 资源类型 |
| user_id  | 是   | integer | 员工id   |

##### 响应

```javascript
{
    "code":0,
    "msg":"提示信息",
    "data":{
         		"deptName":"部门",
                "deptId":"部门ID",
                "gpID":"分组ID",
               "gpName":"分组",
                "userId":"员工id",
                "userName":"员工姓名",
                "userBirthday":"员工出生年月",
                "userGender":"性别",
                "userPhone":"手机",
                "userWx":"微信",
                "email":"邮箱",
                "userIdcard":"身份证",
                "userIndate":"入职时间",
                "userAddress":"地址",
                "userState":"状态"
    }
}
```

#### /yxb/api/v1/admin/member/add

##### Add 添加员工接口

##### 方法：POST

##### 请求参数：

| 参数名        | 必选 | 类型    | 描述       |
| ------------- | ---- | ------- | ---------- |
| res_type      | 否   | integer | 资源类型   |
| user_name     | 是   | string  | 姓名       |
| user_birthday | 是   | string  | 出生年月日 |
| user_gender   | 是   | string  | 性别       |
| user_phone    | 是   | string  | 手机       |
| user_wx       | 否   | string  | 微信       |
| email         | 否   | string  | 邮箱       |
| user_idcard   | 是   | string  | 身份证     |
| user_indate   | 是   | string  | 入职年月日 |
| user_address  | 是   | string  | 地址       |
| user_state    | 是   | string  | 状态       |

##### 响应

```javascript
{
    "code":0,
    "msg":"提示信息",
    "data":{
        "deptId":"员工id"
    }
}
```

#### /yxb/api/v1/admin/member/edit

##### Edit 修改员工信息接口

##### 方法：POST

##### 请求参数：

| 参数名        | 必选 | 类型    | 描述       |
| ------------- | ---- | ------- | ---------- |
| res_type      | 否   | integer | 资源类型   |
| user_id       | 是   | integer | id         |
| user_name     | 否   | string  | 姓名       |
| user_birthday | 否   | string  | 出生年月日 |
| user_gender   | 否   | string  | 性别       |
| user_phone    | 否   | string  | 手机       |
| user_wx       | 否   | string  | 微信       |
| email         | 否   | string  | 邮箱       |
| user_idcard   | 否   | string  | 身份证     |
| user_indate   | 否   | string  | 入职年月日 |
| user_address  | 否   | string  | 地址       |
| user_state    | 否   | string  | 状态       |

##### 响应

```javascript
{
    "code":0,
    "msg":"提示信息",
    "data":{}
}
```

#### /yxb/api/v1/admin/member/delete

##### delete 删除员工信息接口

##### 方法：GET

##### 请求参数：

| 参数名   | 必选 | 类型    | 描述     |
| -------- | ---- | ------- | -------- |
| res_type | 否   | integer | 资源类型 |
| user_id  | 是   | integer | 员工id   |

##### 响应

```javascript
{
    "code":0,
    "msg":"提示信息",
    "data":{}
}
```

#### /yxb/api/v1/admin/groupship/add

##### Add 添加分组关系

##### 方法：POST

##### 请求参数：

| 参数名   | 必选 | 类型    | 描述     |
| -------- | ---- | ------- | -------- |
| res_type | 否   | integer | 资源类型 |
| gp_id    | 是   | integer | 分组id   |
| user_id  | 是   | integer | 员工id   |

##### 响应

```javascript
{
    "code":0,
    "msg":"提示信息",
    "data":{}
}
```

#### /yxb/api/v1/admin/groupship/edit

##### Edit 修改分组关系

##### 方法：POST

##### 请求参数：

| 参数名   | 必选 | 类型    | 描述     |
| -------- | ---- | ------- | -------- |
| res_type | 否   | integer | 资源类型 |
| gp_id    | 是   | integer | 分组id   |
| user_id  | 是   | integer | 员工id   |

##### 响应

```javascript
{
    "code":0,
    "msg":"提示信息",
    "data":{}
}
```

#### /yxb/api/v1/admin/groupship/delete

##### delete 删除分组关系

##### 方法：GET

##### 请求参数：

| 参数名   | 必选 | 类型    | 描述     |
| -------- | ---- | ------- | -------- |
| res_type | 否   | integer | 资源类型 |
| user_id  | 是   | integer | 部门id   |

##### 响应

```javascript
{
    "code":0,
    "msg":"提示信息",
    "data":{}
}
```

#### /yxb/api/v1/admin/company/get

##### Query 获取公司结构信息接口

##### 方法：GET

##### 请求参数：

| 参数名      | 必选 | 类型    | 描述                               |
| ----------- | ---- | ------- | ---------------------------------- |
| res_type    | 否   | integer | 资源类型                           |
| show_member | 否   | integer | 是否显示成员信息，默认0：否，1：是 |

##### 响应

```javascript
{
    "code":0,
    "msg":"提示信息",
    "data":{
    "name":"某公司",
    "departments":[
        {
            "deptName":"业务部",
            "deptId":1,
            "groups":[
                {
                 "gpName":"业务一部",
            	 "gpId":1,
                 "members":[]
                },
                {
                 "name":"业务二部",
                 "groupId":2,
                 "members":[]
                }]
        },
         {
            "deptName":"研发部",
            "deptId":2,
            "groups":[
                {
                 "gpName":"研发一组",
                 "gpId":3,
                 "members":[]
                },
                {
                 "gpName":"研发二组",
                 "gpId":4,
                 "members":[]
                }]
        }]
    }
}
```