Page History

...

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 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

1. Headers

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. Request

STT	Field	Require	Data Type / Length	Description	Note
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
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

1. Headers

STT	Field	Source Data Type / Length	Description	Sample Values
1	authorization	String	Token	Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc

2. Param

STT	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
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

1. Headers

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
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
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

3.4 Mô tả các trường dữ liệu trên màn hình

3.4.1. Mô tả màn hình Danh mục cơ cấu tổ chức ( Danh sách )phòng ban

Màn hình danh mục cơ cấu tổ chức sách phòng ban đường dẫn: Quản lý người dùng -> dùng → Cài đặt cơ sở →Danh mục cơ cấu tổ chức → Danh sáchsách phòng ban

STT	Trường/ Nút chức năng	Kiểu dữ liệu	Mô tả
1	Tìm kiếm tên đơn vị	Textbox	Cho phép tìm kiếm gần đúng theo tên đơn vị: Không phân biệt hoa thường Tìm kiếm gần đúng tên
2	STT	Grid- number	Số thứ tự tự sinh tăng dần
3	Tên đơn vị	Grid- Text	Hiển thị thông tin tên đơn vị Gọi popup Xem chi tiết đơn vị khi click vào tên đơn vị
4	Mã đơn vị	Grid- Text	Hiển thị thông tin mã đơn vị
5	Đơn vị cấp cha	Grid- Text	Hiển thị thông tin tên đơn vị cấp cha
6	Tên viết tắt	Grid- Text	Hiển thị thông tin Tên viết tắt
7	Địa chỉ	Grid- Text	Hiển thị thông tin địa chỉ
8	Trạng thái	Grid- Text	Hiển thị thông tin trạng thái
9	Sửa	Button	Gọi popup Sửa danh sách chức năng
10	Xuất file excel	Button	Gọi popup Xuất file excel

3.4.2. Mô tả màn hình Danh mục cơ cấu tổ chức ( Sơ đồ phân cấp phòng ban)

Màn hình danh mục cơ cấu tổ chức sách phòng ban đường dẫn: Quản lý người dùng -> Cài đặt cơ sở →Danh mục cơ cấu tổ chức sách phòng ban → Sơ đồ phân cấp phòng ban

...

Popup Xem chi tiết đơn vị hiển thị khi người dùng click vào Tên đơn vị tại Danh mục cơ cấu tổ chứcsách phòng ban

STT	Trường/ Nút chức năng	Kiểu dữ liệu	Quy định	Mô tả
1	Xem chi tiết đơn vị	Label		Tên popup
2	Tên đơn vị	Textbox	Disable	Hiển thị thông tin tên đơn vị
3	Mã đơn vị	Textbox	Disable	Hiển thị thông tin mã đơn vị
4	Đơn vị cấp cha	Textbox	Disable	Hiển thị thông tin tên đơn vị cấp cha
5	Tên viết tắt	Textbox	Disable	Hiển thị thông tin Tên viết tắt
6	Tên Tiếng Anh	Textbox	Disable	Hiển thị thông tin tên Tiếng Anh
7	Người phụ trách	Combobox	Disable	Hiển thị thông tin Người phụ trách
8	Số điện thoại	Textbox	Disable	Hiển thị số điện thoại
9	Email	Textbox	Disable	Hiển thị email
10	Địa chỉ	Textbox	Disable	Hiển thị thông tin địa chỉ
11	Trạng thái	Textbox	Disable	Hiển thị thông tin trạng thái
12	Thoát	Button	Enable	Cho phép thoát khỏi popup Xem

...

3.4.3. Mô tả màn hình Sửa danh mục cơ cấu tổ chứcđơn vị

Popup Sửa đơn vị hiển thị khi người dùng click vào Sửa tại Danh mục cơ cấu tổ chứcsách phòng ban

STT	Trường/ Nút chức năng	Kiểu dữ liệu	Điều kiện	Quy định	Mô tả
1	Tên đơn vị	Textbox		Disable	Hiển thị thông tin tên đơn vị
2	Mã đơn vị	Textbox		Disable	Hiển thị thông tin mã đơn vị
3	Đơn vị cấp cha	Textbox		Disable	Hiển thị thông tin tên đơn vị cấp cha
4	Tên viết tắt	Textbox	Không bắt buộc	Enable	Sửa thông tin Tên viết tắt
5	Tên Tiếng Anh	Textbox	Không bắt buộc	Enable	Sửa thông tin tên Tiếng Anh
6	Người phụ trách	Combobox	Không bắt buộc	Enable	Chọn thông tin người phụ trách theo Tên hiển thị của Danh mục nhân viên
7	Số điện thoại	Textbox	Không bắt buộc	Enable	Sửa số điện thoại
8	Email	Textbox	Không bắt buộc	Enable	Sửa email
9	Địa chỉ	Textbox	Không bắt buộc	Enable	Sửa thông tin địa chỉ
10	Trạng thái	Textbox		Disable	Hiển thị thông tin trạng thái
11	Áp dụng	Button		Enable	Lưu thông tin chỉnh sửa và hiển thị thông báo Toast: " Thành công- Cập nhật thông tin đơn vị thành công!"
12	Thoát	Button		Enable	Cho phép thoát khỏi popup Xem

...

Popup xuất excel được hiển thị khi chọn Xuất file excel trên Danh mục cơ cấu tổ chứcsách phòng ban

STT	Trường/ Nút chức năng	Kiểu dữ liệu	Mô tả
1	Xuất file excel	Label	Tên popup
2	Chọn kiểu xuất file	Label
3	Tất cả	Radio button	Mặc định chọn tất cả Cho phép xuất tất cả các đơn vị trên danh sách
4	Trên trang này	Radio button	Cho phép xuất các đơn vị trên trang hiển thị hiện tại
5	X đơn vị phù hợp với kết quả tìm kiếm hiện tại	Radio button	X là số lượng đơn vị của kết quả tìm kiếm Cho phép xuất tất cả các đơn vị phù hợp với tất cả tìm kiếm hiện tại

...

Page tree

Versions Compared

Old Version 37

New Version Current

Key

1. Headers

2. Request

3. Response / Incoming Data Specification

1. Headers

2. Param

3. Response / Incoming Data Specification

1. Headers

2. RequestBody

3. Response / Incoming Data Specification