...
3.3 API Spec: <gắn link tài liệu mô tả API vào đây>
| Panel |
|---|
| title | API lấy danh sách nhân viên |
|---|
|
Method | GET | URL | system/employeeHris/list |
|---|
Description | API lấy danh sách nhân viên |
|---|
Note |
|
|---|
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|
| 1 | authorization | <token> | Token của người dùng đăng nhập | Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjY0NTU3ODksInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.wrvIFd-Q2kHgkTmPf6ryMY6aDIgXpNsWmSvvifQWc5k |
2. RequestSTT | Field | Require | Data Type / Length | Description | Note | Sample Values |
|---|
| 1 | name | false | String | tên cơ cấu tổ chức |
|
| | 2 | workingStatus | false | String | trạng thái làm việc |
|
| | 3 | accountStatus | false | Integer | trạng thái tài khoản |
|
| | 4 | page | true | Integer |
|
|
| | 5 | limit | true | Integer |
|
|
| | 6 | departmentIdHris | false | String | phòng ban (lấy theo Hris) |
|
|
3. Response / Incoming Data Specification| STT | Field | Data Type / Length | Description | Note | Sample Values |
|---|
| 1 | code | Integer | 0: thành công, != 0 thất bại |
|
| | 2 | message | String |
|
|
| | 3 | result | Object | Object |
|
| | 4 | (result) loadMoreAble | Boolean |
|
|
| | 5 | (result) page | Integer |
|
|
| | 6 | (result) preLoadAble | Integer |
|
|
| | 7 | (result) total | Integer |
|
|
| | 8 | (result) items | List<Object> | |
|
| | 9 | (items) id | Integer | Id nhân viên theo chức danh |
|
| | 10 | (items) employeeId | Integer | Id nhân viên |
|
| | 11 | (items) code | String | mã nhân viên |
|
| | 12 | (items) name | String | tên nhân viên |
|
| | 13 | (items) phone | String | số điện thoại |
|
| | 14 | (items) email | String | mail |
|
| | 15 | (items) companyName | String | tên công ty |
|
| | 16 | (items) departmentName | String | tên phòng ban |
|
| | 17 | (items) jobTitle | String | tên chức danh |
|
| | 18 | (items) shiftCode | String | mã ca làm việc |
|
| | 19 | (items) workingStatus | String | trạng thái làm việc |
|
| | 20 | (items) accountStatus | Integer | trạng thái tài khoản |
|
|
|
| Panel |
|---|
| title | API Spec xem thông tin chi tiết 1 nhân viên theo chức danh |
|---|
|
Method | Get | URL | system/employeeHris/get |
|---|
Description | API lấy thông tin chi tiết của 1 nhân viên |
|---|
Note | API mới |
|---|
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|
| 1 | authorization | String | Token | Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc |
2. ParamSTT | Field | Required | Data Type / Length | Description | Note |
|---|
| 1 | id | true | Integer | id nhân viên theo Hris |
|
3. Response / Incoming Data Specification| STT | Field | Data Type / Length | Description | Note |
|---|
| 1 | code | Integer | 0: thành công, != 0 thất bại |
| | 2 | message | String |
|
| | 3 | result | Object | Object |
| | 4 | (result) id | Integer | Id nhân viên theo chức danh |
|
| (result) employeeId | Integer | Id nhân viên |
| | 5 | (result) code | String | mã nhân viên |
| | 6 | (result) name | String | tên nhân viên |
| | 7 | (result) phone | String | số điện thoại |
| | 8 | (result) email | String | mail |
| | 9 | (result) companyName | String | tên công ty |
| | 10 | (result) departmentName | String | tên phòng ban |
| | 11 | (result) jobTitle | String | tên chức danh |
| | 12 | (result) shiftCode | String | mã ca làm việc |
| | 13 | (result) workingStatus | String | trạng thái làm việc |
| | 14 | (result) accountStatus | Integer | trạng thái tài khoản |
| | 15 | (result) address | String | địa chỉ |
| | 16 | (result) jobIndicator | String | Phân loại công việc (P: chính, S: phụ) |
| | 17 | (result) managerId | Integer | id người quản lý trực tiếp |
| | 18 | (result) managerName | String | tên người quả lý trực tiếp |
|
|
| Panel |
|---|
| title | API chỉnh sửa thông tin nhân viên theo Hris |
|---|
|
Method | PUT | URL | system/employeeHris/update |
|---|
Description | API chỉnh sửa thông tin nhân viên theo Hris |
|---|
Note | API mới |
|---|
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|
| 1 | authorization | String | Token | Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc |
2. RequestBody STT | Field | Required | Data Type / Length | Description | Note |
|---|
| 1 | id | true | Integer | id nhân viên theo Hris |
| | 2 | phone | false | String | Số điện thoại |
| | 3 | managerId | false | Integer | Id người quản lý trực tiếp |
| | 4 | employeeId | false | String | id nhân viên |
| | 5 | address | false | String | Địa chỉ |
|
3. Response / Incoming Data Specification| STT | Field | Data Type / Length | Description | Note |
|---|
| 1 | code | Integer | 0: thành công, != 0 thất bại |
| | 2 | message | String |
|
| | 3 | result | Object | Object |
| | 4 | (result) employeeId | Boolean | id nhân viên |
| | 5 | (result) managerId | Số điện thoại | Id người quản lý trực tiếp |
| | 6 | (result) phone | String | Số điện thoại |
| | 7 | (result) address | String | Địa chỉ |
| | 8 | (result) id | Integer | id nhân viên theo Hris |
|
|
3.4 Mô tả các trường dữ liệu trên màn hình:
...
