|
BAN CHẤP HÀNH TRUNG ƯƠNG
VĂN PHÒNG
*
Số 417-QĐ/VPTW
|
ĐẢNG
CỘNG
SẢN
VIỆT
NAM
Hà
Nội,
ngày
15
tháng
7 năm 2026
|
QUYẾT ĐỊNH
ban hành Danh mục các trường dữ liệu chia sẻ, nguyên tắc kết nối và đặc tả giao diện API kết nối, chia sẻ dữ liệu từ Hệ thống thông tin điều hành tác nghiệp trong các cơ quan đảng
- Căn cứ Luật Giao dịch điện tử ngày 22/6/2023; Luật Dữ liệu ngày 30/11/2024; Luật Bảo vệ dữ liệu cá nhân ngày 26/6/2025; Luật An ninh mạng ngày 10/12/2025;
- Căn cứ Nghị quyết số 57-NQ/TW, ngày 22/12/2024 của Bộ Chính trị về đột phá phát triển khoa học, công nghệ, đổi mới sáng tạo và chuyển đổi số quốc gia;
- Căn cứ Quyết định số 204-QĐ/TW, ngày 29/11/2024 của Ban Bí thư phê duyệt Đề án Chuyển đổi số trong các cơ quan đảng;
- Căn cứ Nghị định số 13/2023/NĐ-CP, ngày 17/4/2023 của Chính phủ về bảo vệ dữ liệu cá nhân;
- Căn cứ Quyết định số 333-QĐ/TW, ngày 24/6/2025 của Ban Bí thư về ban hành Kiến trúc chuyển đổi số trong các cơ quan đảng, phiên bản 3.0;
- Căn cứ Quy định số 384-QĐ/TW, ngày 19/11/2025 của Ban Bí thư về kết nối, chia sẻ dữ liệu giữa các cơ quan đảng với các cơ quan, tổ chức khác trong hệ thống chính trị;
- Căn cứ Quy chế số 07-QC/TW, ngày 31/10/2025 của Ban Bí thư về tổ chức, quản lý, sử dụng và bảo vệ hệ thống mạng máy tính của đảng;
- Căn cứ Quyết định số 16-QĐ/BCĐ, ngày 28/12/2025 của Ban Chỉ đạo Chuyển đổi số trong các cơ quan đảng phê duyệt Kiến trúc dữ liệu phiên bản 1.0 trong các cơ quan đảng;
- Căn cứ Hướng dẫn số 07-HD/VPTW, ngày 29/5/2026 của Văn phòng Trung ương Đảng về kết nối, tích hợp, chia sẻ dữ liệu trong các cơ quan đảng;
- Xét đề nghị của Cục Chuyển đổi số - Cơ yếu.
CHÁNH VĂN PHÒNG TRUNG ƯƠNG ĐẢNG
QUYẾT ĐỊNH
Điều 1. Ban hành kèm theo Quyết định này Phụ lục I về Danh mục các trường dữ liệu chia sẻ và Phụ lục II về nguyên tắc kết nối, chia sẻ dữ liệu và đặc tả chi tiết giao diện API kết nối, chia sẻ dữ liệu từ Hệ thống thông tin điều hành tác nghiệp trong các cơ quan đảng.
Điều 2. Các cơ quan đảng ở Trung ương, các đảng uỷ trực thuộc Trung ương, các tỉnh uỷ, thành uỷ và các cơ quan, tổ chức có liên quan chịu trách nhiệm thi hành Quyết định này.
Điều 3. Quyết định này có hiệu lực thi hành kể từ ngày ký ban hành.
- Đồng chí Chánh Văn phòng - Như Điều 2; Nơi nhận: K/T CHÁNH VĂN PHÒNG PHÓ CHÁNH VĂN PHÒNG
Trung ương Đảng (để báo cáo);
- Các đồng chí lãnh đạo Văn phòng
Trung ương Đảng;
- Lưu Văn phòng Trung ương Đảng.
ĂN PHÒN
Võ Thành Hưng
PHỤ LỤC I
DANH MỤC CÁC TRƯỜNG DỮ LIỆU CHIA SẺ
TỪ HỆ THỐNG THÔNG TIN ĐIỀU HÀNH TÁC NGHIỆP
|
STT
|
Trường
dữ
liệu
|
|
I
|
Thông
tin
xác
thực
hệ
thống
|
|
1
|
Access Token (JWT)
|
|
2
|
Thời điểm hết hạn token (expireToken)
|
|
II
|
Thông tin dự thảo văn bản
|
|
3
|
Mã định danh văn bản (textId)
|
|
4
|
Tiêu đề/trích yếu nội dung (title)
|
|
5
|
Nội dung văn bản (content)
|
|
6
|
Người tạo văn bản (creator)
|
|
7
|
Ngày tạo văn bản (createDate)
|
|
8
|
Ngày gửi trình ký (sendDate)
|
|
9
|
Đơn vị trình ký (departSentSign)
|
|
10
|
Trạng thái văn bản (state)
|
|
11
|
Mã và tên độ khẩn (urgencyCode/Name)
|
|
12
|
Mã và tên độ mật (securityCode/Name)
|
|
13
|
Mã và tên loại văn bản (typeId/typeName)
|
|
14
|
Số/ký hiệu văn bản (code)
|
|
15
|
Mức trình ký hiện tại (signLevel)
|
|
16
|
Danh sách file chính trình ký (fileMainSign[])
|
|
17
|
Danh sách file đính kèm (fileAttachFromSign[])
|
|
18
|
Danh sách người tham gia ký (listSubmitter[])
|
|
III
|
Thông
tin
văn
bản
đi
|
|
19
|
ID văn bản (documentId)
|
|
20
|
Số đăng ký (registerNumber)
|
|
21
|
Đơn vị gửi (officeSender)
|
|
22
|
Số, ký hiệu văn bản (code)
|
|
23
|
Trích yếu nội dung văn bản (title)
|
|
24
|
Ngày ban hành (promulgateDate)
|
|
25
|
Hạn xử lý (deadlineDate)
|
|
STT
|
Trường
dữ
liệu
|
|
26
|
Người ký (signer)
|
|
27
|
ID và tên độ khẩn (priorityId, priority)
|
|
28
|
ID và tên thể loại văn bản (typeId, type)
|
|
29
|
ID và tên độ mật (stypeId, stype)
|
|
30
|
Trạng thái văn bản (statusNumber)
|
|
31
|
Số bản (numberOfCopy)
|
|
32
|
ID và tên văn thư ban hành
|
|
33
|
Số điện thoại, email người ban hành
|
|
34
|
Ngày đến (toDate)
|
|
35
|
ID và tên đơn vị ban hành
|
|
36
|
Danh sách file đính kèm (listAttachment)
|
|
37
|
Danh sách file biểu mẫu (listAttachTemplate)
|
|
IV
|
Thông
tin
văn
bản
đến
|
|
38
|
ID sổ văn bản (textBookId)
|
|
39
|
Tên sổ văn bản (textBookName)
|
|
40
|
ID và tên đơn vị sở hữu sổ
|
|
41
|
Loại văn bản áp dụng (typeId)
|
|
42
|
Số đăng ký hiện tại (currentRegisterNumber)
|
|
43
|
Trạng thái sổ (isActive)
|
|
44
|
ID nhóm (groupId)
|
|
45
|
Tên nhóm (groupName)
|
|
46
|
ID tổ chức sở hữu nhóm (orgId)
|
|
47
|
ID văn bản (documentId)
|
|
48
|
Số, ký hiệu văn bản (code)
|
|
49
|
Trích yếu nội dung văn bản (title)
|
|
50
|
Ngày ban hành (promulgateDate)
|
|
51
|
Thể loại văn bản (type)
|
|
52
|
Danh sách file đính kèm (listAttachment)
|
|
53
|
Danh sách file biểu mẫu (listAttachTemplate)
|
|
STT
|
Trường
dữ
liệu
|
|
54
|
Danh sách người đang xử lý phiếu trình
|
|
55
|
Trạng thái chuyển tiếp (status)
|
|
VI
|
Thông tin nhiệm vụ
|
|
56
|
ID nhiệm vụ (missionId)
|
|
57
|
Tên nhiệm vụ (missionName)
|
|
58
|
Đường dẫn phân cấp nhiệm vụ (missionPath)
|
|
59
|
Nội dung/yêu cầu nhiệm vụ (content)
|
|
60
|
Mục tiêu cần đạt được (target)
|
|
61
|
Ngày bắt đầu (dateStart)
|
|
62
|
Ngày hoàn thành dự kiến (dateComplete)
|
|
63
|
Trọng số nhiệm vụ (weight)
|
|
64
|
ID và tên đơn vị giao nhiệm vụ
|
|
65
|
ID và tên người giao nhiệm vụ
|
|
66
|
Số điện thoại, mã đăng nhập người giao
|
|
67
|
Chức vụ người giao (assignPosition)
|
|
68
|
ID và tên đơn vị thực hiện
|
|
69
|
Tần suất cập nhật tiến độ (frequenceUpdate)
|
|
70
|
ID và tên lĩnh vực nhiệm vụ
|
|
71
|
Trạng thái và tên trạng thái nhiệm vụ
|
|
72
|
Ngày tạo và người tạo nhiệm vụ
|
|
73
|
Loại và nhóm nhiệm vụ
|
|
74
|
Mức độ công khai, nội bộ (isPublic)
|
|
75
|
Mức độ quan trọng (levelImportance)
|
|
76
|
Trạng thái hạn (deadlineStatus)
|
|
77
|
Số ngày quá hạn (overDate)
|
|
78
|
Mã màu hiển thị trạng thái hạn
|
|
79
|
Danh sách tài liệu nguồn liên kết
|
|
80
|
Danh sách văn bản tham chiếu
|
|
81
|
Số nhiệm vụ con (count)
|
|
82
|
Quyền của đơn vị giao/thực hiện/phối hợp
|
|
STT
|
Trường
dữ
liệu
|
|
VII
|
Thông tin
hồ
sơ
|
|
83
|
ID hồ sơ (briefId)
|
|
84
|
Tên hồ sơ (name)
|
|
85
|
Số hồ sơ (registerNumber)
|
|
86
|
Mã hồ sơ (code)
|
|
87
|
ID và tên đơn vị quản lý hồ sơ
|
|
88
|
Độ mật hồ sơ (stype)
|
|
89
|
Ngày tạo hồ sơ (createDateStr)
|
|
90
|
Trạng thái hồ sơ (status, briefStatus)
|
|
91
|
Tổng số trang (numPaper)
|
|
92
|
Tổng số tài liệu trong hồ sơ (totalDoc)
|
|
VIII
|
Thông
tin
lịch
họp
|
|
93
|
Mã định danh cuộc họp (meetingId)
|
|
94
|
Tiêu đề cuộc họp (title)
|
|
95
|
Nội dung cuộc họp (content)
|
|
96
|
Thời gian bắt đầu và kết thúc
|
|
97
|
Tên phòng họp (roomName)
|
|
98
|
Người chủ trì cuộc họp (chairman)
|
|
99
|
Đơn vị tổ chức (orgName)
|
|
100
|
Loại lịch họp (meetingType)
|
|
101
|
Trạng thái cuộc họp (status)
|
|
IX
|
Thông
tin
báo
cáo
tổng
hợp
|
|
102
|
Loại đối tượng thống kê (objectType)
|
|
103
|
Tên loại đối tượng (objectName)
|
|
104
|
Tổng số văn bản (countAll)
|
|
105
|
Số văn bản đang xử lý đúng hạn
|
|
106
|
Số văn bản đang xử lý quá hạn
|
|
107
|
Số văn bản hoàn thành đúng hạn
|
|
108
|
Số văn bản hoàn thành quá hạn
|
|
109
|
Dữ liệu biểu đồ theo đơn vị (dataBarChart)
|
|
X
|
Thông
tin
danh
mục
dùng
chung
|
|
X.1
|
Thông tin thể loại văn bản
|
|
110
|
ID thể loại văn bản (id)
|
|
111
|
Tên thể loại văn bản (title)
|
|
STT
|
Trường
dữ
liệu
|
|
112
|
Ký hiệu/tên viết tắt (abbreviate)
|
|
113
|
Phân loại nhóm thể loại (type)
|
|
X.2
|
Thông tin độ mật
|
|
114
|
ID độ mật (id)
|
|
115
|
Tên độ mật (title)
|
|
X.3
|
Thông tin độ khẩn
|
|
116
|
ID độ khẩn (id)
|
|
117
|
Tên độ khẩn (title)
|
|
X.4
|
Thông
tin
cây
đơn
vị
|
|
118
|
Đường dẫn vị trí đơn vị trong cây (path)
|
|
119
|
ID đơn vị cha trực tiếp (orgParentId)
|
|
120
|
Cấp độ đơn vị trong cây (orgLevel)
|
|
121
|
Trạng thái cấu hình đơn vị (isConfigured)
|
|
122
|
Có phải đơn vị gốc không (isRoot)
|
|
123
|
Có phải đơn vị lá không (isLeaf)
|
|
124
|
ID đơn vị (orgId)
|
|
125
|
Mã đơn vị (orgCode)
|
|
126
|
Tên đơn vị (orgName)
|
|
127
|
Tên đầy đủ theo đường dẫn cây (pathName)
|
|
128
|
Tên viết tắt đơn vị (abbreviation)
|
|
129
|
Tên đơn vị cha (orgParentName)
|
|
X.5
|
Thông
tin người
dùng
(Yêu cầu
hệ
thống nhận đảm bảo
quy
định theo luật bảo vệ dữ
liệu
cá
nhân)
|
|
130
|
ID nhân sự (employeeId)
|
|
131
|
Tên đơn vị (orgName)
|
|
132
|
ID đơn vị (sysOrganizationId)
|
|
133
|
Đường dẫn phân cấp đơn vị (pathName)
|
|
134
|
Tên hiển thị (displayName)
|
|
135
|
Họ và tên đầy đủ (fullName)
|
|
136
|
Tên chức vụ (position)
|
|
137
|
ID chức vụ (positionId)
|
|
138
|
Mã nhân sự (employeeCode)
|
|
139
|
Số điện thoại (mobilePhone)
|
|
140
|
Email
|
PHỤ LỤC II
NGUYÊN TẮC KẾT NỐI, CHIA SẺ DỮ LIỆU
VÀ ĐẶC TẢ CHI TIẾT GIAO DIỆN API KẾT NỐI, CHIA SẺ DỮ LIỆU
TỪ HỆ THỐNG THÔNG TIN ĐIỀU HÀNH TÁC NGHIỆP
(Kèm theo Quyết định số 417-QĐ/VPTW, ngày 15/7/2026 của Văn phòng Trung ương Đảng)
1. PHẠM VI, PHÂN LOẠI DỮ LIỆU CHIA SẺ VÀ BASE URL
Hệ thống điều hành tác nghiệp cung cấp 17 API kết nối thuộc 10 module nghiệp vụ: Xác thực; Dự thảo văn bản; Văn bản đi; Phiếu trình; Văn bản đến; Lịch họp; Nhiệm vụ; Danh mục dùng chung; Hồ sơ; Báo cáo tổng hợp.
Base URL: {domain}/ServiceMobile_V02/resources (trong đó {domain} là địa chỉ Nền tảng tích hợp, chia sẻ dữ liệu (LGSP) của Đảng do Cục Chuyển đổi số - Cơ yếu cung cấp).
Quy định này không bao gồm kết nối, chia sẻ bất kỳ dữ liệu nào thuộc phạm vi bí mật nhà nước (từ độ Mật trở lên). Chỉ áp dụng cho kết nối, chia sẻ dữ liệu thông thường và dữ liệu nội bộ của các cơ quan Đảng.
2. NGUYÊN TẮC VÀ LƯU Ý KHI TÍCH HỢP
1. Tuân thủ quy định: Mọi hoạt động kết nối, chia sẻ, khai thác dữ liệu phải tuân thủ nghiêm các nguyên tắc được quy định tại Quy định số 384- QĐ/TW ngày 19/11/2025 của Ban Bí thư và Hướng dẫn số 07-HD/VPTW ngày 29/5/2026 của Văn phòng Trung ương Đảng.
2. Xác thực 2 lớp: Mọi API nghiệp vụ cần Bearer token từ API số 1 (xác thực hệ thống) VÀ API số 2 (xác thực người dùng SSO). Token người dùng SSO xác định phạm vi dữ liệu được phép khai thác.
3. Mã lỗi chuẩn: errorCode 200/code "200" = thành công; 401 = sai thông tin xác thực; 812 = dữ liệu đầu vào không hợp lệ. HTTP 429 = vượt giới hạn lưu lượng.
4. Định dạng ngày giờ: Dữ liệu đầu vào dùng định dạng dd/MM/yyyy (trường hợp cần giờ phút giây áp dụng chuẩn ISO 8601). Dữ liệu đầu ra sử dụng định dạng dd/MM/yyyy HH: mm: ss.
5. Quan hệ với xác thực LGSP: Xác thực bằng APP_CODE/mật khẩu (API số 1) là lớp xác thực ở tầng ứng dụng của Hệ thống thông tin điều hành
tác nghiệp, thực hiện sau khi hệ thống của đơn vị đã hoàn thành đăng ký, thiết lập kết nối tới Nền tảng tích hợp, chia sẻ dữ liệu (LGSP) của Đảng theo quy trình và được cấp khoá định danh (Consumer Key/Secret Key) quy định tại Hướng dẫn số 07-HD/VPTW. Đơn vị hoàn thành đăng ký kết nối LGSP trước, sau đó mới được cấp APP_CODE để gọi các API nghiệp vụ của Hệ thống thông tin điều hành tác nghiệp.
3. QUẢN LÝ VẬN HÀNH VÀ BẢO ĐẢM AN TOÀN THÔNG TIN
1. Lưu trữ nhật ký (Log): Các cơ quan, đơn vị khai thác phải lưu trữ, giám sát nhật ký giao dịch API tối thiểu 24 tháng phục vụ công tác kiểm tra, giám sát, truy vết, điều tra và xử lý sự cố an toàn thông tin.
2. Quản lý vòng đời API: Mọi thay đổi ảnh hưởng đến cấu trúc dữ liệu, tham số hoặc phương thức kết nối phải được Cục Chuyển đổi số - Cơ yếu thông báo bằng văn bản hoặc trên cổng quản lý API trước khi áp dụng.
3. Tạm dừng, thu hồi kết nối: Hệ thống sẽ thu hồi hoặc tạm dừng kết nối trong các trường hợp: Đơn vị vi phạm mục đích sử dụng; Phát sinh nguy cơ làm mất an toàn, an ninh thông tin; Hoặc cơ quan khai thác không còn nhu cầu tiếp tục kết nối.
4. DANH MỤC 17 API KẾT NỐI
Hệ thống điều hành tác nghiệp cung cấp 17 API kết nối thuộc 10 module nghiệp vụ. Base
URL: {domain}/ServiceMobile_V02/resources.
|
STT
|
Tên API
|
Method
|
Module
|
Path
đầy
đủ
(sau
Base
URL)
|
|
1
|
Xác thực đơn vị tích hợp (Client Credential)
|
POST
|
XÁC THỰC
|
/Authentication/Login
|
|
2
|
Xác thực người dùng SSO/VNeID
|
POST
|
XÁC THỰC
|
/ext-doc/login-sso-ext-app
|
|
3
|
Xem chi tiết văn bản trình ký
|
POST
|
DỰ THẢO VĂN BẢN
|
/textAction/getTextDetail
|
|
4
|
Lấy văn bản đi theo cá nhân
|
POST
|
BẢN VĂN
ĐI
|
/ext-doc/get-document-by-sso/out
|
|
5
|
Lấy văn bản đi theo đơn vị
|
POST
|
BẢN VĂN
ĐI
|
/ext-doc/get-document-by-org/out
|
|
6
|
Lấy danh sách sổ văn bản theo đơn vị và loại văn bản
|
POST
|
BẢN VĂN
ĐẾN
|
/textBookAction/getTextBooksByO rgIdAndDocType
|
|
7
|
Lấy danh sách văn bản đến qua SSO
|
POST
|
VĂN BẢN
ĐẾN
|
/ext-doc/get-document-by-sso/in
|
|
8
|
Lấy danh sách văn bản đến theo đơn vị
|
POST
|
BẢN
VĂN
ĐẾN
|
/ext-doc/get-document-by-org/in
|
|
9
|
Lấy danh sách đơn vị đã gửi (getListGroup)
|
POST
|
VĂN BẢN
ĐẾN
|
/DocumentAction/getListGroup
|
|
10
|
Danh sách phiếu trình
|
GET
|
PHIẾU
TRÌNH
|
/api/submission- manager/submission-form/get-list
|
|
11
|
Xem chi tiết nhiệm vụ (getMissionDetail)
|
POST
|
NHIỆM VỤ
|
/missionAction/getMissionDetail
|
|
12
|
Lấy danh sách hồ sơ (get- brief-by-sso)
|
POST
|
HỒ SƠ
|
/ext-brief/get-brief-by-sso
|
|
13
|
Lấy danh sách lịch họp theo tuần
|
POST
|
LỊCH HỌP
|
/MettingWeek/getLstMeetingWeek
|
|
14
|
Báo cáo thống kê KPI (get- kpi-statistic)
|
POST
|
BÁO CÁO TỔNG HỢP
|
/api/kpi/get-kpi-statistic
|
|
STT
|
Tên API
|
Method
|
Module
|
Path
đầy
đủ
(sau
Base
URL)
|
|
15
|
Lấy danh mục dùng chung
(Thể loại, Độ khẩn, Độ mật)
|
POST
|
DANH MỤC
DÙNG
CHUNG
|
/DocumentService/getListFieldsBy Area
|
|
16
|
Lấy danh sách đơn vị dạng cây (getTreeDepartSign)
|
POST
|
DANH MỤC
DÙNG
CHUNG
|
/DocumentService/getTreeDepartSi gn
|
|
17
|
Lấy danh sách cá nhân (getListUser)
|
POST
|
DANH MỤC DÙNG CHUNG
|
/staffAction/getListUser
|
5. Đặc tả chi tiết từng API
API 1: Xác thực đơn vị tích hợp (Client Credential)
Module: XÁC THỰC
|
Method
|
POST
|
|
URL
|
{domain}/ServiceMobile_V02/resources/Authentication/Login
|
|
Content-
Type
|
application/json
|
Mô tả: Xác thực APP_CODE và mật khẩu do ĐHTN cấp, nhận token hệ thống phục vụ các API tiếp theo. Đây là bước bắt buộc đầu tiên trước khi gọi bất kỳ API nghiệp vụ nào.
Tham số đầu vào (Request)
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ liệu
|
Bắt
buộc
|
Mô tả
|
|
1
|
username
|
String
|
Bắt buộc
|
APP_CODE do điều hành tác nghiệp cấp
cho đơn vị tích hợp. Liên hệ admin điều
hành tác nghiệp để được cấp.
|
|
2
|
password
|
String
|
Bắt
buộc
|
Mật khẩu tương ứng với APP_CODE
|
Tham số đầu ra (Response)
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ liệu
|
Bắt
buộc
|
Mô tả
|
|
1
|
result.mess.errorCode
|
Number
|
Mã kết quả. 200 = thành công
|
|
|
2
|
result.mess.message
|
String
|
Thông báo kết quả
|
|
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ
liệu
|
Bắt
buộc
|
Mô tả
|
|
3
|
result.data.token
|
String
|
Bắt
buộc
|
Access Token (JWT) - dùng
cho Header Authorization:
Bearer
|
|
4
|
result.data.expireToken
|
String
|
Thời điểm hết hạn token.
Định dạng dd/MM/yyyy HH: mm: ss
|
|
|
5
|
result.data.refreshToken
|
String
|
Refresh Token để gia hạn Access Token khi hết hạn
|
|
|
6
|
result.data.ssoToken
|
String
|
Token phục vụ cơ chế SSO
|
|
|
7
|
result.data.strSessionId
|
String
|
Mã định danh phiên làm việc
|
|
|
8
|
result.data.requiredChangePassword
|
Boolean
|
true: bắt buộc đổi mật khẩu; false: không yêu cầu
|
API 2: Xác thực người dùng SSO/VNeID
Module: XÁC THỰC
|
Method
|
POST
|
|
URL
|
{domain}/ServiceMobile_V02/resources/ext-doc/login-sso-ext-app
|
|
Content-
Type
|
application/json
|
Mô tả: Xác thực người dùng qua hệ thống SSO tập trung hoặc VNeID, nhận token người dùng để khai thác các API nghiệp vụ. Bắt buộc gọi sau API số 1.
Ghi chú: Header: Authorization: Bearer {token từ API số 1}
Tham số đầu vào (Request)
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ liệu
|
Bắt
buộc
|
Mô tả
|
|
1
|
loginType
|
Number
|
Bắt buộc
|
1 = Đăng nhập qua SSO; 0 = Đăng nhập qua VNeID
|
|
2
|
accessToken
|
String
|
Bắt buộc
|
Token lấy từ hệ thống xacthuctaptrung (SSO)
|
Tham số đầu ra (Response)
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ
liệu
|
Bắt
buộc
|
Mô tả
|
|
1
|
result.mess.errorCode
|
Number
|
Mã kết quả. 200 = thành công
|
|
|
2
|
result.data.token
|
String
|
Access Token người dùng - dùng cho các API nghiệp vụ
|
|
|
3
|
result.data.expireToken
|
String
|
Thời điểm hết hạn token
người dùng
|
|
|
4
|
result.data.refreshToken
|
String
|
Refresh Token
|
|
|
5
|
result.data.ssoToken
|
String
|
SSO Token
|
|
|
6
|
result.data.strSessionId
|
String
|
Mã phiên làm việc
|
|
|
7
|
result.data.requiredChangePassword
|
Boolean
|
Trạng thái yêu cầu đổi mật khẩu
|
1. Module: Dự thảo văn bản
API 3: Xem chi tiết văn bản trình ký
Module: DỰ THẢO VĂN BẢN
|
Method
|
POST
|
|
URL
|
{domain}/ServiceMobile_V02/resources/textAction/getTextDetail
|
|
Content-
Type
|
application/x-www-form-urlencoded
|
|
Header
|
Authorization: Bearer
|
Mô tả: Lấy toàn bộ thông tin chi tiết văn bản trình ký bao gồm metadata, danh sách file và luồng người ký.
Ghi chú: Body: isSecurity="0", data={json}
Tham số đầu vào (Request)
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ liệu
|
Bắt buộc
|
Mô tả
|
|
1
|
textId
|
Number
|
Bắt buộc
|
ID văn bản trình ký
|
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ liệu
|
Bắt
buộc
|
Mô tả
|
|
2
|
isListFile
|
Number
|
Bắt
buộc
|
Mặc định 0
|
|
3
|
type
|
Number
|
Bắt
buộc
|
Mặc định 0
|
Tham số đầu ra (Response)
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ
liệu
|
Bắt
buộc
|
Mô tả
|
|
1
|
data.textId
|
String
|
Mã định danh văn bản
|
|
|
2
|
data.title
|
String
|
Tiêu đề/trích yếu nội dung
|
|
|
3
|
data.content
|
String
|
Nội dung văn bản
|
|
|
4
|
data.creator
|
String
|
Người tạo văn bản
|
|
|
5
|
data.createDate
|
String
|
Ngày tạo. Định dạng
|
|
|
5
|
data.createDate
|
String
|
dd/MM/yyyy HH: mm: ss
|
|
|
6
|
data.sendDate
|
String
|
Ngày gửi trình ký
|
|
|
7
|
data.departSentSign
|
String
|
Đơn vị trình ký
|
|
|
8
|
data.state
|
String
|
Trạng thái văn bản
|
|
|
9
|
data.urgencyCode/Name
|
String
|
Mã và tên độ khẩn
|
|
|
10
|
data.securityCode/Name
|
String
|
Mã và tên độ mật
|
|
|
11
|
data.typeId/typeName
|
String
|
Mã và tên loại văn bản
|
|
|
12
|
data.code
|
String
|
Số/Ký hiệu văn bản
|
|
|
13
|
data.signLevel
|
String
|
Mức trình ký hiện tại
|
|
|
14
|
data.fileMainSign[]
|
Array
|
Danh sách file chính trình ký
|
|
|
15
|
fileMainSign[].fileAttachmentId
|
Number
|
Mã file
|
|
|
16
|
fileMainSign[].fileName
|
String
|
Tên file
|
|
|
17
|
fileMainSign[].filePath
|
String
|
Đường dẫn lưu trữ
|
|
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ
liệu
|
Bắt
buộc
|
Mô tả
|
|
18
|
fileMainSign[].storage
|
String
|
Kho lưu trữ
|
|
|
19
|
fileMainSign[].lFilePage
|
Number
|
Số trang
|
|
|
20
|
fileMainSign[].lFileSize
|
Number
|
Kích thước (byte)
|
|
|
21
|
data.fileAttachFromSign[]
|
Array
|
Danh sách file đính kèm (cấu trúc như fileMainSign)
|
|
|
22
|
data.listSubmitter[]
|
Array
|
Danh sách người tham gia ký
|
|
|
23
|
listSubmitter[].empVhrName
|
String
|
Họ tên người ký
|
|
|
24
|
listSubmitter[].signLevel
|
String
|
Thứ tự ký
|
|
|
25
|
listSubmitter[].stateUserSign
|
Number
|
Trạng thái ký. 0=Chưa xử lý
|
|
|
26
|
listSubmitter[].stateName
|
String
|
Tên trạng thái ký
|
|
|
27
|
listSubmitter[].departmentName
|
String
|
Đơn vị/chức danh người ký
|
2. Module: Văn bản đi
API 4: Lấy văn bản đi theo cá nhân (get-document-by-sso/out)
Module: VĂN BẢN ĐI
|
Method
|
POST
|
|
URL
|
{domain}/ServiceMobile_V02/resources/ext-doc/get-document-by-sso/out
|
|
Content-
Type
|
application/json
|
|
Header
|
Authorization: Bearer
|
Mô tả: Lấy danh sách văn bản đi của một cá nhân trên hệ thống Điều hành tác nghiệp, dựa theo điều kiện lọc được cấu hình. Dữ liệu trả về gồm thông tin metadata của văn bản và danh sách file đính kèm (file ký chính, tài liệu liên quan, file biểu mẫu).
Tham số đầu vào (Request)
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ liệu
|
Bắt
buộc
|
Mô tả
|
|
1
|
pageNo
|
Number
|
Bắt
|
Trang cần lấy
|
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ liệu
|
Bắt
buộc
|
Mô tả
|
|
buộc
|
||||
|
2
|
pageSize
|
Number
|
Bắt
buộc
|
Số record mỗi trang
|
|
3
|
filter
|
Object
|
Tuỳ chọn
|
Object chứa các thông tin tìm kiếm (tìm kiếm trong phạm vi dữ liệu được trả về)
|
|
4
|
promulgateDateFrom
|
String
|
Tuỳ chọn
|
Ngày ban hành phải >= ngày này
|
|
5
|
promulgateDateTo
|
String
|
Tuỳ chọn
|
Ngày ban hành phải <= ngày này
|
|
6
|
priorityId
|
Number
|
Tuỳ
chọn
|
Độ khẩn
|
|
7
|
typeId
|
Number
|
Tuỳ chọn
|
Thể loại văn bản
|
|
8
|
stypeId
|
Number
|
Tuỳ chọn
|
Độ mật
|
Tham số đầu ra (Response)
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ liệu
|
Mô tả
|
|
1
|
result.mess.errorCode
|
Number
|
Mã kết quả. 200 = thành công
|
|
2
|
result.mess.message
|
String
|
Thông báo kết quả
|
|
3
|
result.data.totalRecord
|
Number
|
Tổng số bản ghi dựa theo filter hiện tại
|
|
4
|
result.data.totalPage
|
Number
|
Tổng số trang dựa theo filter và pageSize hiện tại
|
|
5
|
result.data.pageNo
|
Number
|
Số trang hiện tại
|
|
6
|
result.data.pageSize
|
Number
|
Số record trong 1 trang
|
|
7
|
result.data.returnCount
|
Number
|
Số record trả về trong lần gọi API này
|
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ
liệu
|
Mô tả
|
|
8
|
result.data.listResult
|
Array
|
Danh sách văn bản đi trả về
|
|
9
|
listResult[].documentId
|
Number
|
ID văn bản
|
|
10
|
listResult[].registerNumber
|
String
|
Số đăng ký
|
|
11
|
listResult[].officeSender
|
String
|
Đơn vị gửi
|
|
12
|
listResult[].code
|
String
|
Số, ký hiệu văn bản
|
|
13
|
listResult[].title
|
String
|
Trích yếu nội dung văn bản
|
|
14
|
listResult[].promulgateDate
|
String
|
Ngày ban hành
|
|
15
|
listResult[].deadlineDate
|
String
|
Hạn xử lý
|
|
16
|
listResult[].signer
|
String
|
Người ký
|
|
17
|
listResult[].priorityId
|
Number
|
ID độ khẩn
|
|
18
|
listResult[].priority
|
String
|
Tên độ khẩn
|
|
19
|
listResult[].typeId
|
Number
|
ID thể loại văn bản
|
|
20
|
listResult[].type
|
String
|
Tên thể loại văn bản
|
|
21
|
listResult[].stypeId
|
Number
|
ID độ mật
|
|
22
|
listResult[].stype
|
String
|
Tên độ mật
|
|
23
|
listResult[].statusNumber
|
Number
|
Trạng thái văn bản (2: đã xoá/huỷ ban hành)
|
|
24
|
listResult[].numberOfCopy
|
Number
|
Số bản
|
|
25
|
listResult[].creatorIdVof2
|
Number
|
ID văn thư ban hành
|
|
26
|
listResult[].creatorNameVof2
|
String
|
Tên văn thư cấp số ban hành
|
|
27
|
listResult[].creatorMobilePhoneVof2
|
String
|
Số điện thoại người ban hành
văn bản
|
|
28
|
listResult[].creatorEmailVof2
|
String
|
Email người ban hành văn bản
|
|
29
|
listResult[].toDate
|
String
|
Ngày đến (nếu có)
|
|
30
|
listResult[].builtGroupId
|
Number
|
ID đơn vị ban hành
|
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ
liệu
|
Mô tả
|
|
31
|
listResult[].builtGroupName
|
String
|
Tên đơn vị ban hành
|
|
32
|
listResult[].listAttachment
|
Array
|
Danh sách file ký chính và tài
liệu liên quan
|
|
33
|
listAttachment[].documentId
|
Number
|
ID văn bản
|
|
34
|
listAttachment[].filePath
|
String
|
Đường dẫn file
|
|
35
|
listAttachment[].fileName
|
String
|
Tên file
|
|
36
|
listAttachment[].fileAttachmentId
|
Number
|
ID file
|
|
37
|
listAttachment[].storage
|
String
|
Kho lưu trữ
|
|
38
|
listAttachment[].filePage
|
String
|
Số trang
|
|
39
|
listAttachment[].fileSize
|
String
|
Dung lượng file
|
|
40
|
listAttachment[].type
|
Number
|
Loại file: 1 - File ký chính; 3 -
Tài liệu liên quan
|
|
41
|
listResult[].listAttachTemplate
|
Array
|
Danh sách file biểu mẫu
|
|
42
|
listAttachTemplate[].documentId
|
Number
|
ID văn bản
|
|
43
|
listAttachTemplate[].fileAttachmentId
|
Number
|
ID file
|
|
44
|
listAttachTemplate[].fileName
|
String
|
Tên file
|
|
45
|
listAttachTemplate[].storage
|
String
|
Nơi lưu trữ
|
|
46
|
listAttachTemplate[].fileSize
|
String
|
Dung lượng file
|
API 5: Lấy văn bản đi theo đơn vị (get-document-by-org/out)
Module: VĂN BẢN ĐI
|
Method
|
POST
|
|
URL
|
{domain}/ServiceMobile_V02/resources/ext-doc/get-document-by-org/out
|
|
Content-
Type
|
application/json
|
|
Header
|
Authorization: Bearer
|
Mô tả: Lấy danh sách văn bản đi của một đơn vị trên hệ thống Điều hành tác nghiệp, dựa theo điều kiện lọc được cấu hình. Dữ liệu trả về gồm thông tin metadata của văn bản và danh sách file đính kèm (file ký chính, tài liệu liên quan, file biểu mẫu).
Tham số đầu vào (Request)
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ
liệu
|
Bắt
buộc
|
Mô tả
|
|
1
|
pageNo
|
Number
|
Bắt
buộc
|
Trang cần lấy
|
|
2
|
pageSize
|
Number
|
Bắt
buộc
|
Số record mỗi trang
|
|
3
|
filter
|
Object
|
Tuỳ chọn
|
Object chứa các thông tin tìm kiếm (tìm kiếm trong phạm vi dữ liệu được trả về)
|
|
4
|
promulgateDateFrom
|
String
|
Tuỳ chọn
|
Ngày ban hành phải >= ngày này
|
|
5
|
promulgateDateTo
|
String
|
Tuỳ chọn
|
Ngày ban hành phải <= ngày này
|
|
6
|
priorityId
|
Number
|
Tuỳ
chọn
|
Độ khẩn
|
|
7
|
typeId
|
Number
|
Tuỳ
chọn
|
Thể loại văn bản
|
|
8
|
stypeId
|
Number
|
Tuỳ chọn
|
Độ mật
|
Tham số đầu ra (Response)
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ liệu
|
Mô tả
|
|
1
|
result.mess.errorCode
|
Number
|
Mã kết quả. 200 = thành công
|
|
2
|
result.mess.message
|
String
|
Thông báo kết quả
|
|
3
|
result.data.totalRecord
|
Number
|
Tổng số bản ghi dựa theo filter hiện tại
|
|
4
|
result.data.totalPage
|
Number
|
Tổng số trang dựa theo filter và pageSize hiện tại
|
|
5
|
result.data.pageNo
|
Number
|
Số trang hiện tại
|
|
6
|
result.data.pageSize
|
Number
|
Số record trong 1 trang
|
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ liệu
|
Mô tả
|
|
7
|
result.data.returnCount
|
Number
|
Số record trả về trong lần gọi API này
|
|
8
|
result.data.listResult
|
Array
|
Danh sách văn bản đi trả về
|
|
9
|
listResult[].documentId
|
Number
|
ID văn bản
|
|
10
|
listResult[].registerNumber
|
String
|
Số đăng ký
|
|
11
|
listResult[].officeSender
|
String
|
Đơn vị gửi
|
|
12
|
listResult[].code
|
String
|
Số, ký hiệu văn bản
|
|
13
|
listResult[].title
|
String
|
Trích yếu nội dung văn bản
|
|
14
|
listResult[].promulgateDate
|
String
|
Ngày ban hành
|
|
15
|
listResult[].deadlineDate
|
String
|
Hạn xử lý
|
|
16
|
listResult[].signer
|
String
|
Người ký
|
|
17
|
listResult[].priorityId
|
Number
|
ID độ khẩn
|
|
18
|
listResult[].priority
|
String
|
Tên độ khẩn
|
|
19
|
listResult[].typeId
|
Number
|
ID thể loại văn bản
|
|
20
|
listResult[].type
|
String
|
Tên thể loại văn bản
|
|
21
|
listResult[].stypeId
|
Number
|
ID độ mật
|
|
22
|
listResult[].stype
|
String
|
Tên độ mật
|
|
23
|
listResult[].statusNumber
|
Number
|
Trạng thái văn bản (2: đã
xoá/huỷ ban hành)
|
|
24
|
listResult[].numberOfCopy
|
Number
|
Số bản
|
|
25
|
listResult[].creatorIdVof2
|
Number
|
ID văn thư ban hành
|
|
26
|
listResult[].creatorNameVof2
|
String
|
Tên văn thư cấp số ban hành
|
|
27
|
listResult[].creatorMobilePhoneVof2
|
String
|
Số điện thoại người ban hành văn bản
|
|
28
|
listResult[].creatorEmailVof2
|
String
|
Email người ban hành văn bản
|
|
29
|
listResult[].toDate
|
String
|
Ngày đến (nếu có)
|
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ liệu
|
Mô tả
|
|
30
|
listResult[].builtGroupId
|
Number
|
ID đơn vị ban hành
|
|
31
|
listResult[].builtGroupName
|
String
|
Tên đơn vị ban hành
|
|
32
|
listResult[].listAttachment
|
Array
|
Danh sách file ký chính và tài liệu liên quan
|
|
33
|
listAttachment[].documentId
|
Number
|
ID văn bản
|
|
34
|
listAttachment[].filePath
|
String
|
Đường dẫn file
|
|
35
|
listAttachment[].fileName
|
String
|
Tên file
|
|
36
|
listAttachment[].fileAttachmentId
|
Number
|
ID file
|
|
37
|
listAttachment[].storage
|
String
|
Kho lưu trữ
|
|
38
|
listAttachment[].filePage
|
String
|
Số trang
|
|
39
|
listAttachment[].fileSize
|
String
|
Dung lượng file
|
|
40
|
listAttachment[].type
|
Number
|
Loại file: 1 - File ký chính; 3 -
Tài liệu liên quan
|
|
41
|
listResult[].listAttachTemplate
|
Array
|
Danh sách file biểu mẫu
|
|
42
|
listAttachTemplate[].documentId
|
Number
|
ID văn bản
|
|
43
|
listAttachTemplate[].fileAttachmentId
|
Number
|
ID file
|
|
44
|
listAttachTemplate[].fileName
|
String
|
Tên file
|
|
45
|
listAttachTemplate[].storage
|
String
|
Nơi lưu trữ
|
|
46
|
listAttachTemplate[].fileSize
|
String
|
Dung lượng file
|
3. Module: VĂN BẢN ĐẾN
API 6: Lấy danh sách sổ văn bản theo đơn vị và loại văn bản
(getTextBooksByOrgIdAndDocType)
Module: VĂN BẢN ĐẾN
|
Method
|
POST
|
|
URL
|
{domain}/ServiceMobile_V02/resources/textBookAction/getTextBooksByOrgI dAndDocType
|
|
Content-
Type
|
application/x-www-form-urlencoded
|
|
Header
|
Authorization: Bearer
|
Mô tả: Lấy danh sách sổ văn bản (sổ đăng ký) theo đơn vị
Ghi chú: Body: isSecurity="0", data={json}
Tham số đầu vào (Request)
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ liệu
|
Bắt buộc
|
Mô tả
|
|
1
|
isSecurity
|
String
|
Bắt buộc
|
Cố định truyền "0"
|
|
2
|
data
|
String
|
Bắt
buộc
|
Chuỗi JSON chứa tham số lọc
|
|
3
|
data.typeId
|
Number
|
Bắt buộc
|
Loại văn bản. Ví dụ: 1 = văn bản đi
|
|
4
|
data.orgId
|
Number
|
Bắt buộc
|
ID đơn vị / tổ chức cần tra cứu sổ văn bản
|
Tham số đầu ra (Response)
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ liệu
|
Bắt buộc
|
Mô tả
|
|
1
|
result.mess.errorCode
|
Number
|
Mã kết quả. 200 = thành công
|
|
|
2
|
result.mess.message
|
String
|
Thông báo kết quả
|
|
|
3
|
result.data[]
|
Array
|
Danh sách sổ văn bản của đơn vị
|
|
|
4
|
data[].textBookId
|
Number
|
ID sổ văn bản
|
|
|
5
|
data[].textBookName
|
String
|
Tên sổ văn bản
|
|
|
6
|
data[].orgId
|
Number
|
ID đơn vị sở hữu sổ
|
|
|
7
|
data[].orgName
|
String
|
Tên đơn vị sở hữu sổ
|
|
|
8
|
data[].typeId
|
Number
|
Loại văn bản áp dụng cho sổ này
|
|
|
9
|
data[].currentRegisterNumber
|
Number
|
Số đăng ký hiện tại (số vào/ra cuối
cùng đã cấp)
|
|
|
10
|
data[].isActive
|
Number
|
1: sổ đang hoạt động; 0: đã đóng
|
API 7: Lấy danh sách văn bản đến qua SSO (get-document-by-sso/in)
Module: VĂN BẢN ĐẾN
|
Method
|
POST
|
|
URL
|
{domain}/ServiceMobile_V02/resources/ext-doc/get-document-by-sso/in
|
|
Content-Type
|
application/json
|
|
Header
|
Authorization: Bearer
|
Mô tả: Lấy danh sách văn bản đến của cá nhân. Hỗ trợ phân trang và lọc theo khoảng thời gian nhận văn bản. Body gửi dạng JSON (không dùng form-urlencoded).
Ghi chú: Body gửi trực tiếp dạng JSON. pageNo bắt đầu từ 1. Ngày tháng định dạng dd/MM/yyyy.
Tham số đầu vào (Request)
|
STT
|
Tên
thuộc
tính
|
Kiểu
dữ
liệu
|
Bắt buộc
|
Mô tả
|
|
1
|
pageNo
|
Number
|
Bắt buộc
|
Số trang (bắt đầu từ 1)
|
|
2
|
pageSize
|
Number
|
Bắt buộc
|
Số bản ghi trên mỗi trang
|
|
3
|
filter
|
Object
|
Tuỳ
chọn
|
Điều kiện lọc danh sách văn bản đến
|
|
4
|
filter.receiveDateFrom
|
String
|
Tuỳ
chọn
|
Ngày nhận từ (định dạng dd/MM/yyyy)
|
|
5
|
filter.receiveDateTo
|
String
|
Tuỳ
chọn
|
Ngày nhận đến (định dạng dd/MM/yyyy)
|
Tham số đầu ra (Response)
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ liệu
|
Mô tả
|
|
1
|
result.mess.errorCode
|
Number
|
Mã kết quả. 200 = thành công
|
|
2
|
result.mess.message
|
String
|
Thông báo kết quả
|
|
3
|
result.data
|
Object
|
Dữ liệu phân trang
|
|
4
|
result.data.totalRecord
|
Number
|
Tổng số bản ghi
|
|
5
|
result.data.pageNo
|
Number
|
Trang hiện tại
|
|
6
|
result.data.pageSize
|
Number
|
Số bản ghi mỗi trang
|
|
7
|
result.data.shareDocuments
|
Array
|
Danh sách văn bản đến
|
|
8
|
shareDocuments[].documentId
|
Number
|
ID văn bản đến
|
|
9
|
shareDocuments[].code
|
String
|
Số hiệu văn bản
|
|
10
|
shareDocuments[].title
|
String
|
Trích yếu nội dung văn bản
|
|
11
|
shareDocuments[].promulgateDate
|
String
|
Ngày ban hành văn bản
|
|
12
|
shareDocuments[].type
|
String
|
Thể loại văn bản
|
|
13
|
shareDocuments[].builtGroupId
|
Number
|
ID đơn vị ban hành
|
|
14
|
shareDocuments[].builtGroupName
|
String
|
Tên đơn vị ban hành
|
|
15
|
shareDocuments[].listAttachment
|
Array
|
Danh sách file ký chính và tài liệu liên quan
|
|
16
|
listAttachment[].documentId
|
Number
|
ID văn bản
|
|
17
|
listAttachment[].filePath
|
String
|
Đường dẫn file
|
|
18
|
listAttachment[].fileName
|
String
|
Tên file
|
|
19
|
listAttachment[].fileAttachmentId
|
Number
|
ID file
|
|
20
|
listAttachment[].storage
|
String
|
Kho lưu trữ
|
|
21
|
listAttachment[].filePage
|
String
|
Số trang
|
|
22
|
listAttachment[].fileSize
|
String
|
Dung lượng file
|
|
23
|
listAttachment[].type
|
Number
|
Loại file: 1 - File ký chính; 3 - Tài liệu liên quan
|
|
24
|
listResult[].listAttachTemplate
|
Array
|
Danh sách file biểu mẫu
|
|
25
|
listAttachTemplate[].documentId
|
Number
|
ID văn bản
|
|
26
|
listAttachTemplate[].fileAttachmentId
|
Number
|
ID file
|
|
27
|
listAttachTemplate[].fileName
|
String
|
Tên file
|
|
28
|
listAttachTemplate[].storage
|
String
|
Nơi lưu trữ
|
|
29
|
listAttachTemplate[].fileSize
|
String
|
Dung lượng file
|
API 8: Lấy danh sách văn bản đến theo đơn vị (get-document-by-org/in) Module: VĂN BẢN ĐẾN
|
Method
|
POST
|
|
URL
|
{domain}/ServiceMobile_V02/resources/ext-doc/get-document-by-org/in
|
|
Content-Type
|
application/json
|
|
Header
|
Authorization: Bearer
|
Mô tả: Lấy danh sách văn bản đến của đơn vị.
Ghi chú: Body gửi trực tiếp dạng JSON. pageNo bắt đầu từ 1. Ngày tháng định dạng dd/MM/yyyy.
Tham số đầu vào (Request)
|
STT
|
Tên
thuộc
tính
|
Kiểu
dữ
liệu
|
Bắt buộc
|
Mô tả
|
|
1
|
pageNo
|
Number
|
Bắt buộc
|
Số trang (bắt đầu từ 1)
|
|
2
|
pageSize
|
Number
|
Bắt buộc
|
Số bản ghi trên mỗi trang
|
|
3
|
filter
|
Object
|
Tuỳ
chọn
|
Điều kiện lọc danh sách văn bản đến
|
|
4
|
filter.receiveDateFrom
|
String
|
Tuỳ
chọn
|
Ngày nhận từ (định dạng dd/MM/yyyy)
|
|
5
|
filter.receiveDateTo
|
String
|
Tuỳ
chọn
|
Ngày nhận đến (định dạng dd/MM/yyyy)
|
Tham số đầu ra (Response)
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ
liệu
|
Mô tả
|
|
1
|
result.mess.errorCode
|
Number
|
Mã kết quả. 200 = thành công
|
|
2
|
result.mess.message
|
String
|
Thông báo kết quả
|
|
3
|
result.data
|
Object
|
Dữ liệu phân trang
|
|
4
|
result.data.totalRecord
|
Number
|
Tổng số bản ghi
|
|
5
|
result.data.pageNo
|
Number
|
Trang hiện tại
|
|
6
|
result.data.pageSize
|
Number
|
Số bản ghi mỗi trang
|
|
7
|
result.data.shareDocuments
|
Array
|
Danh sách văn bản đến
|
|
8
|
shareDocuments[].documentId
|
Number
|
ID văn bản đến
|
|
9
|
shareDocuments[].code
|
String
|
Số hiệu văn bản
|
|
10
|
shareDocuments[].title
|
String
|
Trích yếu nội dung văn bản
|
|
11
|
shareDocuments[].promulgateDate
|
String
|
Ngày ban hành văn bản
|
|
12
|
shareDocuments[].type
|
String
|
Thể loại văn bản
|
|
13
|
shareDocuments[].builtGroupId
|
Number
|
ID đơn vị ban hành
|
|
14
|
shareDocuments[].builtGroupName
|
String
|
Tên đơn vị ban hành
|
|
15
|
shareDocuments[].listAttachment
|
Array
|
Danh sách file ký chính và tài liệu liên quan
|
|
16
|
listAttachment[].documentId
|
Number
|
ID văn bản
|
|
17
|
listAttachment[].filePath
|
String
|
Đường dẫn file
|
|
18
|
listAttachment[].fileName
|
String
|
Tên file
|
|
19
|
listAttachment[].fileAttachmentId
|
Number
|
ID file
|
|
20
|
listAttachment[].storage
|
String
|
Kho lưu trữ
|
|
21
|
listAttachment[].filePage
|
String
|
Số trang
|
|
22
|
listAttachment[].fileSize
|
String
|
Dung lượng file
|
|
23
|
listAttachment[].type
|
Number
|
Loại file: 1 - File ký chính; 3 -
Tài liệu liên quan
|
|
24
|
listResult[].listAttachTemplate
|
Array
|
Danh sách file biểu mẫu
|
|
25
|
listAttachTemplate[].documentId
|
Number
|
ID văn bản
|
|
26
|
listAttachTemplate[].fileAttachmentId
|
Number
|
ID file
|
|
27
|
listAttachTemplate[].fileName
|
String
|
Tên file
|
|
28
|
listAttachTemplate[].storage
|
String
|
Nơi lưu trữ
|
|
29
|
listAttachTemplate[].fileSize
|
String
|
Dung lượng file
|
API 9: Lấy danh sách đơn vị đã gửi (getListGroup)
Module: VĂN BẢN ĐẾN
|
Method
|
POST
|
|
URL
|
{domain}/ServiceMobile_V02/resources/DocumentAction/getListGroup
|
|
Content-Type
|
application/x-www-form-urlencoded
|
|
Header
|
Authorization: Bearer
|
Mô tả: Lấy danh sách nhóm đơn vị liên quan đến một văn bản đến. Sử dụng trước khi thực hiện gửi/chuyển xử lý để lấy danh sách nhóm hợp lệ có thể nhận văn bản.
Ghi chú: Body: isSecurity (cố định "0") và data (JSON string). isGetAll="1" để lấy toàn bộ nhóm.
Tham số đầu vào (Request)
|
STT
|
Tên
thuộc
tính
|
Kiểu
dữ
liệu
|
Bắt buộc
|
Mô tả
|
|
1
|
isSecurity
|
String
|
Bắt buộc
|
Cố định truyền "0"
|
|
2
|
data
|
String
|
Bắt buộc
|
Chuỗi JSON chứa tham số lọc
|
|
3
|
data.documentId
|
String
|
Bắt buộc
|
ID văn bản đến cần lấy danh sách nhóm
|
|
4
|
data.isGetAll
|
String
|
Tuỳ chọn
|
"1": lấy tất cả nhóm; "0": chỉ lấy nhóm liên quan
|
Tham số đầu ra (Response)
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ liệu
|
Bắt buộc
|
Mô tả
|
|
1
|
result.mess.errorCode
|
Number
|
Mã kết quả. 200 = thành công
|
|
|
2
|
result.mess.message
|
String
|
Thông báo kết quả
|
|
|
3
|
result.data
|
Array
|
Danh sách nhóm văn bản đến
|
|
|
4
|
result.data[].groupId
|
Number
|
ID nhóm
|
|
|
5
|
result.data[].groupName
|
String
|
Tên nhóm
|
|
|
6
|
result.data[].orgId
|
Number
|
ID tổ chức sở hữu nhóm
|
|
|
7
|
result.data[].documentInGroupId
|
Number
|
ID bản ghi văn bản trong nhóm
|
4. Module: PHIẾU TRÌNH API 10: Danh sách phiếu trình Module: PHIẾU TRÌNH
|
Method
|
GET
|
|
URL
|
{domain}/ServiceMobile_V02/resources/api/submission-manager/submission- form/get-list
|
|
Content-
Type
|
application/x-www-form-urlencoded
|
|
Header
|
Authorization: Bearer
|
Mô tả: Lấy danh sách phiếu trình
Tham số đầu vào (Request)
|
STT
|
Tên thuộc tính
|
Kiểu dữ
liệu
|
Bắt
buộc
|
Mô tả
|
|
1
|
sendDateFrom
|
String
|
Bắt
buộc
|
Thời gian bắt đầu tìm kiếm phiếu trình.
Định dạng dd/MM/yyyy HH: mm: ss
|
|
2
|
sendDateTo
|
String
|
Bắt
buộc
|
Thời gian kết thúc tìm kiếm phiếu trình.
Định dạng dd/MM/yyyy HH: mm: ss
|
|
3
|
size
|
Number
|
Bắt
buộc
|
Số lượng bản ghi trên mỗi trang
|
|
4
|
page
|
Number
|
Bắt
buộc
|
Số trang cần lấy dữ liệu. Giá trị bắt đầu từ 0
|
|
5
|
searchType
|
Number
|
Bắt
buộc
|
Loại tìm kiếm phiếu trình
|
|
6
|
title
|
String
|
Từ khoá tìm kiếm theo tiêu đề phiếu trình
|
Tham số đầu ra (Response)
|
STT
1
|
Tên
thuộc
tính
|
Kiểu dữ
liệu
|
Bắt
buộc
|
Mô tả
|
|
STT
1
|
submissionFormId
|
String
|
Bắt
buộc
|
Mã định danh phiếu trình
|
|
2
|
title
|
String
|
Bắt
buộc
|
Tiêu đề phiếu trình
|
|
3
|
officeSender
|
String
|
Bắt
buộc
|
Đơn vị/cơ quan trình
|
|
4
|
signerId
|
Number
|
Bắt buộc
|
Mã người ký chính
|
|
5
|
signerName
|
String
|
Bắt buộc
|
Họ tên người ký chính
|
|
6
|
orgId
|
Number
|
Bắt
buộc
|
Mã đơn vị của người ký
|
|
7
|
submitAddress
|
String
|
Địa điểm trình
|
|
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ
liệu
|
Bắt
buộc
|
Mô tả
|
|
8
|
submitDate
|
String
|
Bắt
buộc
|
Thời gian trình phiếu
|
|
9
|
stypeId
|
Number
|
Bắt
buộc
|
Độ mật phiếu trình
|
|
10
|
securityName
|
String
|
Tên mức độ mật
|
|
|
11
|
descriptionFile
|
String
|
Tài liệu kèm theo hoặc mô tả tài liệu
|
|
|
12
|
opinionInternalOrg
|
String
|
Ý kiến của các cơ quan, đơn vị liên quan
|
|
|
13
|
opinionSubmiter
|
String
|
Ý kiến của người trình
|
|
|
14
|
status
|
Number
|
Bắt buộc
|
Trạng thái xử lý phiếu trình
|
|
15
|
createdDate
|
String
|
Bắt
buộc
|
Ngày tạo phiếu trình
|
|
16
|
createdBy
|
Number
|
Bắt buộc
|
Mã người tạo phiếu trình
|
|
17
|
createdOrgPathName
|
String
|
Tên đầy đủ đơn vị tạo phiếu trình
|
|
|
18
|
createdByName
|
String
|
Họ tên người tạo phiếu trình
|
|
|
19
|
parentId
|
String
|
Mã phiếu trình liên quan (nếu là phiếu trình liên kết)
|
|
|
20
|
lastUserSignerName
|
String
|
Họ tên người ký hoặc người xử lý cuối cùng
|
|
|
21
|
lastUserPosition
|
String
|
Chức vụ của người ký hoặc người xử lý cuối cùng
|
|
|
22
|
currentUserDisplay
|
String
|
Danh sách người đang xử lý phiếu trình
|
|
|
23
|
currentUserIds
|
String
|
Danh sách ID người đang xử lý phiếu trình
|
5. Module: Nhiệm vụ
API 11: Xem chi tiết nhiệm vụ (getMissionDetail)
Module: NHIỆM VỤ
|
Method
|
POST
|
|
URL
|
{domain}/ServiceMobile_V02/resources/missionAction/getMissionDetail
|
|
Content-
Type
|
application/x-www-form-urlencoded
|
|
Header
|
Authorization: Bearer
|
Mô tả: Lấy toàn bộ thông tin chi tiết của một nhiệm vụ.
Ghi chú: Body: isSecurity="0", data={json}
Tham số đầu vào (Request)
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ liệu
|
Bắt
buộc
|
Mô tả
|
|
1
|
isSecurity
|
String
|
Bắt buộc
|
Cố định truyền "0"
|
|
2
|
data
|
String
|
Bắt buộc
|
Chuỗi JSON chứa tham số truy vấn chi tiết nhiệm vụ
|
|
3
|
data.missionId
|
Number
|
Bắt buộc
|
ID nhiệm vụ cần xem chi tiết
|
|
4
|
data.isWeb
|
String
|
Tuỳ
chọn
|
"1": gọi từ web; để trống nếu gọi từ mobile
|
|
5
|
data.language
|
String
|
Tuỳ
chọn
|
Ngôn ngữ hiển thị. "vi": tiếng Việt; "en": tiếng Anh
|
Tham số đầu ra (Response)
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ liệu
|
Bắt
buộc
|
Mô tả
|
|
1
|
result.mess.errorCode
|
Number
|
Mã kết quả. 200 = thành công
|
|
|
2
|
result.mess.message
|
String
|
Thông báo kết quả
|
|
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ
liệu
|
Bắt
buộc
|
Mô tả
|
|
3
|
result.data.missionId
|
Number
|
ID nhiệm vụ
|
|
|
4
|
result.data.missionName
|
String
|
Tên nhiệm vụ
|
|
|
5
|
result.data.missionPath
|
String
|
Đường dẫn phân cấp nhiệm vụ. Ví dụ: /1001899/
|
|
|
6
|
result.data.content
|
String
|
Nội dung / yêu cầu nhiệm vụ
|
|
|
7
|
result.data.target
|
String
|
Mục tiêu cần đạt được
|
|
|
8
|
result.data.dateStart
|
String
|
Ngày bắt đầu. Định dạng: dd/MM/yyyy HH: mm: ss
|
|
|
9
|
result.data.dateComplete
|
String
|
Ngày hoàn thành dự kiến. Định dạng: dd/MM/yyyy HH: mm: ss
|
|
|
10
|
result.data.weight
|
Number
|
Trọng số nhiệm vụ
|
|
|
11
|
result.data.orgAssignId
|
Number
|
ID đơn vị giao nhiệm vụ
|
|
|
12
|
result.data.orgAssignName
|
String
|
Tên đơn vị giao nhiệm vụ
|
|
|
13
|
result.data.assignId
|
Number
|
ID người giao nhiệm vụ
|
|
|
14
|
result.data.assignName
|
String
|
Họ tên người giao
|
|
|
15
|
result.data.assignMobilePhone
|
String
|
Số điện thoại người giao
|
|
|
16
|
result.data.assignCode
|
String
|
Mã đăng nhập người giao
|
|
|
17
|
result.data.assignPosition
|
String
|
Chức vụ người giao
|
|
|
18
|
result.data.orgPerformId
|
Number
|
ID đơn vị thực hiện
|
|
|
19
|
result.data.orgPerformName
|
String
|
Tên đơn vị thực hiện
|
|
|
20
|
result.data.frequenceUpdate
|
Number
|
Tần suất cập nhật tiến độ. 2: hàng tuần
|
|
|
21
|
result.data.frequenceUpdateName
|
String
|
Tên tần suất cập nhật (key i18n)
|
|
|
22
|
result.data.fieldId
|
Number
|
ID lĩnh vực nhiệm vụ
|
|
|
23
|
result.data.fieldName
|
String
|
Tên lĩnh vực nhiệm vụ
|
|
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ
liệu
|
Bắt
buộc
|
Mô tả
|
|
24
|
result.data.status
|
Number
|
Trạng thái nhiệm vụ. 1: Chờ
phê duyệt; 2: Đang thực hiện; 3: Từ chối; 4: Hoàn thành
|
|
|
25
|
result.data.statusName
|
String
|
Tên trạng thái
|
|
|
26
|
result.data.createdDate
|
String
|
Ngày tạo nhiệm vụ
|
|
|
27
|
result.data.createdByName
|
String
|
Tên người tạo
|
|
|
28
|
result.data.missionClass
|
Number
|
Loại nhiệm vụ
|
|
|
29
|
result.data.missionGroup
|
Number
|
Nhóm nhiệm vụ
|
|
|
30
|
result.data.isPublic
|
Number
|
1: công khai; 0: nội bộ
|
|
|
31
|
result.data.levelImportance
|
Number
|
Mức độ quan trọng
|
|
|
32
|
result.data.isDocReport
|
Number
|
1: báo cáo bằng văn bản; 0: không
|
|
|
33
|
result.data.isExtendDeadline
|
Number
|
1: đã gia hạn; 0: chưa gia hạn
|
|
|
34
|
result.data.deadlineStatus
|
Number
|
Trạng thái hạn. 1: Đúng hạn; 2:
Sắp hết hạn; 3: Quá hạn; 4: Chưa đến hạn
|
|
|
35
|
result.data.overDate
|
Number
|
Số ngày quá hạn (nếu có). Âm = còn hạn
|
|
|
36
|
result.data.color
|
String
|
Mã màu hiển thị trạng thái hạn. Ví dụ: #EE0033
|
|
|
37
|
result.data.listSource[]
|
Array
|
Danh sách tài liệu nguồn liên kết với nhiệm vụ
|
|
|
38
|
result.data.listDocumentRef[]
|
Array
|
Danh sách văn bản tham chiếu liên kết
|
|
|
39
|
result.data.count
|
Number
|
Số nhiệm vụ con (sub-mission)
|
|
|
40
|
result.data.permissionOfAssignOr g
|
Object
|
Quyền của đơn vị giao: created, deliver, guide, edit, delete,
|
|
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ
liệu
|
Mô tả
|
|
|
Bắt
buộc
|
transfer, checked,
addComplementInformation,
close
|
|||
|
41
|
result.data.permissionOfPerform Org
|
Object
|
Quyền của đơn vị thực hiện:
create, reject, approve, update, addPerformUser, edit, delete, createSubMission
|
|
|
42
|
result.data.permissionOfCombinat ionOrg
|
Object
|
Quyền của đơn vị phối hợp: update
|
|
|
43
|
result.data.orgCombinationIds
|
String
|
Chuỗi ID các đơn vị phối hợp, phân cách bằng dấu phẩy
|
|
|
44
|
result.data.isTransferOrgPerform
|
Number
|
1: đã chuyển đơn vị thực hiện; 0: chưa
|
|
|
45
|
result.data.delFlag
|
Number
|
0: đang hoạt động; 1: đã xoá
|
|
|
46
|
result.data.orgType
|
Number
|
Loại tổ chức của đơn vị thực hiện
|
6. Module: HỒ SƠ
API 12: Lấy danh sách hồ sơ (get-brief-by-sso)
Module: HỒ SƠ
|
Method
|
POST
|
|
URL
|
{domain}/ServiceMobile_V02/resources/ext-brief/get-brief-by-sso
|
|
Content-
Type
|
application/json
|
Mô tả: Lấy danh sách hồ sơ theo account đang đăng nhập (SSO).
Ghi
chú:
Header
yêu cầu Authorization: Bearer
API forward token (get token của user SSO).
Tham số đầu vào (Request)
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ
liệu
|
Bắt
buộc
|
Mô tả
|
|
1
|
pageNo
|
Number
|
true
|
Số trang cần lấy. Trang bắt đầu từ 1
|
|
2
|
pageSize
|
Number
|
true
|
Số record mỗi trang. Max = 100, default=10
|
|
3
|
filter
|
false
|
Object chứa các thông tin tìm kiếm
|
|
|
4
|
filter.yearNumberOfCatalogFrom
|
Number
|
Năm thư mục hồ sơ từ. Tìm kiếm theo năm không được quá 2 năm. yearNumberOfCatalogFrom <= yearNumberOfCatalogTo
|
|
|
5
|
filter.yearNumberOfCatalogTo
|
Number
|
Năm thư mục hồ sơ đến
|
|
|
6
|
filter.briefStatus
|
Number
|
Trạng thái hồ sơ: 1 - Đang thực
hiện, 2 - Đã đóng. Hồ sơ đã đóng không được phép cập nhật
|
|
|
7
|
filter.createdFrom
|
Date
|
Thời gian tạo từ. Không vượt quá
30 ngày so với createdTo. Mặc định 30 ngày gần nhất. Format: dd/MM/yyyy
|
|
|
8
|
filter.createdTo
|
Date
|
Thời gian tạo đến
|
|
|
9
|
filter.code
|
String
|
Mã hồ sơ
|
|
|
10
|
filter.name
|
String
|
Tên hồ sơ
|
|
|
11
|
filter.orgId
|
Number
|
ID Đơn vị trên điều hành tác nghiệp (hồ sơ thuộc đơn vị)
|
Tham số đầu ra (Response)
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ liệu
|
Bắt buộc
|
Mô tả
|
|
1
|
result.mess.errorCode
|
Number
|
Mã kết quả. 200 = thành công
|
|
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ liệu
|
Bắt buộc
|
Mô tả
|
|
2
|
result.mess.message
|
String
|
Thông báo kết quả
|
|
|
3
|
result.data
|
Object
|
Dữ liệu trả về
|
|
|
4
|
result.data.pageCount
|
Number
|
Tổng số trang
|
|
|
5
|
result.data.totalCount
|
Number
|
Tổng số bản ghi
|
|
|
6
|
result.data.pageSize
|
Number
|
Số bản ghi mỗi trang
|
|
|
7
|
result.data.listResult
|
Array
|
Danh sách hồ sơ
|
|
|
8
|
listResult[].briefId
|
Number
|
ID hồ sơ
|
|
|
9
|
listResult[].name
|
String
|
Tên hồ sơ
|
|
|
10
|
listResult[].registerNumber
|
String
|
Số hồ sơ
|
|
|
11
|
listResult[].code
|
String
|
Mã hồ sơ
|
|
|
12
|
listResult[].orgId
|
Number
|
ID đơn vị quản lý hồ sơ
|
|
|
13
|
listResult[].orgName
|
String
|
Tên đơn vị
|
|
|
14
|
listResult[].stype
|
Number
|
Độ mật: 1 - Thường
|
|
|
15
|
listResult[].createDateStr
|
String
|
Ngày tạo hồ sơ (dd/MM/yyyy)
|
|
|
16
|
listResult[].status
|
Number
|
Trạng thái hồ sơ
|
|
|
17
|
listResult[].numPaper
|
Number
|
Tổng số trang
|
|
|
18
|
listResult[].briefStatus
|
Number
|
Trạng thái: 1 - Đang thực hiện, 2 - Đã đóng
|
|
|
19
|
listResult[].totalDoc
|
Number
|
Tổng số tài liệu trong hồ sơ
|
7. Module: LỊCH HỌP
API 13: Lấy danh sách lịch họp theo tuần
Module: LỊCH HỌP
|
Method
|
POST
|
|
URL
|
{domain}/ServiceMobile_V02/resources/MeetingWeek/getLstMeetingWeek
|
|
Content-Type
|
application/x-www-form-urlencoded
|
|
Header
|
Authorization: Bearer
|
Mô tả: Lấy lịch họp cá nhân, lịch lãnh đạo hoặc lịch tuần cơ quan của người dùng SSO đã xác thực.
Tham số đầu vào (Request)
|
STT
|
Tên
thuộc
tính
|
Kiểu
dữ
liệu
|
Bắt buộc
|
Mô tả
|
|
1
|
data
|
String (JSON)
|
Bắt buộc
|
Chuỗi JSON chứa các điều
kiện tìm kiếm lịch họp.
|
|
2 startTimeFrom String Bắt buộc Ngày bắt đầu khoảng thời gian cần lấy lịch họp. Định dạng dd/MM/yyyy. Hệ thống chỉ trả về các lịch có thời gian từ ngày này trở đi.
|
2 startTimeFrom String Bắt buộc Ngày bắt đầu khoảng thời gian cần lấy lịch họp. Định dạng dd/MM/yyyy. Hệ thống chỉ trả về các lịch có thời gian từ ngày này trở đi.
|
|||
|
3
|
startTimeTo
|
String
|
Bắt buộc
|
Ngày kết thúc khoảng thời gian cần lấy lịch họp. Định dạng dd/MM/yyyy. Hệ thống chỉ trả về các lịch có thời gian đến hết ngày này.
|
|
4
|
orgSelect
|
Number
|
Bắt buộc
|
ID của đơn vị cần tra cứu lịch họp. Hệ thống chỉ lấy các lịch thuộc đơn vị được chỉ định.
|
|
5
|
type
|
String
|
Bắt buộc
|
Loại lịch cần lấy. Giá trị hỗ trợ: 2 - Lịch cá nhân; 3 - Lịch lãnh đạo; 6 - Lịch tuần cơ
quan.
|
Tham số đầu ra (Response)
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ
liệu
|
Bắt
buộc
|
Mô tả
|
|
1
|
result.total
|
Number
|
Tổng số cuộc họp
|
|
|
2
|
result.data[]
|
Array
|
Danh sách cuộc họp
|
|
|
3
|
data[].meetingId
|
Number
|
Mã định danh cuộc họp
|
|
|
4
|
data[].title
|
String
|
Tiêu đề cuộc họp
|
|
|
5
|
data[].content
|
String
|
Nội dung cuộc họp
|
|
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ
liệu
|
Bắt
buộc
|
Mô tả
|
|
6
|
data[].startTime
|
String
|
Thời gian bắt đầu. Định dạng
dd/MM/yyyy HH: mm: ss
|
|
|
7
|
data[].endTime
|
String
|
Thời gian kết thúc. Định dạng dd/MM/yyyy HH: mm: ss
|
|
|
8
|
data[].roomName
|
String
|
Tên phòng họp
|
|
|
9
|
data[].chairman
|
String
|
Người chủ trì cuộc họp
|
|
|
10
|
data[].orgName
|
String
|
Đơn vị tổ chức cuộc họp
|
|
|
11
|
data[].meetingType
|
String
|
Loại lịch họp
|
|
|
12
|
data[].status
|
Number
|
Trạng thái cuộc họp. 1=Đã xác nhận
|
8. Module: BÁO CÁO TỔNG HỢP
API 14: Báo cáo thống kê KPI (get-kpi-statistic)
|
Method
|
POST
|
|
URL
|
{domain}/ServiceMobile_V02/resources/api/kpi/get-kpi-statistic
|
|
Content-
Type
|
application/x-www-form-urlencoded
|
|
Header
|
Authorization: Bearer
|
Tham số đầu vào (Request)
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ
liệu
|
Bắt
buộc
|
Mô tả
|
|
1
|
page
|
Number
|
Bắt buộc
|
Trang hiện tại của danh sách thống kê (bắt đầu từ 0)
|
|
2
|
pageChart
|
Number
|
Tuỳ chọn
|
Trang dữ liệu cho phần biểu đồ cột (dataBarChart.content), bắt đầu từ 0
|
|
3
|
size
|
Number
|
Bắt buộc
|
Số bản ghi mỗi trang
|
|
4
|
dataScopeDocument
|
Number
|
Tuỳ chọn
|
Phạm vi dữ liệu thống kê văn bản (theo cấu hình hệ thống)
|
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ
liệu
|
Bắt
buộc
|
Mô tả
|
|
5
|
dataScopeText
|
Number
|
Tuỳ chọn
|
Phạm vi dữ liệu thống kê công văn/văn bản dạng text
|
|
6
|
dataScopeSubmission
|
Number
|
Tuỳ
chọn
|
Phạm vi dữ liệu thống kê trình ký
|
|
7
|
dataScopeBrief
|
Number
|
Tuỳ chọn
|
Phạm vi dữ liệu thống kê tờ trình/báo cáo tóm tắt
|
|
8
|
vhrEmployeeIds
|
String/Array
|
Tuỳ chọn
|
Danh sách ID nhân sự cần lọc thống kê
|
|
9
|
fromDate
|
String
|
Bắt buộc
|
Ngày bắt đầu khoảng thống kê. Format: dd/MM/yyyy HH: mm: ss
|
|
10
|
toDate
|
String
|
Bắt buộc
|
Ngày kết thúc khoảng thống kê.
|
Tham số đầu ra (Response)
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ
liệu
|
Mô tả
|
|
1
|
result.mess.errorCode
|
Number
|
Mã kết quả. 200 = thành công
|
|
2
|
result.mess.message
|
String
|
Thông báo kết quả
|
|
3
|
result.data
|
Array
|
Danh sách thống kê theo từng loại đối tượng (Văn bản đến, Văn bản đi...)
|
|
4
|
data[].objectType
|
Number
|
Loại đối tượng thống kê: 0 - Văn bản đến; 1 - Văn bản đi
|
|
5
|
data[].objectName
|
String
|
Tên loại đối tượng (VD: "Văn bản đến", "Văn bản đi")
|
|
6
|
data[].countAll
|
Number
|
Tổng số văn bản trong khoảng thời gian thống kê
|
|
7
|
data[].countProcessingOnTime
|
Number
|
Số văn bản đang xử lý còn đúng hạn
|
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ
liệu
|
Mô tả
|
|
8
|
data[].countProcessingOverTime
|
Number
|
Số văn bản đang xử lý đã quá hạn
|
|
9
|
data[].countFinishOnTime
|
Number
|
Số văn bản đã hoàn thành đúng hạn
|
|
10
|
data[].countFinishOverTime
|
Number
|
Số văn bản đã hoàn thành nhưng quá hạn
|
|
11
|
data[].dataBarChart
|
Object
|
Dữ liệu biểu đồ cột thống kê theo đơn vị
|
|
12
|
dataBarChart.content
|
Array
|
Danh sách số liệu thống kê theo từng đơn vị
|
|
13
|
content[].vhrOrgId
|
Number
|
ID đơn vị
|
|
14
|
content[].orgName
|
String
|
Tên đơn vị
|
|
15
|
content[].objectType
|
Number
|
Loại đối tượng (giống data[].objectType)
|
|
16
|
content[].countAll
|
Number
|
Tổng số văn bản của đơn vị này
|
|
17
|
content[].countProcessingOnTime
|
Number
|
Số đang xử lý đúng hạn của đơn vị này
|
|
18
|
content[].countProcessingOverTime
|
Number
|
Số đang xử lý quá hạn của đơn vị này
|
|
19
|
content[].countFinishOnTime
|
Number
|
Số đã hoàn thành đúng hạn của đơn vị này
|
|
20
|
content[].countFinishOverTime
|
Number
|
Số đã hoàn thành quá hạn của đơn vị này
|
|
21
|
dataBarChart.pageable
|
Object
|
Thông tin phân trang chuẩn Spring (pageNumber, pageSize, sort, offset, paged, unpaged)
|
|
22
|
dataBarChart.last
|
Boolean
|
true: đây là trang cuối cùng của dữ liệu biểu đồ
|
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ liệu
|
Mô tả
|
|
23
|
dataBarChart.totalElements
|
Number
|
Tổng số đơn vị có dữ liệu thống kê
|
9. Module: DANH MỤC DÙNG CHUNG
API 15: Lấy danh mục dùng chung (Thể loại, Độ khẩn, Độ mật)
|
Method
|
POST
|
|
URL
|
{domain}/ServiceMobile_V02/resources/DocumentService/getListFieldsByAr ea
|
|
Content-
Type
|
application/x-www-form-urlencoded
|
|
Header
|
Authorization: Bearer
|
Mô tả: Lấy danh sách các danh mục dữ liệu dùng chung (thể loại văn bản, độ mật, độ khẩn) Ghi chú: Body gồm isSecurity (cố định "0") và data (chuỗi JSON chứa tham số lọc). Tham số đầu vào (Request)
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ liệu
|
Bắt
buộc
|
Mô tả
|
|
1
|
isSecurity
|
String
|
Bắt buộc
|
Cố định truyền "0"
|
|
2
|
data
|
String
|
Bắt
buộc
|
Chuỗi JSON chứa tham số lọc
|
|
3
|
data.areaId
|
Number
|
Bắt buộc
|
ID khu vực/đơn vị cần lấy danh mục.
Truyền -1 để lấy theo phạm vi đơn vị hiện tại/toàn bộ
|
|
4
|
data.type
|
Number
|
type = 0: Lấy tất cả các danh mục
type = 1: Chỉ lấy danh sách Thể loại văn bản
type = 2: Chỉ lấy danh sách Độ mật type = 4: Chỉ lấy danh sách Độ khẩn
|
Tham số đầu ra (Response)
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ
liệu
|
Bắt buộc
|
Mô tả
|
|
1
|
result.mess.errorCode
|
Number
|
Mã kết quả. 200 = thành công
|
|
|
2
|
result.mess.message
|
String
|
Thông báo kết quả
|
|
|
3
|
result.data
|
Object
|
Dữ liệu danh mục trả về
|
|
|
4
|
result.data.listForm
|
Array
|
Danh sách thể loại văn bản
|
|
|
5
|
result.data.listForm[].id
|
Number
|
ID thể loại văn bản
|
|
|
6
|
result.data.listForm[].title
|
String
|
Tên thể loại văn bản
|
|
|
7
|
result.data.listForm[].abbreviate
|
String
|
Ký hiệu/tên viết tắt thể loại văn bản
|
|
|
8
|
result.data.listForm[].type
|
Number
|
Phân loại nhóm thể loại (0: thể loại chung, 1: thể loại theo đơn vị/khác)
|
|
|
9
|
result.data.listSecurity
|
Array
|
Danh sách độ mật
|
|
|
10
|
result.data.listSecurity[].id
|
Number
|
ID độ mật
|
|
|
11
|
result.data.listSecurity[].title
|
String
|
Tên độ mật (Thường,
Mật, Tối mật, Tuyệt mật)
|
|
|
12
|
result.data.listUrgency
|
Array
|
Danh sách độ khẩn
|
|
|
13
|
result.data.listUrgency[].id
|
Number
|
ID độ khẩn
|
|
|
14
|
result.data.listUrgency[].title
|
String
|
Tên độ khẩn
|
|
|
15
|
result.data.listPublicForm
|
Array
|
Danh sách thể loại văn
bản công khai (dùng chung toàn hệ thống)
|
|
|
16
|
result.data.listPublicForm[].id
|
Number
|
ID thể loại văn bản công khai
|
|
|
17
|
result.data.listPublicForm[].title
|
String
|
Tên thể loại văn bản công khai
|
|
|
18
|
result.data.listPublicForm[].abbreviate
|
String
|
Ký hiệu/tên viết tắt thể loại văn bản công khai
|
|
|
19
|
result.data.listPublicForm[].type
|
Number
|
Phân loại nhóm thể loại công khai
|
API 16: Lấy danh sách đơn vị dạng cây (getTreeDepartSign)
|
Method
|
POST
|
|
URL
|
{domain}/ServiceMobile_V02/resources/DocumentService/getTreeDepartS ign
|
|
Content-
Type
|
application/x-www-form-urlencoded
|
|
Header
|
Authorization: Bearer
|
Mô tả: Lấy danh sách đơn vị (cơ quan/tổ chức) theo dạng cây phân cấp (cha-con), bắt đầu từ một đơn vị gốc (path) được truyền vào.
Ghi chú: Body gồm isSecurity (cố định "0") và data (chuỗi JSON chứa tham số lọc). Tham số đầu vào (Request)
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ liệu
|
Bắt
buộc
|
Mô tả
|
|
1
|
isSecurity
|
String
|
Bắt buộc
|
Cố định truyền "0"
|
|
2
|
data
|
String
|
Bắt
buộc
|
Chuỗi JSON chứa tham số lọc
|
|
3
|
data.path
|
String
|
Bắt
buộc
|
ID đơn vị gốc cần lấy cây con (ví dụ: "3218")
|
|
4
|
data.type
|
Number
|
Tuỳ chọn
|
Loại cây/phạm vi lấy dữ liệu (theo cấu hình hệ thống)
|
Tham số đầu ra (Response)
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ
liệu
|
Mô tả
|
|
1
|
result.mess.errorCode
|
Number
|
Mã kết quả. 200 = thành công
|
|
2
|
result.mess.message
|
String
|
Thông báo kết quả
|
|
3
|
result.data
|
Array
|
Danh sách đơn vị (dạng phẳng, biểu diễn cấu trúc cây qua path/orgParentId/orgLevel)
|
|
4
|
data[].path
|
String
|
Đường dẫn vị trí đơn vị trong cây (gồm các orgId cha, phân tách bằng /)
|
|
5
|
data[].orgParentId
|
Number
|
ID đơn vị cha trực tiếp
|
|
6
|
data[].orgLevel
|
String
|
Cấp độ của đơn vị trong cây (1: cấp cao nhất, tăng dần theo cấp con)
|
|
7
|
data[].isConfigured
|
Boolean
|
Đơn vị đã được cấu hình hay chưa
|
|
8
|
data[].hasSecurityCert
|
Boolean
|
Đơn vị có chứng thư bảo mật (chữ ký số) hay không
|
|
9
|
data[].isRoot
|
String
|
"1": là đơn vị gốc của cây; "0": không phải gốc
|
|
10
|
data[].isLeaf
|
String
|
"1": là đơn vị lá (không còn đơn vị con);
"0": còn đơn vị con
|
|
11
|
data[].orgId
|
Number
|
ID đơn vị
|
|
12
|
data[].orgCode
|
String
|
Mã đơn vị
|
|
13
|
data[].orgName
|
String
|
Tên đơn vị
|
|
14
|
data[].pathName
|
String
|
Tên đầy đủ theo đường dẫn cây (Tên đơn vị - Tên đơn vị cha)
|
|
15
|
data[].isActive
|
Number
|
Trạng thái hoạt động của đơn vị (0: chưa
xác định/không hoạt động theo dữ liệu mẫu)
|
|
16
|
data[].abbreviation
|
String
|
Tên viết tắt đơn vị (có thể không có ở một
|
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ
liệu
|
Mô tả
|
|
STT
|
Kiểu dữ
liệu
|
số bản ghi)
|
|
|
17
|
data[].orgParentName
|
String
|
Tên đơn vị cha
|
|
18
|
data[].transferring
|
Boolean
|
Đơn vị đang trong trạng thái chuyển đổi/sáp nhập hay không
|
|
19
|
data[].notReceiveDocConfig
|
Number
|
Cấu hình không nhận văn bản (0: nhận văn bản bình thường)
|
API 17: Lấy danh sách cá nhân (getListUser)
|
Method
|
POST
|
|
URL
|
{domain}/ServiceMobile_V02/resources /staffAction/getListUser
|
|
Content-
Type
|
application/x-www-form-urlencoded
|
|
Header
|
Authorization: Bearer
|
Mô tả: Lấy danh sách cá nhân (nhân sự) trong một đơn vị
Ghi chú: Body gồm isSecurity (cố định "0") và data (chuỗi JSON chứa tham số lọc). Tham số đầu vào (Request)
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ liệu
|
Bắt buộc
|
Mô tả
|
|
1
|
isSecurity
|
String
|
Bắt
buộc
|
Cố định truyền "0"
|
|
2
|
data
|
String
|
Bắt
buộc
|
Chuỗi JSON chứa tham số lọc
|
|
3
|
searchType
|
Number
|
Tuỳ
chọn
|
Loại tìm kiếm (theo cấu hình hệ thống, ví dụ: 1 - tìm theo đơn vị)
|
|
4
|
startRecord
|
Number
|
Bắt buộc
|
Vị trí bản ghi bắt đầu (bắt đầu từ 0)
|
|
5
|
pageSize
|
Number
|
Bắt buộc
|
Số bản ghi mỗi trang
|
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ
liệu
|
Bắt
buộc
|
Mô tả
|
|
6
|
keyword
|
String
|
Tuỳ chọn
|
Từ khoá tìm kiếm theo tên/mã nhân sự
|
|
7
|
type
|
String
|
Tuỳ
chọn
|
Loại dữ liệu cần lấy (theo cấu hình hệ thống, ví dụ: "12")
|
|
8
|
user
|
Object
|
Tuỳ chọn
|
Object chứa điều kiện lọc theo nhân sự
|
|
9
|
sysOrgId
|
Number
|
Tuỳ chọn
|
ID đơn vị cần lấy danh sách nhân sự
|
|
10
|
status
|
Number
|
Tuỳ chọn
|
Trạng thái nhân sự cần lọc (1: đang hoạt động)
|
Tham số đầu ra (Response)
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ liệu
|
Mô tả
|
|
1
|
result.mess.errorCode
|
Number
|
Mã kết quả. 200 = thành công
|
|
2
|
result.mess.message
|
String
|
Thông báo kết quả
|
|
3
|
result.data
|
Array
|
Danh sách cá nhân
|
|
4
|
data[].employeeId
|
Number
|
ID nhân sự
|
|
5
|
data[].orgName
|
String
|
Tên đơn vị nhân sự đang thuộc
|
|
6
|
data[].sysOrganizationId
|
Number
|
ID đơn vị (hệ thống)
|
|
7
|
data[].pathName
|
String
|
Đường dẫn phân cấp đơn vị
|
|
8
|
data[].displayName
|
String
|
Tên hiển thị
|
|
9
|
data[].fullName
|
String
|
Họ và tên đầy đủ
|
|
10
|
data[].position
|
String
|
Tên chức vụ
|
|
11
|
data[].positionId
|
Number
|
ID chức vụ
|
|
12
|
data[].employeeCode
|
String
|
Mã nhân sự (tài khoản)
|
|
13
|
data[].mobilePhone
|
String
|
Số điện thoại
|
|
STT
|
Tên
thuộc
tính
|
Kiểu dữ
liệu
|
Mô tả
|
|
14
|
data[].email
|
String
|
Email
|
|
15
|
data[].userRoleId
|
Number
|
ID vai trò người dùng
|
|
16
|
data[].hasSecurityCert
|
Boolean
|
Có chứng thư ký số hay không
|
|
17
|
data[].hasGraspSituation
|
Boolean
|
Có thuộc nhóm "nắm tình hình" hay không
|