Thông tin tỉnh/huyện/xã

Api cung cấp ID tỉnh/thành phố, Quận/Huyện, Phường Xã hỗ trợ cập nhật thông tin khách hàng và phân loại theo tỉnh thành. Đối với phần Phường/Xã sẽ áp dụng thông tin theo chính quyền 2 cấp (Tỉnh/Xã)

Trong trường hợp cần gán địa chỉ khách hàng và phân cấp Tỉnh/Huyện thì sử dụng các api dưới đây để đồng bộ danh bạ tỉnh/thành, quận/huyện về ứng dụng.

Dữ liệu tỉnh/thành phố, quận/huyện, xã/phường chỉ áp dụng cho các địa phương ở Việt Nam

Lấy danh sách tỉnh/thành phố

Dữ liệu đã được cập nhật trạng thái chính quyền 2 cấp đối với các tỉnh được giữ nguyên tên và tỉnh được sát nhập sẽ có thêm trạng thái chỉ thị.

Mô phỏng dữ liệu tỉnh thành từ POSTMAN

Lấy danh sách tỉnh/thành phố

GET {{domain}}/api/v1/cities

Headers

Name	Type	Description
****	String	Thông tin xác thực chung

200: OK Thành công

Kết quả điển hình

{
    "code": "ok",
    "data": [
        {
            "id": "01",
            "name": "Thành phố Hà Nội",
            "type": "Thành phố Trung ương",
            "status": 1
        },
        {
            "id": "02",
            "name": "Tỉnh Hà Giang",
            "type": "Tỉnh",
            "status": 0
        },
....

Cấu trúc thông tin

400: Bad Request

Lấy danh sách quận/huyện

Chi tiết các quận/huyện theo city_id

Danh sách quận/huyện theo ID của tỉnh/thành phố

GET {{domain}}/api/v1/districts

Query Parameters

Name	Type	Description
city_id*	String	ID của tỉnh/thành phố dựa theo api Danh sách tỉnh

Headers

Name	Type	Description
***	String	Thông tin xác thực chung

200: OK Thành công

Kết quả điển hình

{
    "code": "ok",
    "numFound": 30,
    "data": [
        {
            "id": "001",
            "name": "Quận Ba Đình",
            "type": "Quận",
            "city_id": "01"
        },
        {
            "id": "002",
            "name": "Quận Hoàn Kiếm",
            "type": "Quận",
            "city_id": "01"
        },
        ....
        ]
}

Mô tả kết quả

422: Unprocessable Entity Lỗi không cung cấp param city_id

Danh sách xã theo tỉnh (Xã theo cơ chế chính quyền 2 cấp)

Danh sách các xã theo city_id của tỉnh/thành phố có status=1 (Tỉnh sau sát nhập) dựa trên API Tỉnh/thành phố ở trên

GET {{domain}}/api/v1/wards

Name	Type	Description
city_id*	String	ID của tỉnh/thành phố dựa theo api Danh sách tỉnh

Headers

Name	Type	Description
***	String	Thông tin xác thực chung

Response:

200: Thành công

Kết quả điển hình ( payload là: city_id=34)

Kết quả điển hình

{
    "code": "ok",
    "numFound": 104,
    "data": [
        {
            "id": "13279",
            "name": "Xã Vũ Tiên",
            "city_id": "33"
        },
        {
            "id": "13264",
            "name": "Xã Thư Vũ",
            "city_id": "33"
        },
        {
            "id": "13246",
            "name": "Xã Tân Thuận",
            "city_id": "33"
        },
...

Mô tả kết quả

422: Lỗi thiếu thông tin