Kính gửi: Các Sở Giáo dục
và Đào tạo
Thực hiện Công văn số 7802/BGDĐT-GDPT
ngày 27/11/2025 về việc hướng dẫn thực hiện Học bạ số đối với giáo dục phổ
thông và giáo dục thường xuyên năm học
2025-2026; Công văn số 2239/BGDĐT-KHCNTT ngày 29/4/2026 về việc hướng dẫn kết nối,
đồng bộ dữ liệu Học bạ số. Việc kết nối, đồng bộ dữ liệu Học bạ số là nhiệm vụ trọng tâm
trong công tác xây dựng, hoàn thiện hạ tầng dữ liệu giáo dục quốc gia, phục vụ
quản lý, điều hành, cải cách thủ tục hành chính và đẩy mạnh chuyển đổi số trong giáo dục theo chỉ
đạo của Chính phủ.
Bộ Giáo dục và Đào tạo (GDĐT) đề nghị
các Sở GDĐT khẩn trương chuẩn bị thực hiện kết nối, đồng bộ dữ liệu Học bạ số
năm học 2025-2026 về Cơ sở dữ liệu Học bạ số của Bộ GDĐT và cử cán bộ tham gia tập huấn với
các nội dung cụ thể như sau:
1. Kết nối, đồng bộ dữ
liệu Học bạ số
- Chỉ đạo các cơ sở giáo dục và đơn vị
cung cấp phần mềm Học bạ số rà soát, chuẩn bị dữ liệu, thực hiện kết nối API để đồng bộ
dữ liệu Học bạ số năm học 2025-2026 về Cơ sở dữ liệu Học bạ số của Bộ Giáo dục
và Đào tạo (theo chuẩn API tại Phụ lục
02).
- Hoàn thành việc cài đặt, kết nối API
trước ngày 12/7/2026.
2. Cung cấp thông tin
phục vụ triển khai
- Nhằm kịp thời có biện pháp hỗ trợ kỹ
thuật trong quá trình triển khai kết nối, đề nghị các sở GDĐT tổng hợp và cung
cấp thông tin bằng văn bản về cán bộ phụ trách triển khai kết nối Học bạ số của
Sở (đầu mối tiếp nhận tài khoản của Sở trên Cơ sở dữ liệu Học bạ số), cùng danh
sách các nhà cung cấp phần mềm Học bạ số tại địa phương (theo mẫu tại Phụ lục
01).
- Danh sách hoàn thiện bản mềm gửi về Bộ
GDĐT qua địa chỉ email: [email protected] trước ngày 07/7/2026.
3. Tổ chức tập huấn
Bộ Giáo dục và Đào tạo tổ chức tập huấn
trực tuyến về triển khai,
kết nối và đồng bộ dữ
liệu Học bạ số, cụ thể:
- Thành phần: Đại diện lãnh đạo Sở;
chuyên viên phụ trách Học bạ số các cấp học; cán bộ quản trị hệ thống, cán bộ
công nghệ thông tin có liên quan (tối đa 07 cán bộ/Sở)
- Thời gian: 01 buổi, bắt đầu từ 8h30
ngày 09/7/2026.
- Hình thức: Trực tuyến
- Tài liệu tập huấn: Đại biểu Quét mã QR đính kèm để nghiên cứu tài liệu
- Danh sách đại biểu tham gia tập huấn gửi
về địa chỉ Email: [email protected] trước ngày 07/7/2026, Bộ GDĐT sẽ gửi
link truy cập cho cán bộ phụ trách của Sở GDĐT (theo mẫu tại Phụ lục 01).
4. Tổ chức thực hiện
Đề nghị các sở GDĐT chịu trách nhiệm
chỉ đạo, đôn đốc các cơ sở giáo dục thuộc phạm vi quản lý thực hiện Học bạ số
năm học 2025-2026; rà soát, kiểm tra dữ liệu trước khi đồng bộ để bảo đảm dữ liệu đầy đủ, chính
xác, đúng cấu trúc và đúng tiến độ.
Chỉ đạo các cơ sở giáo dục thuộc phạm vi
quản lý rà soát các chứng thư số đang được sử dụng để ký học bạ số, bảo đảm thông tin trên chứng thư
số tuân thủ đúng
quy định. Đối với các chứng thư số còn chứa thông tin đơn vị hành chính theo mô
hình chính quyền địa phương ba cấp trước đây, cần thực hiện cập nhật, điều
chỉnh theo đơn vị hành chính mới.
Đề nghị các Sở GDĐT nghiêm túc triển
khai thực hiện các nội dung nêu trên nhằm bảo đảm tiến độ, chất lượng và tính
thống nhất trong việc triển khai Học bạ số trên phạm vi toàn quốc.
Trong quá trình thực hiện, nếu có khó
khăn, vướng mắc, đề nghị liên hệ đầu mối hỗ trợ kỹ thuật: ông Nguyễn Văn Tuân, số điện thoại
0982.947.125 (Đầu mối hỗ trợ tích hợp API).
|
Nơi nhận:
-
Như trên;
- Bộ trưởng (để báo cáo);
- TT.TTr Phạm Ngọc Thưởng (để báo cáo);
- Các Cục: KHCNTT, GDNNGDTX (để biết);
- Lưu: VT, Vụ GDPT.
|
TL. BỘ TRƯỞNG
VỤ TRƯỞNG VỤ GIÁO DỤC PHỔ THÔNG
Thái Văn Tài
|
Phụ
lục 1
(Kèm theo Công
văn số
4160/BGDĐT-GDPT
ngày 03
tháng 7 năm 2026)
ĐƠN VỊ………………………………
DANH SÁCH CÁN BỘ ĐẦU MỐI, ĐƠN VỊ TRIỂN KHAI HỌC BẠ SỐ VÀ
THAM GIA TẬP HUẤN
1. Thông tin cán bộ đầu mối triển khai kết
nối Học bạ số của Sở GDĐT
|
STT
|
Đơn vị
|
Họ và Tên
|
Chức vụ
|
Số điện thoại
|
Email
|
Ghi chú
|
|
1
|
|
|
|
|
|
|
|
2
|
|
|
|
|
|
|
|
...
|
|
|
|
|
|
|
2. Thông tin nhà cung cấp Học bạ số tại
địa phương
|
STT
|
Đơn vị cung cấp
|
Họ và Tên
|
Chức vụ
|
Số điện thoại
|
Email
|
Ghi chú
|
|
1
|
|
|
|
|
|
|
|
2
|
|
|
|
|
|
|
|
3
|
|
|
|
|
|
|
|
4
|
|
|
|
|
|
|
|
5
|
|
|
|
|
|
|
|
…
|
|
|
|
|
|
|
3. Danh sách Đại biểu tham gia tập huấn
|
STT
|
Họ và Tên
|
Chức vụ/đơn vị
|
Số điện thoại
|
Ghi chú
|
|
1
|
|
|
|
|
|
2
|
|
|
|
|
|
3
|
|
|
|
|
|
4
|
|
|
|
|
|
5
|
|
|
|
|
|
...
|
|
|
|
|
Phụ lục 02
(Kèm
theo Công văn số: 4160/BGDĐT-GDTH ngày 03 tháng 7 năm 2026 của Bộ Giáo dục và
Đào tạo)
TÀI LIỆU MÔ TẢ DỊCH VỤ
KẾT NỐI DỮ LIỆU HỆ THỐNG CSDL HỌC BẠ SỐ
BỘ
GIÁO DỤC VÀ ĐÀO TẠO
(Phiên
bản 1.0.2, tháng 6/2026)
Hà
Nội, 2026
MỤC
LỤC
I.
II.
1.
2.
3.
4.
Mã trạng thái xử lý gói
tin (ResponseCode)
Mã lỗi (Error)
5.
5.1.
5.2.
5.3.
5.4.
5.5.
5.6.
5.7.
5.8.
5.9.
5.10.
5.10.1.
5.10.2.
THUẬT
NGỮ VÀ VIẾT TẮT
|
Thuật ngữ, từ viết tắt
|
Giải thích
|
|
CSDL
|
Cơ
sở dữ liệu
|
|
CSGD
|
Cơ
sở giáo dục
|
|
HBS
|
Học
bạ số
|
|
CCCD
|
Căn
cước công dân
|
|
CBQL
|
Cán
bộ quản lý
|
|
GVCN
|
Giáo
viên chủ nhiệm
|
|
GVBM
|
Giáo
viên bộ môn
|
|
UUID
|
Universal
Unique Identifier
|
|
XML
|
Extensible
Markup Language
|
I.
TỔNG QUAN
Tài liệu này mô tả
thông điệp dữ liệu phục vụ kết nối, đồng bộ dữ liệu Học bạ số (thí điểm) giữa phần
mềm quản trị của nhà trường (đã đáp ứng các yêu cầu triển khai học bạ số của Bộ)
với CSDL học bạ số Bộ GDĐT.
II.
CÁC DỊCH VỤ KẾT NỐI
1.
Danh sách dịch vụ học bạ
|
TT
|
Dịch
vụ
|
Mã
dịch vụ
|
Mục
đích sử dụng
|
|
1
|
Lấy token
|
00
|
Dịch vụ tạo
token của CSDL Học bạ số sẽ khởi tạo token cho phép thực hiện phiên làm việc
giữa phần mềm tạo lập học bạ của cơ sở giáo dục (CSGD) với CSDL học bạ. Token
tài khoản của CSGD với CSDL Học bạ
|
|
2
|
Lấy danh mục
loại chữ ký số
|
01
|
Dịch vụ lấy
danh sách các loại chữ ký số
|
|
3
|
Dịch vụ lấy
danh mục nhà cung cấp chữ ký số
|
02
|
Dịch vụ lấy
danh sách các nhà cung cấp chữ ký số
|
|
3
|
Giao dịch
đăng ký chứng thư chữ ký số
|
03
|
Sử dụng để
CSGD đăng ký chứng thư chữ ký số để quản lý, xác thực giao dịch nộp học bạ
|
|
4
|
Giao dịch
truy vấn kết quả đăng ký chứng thư chữ ký số
|
04
|
Sử dụng để
CSGD kiểm tra trạng thái xử lý đăng ký chứng thư chữ ký số
|
|
5
|
Giao dịch gửi
yêu cầu nộp báo cáo dữ liệu học bạ số
|
05
|
Sử dụng để
đóng gói dữ liệu học bạ số từ CSGD gửi lên CSDL học bạ số Bộ GDĐT.
|
|
6
|
Giao dịch
truy vấn kết quả phát hành học bạ số
|
06
|
Dùng để kiểm
tra trạng thái xử lý của yêu cầu nộp phát hành học bạ số.
|
|
7
|
Giao dịch gửi
yêu cầu thu hồi dữ liệu học bạ số
|
07
|
Sử dụng để
CSGD gửi yêu cầu thu hồi dữ liệu học bạ số lên CSDL học bạ số Bộ GDĐT
|
|
8
|
Giao dịch
truy vấn kết quả thu hồi dữ liệu học bạ số
|
08
|
Dùng để kiểm
tra trạng thái xử lý của yêu cầu yêu cầu thu hồi dữ liệu học bạ số
|
|
9
|
Giao dịch
chia sẻ danh mục dùng chung
|
09
|
Cung cấp các
danh mục chuẩn dùng chung kết nối (cấp học, môn học, loại chữ ký số, nhà cung
cấp chữ ký số …) dùng thống nhất toàn hệ thống.
|
2.
Cơ chế kết nối các dịch vụ
- Sử dụng cơ chế kết nối
qua các giao thức Rest Service
- Cấu trúc bản tin trao
đổi theo định dạng Http Request
- Trước khi kết nối dịch
vụ, các đơn vị kết nối cần thực hiện khai báo IP hệ thống với Cục CNTT để mở
quyền kết nối.
- Mỗi CSGD dùng tài khoản/mật
khẩu do cục KHCNTT cấp dùng để xác thực kết nối các API.
- Mỗi đơn vị phần mềm tạo
lập học bạ ( QLNT) sẽ được cấp tài khoản/mật khẩu dùng để xác thực kết nối các
API.
3.
Hướng dẫn chuẩn hoá và nén dữ liệu trước khi gửi tích hợp
Để đảm bảo dữ liệu truyền
nhận thống nhất, tiết kiệm băng thông và tránh lỗi ký tự, hệ thống yêu cầu các
đơn vị tích hợp thực hiện chuẩn hoá và nén dữ liệu theo quy trình sau trước khi
gửi.
- B1. Chuẩn hoá
mã hóa ký tự
Toàn bộ nội dung dữ liệu
(text) phải được chuyển về chuẩn UTF-8 trước khi xử lý tiếp theo.
Việc này nhằm đảm bảo
tính tương thích khi dữ liệu có chứa ký tự Unicode (ví dụ: tiếng Việt có dấu).
- B2. Xác định
độ dài dữ liệu gốc
Sau khi chuẩn hóa
UTF-8, cần xác định:
- Độ dài tính theo byte
của chuỗi
- Chuyển giá trị độ dài
này thành 4 byte dạng unsigned integer (little-endian)
4 byte này sẽ được đặt ở
phần đầu của dữ liệu.
Cấu trúc dữ liệu sau bước
này:
[4 byte độ dài ban đầu]
- B3. Nén dữ liệu
Phần nội dung sau khi
chuẩn hóa UTF-8 cần được:
Nén theo chuẩn GZIP
Khuyến nghị mức nén:
level 9 (mức cao nhất)
- B4. Ghép dữ
liệu
Sau khi có:
4 byte độ dài ban đầu
Nội dung đã nén GZIP
Tiến hành ghép theo thứ
tự:
[4 byte độ dài] + [dữ
liệu gzip]
- B5. Mã hoá
Base64
Vì dữ liệu sau khi ghép
là dạng nhị phân (binary), bắt buộc phải:
Mã hoá toàn bộ khối dữ
liệu bằng Base64
Chuỗi Base64 này chính
là giá trị cuối cùng được gửi sang hệ thống tiếp nhận.
Cấu trúc dữ liệu cuối
cùng
Base64(
4 byte length
(little-endian)
+
gzip(compressed UTF-8
content)
)
* Lưu ý quan trọng
Độ dài được tính theo
byte, không phải số ký tự.
Định dạng 4 byte phải
là unsigned 32-bit little-endian.
Phải sử dụng chuẩn
GZIP, không dùng zlib hoặc raw deflate.
Bắt buộc mã hoá Base64
trước khi gửi qua API hoặc lưu trữ.
4.
Quy ước chung
- Tất cả API tích hợp
luôn trả về HTTP 200, kể cả khi có lỗi
- Lỗi được mô tả trong
trường Error / errorCode của response body
- Các API nộp gói tin
trả về MessageId để tra cứu kết quả xử lý bất đồng bộ
Mã
trạng thái xử lý gói tin (ResponseCode)
|
Mã
|
Mô tả
|
|
000-000
|
Hoàn thành
|
|
000-100
|
Đang xử lý
|
|
000-101
|
Chờ xử lý
|
Mã
lỗi (Error)
|
000-000
|
Không có lỗi
|
|
000-401
|
Không có quyền
truy cập
|
|
000-404
|
Không tìm thấy
|
|
000-422
|
Dữ liệu không
hợp lệ
|
|
000-423
|
Dữ liệu học bạ
|
|
000-500
|
Lỗi hệ thống
|
5. Chi tiết các
dịch vụ
5.1.
Dịch vụ lấy token
Dịch vụ tạo token sẽ khởi
tạo token cho phép thực hiện phiên làm việc giữa phần mềm tạo lập học bạ (
token đối tác ) và Các cơ sở giáo dục (CSGD) ( token trường). kết nối với CSDL
học bạ.
- Đặc tả đầu vào API:
|
Tham số
|
Mô tả
|
Kiểu dữ liệu
|
Ràng buộc
|
|
user_name
|
Tên tài khoản
đồng bộ ứng với tài khoản của Cục KHCNTT được cấp. Mỗi đơn vị, CSGD được cấp
duy nhất 1 tài khoản
|
String
|
Bắt buộc
|
|
password
|
Mật khẩu tài khoản
được cấp
|
String
|
Bắt buộc
|
|
|
|
|
|
- Đặc tả đầu ra API:
|
Tham số
|
Mô tả
|
Kiểu dữ liệu
|
Ràng buộc
|
|
access_token
|
Key token trả
về
|
String
|
Bắt buộc
|
|
Issued_On
|
Thời gian tạo
token
|
Datetime
|
Bắt buộc
|
|
Expires_On
|
Thời gian hết
hạn token
|
Datetime
|
Bắt buộc
|
|
|
|
|
|
- Chi tiết dịch vụ:
|
Địa chỉ kết nối
|
|
URL
|
[BaseUrl]/AuthToken/GetAuthToken
|
|
Request
header
|
|
Content-Type
|
application/json
|
|
Request Body
|
|
Body
|
{
"user_name":
"01",
"password":"*********"
}
|
|
Response Body
|
|
Body
|
{
"access_token":
"e5f2a7c7-1791-4d92-b240-d7ae416b54be-638469794625130000",
"Issued_On":
"2024-03-25T16:04:22.513",
"Expires_On":
"2024-04-24T16:31:34.06"
}
|
5.2.
Dịch vụ lấy danh mục kiểu chữ ký số
- Đặc tả đầu vào API:
Không cần truyền dữ liệu tham số đầu vào
- Đặc tả đầu vào API
|
Tham số
|
Mô tả
|
Kiểu dữ liệu
|
Ràng buộc
|
|
Thông tin của
đơn vị giao dịch được bao trong object {authenticationRequest}. Chi tiết như
sau:
|
|
token
|
Đoạn mã bảo mật
để xác thực phiên giao dịch. Token đối tác
|
String
|
Bắt buộc
|
|
MA_DANH_MUC
|
Mã danh mục cần
lấy dữ liệu
|
String
|
Bắt buộc
|
|
|
|
|
|
- Đặc tả đầu ra API
|
Tham số
|
Kiểu dữ liệu
|
Kiểu dữ liệu
|
|
errorCode
|
string
|
Mã lỗi trả về
|
|
status
|
string
|
Trạng thái trả
về
|
|
message
|
string
|
Mã lỗi chi tiết
|
|
itemsPerPage
|
string
|
Số bản ghi 1
trang
|
|
pageNo
|
string
|
Số trang
|
|
totalItems
|
string
|
Tổng số bản
ghi
|
|
data
|
string
|
Danh sách chi
tiết
|
|
MA
|
string
|
Mã chi tiết
danh mục
|
|
TEN
|
string
|
Tên chi tiết
danh mục
|
|
TRANG_THAI
|
Number
|
1: Hoạt động
0: Không hoạt
động
|
|
NGAY_CAP_NHAT
|
|
Ngày cập nhật
|
|
THU_TU
|
Number
|
Thứ tự hiển
thị
|
|
|
|
|
- Chi tiết dịch vụ
- Phương thức: GET
|
Địa chỉ kết nối
|
|
URL
|
[BaseUrl]/api/integration/declaration/v1/types/DM_KIEU_CHU_KY_SO
?pageNo=1&itemsPerPage=20
|
|
Request
header
|
|
Content- Type
|
application/json
|
|
Authorizatio
n
|
Token {token}
(token sinh ra từ API lấy thông tin token phía trên)
|
|
Request Body
|
|
Body
|
|
|
Response Body
|
|
Body
|
{
"errorCode":
0,
"status":
"success",
"message":
"Lấy dữ liệu danh mục thành công",
"itemsPerPage":
20,
"pageNo":
1,
"totalItems":
"13",
"data":
[
{
"MA":
"USB_TOKEN",
"NGAY_CAP_NHAT":
"2026-04-01T07:02:38Z",
"TEN":
"Chữ ký số USB Token",
"THU_TU":
1,
"TRANG_THAI":
1
},
{
"MA":
"REMOTE_SIGNING",
"NGAY_CAP_NHAT":
"2026-04-01T07:02:38Z",
"TEN":
"Chữ ký số Remote Signing",
"THU_TU":
2,
"TRANG_THAI":
1
}
]
}
|
5.3.
Dịch vụ lấy danh mục nhà cung cấp chữ ký số
- Đặc tả đầu vào API
|
Tham số
|
Mô tả
|
Kiểu dữ liệu
|
Ràng buộc
|
|
Thông tin của
đơn vị giao dịch được bao trong object {authenticationRequest}. Chi tiết như
sau:
|
|
token
|
Đoạn mã bảo mật
để xác thực phiên giao dịch. Token đối tác
|
String
|
Bắt buộc
|
|
DM_NHA_CUNG_CAP_CHU_KY_SO
|
Danh mục nhà
cung cấp chữ ký số
|
String
|
Bắt buộc
|
|
|
|
|
|
- Đặc tả đầu ra API
|
Tham số
|
Kiểu dữ liệu
|
Kiểu dữ liệu
|
|
errorCode
|
string
|
Mã lỗi trả về
|
|
status
|
string
|
Trạng thái trả
về
|
|
message
|
string
|
Mã lỗi chi tiết
|
|
itemsPerPage
|
string
|
Số bản ghi 1
trang
|
|
pageNo
|
string
|
Số trang
|
|
totalItems
|
string
|
Tổng số bản
ghi
|
|
data
|
string
|
Danh sách chi
tiết
|
|
MA
|
string
|
Mã chi tiết
danh mục
|
|
TEN
|
string
|
Tên chi tiết
danh mục
|
|
TRANG_THAI
|
Number
|
1: Hoạt động
0: Không hoạt
động
|
|
NGAY_CAP_NHAT
|
|
Ngày cập nhật
|
|
THU_TU
|
Number
|
Thứ tự hiển
thị
|
|
|
|
|
- Chi tiết dịch vụ
- Phương thức: GET
|
Địa chỉ kết nối
|
|
URL
|
[BaseUrl]/api/integration/declaration/v1/types/DM_NHA_CUNG_CAP_CHU_KY_SO? pageNo=1&itemsPerPage=20
|
|
Request
header
|
|
Content-Type
|
application/json
|
|
Authorization
|
Token {token}
(token sinh ra từ API lấy thông tin token phía trên)
|
|
Request Body
|
|
Body
|
|
|
Response Body
|
|
Body
|
{
"errorCode":
0,
"status":
"success",
"message":
"Lấy dữ liệu danh mục thành công",
"itemsPerPage":
20,
"pageNo":
1,
"totalItems":
"13",
"data":
[
{
"MA":
"BAN_CO_YEU",
"NGAY_CAP_NHAT":
"2026-04-01T07:02:38Z",
"TEN":
"Chữ ký số của Ban cơ yếu Chính phủ",
"THU_TU":
1,
"TRANG_THAI":
1
},
{
"MA":
"VIETTEL",
"NGAY_CAP_NHAT":
"2026-04-01T07:02:38Z",
"TEN":
"Nhà phát hành VIETTEL VIETTEL CA - RS",
"THU_TU":
2,
"TRANG_THAI":
1
}
]
}
|
5.4.
Đăng ký chứng thư chữ ký số của CSGD
- Đặc tả đầu vào API:
|
Tham số
|
Mô tả
|
Kiểu dữ liệu
|
Ràng buộc
|
|
Thông tin của
đơn vị giao dịch được bao trong object {authenticationRequest}. Chi tiết như
sau:
|
|
token
|
Đoạn mã bảo mật
để xác thực phiên giao dịch. Token trường
|
String
|
Bắt buộc
|
|
user_name
|
Thông tin tài
khoản của CSGD được cấp
|
String
|
Bắt buộc
|
|
password
|
Mật khẩu của
đơn vị (sử dụng hàm băm SHA256)
|
String
|
Bắt buộc
|
|
messageid
|
ID của gói
tin
|
String
|
Bắt buộc
|
|
type
|
Loại gói tin
DANG_KY_SERIAL
|
String
|
Bắt buộc
|
|
function
|
Mã chức năng:
00
|
String
|
Bắt buộc
|
|
ma_don_vi
|
Mã đơn vị
chính là mã CSGD được cấp bởi Bộ GDĐT
|
String
|
Bắt buộc
|
|
nam_hoc
|
Năm học
|
String
|
|
|
serial_number
|
Serial của chứng
thư chữ ký số
|
String
|
Bắt buộc
|
|
ngay_hieu_luc
|
Ngày có hiệu
lực của chứng thư chữ ký số
|
Date
|
Bắt buộc
|
|
ma_kieu_chu_ky
|
Mã kiểu chứng
thư chữ ký số
|
String
|
Bắt buộc
|
|
nha_phat_hanh
|
Nhà phát hành
chứng thư chữ ký số
|
String
|
Bắt buộc
|
|
Thông tin chứng
thư chữ ký số được nén và đóng gói trong tham số “content”. Chi tiết như sau:
|
|
content
|
Đoạn chuỗi mã
hoá dữ liệu thông tin chứng thư chữ ký số kèm theo chữ ký số của đơn vị đăng
ký.
Chuyển đổi
model envelope request gói tin sang định dạng XML. CompressString trước khi gửi.
|
String
|
Bắt buộc
|
|
|
|
|
|
Thông tin về chứng thư
chữ ký số kèm theo chữ ký số của CSGD (để đối sánh) được đóng gói trong tham số
“content” (thông tin chi tiết được sẽ được hướng dẫn trong tài liệu mô tả API
do Bộ GDĐT cung cấp).
Danh mục
“ma_kieu_chu_ky”:
● REMOTE_SIGNING: Chữ
ký số Remote Signing
● USB_TOKEN: Chữ ký số
USB Token
Dữ liệu trong danh mục
“ma_kieu_chu_ky” sẽ có thể được bổ sung điều chỉnh thêm (Bộ GDĐT sẽ cung cấp
API trả về danh mục kiểu chữ ký số).
Danh mục
“nha_phat_hanh” nhà cung cấp chứng thư chữ ký số được Bộ Thông tin và Truyền
thông cấp phép, ví dụ:
● VNPT: Nhà phát hành
VNPT SMART CA
● BKAV: Nhà phát hành
BKAV
● VIETTEL: Nhà phát
hành VIETTEL VIETTEL CA - RS
● BAN_CO_YEU: Chữ ký số
của Ban cơ yếu Chính phủ
Dữ liệu trong danh mục
“nha_phat_hanh” sẽ có thể được bổ sung điều chỉnh thêm (Bộ sẽ cung cấp API
trả về danh mục nhà cung cấp chữ ký số).
- Đặc tả đầu ra API:
|
Tham số
|
Mô tả
|
Kiểu dữ liệu
|
Ràng buộc
|
|
MessageId
|
ID gói tin,
dùng để đối soát trạng thái của gói tin truyền lên.
|
String
|
Bắt buộc
|
|
Error
|
Mã lỗi
|
String
|
Bắt buộc
|
|
error_field_title
|
Tiêu đề mã lỗi
|
String
|
Bắt buộc
|
|
error_description
|
Thông tin lỗi
|
String
|
Bắt buộc
|
|
|
|
|
|
- Chi tiết dịch vụ:
Phương thức: POST
|
Địa chỉ kết nối
|
|
URL
|
[BaseUrl]/MoetService/TiepNhanGoiTin
|
|
Request
header
|
|
Content-Type
|
application/json
|
|
Authorization
|
Token {token}
(token sinh ra từ API lấy thông tin token phía trên)
|
|
Request Body
|
|
Body
|
{
"authenticationRequest":
{
"token":
"e5f2a7c7-1791-4d92-b240-d7ae416b54be",
"user_name":
"01",
"password":
"********",
"ma_don_vi":
"01004422",
"nam_hoc":
2025,
"messageid":
"",
"type":
"DANG_KY_SERIAL",
"function":
"00",
"serial_number":
"5404FFFEB7033FB324B728D3C2FAE58E",
"ngay_hieu_luc":
"09/01/2029",
"ma_kieu_chu_ky":
"Chữ ký số USB Token",
"nha_phat_hanh":
"VIETTEL",
"content":
"dsnsgjfdnajonjwewitrt23423jndsvj"
}
|
|
Response Body
|
|
Body
|
{
"Header":
{
"MessageId":
"e5f2a7c7-1791-4d92-b240-d7ae416b54be"
},
"Body":
{
"Result":
{
"Error":
"000-000",
"error_field_title":
"Không có lỗi",
"ResponseCode":
"000-101",
"error_description":
"Đang chờ xử lý",
"Items":
{
"Item":
[]
}
}
}
}
|
5.5.
Kiểm tra trạng thái phê duyệt chứng thư chữ ký số của CSGD
- Đặc tả dữ liệu đầu
vào:
|
Tham số
|
Mô tả
|
Kiểu dữ liệu
|
Ràng buộc
|
|
Thông tin của
đơn vị giao dịch được bao trong object {authenticationRequest}. Chi tiết như
sau:
|
|
token
|
Đoạn mã bảo mật
để xác thực phiên giao dịch. Token trường
|
String
|
Bắt buộc
|
|
user_name
|
Thông tin tài
khoản của đối tác được cấp
|
String
|
Bắt buộc
|
|
password
|
Mật khẩu của
đơn vị (sử dụng hàm băm SHA256)
|
String
|
Bắt buộc
|
|
messageid
|
MessageId
|
String
|
Bắt buộc
|
|
ma_don_vi
|
Mã đơn vị
|
String
|
Bắt buộc
|
|
ma_nam_hoc
|
Mã năm học
|
Number
|
Bắt buộc
|
|
type
|
Loại gói tin:
DANG_KY_SERIAL
|
String
|
Bắt buộc
|
|
function
|
Mã chức năng:
100
|
String
|
Bắt buộc
|
|
|
|
|
|
Đặc tả dữ liệu đầu ra:
|
Tham số
|
Tên thẻ
|
Kiểu dữ liệu
|
Ràng
buộc
|
|
messageid
|
MessageId
|
String
|
Bắt buộc
|
|
ma_don_vi
|
Mã đơn vị
|
String
|
Bắt buộc
|
|
serial_number
|
Serial của chứng
thư chữ ký số
|
String
|
Bắt buộc
|
|
trang_thai_phe_duyet
|
Trạng thái
phê duyệt của chứng thư chữ ký số
2 - chờ duyệt
1 - phê duyệt
0 - từ chối
|
Number
|
Bắt buộc
|
|
Error
|
Mã lỗi
|
String
|
Bắt buộc
|
|
error_field_title
|
Tiêu đề mã lỗi
|
String
|
Bắt buộc
|
|
error_description
|
Thông tin lỗi
|
String
|
Bắt buộc
|
|
|
|
|
|
- Chi tiết dịch vụ:
Phương thức: GET
|
Địa chỉ kết nối
|
|
URL
|
[BaseUrl]/MoetService/TiepNhanGoiTin
|
|
Request
header
|
|
Content-Type
|
application/json
|
|
Authorization
|
Token {token}
(token sinh ra từ API lấy thông tin token phía trên)
|
|
Request Body
|
|
Body
|
{
"authenticationRequest":
{
"token":
"e5f2a7c7-1791-4d92-b240-d7ae416b54be",
"user_name":
"01",
"password":
"******",
"ma_don_vi":
"01004422",
"cap_hoc":
"02",
"nam_hoc":
2025,
"messageid":
"",
"type":
"DANG_KY_SERIAL",
"function":
"100"
},
"content":
""
}
|
|
Response Body
|
|
Body
|
{
"Header":
{
"messageid":
"e5f2a7c7-1791-4d92-b240-d7ae416b54be"
},
"Body": {
"Result":
{
"Error":
"000-000",
"ErrorDescription":
"Không có lỗi",
"ResponseCode":
"000-102",
"ResponseDescription":
"Đã xử lý thành công",
"Items":
{
"Item":
[
{
"Error":
"000-000",
"error_field_title":
"",
"error_description":
"Không có lỗi",
"ma_don_vi":
"01",
"serial_number":
"540101012cb166cb1dbf5affe0a7a408",
"trang_thai_phe_duyet":
"1"
}
]
}
}
}
}
|
5.6.
Gửi báo cáo học bạ số
- Đặc tả đầu vào API:
|
Tham số
|
Mô tả
|
Kiểu dữ liệu
|
Ràng buộc
|
|
Thông tin của
đơn vị giao dịch được bao trong object {authenticationRequest}. Chi tiết như
sau:
|
|
token
|
Đoạn mã bảo mật
để xác thực phiên giao dịch. Token trường
|
String
|
Bắt buộc
|
|
user_name
|
Thông tin tài
khoản của CSGD được cấp
|
String
|
Bắt buộc
|
|
password
|
Mật khẩu của
đơn vị (sử dụng hàm băm SHA256)
|
String
|
Bắt buộc
|
|
ma_don_vi
|
Mã đơn vị
chính là mã CSGD được cấp bởi Bộ GDĐT
|
String
|
Bắt buộc
|
|
nam_hoc
|
Năm học
|
Number
|
Bắt buộc
|
|
messageid
|
Message ID,
dùng để đối soát trạng thái của gói tin truyền lên.
Khi gửi 1 gói
tin mới lên sẽ để trống Message ID, API sẽ tự cấp Message ID.
|
String
|
Bắt buộc
|
|
type
|
Loại gói tin:
PHAT_HANH_HOC_BA_SO_C1
PHAT_HANH_HOC_BA_SO_C2
PHAT_HANH_HOC_BA_SO_C3
PHAT_HANH_HOC_BA_SO_GDTX
|
String
|
Bắt buộc
|
|
function
|
Mã chức năng:
00
|
String
|
Bắt buộc
|
|
Thông tin dữ
liệu học bạ số được nén và đóng gói trong tham số “content”. Chi tiết như
sau:
|
|
content
|
Đoạn chuỗi mã
hoá dữ liệu học bạ số.
Chuyển đổi
model envelope request gói tin sang định dạng XML. CompressString trước khi gửi.
|
String
|
Bắt buộc
|
|
|
|
|
|
- Đặc tả đầu ra API:
|
Tham số
|
Mô tả
|
Kiểu dữ liệu
|
Ràng buộc
|
|
MessageId
|
ID gói tin,
dùng để đối soát trạng thái của gói tin truyền lên.
|
String
|
Bắt buộc
|
|
Error
|
Mã lỗi
|
String
|
Bắt buộc
|
|
ErrorDescription
|
Tiêu đề mã lỗi
|
String
|
Bắt buộc
|
|
ResponseCode
|
Mã phản hồi
|
String
|
Bắt buộc
|
|
ResponseDescription
|
Chi tiết phản
hồi
|
String
|
Bắt buộc
|
|
|
|
|
|
- Chi tiết dịch vụ:
Phương thức: POST
|
Địa chỉ kết nối
|
|
URL
|
[BaseUrl]/MoetService/TiepNhanGoiTin
|
|
Request
header
|
|
Content-Type
|
application/json
|
|
Authorization
|
Token {token}
(token sinh ra từ API lấy thông tin token phía trên)
|
|
Request Body
|
|
Body
|
{
"authenticationRequest":
{
"token":
"e5f2a7c7-1791-4d92-b240-d7ae416b54be",
"user_name":
"01",
"password":
"********",
"ma_don_vi":
"01004422",
"cap_hoc":
"02",
"nam_hoc":
2025,
"messageid":
"",
"type":
"PHAT_HANH_HOC_BA_SO_C1",
"function":
"00"
},
"content":
"dsnsgjfdnajonjwewitrt23423jndsvj"
}
|
|
Response Body
|
|
Body
|
{
"Header":
{
"MessageId":
"48491401a3fd8ac7-9c8c-4635-acd2- b402f8fedf8a"
},
"Body":
{
"Result":
{
"Error":
"000-000",
"ErrorDescription":
"Không có lỗi",
"ResponseCode":
"000-101",
"ResponseDescription":
"Đang chờ xử lý",
"Items":
{
"Item":
[]
}
}
}
}
|
5.7.
Kiểm tra trạng thái tiếp nhận học bạ số
- Đặc tả đầu vào API:
|
Tham số
|
Mô tả
|
Kiểu dữ liệu
|
Ràng buộc
|
|
Thông tin của
đơn vị giao dịch được bao trong object {authenticationRequest}. Chi tiết như
sau:
|
|
token
|
Đoạn mã bảo mật
để xác thực phiên giao dịch. Token trường
|
String
|
Bắt buộc
|
|
user_name
|
Thông tin tài
khoản của CSGD được cấp
|
String
|
Bắt buộc
|
|
password
|
Mật khẩu của
đơn vị (sử dụng hàm băm SHA256)
|
String
|
Bắt buộc
|
|
ma_don_vi
|
Mã đơn vị
chính là mã CSGD được cấp bởi Bộ
GDĐT
|
String
|
Bắt buộc
|
|
messageid
|
Message ID,
dùng để đối soát trạng thái của gói tin truyền lên.
Khi gửi 1 gói
tin mới lên sẽ để trống Message ID, API sẽ tự cấp Message ID.
|
String
|
Bắt buộc
|
|
type
|
Loại gói tin:
PHAT_HANH_HOC_BA_SO_C1
|
String
|
Bắt buộc
|
|
function
|
Mã chức năng:
100
|
String
|
Bắt buộc
|
|
content
|
API hỏi trạng
thái thì truyền content rỗng.
|
String
|
Bắt buộc
|
|
|
|
|
|
- Đặc tả đầu ra API:
|
Tham số
|
Mô tả
|
Kiểu dữ liệu
|
Ràng buộc
|
|
ma_hoc_sinh
|
Mã học sinh
|
String
|
Bắt buộc
|
|
ten_hoc_sinh
|
Tên học sinh
|
String
|
Bắt buộc
|
|
so_cccd
|
Số căn cước
công dân
|
String
|
Bắt buộc
|
|
ma_dinh_danh_hoc_ba
|
Mã định danh
học bạ
|
String
|
Bắt buộc
|
|
trang_thai
|
Trạng thái
phê duyệt học bạ
1 - phê duyệt
0 - từ chối
|
Number
|
Bắt buộc
|
|
Error
|
Mã lỗi
|
String
|
Bắt buộc
|
|
error_field_title
|
Tiêu đề mã lỗi
|
String
|
Bắt buộc
|
|
error_description
|
Thông tin lỗi
|
String
|
Bắt buộc
|
|
|
|
|
|
- Chi tiết dịch vụ:
Phương thức: GET
|
Địa chỉ kết nối
|
|
URL
|
[BaseUrl]/MoetService/TiepNhanGoiTin
|
|
Request
header
|
|
Content-Type
|
application/json
|
|
Authorization
|
Token {token}
(token sinh ra từ API lấy thông tin token phía trên)
|
|
Request Body
|
|
Body
|
{
"authenticationRequest":
{
"token":
"e5f2a7c7-1791-4d92-b240-d7ae416b54be",
"user_name":
"01",
"password":
"********",
"ma_don_vi":
"01004422",
"cap_hoc":
"02",
"nam_hoc":
2025,
"messageid":
"",
"type":
"PHAT_HANH_HOC_BA_SO_C1",
"function":
"100"
},
"content":
""
}
|
|
Response Body
|
|
Body
|
{
"Header":
{
"MessageId":
"e5f2a7c7-1791-4d92-b240-d7ae416b54be"
},
"Body":
{
"Result":
{
"Error":
"000-000",
"ErrorDescription":
"Không có lỗi",
"ResponseCode":
"000-102",
"ResponseDescription":
"Đã xử lý thành công",
"Items":
{
"Item":
[
{
"ma_hoc_sinh":
"4847679167",
"ten_hoc_sinh":
"Trương Phương Anh",
"so_cccd":
null,
"trang_thai":
"1",
"ma_dinh_danh_hoc_ba":
"7c071816-e15d-4aea-8946-32e06f1642ad",
"Error":
"000-000",
"error_field_title":
"Tiêu đề mã lỗi",
"error_description":
"Thông tin lỗi"
}
]
}
}
}
}
|
5.8.
Gửi yêu cầu thu hồi học bạ
- Đặc tả đầu vào API:
|
Tham số
|
Mô tả
|
Kiểu dữ liệu
|
Ràng buộc
|
|
Thông tin của
đơn vị giao dịch được bao trong object {authenticationRequest}. Chi tiết như
sau:
|
|
token
|
Đoạn mã bảo mật
để xác thực phiên giao dịch. Token trường
|
String
|
Bắt buộc
|
|
user_name
|
Thông tin tài
khoản của CSGD được cấp
|
String
|
Bắt buộc
|
|
password
|
Mật khẩu của
đơn vị (sử dụng hàm băm SHA256)
|
String
|
Bắt buộc
|
|
ma_don_vi
|
Mã đơn vị
chính là mã CSGD được cấp bởi Bộ GDĐT
|
String
|
Bắt buộc
|
|
cap_hoc
|
Cột Mã trong
Danh mục Cấp học
|
String
|
Bắt buộc
|
|
nam_hoc
|
Năm học
|
Number
|
Bắt buộc
|
|
messageid
|
Message ID,
dùng để đối soát trạng thái của gói tin truyền lên.
Khi gửi 1 gói
tin mới lên sẽ để trống Message ID, API sẽ tự cấp Message ID.
|
String
|
Bắt buộc
|
|
type
|
Loại gói tin:
THU_HOI_HOC_BA_SO
|
String
|
Bắt buộc
|
|
function
|
Mã chức năng:
00
|
String
|
Bắt buộc
|
|
Thông tin học
bạ số cần thu hồi được nén và đóng gói trong tham số “content”. Chi tiết như
sau:
|
|
content
|
Đoạn chuỗi mã
hoá thông tin học bạ số cần thu hồi.
Chuyển đổi
model envelope request gói tin sang định dạng XML. CompressString trước khi gửi.
|
String
|
Bắt buộc
|
|
|
|
|
|
- Danh sách thông tin học
bạ số cần thu hồi (bao gồm: thông tin cơ bản về học bạ cần thu hồi; lý do
thu hồi; người đề xuất thu hồi; người phê duyệt thu hồi) được nối với nhau
trong 1 file xml. Thẻ gốc <DANH_SACH_HOC_BA>, chứa danh sách thông tin học
bạ cần thu hồi.
Cấu trúc thông tin cụ
thể về Danh sách thông tin học bạ số cần thu hồi như sau:
<DANH_SACH_HOC_BA
id="dataDanhSach">
<HOC_BA>
<MA_DINH_DANH_HOC_BA/>
<HO_VA_TEN/>
<GIOI_TINH/>
<NGAY_SINH/>
<SO_CCCD/>
<TEN_TRUONG/>
<MA_TRUONG/>
<TEN_NAM_HOC/>
<LY_DO_TRUONG_GUI_YEU_CAU_THU_HOI
/>
<HO_VA_TEN_NGUOI_DE_XUAT_THU_HOI
/>
<SO_CCCD_NGUOI_DE_XUAT_THU_HOI
/>
<HO_VA_TEN_NGUOI_PHE_DUYET_THU_HOI/>
<SO_CCCD_NGUOI_PHE_DUYET_THU_HOI
/>
</HOC_BA>
<HOC_BA>
…
</HOC_BA>
</DANH_SACH_HOC_BA>
- Dữ liệu xml này được
xử lý “escape quote”, sau đó nén lại theo chuẩn Gzip và mã hoá chuỗi theo định
dạng Base64 (chi tiết tham khảo trong Phụ lục 5).
- “Signature” là chữ ký
số của tổ chức (CSGD) - dùng để ký xác nhận điện tử mỗi giao dịch thu hồi học bạ.
- Đặc tả đầu ra API:
|
Tham số
|
Mô tả
|
Kiểu dữ liệu
|
Ràng buộc
|
|
MessageId
|
ID gói tin,
dùng để đối soát trạng thái của gói tin truyền lên.
|
String
|
Bắt buộc
|
|
Error
|
Mã lỗi
|
String
|
Bắt buộc
|
|
ErrorDescription
|
Tiêu đề mã lỗi
|
String
|
Bắt buộc
|
|
ResponseCode
|
Mã phản hồi
|
String
|
Bắt buộc
|
|
ResponseDescription
|
Chi tiết phản
hồi
|
String
|
Bắt buộc
|
|
|
|
|
|
- Chi tiết dịch vụ:
Phương thức: POST
|
Địa chỉ kết nối
|
|
URL
|
[BaseUrl]/MoetService/TiepNhanGoiTin
|
|
Request
header
|
|
Content-Type
|
application/json
|
|
Authorization
|
Token {token}
(token sinh ra từ API lấy thông tin token phía trên)
|
|
Request Body
|
|
Body
|
{
"authenticationRequest":
{
"token":
"e5f2a7c7-1791-4d92-b240-d7ae416b54be",
"user_name":
"01",
"password":
"********",
"ma_don_vi":
"01004422",
"cap_hoc":
"02",
"nam_hoc":
2025,
"messageid":
"",
"type":
"THU_HOI_HOC_BA_SO",
"function":
"00"
},
"content":
"dsnsgjfdnajonjwewitrt23423jndsvj"
}
|
|
Response Body
|
|
Body
|
{
"Header":
{
"MessageId":
"e5f2a7c7-1791-4d92-b240-d7ae416b54be"
},
"Body":
{
"Result":
{
"Error":
"000-000",
"ErrorDescription":
"Không có lỗi",
"ResponseCode":
"000-101",
"ResponseDescription":
"Đang chờ xử lý",
"Items":
{
"Item":
[]
}
}
}
}
|
5.9.
Kiểm tra trạng thái xử lý thu hồi học bạ
Đặc tả dữ liệu đầu vào:
|
Tham số
|
Mô tả
|
Kiểu dữ liệu
|
Ràng buộc
|
|
Thông tin của
đơn vị giao dịch được bao trong object {authenticationRequest}. Chi tiết như
sau:
|
|
token
|
Đoạn mã bảo mật
để xác thực phiên giao dịch. Token trường
|
String
|
Bắt buộc
|
|
user_name
|
Thông tin tài
khoản của CSGD được cấp
|
String
|
Bắt buộc
|
|
password
|
Mật khẩu của
đơn vị (sử dụng hàm băm SHA256)
|
String
|
Bắt buộc
|
|
ma_don_vi
|
Mã đơn vị
chính là mã CSGD được cấp bởi Bộ GDĐT
|
String
|
Bắt buộc
|
|
nam_hoc
|
Năm học
|
Number
|
Bắt buộc
|
|
messageid
|
Message ID,
dùng để đối soát trạng thái của gói tin truyền lên.
Khi gửi 1 gói
tin mới lên sẽ để trống Message ID, API sẽ tự cấp Message ID.
|
String
|
Bắt buộc
|
|
type
|
Loại gói tin:
THU_HOI_HOC_BA_SO
|
String
|
Bắt buộc
|
|
function
|
Mã chức năng:
100
|
String
|
Bắt buộc
|
|
Thông tin dữ
liệu học bạ số được nén và đóng gói trong tham số “content”. Chi tiết như
sau:
|
|
content
|
API hỏi trạng
thái thì truyền content rỗng.
|
String
|
Bắt buộc
|
|
|
|
|
|
Đặc tả dữ liệu đầu ra:
Là danh sách trạng thái phê duyệt của từng học bạ số. Chi tiết như sau:
|
Tham số
|
Mô tả
|
Kiểu dữ liệu
|
Ràng buộc
|
|
ma_hoc_sinh
|
Mã học sinh
|
String
|
Bắt buộc
|
|
ten_hoc_sinh
|
Tên học sinh
|
String
|
Bắt buộc
|
|
so_cccd
|
Số căn cước
công dân
|
String
|
Bắt buộc
|
|
ma_dinh_danh_hoc_ba
|
Mã định danh
học bạ
|
String
|
Bắt buộc
|
|
trang_thai
|
Trạng thái
thu hồi học bạ
1 - Chờ xử lý
2 - Đồng ý
thu hồi
3 - Từ chối
thu hồi
|
Number
|
Bắt buộc
|
|
Error
|
Mã lỗi
|
String
|
Bắt buộc
|
|
error_field_title
|
Tiêu đề mã lỗi
|
String
|
Bắt buộc
|
|
error_description
|
Thông tin lỗi
|
String
|
Bắt buộc
|
|
|
|
|
|
- Chi tiết dịch vụ:
Phương thức: GET
|
Địa chỉ kết nối
|
|
URL
|
[BaseUrl]/MoetService/TiepNhanGoiTin
|
|
Request
header
|
|
Content-Type
|
application/json
|
|
Authorization
|
Token {token}
(token sinh ra từ API lấy thông tin token phía trên)
|
|
Request Body
|
|
Body
|
{
"authenticationRequest":
{
"token":
"e5f2a7c7-1791-4d92-b240-d7ae416b54be",
"user_name":
"01",
"password":
"********",
"ma_don_vi":
"01004422",
"cap_hoc":
"02",
"nam_hoc":
2025,
"messageid":
"",
"type":
"THU_HOI_HOC_BA_SO",
"function":
"100"
},
"content":
""
}
|
|
Response Body
|
|
Body
|
{
"Header":
{
"MessageId":
"e5f2a7c7-1791-4d92-b240-d7ae416b54be"
},
"Body":
{
"Result":
{
"Error":
"000-000",
"ErrorDescription":
"Không có lỗi",
"ResponseCode":
"000-102",
"ResponseDescription":
"Đã xử lý thành công",
"Items":
{
"Item":
[
{
"ma_hoc_sinh":
"0132102192",
"ten_hoc_sinh":
"Nguyễn Công Đăng",
"so_cccd":
null,
"ma_dinh_danh_hoc_ba":
"cf460298-d896-4860-9dde-2ade13f55be2",
"trang_thai":
"2",
"Error":
"000-000",
"error_field_title":
"",
"error_description":
"Không có lỗi"
}
]
}
}
}
}
|
5.10.
Danh mục dùng chung
5.10.1. Lấy
danh sách loại danh mục
- Đặc tả đầu vào API
|
Tham số
|
Mô tả
|
Kiểu dữ liệu
|
Ràng buộc
|
|
Thông tin của
đơn vị giao dịch được bao trong object {authenticationRequest}. Chi tiết như
sau:
|
|
token
|
Đoạn mã bảo mật
để xác thực phiên giao dịch. Token đối tác
|
String
|
Bắt buộc
|
|
|
|
|
|
- Đặc tả đầu ra API
|
Tham số
|
Kiểu dữ liệu
|
Kiểu dữ liệu
|
|
errorCode
|
string
|
Mã lỗi trả về
|
|
message
|
string
|
Mô tả chi tiết
|
|
status
|
string
|
Trạng thái trả
về
success
error
|
|
data
|
string
|
Danh sách chi
tiết
|
|
MA_DANH_MUC
|
string
|
Mã danh mục
|
|
TEN_DANH_MUC
|
string
|
Tên danh mục
|
|
|
|
|
- Chi tiết dịch vụ
- Phương thức: GET
|
Địa chỉ kết nối
|
|
URL
|
{base_url}/api/integration/declaration/v1/types
|
|
Request
header
|
|
Content-Type
|
application/json
|
|
Authorization
|
Token {token}
(token sinh ra từ API lấy thông tin token phía trên)
|
|
Request Body
|
|
Body
|
|
|
Response Body
|
|
Body
|
{
"errorCode":
0,
"status":
"success",
"message":
"Lấy danh sách danh mục thành công",
"data":
[
{
"MA_DANH_MUC":
"DM_MON_HOC",
"TEN_DANH_MUC":
"Danh mục môn học"
},
{
"MA_DANH_MUC":
"DM_CAP_HOC",
"TEN_DANH_MUC":
"Danh mục cấp học"
}
]
}
|
5.10.2. Lấy chi
tiết danh mục theo mã
- Đặc tả đầu vào API
|
Tham số
|
Mô tả
|
Kiểu dữ liệu
|
Ràng buộc
|
|
Thông tin của
đơn vị giao dịch được bao trong object {authenticationRequest}. Chi tiết như
sau:
|
|
token
|
Đoạn mã bảo mật
để xác thực phiên giao dịch. Token đối tác
|
String
|
Bắt buộc
|
|
MA_DANH_MUC
|
Mã danh mục cần
lấy dữ liệu
|
String
|
Bắt buộc
|
|
|
|
|
|
- Đặc tả đầu ra API
|
Tham số
|
Kiểu dữ liệu
|
Kiểu dữ liệu
|
|
errorCode
|
string
|
Mã lỗi trả về
|
|
status
|
string
|
Trạng thái trả
về
|
|
message
|
string
|
Mã lỗi chi tiết
|
|
itemsPerPage
|
string
|
Số bản ghi 1
trang
|
|
pageNo
|
string
|
Số trang
|
|
totalItems
|
string
|
Tổng số bản
ghi
|
|
data
|
string
|
Danh sách chi
tiết
|
|
MA
|
string
|
Mã chi tiết
danh mục
|
|
TEN
|
string
|
Tên chi tiết
danh mục
|
|
TRANG_THAI
|
Number
|
1: Hoạt động
0: Không hoạt
động
|
|
NGAY_CAP_NHAT
|
|
Ngày cập nhật
|
|
THU_TU
|
Number
|
Thứ tự hiển
thị
|
|
|
|
|
- Chi tiết dịch vụ
[BaseUrl]/api/integration/declaration/v1/types/{MA_DANH_MUC}?pageNo=1&itemsPerPage=20
Phương thức: GET
|
Địa chỉ kết nối
|
|
URL
|
[BaseUrl]/api/integration/declaration/v1/types/DM_CAP_HOC?pageN
o=1&itemsPerPage=20
|
|
Request
header
|
|
Content- Type
|
application/json
|
|
Authoriza
tion
|
Token {token}
(token sinh ra từ API lấy thông tin token phía trên)
|
|
Request Body
|
|
Body
|
|
|
Response Body
|
|
Body
|
{
"errorCode":
0,
"status":
"success",
"message":
"Lấy dữ liệu danh mục thành công",
"itemsPerPage":
20,
"pageNo":
1,
"totalItems":
"13",
"data":
[
{
"MA":
"02",
"NGAY_CAP_NHAT":
"2026-04-01T07:02:38Z",
"TEN":
"Tiểu học",
"THU_TU":
1,
"TRANG_THAI":
1
},
{
"MA":
"03",
"NGAY_CAP_NHAT":
"2026-04-01T07:02:38Z",
"TEN":
"Trung học cơ sở",
"THU_TU":
2,
"TRANG_THAI":
1
}
]
}
|