I. Danh sách danh mục dùng chungMethod | GET | URL | /masterData/list |
|---|
1. HeadersSTT | Field | Source Data Type / Length | Description | Sample Values |
|---|
| 1 | Authorization | String | token |
|
2. ParamSTT | Field | Required | Data Type / Length | Description | Note | Sample Values |
|---|
| 1 | name | false | String | Tên danh mục dùng chung |
|
| | 2 | categoryTypeCode | false | String | Mã loại danh mục |
|
| | 3 | categoryTypeId | false | Integer | Mã tự sinh loại danh mục |
|
| | 4 | maxValue | false | Long | Lọc giá trị lớn nhất |
|
| | 5 | minValue | false | Long | Lọc giá trị nhỏ nhất |
|
| | 6 | limit | false | Integer | Giới hạn bản ghi trên 1 trang |
|
| | 7 | 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 danh mục dùng chung |
|
| | 2 | code | String | Mã duy nhất của danh mục dùng chung |
|
| | 3 | name | String | Tên danh mục dùng chung |
|
| | 4 | value | Long | Giá trị của danh mục dùng chung |
|
| | 5 | usedCount | Integer | Số lần sử dụng của danh mục dùng chung |
|
| | 6 | categoryTypeId | Integer | Id tự sinh của loại danh mục |
|
| | 7 | departmentId | Integer | Id phòng ban khởi tạo |
|
| | 8 | categoryTypeCode | String | Mã duy nhất của loại danh mục |
|
| | 9 | categoryTypeName | String | Tên loại danh mục |
|
|
II. Chi tiết danh mục dùng chungMethod | GET | URL | /masterData/get |
|---|
1. HeadersSTT | Field | Source Data Type / Length | Description | Sample Values |
|---|
| 1 | Authorization | String | token |
|
2. ParamSTT | Field | Required | Data Type / Length | Description | Note | Sample Values |
|---|
| 1 | id | true | Integer | Mã tự sinh của danh mục dùng chung |
|
|
3. Response / Incoming Data Specification| STT | Field | Data Type / Length | Description | Note | Sample Values |
|---|
| 1 | id | Integer | Mã tự sinh của danh mục dùng chung |
|
| | 2 | code | String | Mã duy nhất của danh mục dùng chung |
|
| | 3 | name | String | Tên danh mục dùng chung |
|
| | 4 | value | Long | Giá trị của danh mục dùng chung |
|
| | 5 | usedCount | Integer | Số lần sử dụng của danh mục dùng chung |
|
| | 6 | categoryTypeId | Integer | Id tự sinh của loại danh mục |
|
| | 7 | departmentId | Integer | Id phòng ban khởi tạo |
|
| | 8 | categoryTypeCode | String | Mã duy nhất của loại danh mục |
|
| | 9 | categoryTypeName | String | Tên loại danh mục |
|
|
III. Thêm mới/chỉnh sửa danh mục dùng chungMethod | POST | URL | /masterData/update |
|---|
1. HeadersSTT | Field | Source Data Type / Length | Description | Sample Values |
|---|
| 1 | Authorization | String | token |
|
2. BodySTT | Field | Required | Data Type / Length | Description | Note | Sample Values |
|---|
| 1 | id | false | Integer | Mã tự sinh của danh mục dùng chung | 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 danh mục dùng chung |
|
| | 3 | name | true | String | Tên danh mục dùng chung |
|
| | 4 | categoryTypeId | true | Integer | Mã tự sinh của loại danh mục |
|
| | 5 | value | false | Integer | Giá trị của danh mục dùng chung |
|
|
3. Response / Incoming Data Specification| STT | Field | Data Type / Length | Description | Note | Sample Values |
|---|
| 1 | id | Integer | Mã tự sinh của danh mục dùng chung |
|
| | 2 | code | String | Mã duy nhất của danh mục dùng chung |
|
| | 3 | name | String | Tên danh mục dùng chung |
|
| | 4 | value | Long | Giá trị của danh mục dùng chung |
|
| | 5 | usedCount | Integer | Số lần sử dụng của danh mục dùng chung |
|
| | 6 | categoryTypeId | Integer | Id tự sinh của loại danh mục |
|
| | 7 | departmentId | Integer | Id phòng ban khởi tạo |
|
| | 8 | categoryTypeCode | String | Mã duy nhất của loại danh mục |
|
| | 9 | categoryTypeName | String | Tên loại danh mục |
|
|
IV. Cập nhật số lần sử dụng danh mục dùng chungMethod | POST | URL | /masterData/updateUsedCount |
|---|
1. HeadersSTT | Field | Source Data Type / Length | Description | Sample Values |
|---|
| 1 | Authorization | String | token |
|
2. BodySTT | Field | Required | Data Type / Length | Description | Note | Sample Values |
|---|
| 1 | id | true | Integer | Mã tự sinh của danh mục dùng chung |
|
| | 2 | usedCount | true | Integer | Số lần sử dụng 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 danh mục dùng chung |
|
| | 2 | code | String | Mã duy nhất của danh mục dùng chung |
|
| | 3 | name | String | Tên danh mục dùng chung |
|
| | 4 | value | Long | Giá trị của danh mục dùng chung |
|
| | 5 | usedCount | Integer | Số lần sử dụng của danh mục dùng chung |
|
| | 6 | categoryTypeId | Integer | Id tự sinh của loại danh mục |
|
| | 7 | departmentId | Integer | Id phòng ban khởi tạo |
|
| | 8 | categoryTypeCode | String | Mã duy nhất của loại danh mục |
|
| | 9 | categoryTypeName | String | Tên loại danh mục |
|
|
V. Xóa loại danh mụcMethod | DELETE | URL | /masterData/delete |
|---|
1. HeadersSTT | Field | Source Data Type / Length | Description | Sample Values |
|---|
| 1 | Authorization | String | token |
|
2. ParamSTT | 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 | Số bản ghi xóa thành công | Trả về 0 nếu xóa thất bại |
|
VI. Xóa nhiều loại danh mụcMethod | DELETE | URL | /masterData/deleteList |
|---|
1. HeadersSTT | Field | Source Data Type / Length | Description | Sample Values |
|---|
| 1 | Authorization | String | token |
|
2. ParamSTT | Field | Required | Data Type / Length | Description | Note | Sample Values |
|---|
| 1 | lstId | true | List<Integer> | Danh sách mã tự sinh của danh mục dùng chung |
|
|
3. Response / Incoming Data Specification| STT | Field | Data Type / Length | Description | Note | Sample Values |
|---|
| 1 | result | Integer | Số bản ghi xóa thành công | 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ã danh mục dùng chung không được phép trùng nhau trong cùng một loại danh mục |
| | name | String | true | < 255 ký tự |
| | value | Integer | false |
|
| | usedCount | Integer | false |
|
| | categoryTypeId | Integer | true |
|
| | departmentId | Integer | true |
|
| | categoryTypeCode | String | false |
|
| | categoryTypeName | String | false |
|
|
|