Staff Manager接口文档

API文档

url规则参考JT-SOFT ,

1.用户登录

提供用户登录的后端接口，保证账号登录过程中的安全性，登录成功后不能返回用户的密码到前端
接口调用： http://xxx.xxx.xxx/staff/login
请求方法：POST
请求参数：

字段	Value	说明
username	String	名字，确保名字的字符有效性，可以使用英文和数字
passwrod	String	密码，确保名字的字符有效性，可以使用英文和数字，特殊字符不能使用空格

返回的JSON数据包：
成功返回

{
    "code": 200,
    "message": "OK",
    "data": "登录成功"
}

失败返回

{
    "code": 201,
    "message": "error",
    "data": "登录失败，账号或密码错误"
}

2.获取员工个人信息

返回用户的个人信息的Json数据
接口调用： http://xxx.xxx.xxx/staff/{ids}
请求方法：GET
请求参数：

字段	Value	说明
ids	Integer	工号

返回的JSON数据包：
成功返回
返回staff对象

{
    "code": 200,
    "message": "OK",
    "data": "staff[{
    "……":"……"
    }]"
}

失败返回

{
    "code": 201,
    "message": "error",
    "data": "没有找到对应的员工"
}

3.显示员工

在员工信息中以列表的形式显示所有员工
接口调用： http://xxx.xxx.xxx/staff/query
请求方法：GET
请求参数：

字段	Value	说明
page	Integer	页数，想要查看哪一页
rows	Integer	每页显示的行数

返回的JSON数据包：
成功返回

{
    "state": 1,
    "message": "ok",
    "data": {
        "total": 17,
        "list": [
            {
                "workId": 21,
                …………

            }

失败返回

{
    "code": 201,
    "message": "error",
    "data": "找不到员工
}

4.增加员工

提供增加的后端接口
接口调用： http://xxx.xxx.xxx/staff/save
请求方法：POST
请求参数：

字段	Value	说明
staff	Staff	员工对象

返回的JSON数据包：
成功返回

{
    "code": 200,
    "message": "OK",
    "data": "保存成功"
}

失败返回

{
    "code": 201,
    "message": "error",
    "data": "保存失败"
}

5.删除员工

提供删除员工的后端接口
接口调用： http://xxx.xxx.xxx/staff/delete
请求方法：POST
请求参数：

字段	Value	说明
ids	Long[]	需要删除的员工工号，可能为数组

返回的JSON数据包：
成功返回

{
    "code": 200,
    "message": "OK",
    "data": "删除成功"
}

失败返回

{
    "code": 201,
    "message": "error",
    "data": "删除失败"
}

6.修改员工

提供修改员工的后端接口
接口调用： http://xxx.xxx.xxx/staff/update
请求方法：POST
请求参数：

字段	Value	说明
staff	Staff	员工对象

返回的JSON数据包：
成功返回

{
    "code": 200,
    "message": "OK",
    "data": "修改成功"
}

失败返回

{
    "code": 201,
    "message": "error",
    "data": "修改失败"
}

7.批量修改员工状态

提供修改员工在职离职状态的后端接口
接口调用： http://xxx.xxx.xxx/staff/updateStatus/{status}
请求方法：POST
请求参数：

字段	Value	说明
status	Integer	员工在职状态，1代表在职，0代表离职
ids	Long[]	需要修改状态的员工工号，可能为数组

返回的JSON数据包：
成功返回

{
    "code": 200,
    "message": "OK",
    "data": "修改成功"
}

失败返回

{
    "code": 201,
    "message": "error",
    "data": "修改失败"
}

其余表的增删改查大同小异，controller类上的url用本controller类的类名去掉controller，例如员工培训表的url为/traing/xxxx
每张表需要的基础方法有（）以员工培训表为例：
查询所有员工奖惩，参照第3条，增加一条培训信息，参照4；删除一条培训信息，参照5；修改一条培训信息，参照6

8.查询发放情况

员工调薪操作时需要同时操作员工薪资表和员工调薪表，分别做这两张表的展示页面
额外做一个某月份 某范围员工 工资发放情况表的功能
例1：2021年三月人事部工资发放表

姓名	基础工资	餐饮补助	…	总工资
张三	1000	100	…	2000

例2：2021年二月全体员工工资发放表

接口调用： http://xxx.xxx.xxx/staffSalary/provide/{depIds}
请求方法：GET
请求参数：

字段	Value	说明
depIds	Long[]	员工部门编号，可能为数组

返回的JSON数据包：
成功返回

{
    "code": 200,
    "message": "OK",
    "data":  
    	   "……":"……"
}

失败返回

{
    "code": 201,
    "message": "error",
    "data": "查询失败"
}

9.综合统计查询

统计人事记录，例如某员工共调动x次，培训x次，奖励x次，惩罚x次
接口调用： http://xxx.xxx.xxx/Statistics/{ids}
请求方法：GET
请求参数：

字段	Value	说明
ids	Long[]	需要查询综合统计信息的员工工号，可能为数组

返回的JSON数据包：
成功返回

{
    "code": 200,
    "message": "OK",
    "data": 
    		"……":"……"
}

失败返回

{
    "code": 201,
    "message": "error",
    "data": "查询失败"
}