Giải pháp thực hiện

  1. TỔNG QUAN
    1. Mô tả nghiệp vụ
  • CSDL Dùng chung là nơi tập trung toàn bộ kho dữ liệu dùng chung của TPHCM. Cơ quan, tổ chức có thể thực hiện việc khai thác và đồng bộ dữ liệu về CSDL Dùng chung của Thành phố thông qua Nền tảng HCM LGSP.
  • Nền tảng HCM LGSP đảm nhiệm vai trò chính trong việc cung cấp các thông tin kết nối đến các phần mềm tại đơn vị, khai thác và đồng bộ dữ liệu từ CSDL tập trung của thành phố.
  • APICungCapThongTinHoSoTheoMaDinhDanh hỗ trợ phần mềm kết nối vào Nền tảng HCM LGSP lấy Thông tin hồ sơ chuẩn từ CSDL dùng chung của Thành phố.
  • Phần mềm của đơn vị gọi đến Nền tảng HCM LGSP thông qua api kèm theo access token.
  • Nền tảng HCM LGSP kiểm tra access token của đơn vị. Nếu thất bại sẽ trả về gói tin JSON lỗi cho phần mềm của đơn vị.
  • Nền tảng HCM LGSP xử lý dữ liệu và trả về gói tin JSON kết quả cho phần mềm đơn vị.
    1. Mục đích tài liệu
  • Tài liệu này nhằm hướng dẫn vai trò chính trong việc cung cấp các thông tin kết nối đến các phần mềm tại đơn vị, khai thác và đồng bộ dữ liệu từ CSDL tập trung của thành phố.
    1. Phạm vi và đối tượng áp dụng
  • Tài liệu này được sử dụng bởi các kỹ thuật viên của các đơn vị cần cung cấp thông tin hồ sơ về CSDL dùng chung của Thành phố.

 

 

  1. MÔ HÌNH KẾT NỐI
    1. Mô hình gói tin

 

Hình 1: Mô hình kết kết cung cấp thông tin hồ sơ

  • CSDL Dùng chung là nơi tập trung toàn bộ kho dữ liệu dùng chung của TPHCM. Cơ quan, tổ chức có thể thực hiện việc khai thác và đồng bộ dữ liệu về CSDL Dùng chung của Thành phố thông qua Nền tảng HCM LGSP.
  • Nền tảng HCM LGSP đảm nhiệm vai trò chính trong việc cung cấp các thông tin kết nối đến các phần mềm tại đơn vị, khai thác và đồng bộ dữ liệu từ CSDL tập trung của thành phố.
  • APICungCapThongTinHoSoTheoMaDinhDanh hỗ trợ phần mềm kết nối vào Nền tảng HCM LGSP lấy Thông tin hồ sơ chuẩn từ CSDL dùng chung của Thành phố
    1. Quá trình trao đổi gói tin

Hình 2: Quy trình trao đổi gói tin

                              

  • Phần mềm của đơn vị gọi đến Nền tảng HCM LGSP thông qua api kèm theo access token.
  • Nền tảng HCM LGSP kiểm tra access token của đơn vị. Nếu thất bại sẽ trả về gói tin JSON lỗi cho phần mềm của đơn vị.
  • Nền tảng HCM LGSP xử lý dữ liệu và trả về gói tin JSON kết quả cho phần mềm đơn vị.
  1. ĐẶC TẢ API TRA CỨU THÔNG TIN HỒ SƠ THEO MÃ ĐỊNH DANH
    1. Thông tin kết nối

Kiểu

Diễn giải

Ví dụ

Địa chỉ adapter Nền tảng HCM chính

Địa chỉ cổng dịch vụ dự kiến chính thức

https://hcmesb.tphcm.gov.vn

Địa chỉ adapter Nền tảng HCM thử nghiệm

Địa chỉ cổng dịch vụ thử nghiệm

https://hcmesb.tphcm.gov.vn/test

AccessKey

Khóa

rTkhYCBwHM

SecretKey

Khóa bí mật

DWkQgY1YSS

AppName

Đơn vị kết nối

TPHCM

Authorization/Token

Khai báo trong Header, Là chuỗi gồm 3 tham số dạng json được mã hóa thành StringBase64

eyJhcHAiOiJRTkkiLCJzZWNyZXQiOiJEV2tRZ1kxWVNTIiwia2V5IjoiclRraFlDQndITSJ9

được stringbase64 từ:

{

"AccessKey":"rTkhYCBwHM",

"SecretKey":"DWkQgY1YSS",

"AppName": "TPHCM"

}

Bảng 1: bảng thông tin kết nối

    1. API tra cứu thông tin hồ sơ theo mã định danh
  • Đường dẫn: /LayThongTinHoSoCaNhan
  • Method: GET
  • Đầu vào:
    • Header: Authorization
    • Parram:
      • MaDinhDanh=00.0H49.000001
      • PageSize=10
      • PageIndex=1
  • Đầu ra:
    • chuỗi json chứa thông tin trả về, resultObject là chuỗi string chứa json thông tin chi tiết hồ sơ, chi tiết dữ liệu tại mục 3.3

STT

Tham số

Thuộc tính tham số

Mô tả

1

StatusCode  

Int

Mã trạng thái gói tin

- 200: Request đã được tiếp nhận và xử lý thành công

- 400: Request bị lỗi hoặc không thể xử lý

- 404: Tài nguyên không tồn tại

- 500: Lỗi trong quá trình xử lý

2

Description

String

Nội dung lỗi trả về

3

ResultObject

JSON

Chuỗi string json trả về

4

ResultType

String

Type của gói tin trả về Mặc định là “JSON”

5

Status

String

Trạng thái gói tin“SUCCESS” hoặc “FAIL”

6

ThrowException

bool

 Có lỗi xảy ra hay không

Bảng 2: tham số trả về của chuỗi json

Ví dụ:

 

Thành công

Lỗi

{

    "StatusCode": 200,

    "Description": null,

    "ResultObject": "[{

           "BoSung": false,

                     "ChucDanh": "Nhân viên lập trình",

                     "ChucVuDuyet": "",

                     "DiaChi": {…},

                     "DiaChiTamTru": "",

                     "DiaChiThuongTru": "47/80/10 Trường Lưu …. ",

                     "DienThoai": "0359093780",

                     "DonViXuLy": "38.98.H29",

                     "Email": "",

                     "Fax": "",

                     "GhiChu": "",

                     "GiayToThuKems": [{…}],

"KetQuaGiaiQuyets": [{…}],

                     "GioiTinh": 0,

                     "HanXuLy": "16/09/2016 8:30:15",

                     "HinhThucTra": 0,

                     "HoSoBoSungs": null,

                     "LePhis": [{…}],

                     "LoaiDoiTuong": 1,

                     "MaDoiTuong": "00001",

                     "MaDonViC1": "38.98.H29",

                     "MaDonViC2": "",

                     "MaDonViC3": "",

                     "MaGiaoDich": "",

                     "MaHoSo": "SBN-0010",

                     "MaLinhVuc": "046",

                     "MaNguoiDaiDien": "NĐD-0001",

                      "MaNguoiTiepNhanHoSo": "NTN-0001",

                     "MaSoThue": "000000000",

                     "MaThuTuc": "046002",

                     "MaTrangThai": "SUBMITED",

                     "NgayBoSung": "",

                     "NgayCapCMND": "2009",

                     "NgayDuyet": "",

                     "NgayHenTra": "30/4/2019 22:08:32",

                      "NgayKetThucXuLy": "",

                     "NgaySinh": "1994",

                     "NgayThanhToan": "",

                     "NgayTiepNhan": "16/4/2019 22:08:32",

                     "NgayTra": "",

                      "NgayYeuCauThanhToan": "",

                     "NguoiDuyet": "",

                     "PhiDichVu": "0",

                     "SoCMND": "025127579",

                     "SoLuongDinhKem": 1,

                     "SoTaiKhoan": "",

                     "TenCoQuan": "",

                     "TenDonViC1": "Sở Du Lịch",

                     "TenDonViC2": "",

                     "TenDonViC3": "",

                     "TenLinhVuc": "Lữ hành",

                     "TenNguoiDaiDien": "Người đại diện test",

                      "TenNguoiTiepNhanHoSo": "Người tiếp nhận 1",

                     "TenThuTuc": "Thủ tục cấp thẻ hướng dẫn viên du lịch quốc tế",

                     "TepDinhKems": [{…}],

                      "ThongTinChuyenPhat": {…},

                     "ThongTinDuyet": "",

                     "ThongTinKhac": "",

                      "ThongTinTacNghiep": null,

                     "ThongTinTra": "",

                     "Ticket": "38.98.H292019046046002010",

                     "TrangThaiDuyet": false,

                     "TrangThaiTra": false,

                     "TrangThaiXuLy": 1,

                     "TrichYeuHoSo": "",

                     "Version": "v1.0",

                     "Website": "",

                     "TotalCount": 20

}]",

    "ResultType": "JSON",

    "Status": "SUCCESS",

    "ThrowException": false

}

{

    "StatusCode": 500,

    "Description": "Tham số đầu vào không đúng",

    "ResultObject": null,

    "ResultType": null,

    "Status": "FAIL",

    "ThrowException": true

}

         

 

    1. Gói tin thông tin hồ sơ

STT

Tên trường

Định Dạng

Mô tả

Yêu cầu

1

MaThuTuc

String

Mã thủ tục hành chính trong hệ thống Cơ sở dữ liệu về Thủ tục hành chính của thành phố

Bắt buộc

2

TenThuTuc

String

Tên loại thủ tục.

Bắt buộc

3

MaLinhVuc

String

Mã lĩnh vực trong hệ thống Cơ sở dữ liệu về Thủ tục hành chính của thành phố

Bắt buộc

4

TenLinhVuc

String

Tên loại lĩnh vực

Bắt buộc

5

MaHoSo

String

Lấy hoặc thiết lập Mã hồ sơ đã được đơn vị thụ lý đồng ý tiếp nhận.

Bắt buộc

6

MaNguoiDaiDien

String

Số định danh của người đại diện

Bắt buộc

7

TenNguoiDaiDien

String

Tên người đại diện đăng ký hồ sơ một cửa.

Bắt buộc

8

NgaySinh

String

Ngày sinh người đại diện
Kiểu Date: dd/MM/yyyy
Ví dụ: 22/12/1980

Không bắt buộc

9

GioiTinh

Int

Giới tính người đại diện

Không bắt buộc

10

SoCMND

String

Chứng minh nhân dân hoặc hộ chiếu người đại diện

Không bắt buộc

11

NgayCapCMND

String

Ngày cấp CMND
Kiểu Date: dd/MM/yyyy
Ví dụ: 15/10/2000

Không bắt buộc

12

DiaChiTamTru

String

Địa chỉ tạm trú

Không bắt buộc

13

DiaChiThuongTru

String

Địa chỉ thường trú

Không bắt buộc

14

ChucDanh

String

Chức danh

Không bắt buộc

15

TenCoQuan

String

Tên cơ quan

Bắt buộc đối với doanh nghiệp

16

MaSoThue

String

Mã số thuế

Không bắt buộc

17

DienThoai

String

Điện thoại

Bắt buộc

18

Email

String

Email

Không bắt buộc

19

Website

String

Website

Không bắt buộc

20

Fax

String

Fax

Không bắt buộc

21

ThongTinKhac

String

Thông tin khác.

Không bắt buộc

22

MaDoiTuong

String

Mã đối tượng nộp hồ sơ.

Bắt buộc

23

LoaiDoiTuong

Int

Kiểu đối tượng nộp hồ sơ:

- 1: Người dân;

- 2: Doanh nghiệp;

- 3: Cơ quan nhà nước;

- 4: Tổ chức khác.

Bắt buộc

24

DiaChi

JSON Object

JSON địa chỉ tại mục 3.10

Không bắt buộc

25

TrichYeuHoSo

String

Trích yếu hồ sơ một cửa.

Không bắt buộc

26

MaNguoiTiepNhanHoSo

String

Mã người tiếp nhận hồ sơ

Không bắt buộc

27

TenNguoiTiepNhanHoSo

String

Tên người tiếp nhận hồ sơ

Không bắt buộc

28

NgayTiepNhan

String

Ngày tiếp nhận hồ sơ
Kiểu Date: dd/MM/yyyy hh:mm:ss
Ví dụ: 16/09/2016 15:30:16

Bắt buộc

29

NgayHenTra

String

Ngày hẹn trả hồ sơ
Kiểu Date: dd/MM/yyyy hh:mm:ss
Ví dụ: 16/09/2016 15:30:16

Bắt buộc

30

HanXuLy

String

Hạn xử lý của trạng thái hiện tại
Kiểu Date: dd/MM/yyyy hh:mm:ss
Ví dụ: 16/09/2016 15:30:16

 

31

TrangThaiDuyet

Boolean

Trạng thái xử lý cuối cùng của hồ sơ.

- True: Đã duyệt;

- False: Không duyệt;

- Null: Chưa duyệt kết quả.

Bắt buộc

32

NgayDuyet

Kiểu date

Ngày duyệt hồ sơ
Kiểu Date: dd/MM/yyyy hh:mm:ss
Ví dụ: 16/09/2016 15:30:16

NgayDuyet = NULL khi TrangThaiDuyet = NULL

Bắt buộc khi TrangThaiDuyet khác Null

33

NguoiDuyet

String

Người duyệt hồ sơ.

Không bắt buộc

34

ChucVuDuyet

String

Chức vụ của người duyệt hồ sơ.

Không bắt buộc

35

ThongTinDuyet

String

Thông tin Duyệt hồ sơ

Ví dụ: lý do không duyệt.

Không bắt buộc

36

TrangThaiTra

Boolean

Tập trạng thái đã trả kết quả hồ sơ:

- True: Đã trả kết quả;

- False: Chưa trả kết quả;

- Null: Không trả kết quả.

Bắt buộc

37

NgayTra

Kiểu date

Ngày trả kết quả hồ sơ cho công dân, tổ chức.
Kiểu Date: dd/MM/yyyy hh:mm:ss
Ví dụ: 16/09/2016 15:30:16

NgayTra = NULL khi TrangThaiTra = NULL

Bắt buộc khi TrangThaiTra khác Null

38

ThongTinTra

String

Thông tin trả kết quả

Ví dụ: Ông bà Nguyễn Văn A đã nhận kết quả hồ sơ (0987987894).

Không bắt buộc

39

HinhThucTra

Int

Hình thức trả kết quả:

0 - Trả kết quả tại bộ phận tiếp nhận và trả kết quả;

1 - Trả kết quả qua đường bưu điện.

Bắt buộc

40

NgayKetThucXuLy

Kiểu date

Ngày kết thúc xử lý hồ sơ.
Kiểu Date: dd/MM/yyyy hh:mm:ss
Ví dụ: 16/09/2016 15:30:16

Không bắt buộc

41

TrangThaiXuLy

Int

Trạng thái xử lý hồ sơ một cửa:

- 0: Hồ sơ đã được tiếp nhận:

- 1: Hồ sơ đang xử lý;

- 2: Hồ sơ đã có kết quả.

Bắt buộc

42

DonViXuLy

String

Tên đơn vị thụ lý hồ sơ một cửa.

Bắt buộc

43

BoSung

Boolean

Trạng thái hồ sơ đang có yêu cầu bổ sung hay không:

- True: Có yêu cầu bổ sung;

- False: Không có yêu cầu bổ sung.

Không bắt buộc

44

NgayBoSung

Kiểu date

Lấy hoặc thiết lập ngày yêu cầu bổ sung.

Không bắt buộc

45

GhiChu

String

Ghi chú thông tin khác.

Không bắt buộc

46

SoLuongDinhKem

Int

Số lượng tệp đính kèm

Bắt buộc.

47

TepDinhKems

JSON Array

Json danh sách tệp đính kèm tại mục 3.5

Không bắt buộc

48

KetQuaGiaiQuyets

JSON Array

Json danh sách tệp đính kèm tại mục 3.5

Không bắt buộc

49

LePhis

JSON Array

Json danh sách lệ phí tại mục 3.6

Không bắt buộc

50

GiayToThuKems

JSON Array

Json danh sách giấy tờ thu kèm theo hồ sơ một cửa tại mục 3.7

Không bắt buộc

51

HoSoBoSungs

JSON Array

Danh sách các yêu cầu bổ sung hồ sơ.

Không bắt buộc

52

PhiDichVu

String

Phí dịch vụ công

Bắt buộc khi trạng thái là:

PAYMENT_REQUEST

53

NgayYeuCauThanhToan

String

Ngày thanh toán thành công
Kiểu Date: dd/MM/yyyy hh:mm:ss
Ví dụ: 16/09/2016 15:30:16

Bắt buộc khi trạng thái là: PAYMENT_REQUEST

54

NgayThanhToan

String

Ngày yêu cầu thanh toán
Kiểu Date: dd/MM/yyyy hh:mm:ss
Ví dụ: 16/09/2016 15:30:16

Bắt buộc khi trạng thái là: PAID

55

MaGiaoDich

String

Mã giao dịch

Bắt buộc khi trạng thái là: PAID

56

SoTaiKhoan

String

Số tài khoản

Bắt buộc khi trạng thái là: PAID

57

ThongTinChuyenPhat

JSON

JSON Thông tin chuyển phát bưu điện tại mục 3.4

Không bắt buộc

58

ThongTinTacNghiep

JSON

JSON chứa dữ liệu tác nghiệp
Cấu trúc và dữ liệu được quy định bởi các đơn vị tham gia trao đổi gói tin với nhau

Không bắt buộc

59

MaTrangThai

String

Mã trạng thái xử lý của hồ sơ
Ví dụ: VERIFIED

Bắt buộc

60

Ticket

String

Mã định danh của hồ sơ nộp qua mạng. Dùng để xác định hồ sơ qua mạng khi trao đổi thông tin giữa các phần mềm với nhau.

Hồ sơ phát sinh từ phần mềm nào thì phần mềm đó sinh một mã định danh  duy nhất trong phần mềm đó để trao đổi qua mạng.

Phần mềm nên đặt ticket theo cấu trúc sau:[Mã đơn vị] [Năm nhận hồ sơ][Mã lĩnh vực][Mã thủ tục][Số thứ tự hồ sơ]

Bắt buộc

61

MaDonViC1

String

- Mã cấp I của cơ quan, tổ chức là đầu mối (Bộ, tỉnh...) kết nối với Cổng DVCQG

- Đối với các Bộ, tỉnh: sử dụng mã cấp 1 theo QCVN 102:2016/BTTTT.

Bắt buộc

62

TenDonViC1

String

Tên cơ quan, tổ chức là đầu mối kết nối với Cổng DVCQG (Bộ, tỉnh).

Bắt buộc

63

MaDonViC2

String

- Mã cấp II của cơ quan, tổ chức là các sở, ngành, quận, huyện của TpHCM

 

Bắt buộc

64

TenDonViC2

String

Tên cơ quan, tổ chức là các sở, ngành, quận, huyện của TpHCM.

Bắt buộc

65

MaDonViC3

String

- Mã cấp III của cơ quan, tổ chức là các UBND phường, xã của TpHCM

Bắt buộc

66

TenDonViC3

String

Tên cơ quan, tổ chức là các UBND phường xã của TpHCM.

Bắt buộc

67

Version

String

Phiên bản của chuẩn gói tin

Bắt buộc

68

TotalCount

Int

Tổng số hồ sơ tìm được

Bắt buộc

Bảng 3: Gói thông tin hồ sơ

Ví dụ:

{

           "BoSung": false,

                     "ChucDanh": "Nhân viên lập trình",

                     "ChucVuDuyet": "",

                     "DiaChi": {…},

                     "DiaChiTamTru": "",

                     "DiaChiThuongTru": "47/80/10 …",

                     "DienThoai": "0359093780",

                     "DonViXuLy": "38.98.H29",

                     "Email": "",

                     "Fax": "",

                     "GhiChu": "",

                     "GiayToThuKems": [{…}],

"KetQuaGiaiQuyets": [{…}],

                     "GioiTinh": 0,

                     "HanXuLy": "16/09/2016 8:30:15",

                     "HinhThucTra": 0,

                     "HoSoBoSungs": null,

                     "LePhis": [{…}],

                     "LoaiDoiTuong": 1,

                     "MaDoiTuong": "00001",

                     "MaDonViC1": "38.98.H29",

                     "MaDonViC2": "",

                     "MaDonViC3": "",

                     "MaGiaoDich": "",

                     "MaHoSo": "SBN-0010",

                     "MaLinhVuc": "046",

                     "MaNguoiDaiDien": "NĐD-0001",

                     "MaNguoiTiepNhanHoSo": "NTN-0001",

                     "MaSoThue": "000000000",

                     "MaThuTuc": "046002",

                     "MaTrangThai": "SUBMITED",

                     "NgayBoSung": "",

                     "NgayCapCMND": "2009",

                     "NgayDuyet": "",

                     "NgayHenTra": "30/4/2019 22:08:32",

                     "NgayKetThucXuLy": "",

                     "NgaySinh": "1994",

                     "NgayThanhToan": "",

                     "NgayTiepNhan": "16/4/2019 22:08:32",

                     "NgayTra": "",

                     "NgayYeuCauThanhToan": "",

                     "NguoiDuyet": "",

                     "PhiDichVu": "0",

                     "SoCMND": "025127579",

                     "SoLuongDinhKem": 1,

                     "SoTaiKhoan": "",

                     "TenCoQuan": "…",

                     "TenDonViC1": "Sở Du Lịch",

                     "TenDonViC2": "",

                     "TenDonViC3": "",

                     "TenLinhVuc": "Lữ hành",

                     "TenNguoiDaiDien": "Người đại diện test",

                     "TenNguoiTiepNhanHoSo": "Người tiếp nhận 1",

                     "TenThuTuc": "Thủ tục cấp thẻ hướng dẫn viên du lịch quốc tế",

                     "TepDinhKems": [{…}],

                     "ThongTinChuyenPhat": {…},

                     "ThongTinDuyet": "",

                     "ThongTinKhac": "",

                     "ThongTinTacNghiep": null,

                     "ThongTinTra": "",

                     "Ticket": "38.98.H292019046046002010",

                     "TrangThaiDuyet": false,

                     "TrangThaiTra": false,

                     "TrangThaiXuLy": 1,

                     "TrichYeuHoSo": "",

                     "Version": "v1.0",

                     "Website": "",

                      "TotalCount": 20

 }

 

    1. Gói tin thông tin chuyển phát

STT

Tên trường

Định Dạng

Mô tả

Yêu cầu

1

MaDonVi

String

ID của cơ quan, tổ chức

Bắt buộc

2

LoaiDichVu

String

Tên Loại DV: (a) nhận HS tại nhà chuyển cho CQ HCC hay (b) trả KQ của CQ HCC cho người dân. (c) Nhận HS Tại nhà - chuyển trả KQ

Bắt buộc

4

NguoiLH

String

Người liên hệ để nhân viên bưu điện liên hệ nhận hồ sơ đi nộp giúp

Bắt buộc

5

DienThoaiLH

String

Số điện thoại để nhân viên bưu điện liên hệ nhận hồ sơ đi nộp giúp

Bắt buộc

6

DiaChiLH

JSON Object

JSON địa chỉ tại mục 3.10
Địa chỉ để nhân viên bưu điện đến liên hệ nhận hồ sơ đi nộp giúp

Bắt buộc

7

GhiChu

String

Ghi chú, Ghi nội dung hàng cần gửi, mô tả các yêu cầu nhận gửi, nhận

Không bắt buộc

8

NguoiNhans

JSONArray

Json danh sách người nhận tại mục 3.11
Độ ưu tiên theo số được chỉ định ưu tiên từ nhỏ đến lớn (Mặc định là số 1 người nhận chính)

Bắt buộc

1

MaDonVi

String

ID của cơ quan, tổ chức

Bắt buộc

Bảng 4: Gói tin thông tin chuyển phát

Ví dụ:

{

  "MaDonVi": "ĐVCP0001",

  "LoaiDichVu": "Nhận HS Tại nhà - chuyển trả KQ",

  "NguoiLH": "Nguyễn Nghiêm Thuận",

  "DienThoaiLH": "00000000",

  "DiaChiLH": {..},

  "GhiChu": "",

  "NguoiNhans": [{…}]

}

 

    1. Gói tin tệp đính kèm

STT

Tên trường

Định Dạng

Mô tả

Yêu cầu

1

TenTepDinhKem

String

Tên file đính kèm.

Bắt buộc

2

MaHoSoKemTheo

String

Mã hồ sơ kèm theo

Không bắt buộc

3

MaHoSo

String

Mã hồ sơ

Bắt buộc

4

FileID

String

Mã tệp đính kèm trên hệ thống DIP.

Bắt buộc

5

XacThuc

Boolean

Các tệp (thành phần hồ sơ) đính kèm gắn liền với hồ sơ của người sử dụng đã được xác thực.

Bắt buộc

6

MoTa

String

Mô tả tệp đính kèm

Không bắt buộc

7

DinhDang

String

Định dạng file

(Theo chuẩn MIME Types)

Bắt buộc

Bảng 5: Gói tin tệp đính kèm

 

Ví dụ:

{

  "TenTepDinhKem": "DonDangKy.doc",

  "DinhDang": "application/msword",

  "MaHoSo":"SBN-0010",

  "XacThuc":false,

  "MaHoSoKemTheo":"SBN-0010-hskt001",

  "MoTa":"Hồ sơ đính kèm đơn đăng ký",

  "FileID":"0001",

}

 

 

    1. Gói tin lệ phí

STT

Tên trường

Định Dạng

Mô tả

Yêu cầu

1

TenLePhi

String

Tên Lệ phí.

Bắt buộc

2

Gia

Decimal

Số tiền thu.

Bắt buộc

3

LoaiLePhi

Int

Loại Lệ phí thu:

- 1: Lệ phí thu khi tiếp nhận hồ sơ;

- 2: Lệ phí thu khi bổ sung hồ sơ;

- 4: Lệ phí thu khi trả kết quả.

Bắt buộc

Bảng 6: Gói tin lệ phí

Ví dụ:

{

                    "Gia": 1000000,

                    "LoaiLePhi": 1,

                    "TenLePhi": "Lệ phí hồ sơ"

 }

 

    1. Gói tin giấy tờ thu kèm

STT

Tên trường

Định Dạng

Mô tả

Yêu cầu

1

TenGiayTo

String

Tên giấy tờ.

Bắt buộc

2

SoLuong

Int

Số lượng.

Bắt buộc

3

LoaiGiayTo

Int

Loại giấy tờ thu:

- 1: Giấy tờ thu khi tiếp nhận hồ sơ;

- 2: Giấy tờ thu khi bổ sung hồ sơ;

- 4: Giấy tờ thu khi trả kết quả.

Bắt buộc

Bảng 7: Gói tin giấy tờ thu kèm

Ví dụ:

{

                    "SoLuong": 1,

                    "LoaiGiayTo": 1,

                    "TenGiayTo": "Bản sao CMND"

 }

 

 

    1. Gói tin hồ sơ bổ sung

STT

Tên trường

Định Dạng

Mô tả

Yêu cầu

1

HoSoBoSungID

Int

Id của Yêu cầu bổ sung trong hệ thống Cơ quan thụ lý.

Bắt buộc

2

NguoiYeuCauBoSung

String

Người gửi yêu cầu bổ sung.

Bắt buộc

3

NoiDungBoSung

String

Nội dung yêu cầu bổ sung.

Bắt buộc

4

NguoiYeuCauBoSung

String

Ngày gửi yêu cầu bổ sung.
Kiểu Date: dd/MM/yyyy hh:mm:ss
Ví dụ: 16/09/2016 15:30:16

Bắt buộc

5

NgayTiepNhanBoSung

String

Người tiếp nhận Bổ sung hồ sơ từ công dân.

Không bắt buộc

6

ThongTinTiepNhan

String

Thông tin tiếp nhận. Ví dụ: Ông Nguyễn Văn A đã bổ sung đầy đủ ...

Không bắt buộc

7

NguoiTiepNhanBoSung

String

Ngày tiếp nhận bổ sung hồ sơ.
Kiểu Date: dd/MM/yyyy hh:mm:ss
Ví dụ: 16/09/2016 15:30:16

Bắt buộc

8

TrangThaiBoSung

Boolean

Trạng thái bổ sung hồ sơ:

- True: Công dân đã bổ sung đầy đủ thủ tục hồ sơ;

- False: Công dân không bổ sung hồ sơ (quá hạn bổ sung);

- Null: Công dân chưa tới bổ sung hồ sơ (còn hạn).

Bắt buộc

9

LePhiBoSungs

JSON Array

Json danh sách lệ phí tại mục 3.6

Không bắt buộc

10

GiayToBoSungs

JSON Array

Json danh sách giấy tờ thu kèm theo hồ sơ một cửa tại mục 3.7

Không bắt buộc

11

NgayHenTraTruoc

String

Ngày hẹn trả trước khi bổ sung.
Kiểu Date: dd/MM/yyyy hh:mm:ss
Ví dụ: 16/09/2016 15:30:16

Bắt buộc

12

NgayHenTraMoi

String

Ngày hẹn trả mới sau khi bổ sung hồ sơ.
Kiểu Date: dd/MM/yyyy hh:mm:ss
Ví dụ: 16/09/2016 15:30:16

Không bắt buộc

13

SoLuongDinhKem

Int

Số lượng file đính kèm bổ sung

Không bắt buộc

14

TepDinhKemBoSungs

JSON Array

Json danh sách tệp đính kèm tại mục 3.9

Không bắt buộc

Bảng 8: Gói tin hồ sơ bổ sung

 

Ví dụ:

{

                    "HoSoBoSungID ": 100,

                    "NguoiYeuCauBoSung": "Nguyễn Văn A",

                    "NoiDungBoSung": "Bổ sung bản sao CMND",

                    "NgayBoSung": "16/09/2016 15:30:16",

                    "NguoiTiepNhanBoSung": "Nguyễn Văn A",

                    "ThongTinTiepNhan": "Ông Nguyễn Văn A  đã bổ sung hồ sơ đầy đủ",

                    "NgayTiepNhanBoSung": "16/09/2016 15:30:16",

                    "TrangThaiBoSung": true

                    "NgayHenTraTruoc": "16/09/2016 15:30:16",

                    "NgayHenTraMoi": "16/09/2016 15:30:16",

         "LePhiBoSungs": [{…}],    

         "GiayToBoSungs": [{…}],

         "SoLuongDinhKem": 2,

         "TepDinhKemBoSungs": [{…}],

 }

 

    1. Gói tin tệp đính kèm của hồ sơ bổ sung

STT

Tên trường

Định Dạng

Mô tả

Yêu cầu

1

TenTepDinhKem

String

Tên file đính kèm.

Bắt buộc

2

MaHoSoKemTheo

String

Mã hồ sơ kèm theo

Không bắt buộc

3

MaHoSo

String

Mã hồ sơ

Bắt buộc

4

FileID

String

Mã tệp đính kèm trên hệ thống DIP.

Bắt buộc

5

XacThuc

Boolean

Các tệp (thành phần hồ sơ) đính kèm gắn liền với hồ sơ của người sử dụng đã được xác thực.

Bắt buộc

6

MoTa

String

Mô tả tệp đính kèm

Không bắt buộc

7

BoSungID

String

Mã hồ sơ bổ sung tại phần mềm một cửa

Bắt buộc

8

DinhDang

String

Định dạng file

(Theo chuẩn MIME Types)

Bắt buộc

Bảng 9: Gói tin tệp đính kèm của hồ sơ bổ sung

Ví dụ:

{

  "TenTepDinhKem": "DonDangKy.doc",

  "DinhDang": "application/msword",

  "MoTa": "",

  "MaHoSo":"SBN-0010",

  "XacThuc":false,

  "MaHoSoKemTheo":"SBN-0010-hskt001",

  "MoTa":"Hồ sơ đính kèm đơn đăng ký",

  "FileID":"0001",

  "BoSungID":"0001",

}

 

    1. Gói tin địa chỉ

STT

Tên trường

Định Dạng

Mô tả

Yêu cầu

1

MaThanhPho

String

Mã thành phố

Bắt buộc

2

TenThanhPho

String

Tên thành phố

 

3

MaQuanHuyen

String

Mã quận huyện

Bắt buộc

4

TenQuanHuyen

String

Tên quận huyện

 

5

MaPhuongXa

String

Mã phường

Bắt buộc

6

TenPhuongXa

String

Tên phường

 

7

DiaChi

String

Số nhà và tên đường

Bắt buộc

8

TenDuong

String

Tên đường

Không bắt buộc

9

KhuPho

String

Khu phố

Không bắt buộc

10

SoNha

String

Số nhà

Không bắt buộc

11

Tang

String

Tầng

Không bắt buộc

12

Phong

String

Phòng

Không bắt buộc

Bảng 10: Gói tin địa chỉ

Ví dụ:

{

  "MaThanhPho": "",

  "TenThanhPho": "",

  "MaQuanHuyen": "",

  "TenQuanHuyen": "",

  "MaPhuongXa": "",

  "TenPhuongXa": "",

  "DiaChi": "",

  "TenDuong": "",

  "KhuPho": "",

  "SoNha": "",

  "Tang": "",

  "Phong": ""

}

 

    1. Gói tin người nhận

STT

Tên trường

Định Dạng

Mô tả

Yêu cầu

1

ChiDinh

Int

Độ ưu tiên theo số được chỉ định ưu tiên từ nhỏ đến lớn (Mặc định là số 1 người nhận chính)

Bắt buộc

2

NguoiNhan

String

Họ tên người nhận hồ sơ gửi đến

Bắt buộc

3

DiaChiNhan

JSON Object

JSON địa chỉ tại mục 3.10
Địa chỉ được hồ sơ gửi đến

Bắt buộc

4

DienThoaiNhan

String

Số điện thoại người nhận được hồ sơ gửi đến

Không bắt buộc

5

EmailNhan

String

Email người nhận được hồ sơ gửi đến

Không bắt buộc

Bảng 11: Gói tin người nhận

Ví dụ:

{

  "ChiDinh": 0,

  "NguoiNhan": "Nguyễn Văn A",

  "DiaChiNhan": {…}

  "DienThoaiNhan": "0359093780",

  "EmailNhan": ""

}

 

Danh sách tệp tin đính kèm

  • 22.DacTaLienThong_APICungCapThongTinHoSoTheoMaDinhDanh_v1.1.docx

API Cung cấp thông tin hồ sơ theo mã định danh

Câu hỏi thường gặp

CHÚNG TÔI LUÔN SẴN
SÀNG ĐỂ GIÚP ĐỠ BẠN

Hỗ trợ trực tuyến

Để được hỗ trợ tốt nhất. Hãy gọi

028 38233717 - 111
HOẶC
0889490111

SỞ THÔNG TIN VÀ TRUYỀN THÔNG TPHCM

LIÊN KẾT WEBSITE

KẾT NỐI VỚI CHÚNG TÔI

  • chinh-se-tren-gm
  • chinh-se-tren-fb
  • chinh-se-mes-tren-fb
  • chinh-se-tren-gg
  • chinh-se-tren-tw
Giấy phép số 91/GP-TTĐT, do Cục Phát thanh, Truyền hình và Thông tin điện tử - Bộ Thông tin và Truyền thông cấp ngày 26/04/2018