Toanph 21/05/2020

Tư pháp hộ tịch#

1. API Đăng ký hộ tịch#

1. Request Header

URL: ***/api/HoTichTuPhap/GuiHoSo
Method:: POST
Authorization: Bearer 'token'
Content-Type: application/json

2. Request body

{
    "maDonVi": "Mã đơn vị tiếp nhận hồ sơ theo tổng cục thống kê", // Interger
    "maNghiepVu": "Mã nghiệp vụ tham khảo bên dưới", // String
    "maHoSo": "Số phiếu tiếp nhận của hồ sơ trên Hệ thống thông tin một cửa điện tử.", // String
    "ngayTiepNhan": "Ngày tiếp nhận hồ sơ. VD: 15/05/2020", // String
    "data":  // Dữ liệu gói tin như: Khai sinh, khải tử....
        "<?xmlversion='1.0'encoding='utf-8'?><hotich><hoso><so>2</so><quyenSo>01/2020</quyenSo><trangSo>1</trangSo><ngayDangKy>04.11.2020</ngayDangKy><loaiDangKy>1</loaiDangKy><noiDangKy>19</noiDangKy><nguoiKy></nguoiKy><ghiChu></ghiChu><nksHoTen>TRONG 123 CON</nksHoTen><nksGioiTinh>1</nksGioiTinh><nksNgaySinh>04.11.2020</nksNgaySinh><nksNgaySinhBangChu>Ngày mùng bốn, tháng mười một, năm hai nghìn không trăm hai mươi</nksNgaySinhBangChu><nksDanToc>63001</nksDanToc><nksQuocTich>VN</nksQuocTich><nksQueQuan></nksQueQuan><meHoTen>VO TRONG</meHoTen><meNgaySinh>01.01.1998</meNgaySinh><meDanToc>63001</meDanToc><meQuocTich>VN</meQuocTich><meLoaiCuTru>1</meLoaiCuTru><meNoiCuTru></meNoiCuTru><chaHoTen>TRONG</chaHoTen><chaNgaySinh>01.01.1996</chaNgaySinh><chaDanToc>63001</chaDanToc><chaQuocTich>VN</chaQuocTich><chaLoaiCuTru>1</chaLoaiCuTru><chaNoiCuTru></chaNoiCuTru><nycHoTen>Đinh hoàng điệp 123</nycHoTen><nycQuanHe></nycQuanHe><nycSoGiayToTuyThan></nycSoGiayToTuyThan></hoso></hotich>"
}

Mã nghiệp vụ (Tham khảo)
Mã gói tin Khai sinh, khai tử... (tham khảo)

3. Response body

{  
"code": "Mã trạng thái HTTP trả về", 
"status": "Mã trạng thái xử lý trả về", 
"correlationId": "Mã correlationId dành cho người lập trình trong quá trình kiểm tra kết nối",
"response": "Chuỗi Json kết quả dữ liệu được trả về từ hệ thống " 
}

Mã trạng thái HTTP Tham khảo
Mã trạng thái xử lý:
- 1: thành công;
- 0: thất bại

2. API tra cứu trạng thái xử lý hồ sơ#

1. Request Header

URL: ***/api/HoTichTuPhap/LayTrangThaiHoSo
Method:: GET
Authorization: Bearer 'token'
Content-Type: application/json

2. Request body

{
    "maDonVi": "Mã đơn vị tiếp nhận hồ sơ theo tổng cục thống kê",
    "maHoSo": "Mã hồ sơ lưu trong phần mềm một cửa"
}

3. Response body

{  
"code": "Mã trạng thái HTTP trả về", 
"status": "Mã trạng thái xử lý trả về", 
"correlationId": "Mã correlationId dành cho người lập trình trong quá trình kiểm tra kết nối",
"response": "Chuỗi Json kết quả dữ liệu được trả về từ hệ thống " 
}

Mã trạng thái HTTP Tham khảo
Mã trạng thái xử lý:
- 1: thành công;
- 0: thất bại

3. API nhận kết quả đăng ký hồ sơ#

1. Request Header

URL: ***/api/HoTichTuPhap/LayKetQuaHoSo
Method:: GET
Authorization: Bearer 'token'
Content-Type: application/json

2. Request body

{
    "maDonVi": "Mã đơn vị tiếp nhận hồ sơ theo tổng cục thống kê",
    "maHoSo": "Mã hồ sơ lưu trong phần mềm một cửa"
}

3. Response body

{  
"code": "Mã trạng thái HTTP trả về", 
"status": "Mã trạng thái xử lý trả về", 
"correlationId": "Mã correlationId dành cho người lập trình trong quá trình kiểm tra kết nối",
"response": "Chuỗi Json kết quả dữ liệu được trả về từ hệ thống " 
}

Mã trạng thái HTTP Tham khảo
Mã trạng thái xử lý:
- 1: thành công;
- 0: thất bại

4. API lấy danh sách hồ sơ đã đăng ký#

1. Request Header

URL: ***/api/HoTichTuPhap/LayDanhSachHoSo
Method:: GET
Authorization: Bearer 'token'
Content-Type: application/json

2. Request body

Là chuỗi json với các tham số:

{
    "maNghiepVu": "Mã nghiệp vụ.",
    "ngayCapNhat": "Ngày cập nhật hồ sơ – là ngày hồ sơ được tạo mới trên Hệ thống thông tin đăng ký và quản lý hộ tịch hoặc ngày hồ sơ được thay đổi thông tin gần nhất nếu hồ sơ đã được cập nhật, thay đổi nội dung"
}

3. Response body

{  
"code": "Mã trạng thái HTTP trả về", 
"status": "Mã trạng thái xử lý trả về", 
"correlationId": "Mã correlationId dành cho người lập trình trong quá trình kiểm tra kết nối",
"response": "Chuỗi Json kết quả dữ liệu được trả về từ hệ thống " 
}

Mã trạng thái HTTP Tham khảo
Mã trạng thái xử lý:
- 1: thành công;
- 0: thất bại

5. API Trả thông tin chi tiết danh sách các hồ sơ#

1. Request Header

URL: ***/api/HoTichTuPhap/LayHoSo
Method:: GET
Authorization: Bearer 'token'
Content-Type: application/json

2. Request body

Là chuỗi json với các tham số:

{
    "maNghiepVu": "Mã nghiệp vụ.",
    "maHoSo": "Mã hồ sơ"
}

3. Response body

{  
"code": "Mã trạng thái HTTP trả về", 
"status": "Mã trạng thái xử lý trả về", 
"correlationId": "Mã correlationId dành cho người lập trình trong quá trình kiểm tra kết nối",
"response": "Chuỗi Json kết quả dữ liệu được trả về từ hệ thống " 
}

Mã trạng thái HTTP Tham khảo
Mã trạng thái xử lý:
- 1: thành công;
- 0: thất bại

6. API lấy danh mục#

1. Request Header

URL: ***/api/HoTichTuPhap/LayDanhMuc
Method:: GET
Authorization: Bearer 'token'
Content-Type: application/json

2. Request body

Là chuỗi json với các tham số:

{
    "loaiDanhMuc": "Loại danh mục cần lấy" // VD: 1; Tham khảo bên dưới
}

Bảng giá trị các danh mục

Tên danh mục	Giá trị
Danh mục quốc tịch	1
Danh mục quốc gia	2
Danh mục dân tộc	3
Danh mục địa danh hành chính (cấp tỉnh);	4
Danh mục giấy tờ tùy thân.	5

3. Response body

{  
"code": "Mã trạng thái HTTP trả về", 
"status": "Mã trạng thái xử lý trả về", 
"correlationId": "Mã correlationId dành cho người lập trình trong quá trình kiểm tra kết nối",
"response": "Chuỗi Json kết quả dữ liệu được trả về từ hệ thống " 
}

Mã trạng thái HTTP Tham khảo