...
| title | API chỉnh sửa phòng ban |
|---|
...
Method
...
URL
...
Description
...
API chỉnh sửa phòng ban
...
Note
...
API mới
...
STT
...
Field
...
Source Data Type / Length
...
Description
...
Sample Values
...
2. RequestBody
...
STT
...
Field
...
Required
...
Data Type / Length
...
Description
...
Note
...
shortName
...
englishName
...
phoneNumber
...
email
...
3. Response / Incoming Data Specification
...
Field
...
Data Type / Length
...
Description
...
Note
...
(result) name
...
(result) parentId
...
(result) path
...
path
...
(result) id
...
thư mục
...
| Panel |
|---|
| title | API lấy danh sách cơ cấu tổ chức |
|---|
|
Method | GET | URL | system/departments |
|---|
Description | API lấy danh sách cơ cấu tổ chức |
|---|
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 | status | false | Integer | trạng thái |
|
| | 3 | page | true | Integer |
|
|
| | 4 | limit | true | Integer |
|
|
| | 5 | rootOnly | false | Integer | chỉ lấy department cấp root, 0: chỉ lấy parentId != null, 1: chỉ lấy parentId = null, -1: lấy tất cả |
|
| | 6 | parentId | false | Integer | id phòng ban cha - nếu truyền vào sẽ tìm tất cả các phòng ban con/cháu/chắt thuộc id phòng ban cha | Nếu truyền parentId thì rootOnly nên set giá trị = 0. |
|
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 cơ cấu tổ chức |
|
| | 10 | (items) name | String | tên cơ cấu tổ chức |
|
| | 11 | (items) shortName | String | Tên viết tắt |
|
| | 12 | (items) status | Integer | Trạng thái (2: inactive, 1: active) |
|
| | 13 | (items) parentName | String | tên phòng ban cha |
|
| | 14 | (items) parentId | Integer | id phòng ban cha |
|
| | 16 | (items) address | String | địa chỉ |
|
|
|
| Panel |
|---|
| title | API Spec xem thông tin chi tiết 1 phòng ban |
|---|
|
Method | Get | URL | system/department/get |
|---|
Description | API lấy thông tin chi tiết của 1 phòng ban |
|---|
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 phòng ban |
|
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 phòng ban |
|
| (result) departmentIdHris | String | id phòng ban lấy từ Hris. |
| | 5 | (result) name | String | Tên phòng ban |
| | 6 | (result) shortName | String | tên viết tắt |
| | 7 | (result) status | Integer | Trạng thái (2: inactive, 1: active) |
| | 8 | (result) parentName | String | tên phòng ban cha |
| | 9 | (result) englishName | String | tên tiếng Anh |
| | 10 | (result) managerId | Integer | Id người quản lý trực tiếp |
| | 11 | (result) phoneNumber | String | Số điện thoại |
| | 12 | (result) email | String | email |
| | 13 | (result) address | String | Địa chỉ |
| | 14 | (result) managerName | String | Tên người quản lý |
|
|
| Panel |
|---|
| title | API chỉnh sửa phòng ban |
|---|
|
Method | PUT | URL | system/department/update |
|---|
Description | API chỉnh sửa phòng ban |
|---|
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 phòng ban |
| | 2 | name | true | String | tên phòng ban |
| | 3 | managerId | false | Integer | Id người quản lý trực tiếp |
| | 4 | shortName | false | String | tên viết tắt |
| | 5 | englishName | false | String | tên tiếng Anh |
| | 6 | phoneNumber | false | String | Số điện thoại |
| | 7 | email | false | String | email |
| | 8 | 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) id | Integer | id phòng ban |
| | 5 | (result) name | String | tên phòng ban |
| | 6 | (result) managerId | Integer | Id người quản lý trực tiếp |
| | 7 | (result) shortName | String | tên tiếng Anh |
| | 8 | (result) englishName | String | tên viết tắt |
| | 9 | (result) email | String | email |
| | 10 | (result) address | String | Địa chỉ |
| | 11 | (result) phoneNumber | String | Số điẹn thoại |
|
|
...