...
- Sequence Diagram:
- Flowchart:
3.3 API Spec: <gắn link tài liệu mô tả API vào đây>Loại danh mục
| Panel | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
I. Danh sách loại danh mục
1. Headers
2.Body | STT | Path | Field
STT | Field | Required | Data Type / Length | Description | Note | Sample Values |
|---|---|---|---|---|---|---|
| 1 | name | false | String | Tên loại danh mục | ||
| 2 | status | false | Integer | Trạng thái loại danh mục | Chư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) | |
| 3 | limit | false | Integer | Giới hạn bản ghi trên 1 trang | ||
| 4 | page | false | Integer | Vị trí trang |
3. Response / Incoming Data Specification
| STT | Field | Data Type / Length | Description | Note | Sample Values |
|---|---|---|---|---|---|
| 1 | id | Integer | Mã tự sinh của loại danh mục | ||
| 2 | code | String | Mã duy nhất của loại danh mục | ||
| 3 | name | String | Tên loại danh mục | ||
| 4 | status | Integer | Trạng thái loại danh mục | ||
| 5 | departmentId | Integer | Phò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 |
|---|---|---|---|---|
| 1 | Authorization | String | token |
2. Param
STT | Field | Required | Data Type / Length | Description | Note | Sample Values |
|---|---|---|---|---|---|---|
| 1 | id | true | Integer | Mã tự sinh của loại danh mục |
3. Response / Incoming Data Specification
| STT | Field | Data Type / Length | Description | Note | Sample Values |
|---|---|---|---|---|---|
| 1 | id | Integer | Mã tự sinh của loại danh mục | ||
| 2 | code | String | Mã duy nhất của loại danh mục | ||
| 3 | name | String | Tên loại danh mục | ||
| 4 | status | Integer | Trạng thái loại danh mục | ||
| 5 | departmentId | Integer | Phò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 |
|---|---|---|---|---|
| 1 | Authorization | String | token |
2. Body
STT | Field | Required | Data Type / Length | Description | Note | Sample Values |
|---|---|---|---|---|---|---|
| 1 | id | false | Integer | Mã tự sinh của loại danh mục | Truyền mã tự sinh > 0 thì sẽ cập nhật, còn không thì thêm mới | |
| 2 | code | true | String | Mã duy nhất của loại danh mục | ||
| 3 | name | true | String | Tên loại danh mục | ||
| 4 | status | true | Integer | Trạng thái loại danh mục |
3. Response / Incoming Data Specification
| STT | Field | Data Type / Length | Description | Note | Sample Values |
|---|---|---|---|---|---|
| 1 | id | Integer | Mã tự sinh của loại danh mục | ||
| 2 | code | String | Mã duy nhất của loại danh mục | ||
| 3 | name | String | Tên loại danh mục | ||
| 4 | status | Integer | Trạng thái loại danh mục | ||
| 5 | departmentId | Integer | Phò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 |
|---|---|---|---|---|
| 1 | Authorization | String | token |
2. Body
STT | Field | Required | Data Type / Length | Description | Note | Sample Values |
|---|---|---|---|---|---|---|
| 1 | id | true | Integer | Mã tự sinh của loại danh mục | ||
| 2 | status | true | Integer | Trạng thái loại danh mục |
3. Response / Incoming Data Specification
| STT | Field | Data Type / Length | Description | Note | Sample Values |
|---|---|---|---|---|---|
| 1 | id | Integer | Mã tự sinh của loại danh mục | ||
| 2 | code | String | Mã duy nhất của loại danh mục | ||
| 3 | name | String | Tên loại danh mục | ||
| 4 | status | Integer | Trạng thái loại danh mục | ||
| 5 | departmentId | Integer | Phò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 |
|---|---|---|---|---|
| 1 | Authorization | String | token |
2. Param
STT | Field | Required | Data Type / Length | Description | Note | Sample Values |
|---|---|---|---|---|---|---|
| 1 | id | true | Integer | Mã tự sinh của loại danh mục |
3. Response / Incoming Data Specification
| STT | Field | Data Type / Length | Description | Note | Sample Values |
|---|---|---|---|---|---|
| 1 | result | Integer | Mã của bản ghi vừa xóa | Trả 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:
Field (Trường dữ liệu) | Type (Kiểu dữ liệu) | Required (Bắt buộc) | Validation (Quy định) | Description (Mô tả) |
|---|---|---|---|---|
| id | Integer | true | ||
| code | String | true | < 100 ký tự, mã loại danh mục không được phép trùng nhau | |
| name | String | true | < 255 ký tự | |
| status | Integer | true | ||
| departmentId | Integer | false |
...