Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
titleAPI Spec Document

I. Danh sách loại danh mục

Method

GET

URL

/categoryType/list

1. Headers

STT

Field

Source Data Type / Length 

Description

Sample Values

1AuthorizationStringtoken

2. Param

STT

Field

Required

Data Type / Length

Description

Note

Sample Values

1namefalseStringTên loại danh mục

2statusfalseIntegerTrạng thái loại danh mụcChưa định nghĩa trạng thái do k có mô tả cũng như figma nên tạm thời đang mặc định là (1: active, 0: inactive)
3limitfalseIntegerGiới hạn bản ghi trên 1 trang

4pagefalseIntegerVị trí trang

3. Response / Incoming Data Specification

STT

Field

Data Type / Length

Description

Note

Sample Values

1idIntegerMã tự sinh của loại danh mục

2codeStringMã duy nhất của loại danh mục

3nameStringTên loại danh mục

4statusIntegerTrạng thái loại danh mục

5departmentIdIntegerPhòng ban khởi tạo


II. Chi tiết loại danh mục

Method

GET

URL

/categoryType/get

1. Headers

STT

Field

Source Data Type / Length 

Description

Sample Values

1AuthorizationStringtoken

2. Param

STT

Field

Required

Data Type / Length

Description

Note

Sample Values

1idtrueIntegerMã tự sinh của loại danh mục

3. Response / Incoming Data Specification

STT

Field

Data Type / Length

Description

Note

Sample Values

1idIntegerMã tự sinh của loại danh mục

2codeStringMã duy nhất của loại danh mục

3nameStringTên loại danh mục

4statusIntegerTrạng thái loại danh mục

5departmentIdIntegerPhòng ban khởi tạo


III. Thêm mới/chỉnh sửa loại danh mục

Method

POST

URL

/categoryType/update

1. Headers

STT

Field

Source Data Type / Length 

Description

Sample Values

1AuthorizationStringtoken

2. Body

STT

Field

Required

Data Type / Length

Description

Note

Sample Values

1idfalseIntegerMã tự sinh của loại danh mụcTruyền mã tự sinh > 0 thì sẽ cập nhật, còn không thì thêm mới
2codetrueStringMã duy nhất của loại danh mục

3nametrueStringTên loại danh mục

4statustrueIntegerTrạng thái loại danh mục

3. Response / Incoming Data Specification

STT

Field

Data Type / Length

Description

Note

Sample Values

1idIntegerMã tự sinh của loại danh mục

2codeStringMã duy nhất của loại danh mục

3nameStringTên loại danh mục

4statusIntegerTrạng thái loại danh mục

5departmentIdIntegerPhòng ban khởi tạo


IV. Chỉnh sửa trạng thái loại danh mục

Method

POST

URL

/categoryType/update/status

1. Headers

STT

Field

Source Data Type / Length 

Description

Sample Values

1AuthorizationStringtoken

2. Body

STT

Field

Required

Data Type / Length

Description

Note

Sample Values

1idtrueIntegerMã tự sinh của loại danh mục

2statustrueIntegerTrạng thái loại danh mục

3. Response / Incoming Data Specification

STT

Field

Data Type / Length

Description

Note

Sample Values

1idIntegerMã tự sinh của loại danh mục

2codeStringMã duy nhất của loại danh mục

3nameStringTên loại danh mục

4statusIntegerTrạng thái loại danh mục

5departmentIdIntegerPhòng ban khởi tạo


V. Xóa loại danh mục

Method

DELETE

URL

/categoryType/delete

1. Headers

STT

Field

Source Data Type / Length 

Description

Sample Values

1AuthorizationStringtoken

2. Param

STT

Field

Required

Data Type / Length

Description

Note

Sample Values

1idtrueIntegerMã tự sinh của loại danh mục

3. Response / Incoming Data Specification

STT

Field

Data Type / Length

Description

Note

Sample Values

1resultIntegerSố bản ghi xóa thành côngTrả về 0 nếu xóa thất bại


VI. Xóa nhiều loại danh mục

Method

DELETE

URL

/categoryType/deleteList

1. Headers

STT

Field

Source Data Type / Length 

Description

Sample Values

1AuthorizationStringtoken

2. Param

STT

Field

Required

Data Type / Length

Description

Note

Sample Values

1lstIdtrueList<Integer>Danh sách mã tự sinh của loại danh mục

3. Response / Incoming Data Specification

STT

Field

Data Type / Length

Description

Note

Sample Values

1resultIntegerSố bản ghi xóa thành côngTrả về 0 nếu xóa thất bại


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

...

STT

Trường thông tin/ Nút chức năng

Kiểu dữ liệu

Điều kiện

Quy địnhMô tả
1Ô tìm kiếmVăn bản (Text)Không bắt buộc

- Cho phép người dùng nhập từ khóa liên quan đến "Tên/mã loại danh mục dùng chung".

- Hệ thống thực hiện tìm kiếm và cập nhật màn hình "Loại danh mục dùng chung" khi người dùng nhấn Enter hoặc biểu tượng kính lúp sau khi hoàn thành nhập từ khóa.

- Hành vi hệ thống khi Thể hiện kết quả:

  • Trường hợp 1 - Có kết quả:
    • Điều kiện: Có ít nhất một loại danh mục dùng chung trong hệ thống khớp với từ khóa người dùng nhập.
    • Hành vi: Hệ thống thể hiện danh sách loại danh mục dùng chung khớp với từ khóa tìm kiếm.
  • Trường hợp 2 - Không có kết quả/Danh sách trống (không có dữ liệu ban đầu):
    • Điều kiện: Không có loại danh mục dùng chung nào khớp với từ khóa tìm kiếm hoặc danh sách loại danh mục dùng chung ban đầu trống.
    • Hành vi: Hệ thống Thể hiện thông báo "Ở đây chưa có gì cả. Hiện tại chưa có loại danh mục dùng chung nào."

Thể hiện ô tìm kiếm với gợi ý mặc định (placeholder) “Tìm theo tên/mã loại danh mục dùng chung” và biểu tượng kính lúp ở phần đầu ô nhập.

2Nút Thêm mớiNút chức năng (Button)

Không bắt buộc

Cho phép người dùng nhấn để mở ra màn hình pop-up "Thêm mới Loại danh mục dùng chung": tham chiếu mục 3.4.2. Màn hình pop-up "Thêm mới loại danh mục dùng"

Thể hiện nút chức năng thêm mới đơn 1 bản ghi loại danh mục dùng chung vào màn hình danh sách loại danh mục dùng chung.
3Hộp chọn (Select box) Boolean (True/False)Không bắt buộc

- Cho phép người dùng tích chọn một/nhiều/tất cả bản ghi loại danh mục dùng chung để phục vụ cho chức năng xóa nhiều bản ghi ở trạng thái Không hoạt động (Inactive/Off).

- Khi nhấn hệ thống hiển thị thông báo (toast):

  • Tiêu đề: Cảnh báo
  • Nội dung: Loại danh mục dùng chung đang được sử dụng nên không thể xóa 
Thể hiện trường lựa chọn (select) phục vụ cho chức năng xóa nhiều bản ghi trên màn hình danh sách loại danh mục dùng chung.
4STTSố (Number)Không bắt buộc

- Số thứ tự động sinh, bắt đầu từ 1, tăng dần
- Sau khi thêm mới bản ghi:

  • Bản ghi mới hiển thị STT = 1

  • Các bản ghi khác tăng STT theo thứ tự hiển thị

- Khi xóa bản ghi: STT không đánh lại (giữ nguyên để đảm bảo truy vết).

- Không cho phép người dùng thao tác tương tác (nhấn/chọn/sửa).

Thể hiện thứ tự các bản ghi trên màn hình danh sách loại danh mục dùng chung.
5Mã loại danh mụcVăn bản (Text)Không bắt buộcKhông cho phép người dùng thao tác tương tác (nhấn/chọn/sửa).Thể hiện mã định danh duy nhất của từng bản ghi trên màn hình danh sách loại danh mục dùng chung.
6Tên loại danh mụcĐường dẫn (Hyperlink)Không bắt buộcCho phép người dùng nhấn vào bản ghi để hệ thống mở màn hình Xem chi tiết loại danh mục dùng chung: tham chiếu mục 3.4.3. Màn hình pop-up "Xem chi tiết loại danh mục dùng chung"Thể hiện tên loại danh mục dùng chung ứng với bản ghi trên màn hình danh sách loại danh mục dùng chung.
7Hoạt độngCông tắc (Toggle/Switch)Không bắt buộc

1. Ý nghĩa trạng thái

- Trạng thái Bật (Active/On): Hệ thống ghi nhận trạng thái loại danh mục dùng chung là Hoạt động và được phép sử dụng trong hệ thống.

- Trạng thái Tắt (Inactive/Off): Hệ thống ghi nhận trạng thái loại danh mục dùng chung là Không hoạt động và không được phép sử dụng trong hệ thống.

2. Phân quyền

- Người dùng cuối (End-user):  Không hiển thị tab Hoạt động đối với người dùng này và Không được phép thao tác trong tab Hoạt động.
- Quản trị viên (Admin): Hiển thị công tắc (toggle) trong tab Hoạt động và được phép thay đổi trạng thái.

3. Quy định ràng buộc dữ liệu

- Trường hợp bản ghi đang được sử dụng trong hệ thống và người dùng thực hiện thay đổi trạng thái, hành vi hệ thống như sau:

  • Không cho phép xóa bản ghi

  • Không cho phép chuyển trạng thái sang Không hoạt động (Inactive)

  • Hiển thị thông báo cảnh báo (toast)

    • Tiêu đề: Không thành công

    • Nội dung: Không thể đổi trạng thái do loại danh mục đang được sử dụng
Thể hiện công tắc để thiết lập trạng thái hoạt động của từng bản ghi trên màn hình danh sách loại danh mục dùng chung.
8

Nút Chỉnh sửa image-2025-12-4_17-3-18.png

Nút chức năng (Button)Không bắt buộc

Cho phép người dùng nhấn để mở ra màn hình pop up "Chỉnh sửa loại danh mục dùng chung": tham chiếu mục 3.4.4. Màn hình pop up "Chỉnh sửa loại danh mục dùng chung"

Thể hiện nút chức năng chỉnh sửa thông tin từng bản ghi trên màn hình danh sách loại danh mục dùng chung.
9

Nút Xóa

Nút chức năng (Button)Không bắt buộc

- Cho phép người dùng thao tác đối với CHỈ những bản ghi loại danh mục dùng chung đang ở trạng thái Không hoạt động (Inactive/Off).

- Khi nhấn hệ thống hiển thị thông báo (toast):

  • Tiêu đề: Cảnh báo
  • Nội dung: Loại danh mục dùng chung đang được sử dụng nên không thể xóa 
Thể hiện nút chức năng xóa đơn 1 bản ghi trên màn hình danh sách loại danh mục dùng chung.

...