Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
titleAPI 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

1authorizationStringTokenBearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc

2. RequestBody      

STT

Field

Required

Data Type / Length

Description

Note

1idtrueIntegerid phòng ban
2nametrueStringtên phòng ban
3managerIdfalseIntegerId người quản lý trực tiếp
4

shortName

falseStringtên viết tắt
5

englishName

falseStringtên tiếng Anh
6

phoneNumber

falseStringSố điện thoại
7

email

falseStringemail
8addressfalseStringĐịa chỉ

3. Response / Incoming Data Specification

STT 

Field

Data Type / Length

Description

Note

1codeInteger0: thành công, != 0 thất bại
2messageString

3resultObjectObject
4

(result) name

Booleantên thư mục
5

(result) parentId

Integerid thư mục cha
6

(result) path 

Integer

path


7

(result) id

Integer

thư mục



Nghiệp vụ

IT

Người lập

Người duyệt

Người lập

Người duyệt

Họ & Tên

Vũ Thị Mơ




Chức danh

BA




Tài khoản MS Team

movt2




Ngày soạn thảo/phê duyệt





Jira Link

https://jira.popplife.vn/browse/BPMKVH-2606

...

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

1authorization<token>Token của người dùng đăng nhậpBearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjY0NTU3ODksInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.wrvIFd-Q2kHgkTmPf6ryMY6aDIgXpNsWmSvvifQWc5k

2. Request

STT

Field

Require

Data Type / Length

Description

Note

Sample Values

1namefalseString tên cơ cấu tổ chức

2statusfalseIntegertrạng thái

3pagetrueInteger


4limittrueInteger


3. Response / Incoming Data Specification

STT

Field

Data Type / Length

Description

Note

Sample Values

1codeInteger0: thành công, != 0 thất bại

2messageString


3resultObjectObject

4

(result) loadMoreAble

Boolean


5

(result) page

Integer


6

(result) preLoadAble

Integer


7

(result) total

Integer




8

(result) items

List<Object>        

9

(items) id

IntegerId cơ cấu tổ chức

10

(items) name

Stringtên cơ cấu tổ chức

11

(items) shortName

StringTên viết tắt

12

(items) status

IntegerTrạng thái (2: inactive, 1: active)

13

(items) parentName

Stringtên phòng ban cha

14

(items) parentId

Integerid phòng ban cha

16(items) addressString địa chỉ



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

1authorizationStringTokenBearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc

2. Param

STT

Field

Required

Data Type / Length

Description

Note

1idtrueIntegerid phòng ban

3. Response / Incoming Data Specification

STT

Field

Data Type / Length

Description

Note

1codeInteger0: thành công, != 0 thất bại
2messageString

3resultObjectObject
4

(result) id

IntegerId phòng ban

(result) departmentIdHris

Stringid phòng ban lấy từ Hris.
5

(result) name

StringTên phòng ban
6

(result) shortName

Stringtên viết tắt
7

(result) status

IntegerTrạng thái (2: inactive, 1: active)
8

(result)  parentName

Stringtên phòng ban cha
9

(result) englishName

Stringtên tiếng Anh
10

(result) managerId

IntegerId người quản lý trực tiếp
11

(result) phoneNumber

StringSố điện thoại
12

(result) email

Stringemail
13(result) addressStringĐịa chỉ
14(result) managerNameStringTên người quản lý

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


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

1authorizationStringTokenBearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc

2. RequestBody      

STT

Field

Required

Data Type / Length

Description

Note

1idtrueIntegerid phòng ban
2nametrueStringtên phòng ban
3managerIdfalseIntegerId người quản lý trực tiếp
4

shortName

falseStringtên viết tắt
5

englishName

falseStringtên tiếng Anh
6

phoneNumber

falseStringSố điện thoại
7

email

falseStringemail
8addressfalseStringĐịa chỉ

3. Response / Incoming Data Specification

STT 

Field

Data Type / Length

Description

Note

1codeInteger0: thành công, != 0 thất bại
2messageString

3resultObjectObject
4

(result) name

Booleantên thư mục
5

(result) parentId

Integerid thư mục cha
6

(result) path 

Integer

path


7

(result) id

Integer

thư mục


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)

...