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

Thành công

Lỗi

{

    "StatusCode": 200,

    "Description": null,

    "ResultObject": [{

           "HoSoMotCuaID": "HSMC-00001",

           "MaHoSo": "SBN-0010",

           "NguoiXuLy": "Nguyễn Văn Thảo",

           "PhongBanNguoiXuLy": "Phòng ban 01",

           "ChucVuNguoiXuLy": "Chuyên viên",

           "NgayXuLy": "15/09/2016 15:30:15",

           "NgayHenTra": "20/09/2016 15:30:15",

           "NoiDungXuLy": "Thẩm định hồ sơ",

           "NgayKetThucTTTruoc": "15/09/2016 15:30:15",

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

           "MaTrangThaiHoSo": " SUBMITED12345",

           "TrangThaiHoSo": "SUBMITED",

           "MaDonViC1": "38.98.H29",

           "TenDonViC1": "Sở Du lịch TP.HCM",

           "MaDonViC2": null,

           "TenDonViC2": null,

           "MaDonViC3": null,

           "TenDonViC3": null,

           "Version": "v1.0",

      "Ticket":"38.98.H292019046046002010"

}],

    "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

}

STT

Tên trường

Định Dạng

Mô tả

Yêu cầu

1

HoSoMotCuaID

String

Mã định danh của hồ sơ tại phần mềm một cửa

Bắt buộc

2

MaTrangThaiHoSo

String

Mã của gói tin trạng thái. Phần mềm tự phát sinh duy nhất trong một hồ sơ

Bắt buộc

3

TrangThaiHoSo

String

Mã trạng thái xử lý của hồ sơ. Tham khảo Error! Reference source not found.

Ví dụ: SUBMITED

Bắt buộc

4

NgayKetThucTTTruoc

String
 

Ngày kết thúc của trạng thái trước

Đinh dạng: dd/mm/yyyy hh:mm:ss
Ví du: 15/09/2016 15:30:15

Bắt buộc

5

NgayXuLy

String

Ngày bắt đầu xử lý trạng thái hiện tại

Đinh dạng: dd/mm/yyyy hh:mm:ss
Ví du: 15/09/2016 15:30:15

Bắt buộc

6

HanXuLy

String

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

Không bắt buộc

7

MaNguoiXuLy

String

Mã chuyên viên đang xử lý hồ sơ

Bắt buộc

8

TenNguoiXuLy

String

Họ và tên chuyên viên đang xử lý hồ sơ

Bắt buộc

9

PhongBanNguoiXuLy

String

Phòng ban của chuyên viên đang xử lý hồ sơ

Bắt buộc

10

ChucVuNguoiXuLy

String

Chức vụ của chuyên viên đang xử lý hồ sơ

Bắt buộc

11

NoiDungXuLy

String

Mô tả nội dung xử lý

Không bắt buộc

12

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 khi trạng thái là:  VERIFIED

13

MaHoSo

String

Mã hồ sơ

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

14

PhiDichVu

String

Phí dịch vụ công

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

PAYMENT_REQUEST

15

NgayThanhToan

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à: PAID

16

MaGiaoDich

String

Mã giao dịch

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

17

SoTaiKhoan

String

Số tài khoản

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

18

NgayYeuCauThanhToan

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à:

PAYMENT_REQUEST

19

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

20

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

21

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

22

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

23

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

24

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

25

TenDonViC3

String

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

Bắt buộc

26

Version

String

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

Bắt buộc

{

  "HoSoMotCuaID": "HSMC-00001",

  "MaHoSo": "SBN-0010",

  "NguoiXuLy": "Nguyễn Văn Thảo",

  "PhongBanNguoiXuLy": "Phòng ban 01",

  "ChucVuNguoiXuLy": "Chuyên viên",

  "NgayXuLy": "15/09/2016 15:30:15",

  "NgayHenTra": "20/09/2016 15:30:15",

  "NoiDungXuLy": "Thẩm định hồ sơ",

  "NgayKetThucTTTruoc": "15/09/2016 15:30:15",

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

  "MaTrangThaiHoSo": " SUBMITED12345",

  "TrangThaiHoSo": "SUBMITED",

  "MaDonViC1": "38.98.H29",

  "TenDonViC1": "Sở Du lịch TP.HCM",

  "MaDonViC2": null,

  "TenDonViC2": null,

  "MaDonViC3": null,

  "TenDonViC3": null,

  "Version": "v1.0",

  "Ticket":"38.98.H292019046046002010"

}