Versions Compared

Key

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

...

Panel
titleAPI Spec Document

I. Danh sách danh mục dùng chung

Method

GET

URL

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

1

name

falseStringTên danh mục dùng chung

2

categoryTypeCode

falseStringMã loại danh mục

3

categoryTypeId

falseIntegerMã tự sinh loại danh mục

4

maxValue

falseLongLọc giá trị lớn nhất

5

minValue

falseLongLọc giá trị nhỏ nhất

6

limit

falseIntegerGiới hạn bản ghi trên 1 trang

7

page

falseIntegerVị trí trang

3. Response / Incoming Data Specification

STT

Field

Data Type / Length

Description

Note

Sample Values

1idIntegerMã tự sinh của danh mục dùng chung

2codeStringMã duy nhất của danh mục dùng chung

3nameStringTên danh mục dùng chung

4valueLongGiá trị của danh mục dùng chung

5usedCountIntegerSố lần sử dụng của danh mục dùng chung

6categoryTypeIdIntegerId tự sinh của loại danh mục

7departmentIdIntegerId phòng ban khởi tạo

8categoryTypeCodeStringMã duy nhất của loại danh mục

9categoryTypeNameStringTên loại danh mục

Panel
titleAPI Spec Document

II. Chi tiết danh mục dùng chung

Method

GET

URL

/masterData/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 danh mục dùng chung

3. Response / Incoming Data Specification

STT

Field

Data Type / Length

Description

Note

Sample Values

1idIntegerMã tự sinh của danh mục dùng chung

2codeStringMã duy nhất của danh mục dùng chung

3nameStringTên danh mục dùng chung

4valueLongGiá trị của danh mục dùng chung

5usedCountIntegerSố lần sử dụng của danh mục dùng chung

6categoryTypeIdIntegerId tự sinh của loại danh mục

7departmentIdIntegerId phòng ban khởi tạo

8categoryTypeCodeStringMã duy nhất của loại danh mục

9categoryTypeNameStringTên loại danh mục


III. Thêm mới/chỉnh sửa danh mục dùng chung

Method

POST

URL

/masterData/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 danh mục dùng chungTruyề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 danh mục dùng chung

3nametrueStringTên danh mục dùng chung

4categoryTypeIdtrueIntegerMã tự sinh của loại danh mục

5valuefalseIntegerGiá trị của danh mục dùng chung

3. Response / Incoming Data Specification

STT

Field

Data Type / Length

Description

Note

Sample Values

1idIntegerMã tự sinh của danh mục dùng chung

2codeStringMã duy nhất của danh mục dùng chung

3nameStringTên danh mục dùng chung

4valueLongGiá trị của danh mục dùng chung

5usedCountIntegerSố lần sử dụng của danh mục dùng chung

6categoryTypeIdIntegerId tự sinh của loại danh mục

7departmentIdIntegerId phòng ban khởi tạo

8categoryTypeCodeStringMã duy nhất của loại danh mục

9categoryTypeNameStringTên loại danh mục


IV. Cập nhật số lần sử dụng danh mục dùng chung

Method

POST

URL

/masterData/updateUsedCount

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 danh mục dùng chung

2usedCounttrueIntegerSố lần sử dụng danh mục

3. Response / Incoming Data Specification

STT

Field

Data Type / Length

Description

Note

Sample Values

1idIntegerMã tự sinh của danh mục dùng chung

2codeStringMã duy nhất của danh mục dùng chung

3nameStringTên danh mục dùng chung

4valueLongGiá trị của danh mục dùng chung

5usedCountIntegerSố lần sử dụng của danh mục dùng chung

6categoryTypeIdIntegerId tự sinh của loại danh mục

7departmentIdIntegerId phòng ban khởi tạo

8categoryTypeCodeStringMã duy nhất của loại danh mục

9categoryTypeNameStringTên loại danh mục


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

Method

DELETE

URL

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

/masterData/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 danh mục dùng chung

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:

Field

(Trường dữ liệu)

Type

(Kiểu dữ liệu)

Required

(Bắt buộc)

Validation

(Quy định)

Description

(Mô tả)

idIntegertrue


codeStringtrue< 100 ký tự, mã loại danh mục không được phép trùng nhau


nameStringtrue< 255 ký tự


statusIntegertrue


departmentIdIntegerfalse



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

...