Districts
1. Danh sách quận/huyện
Loading...
Lấy danh sách quận/huyện theo mã tỉnh/thành phố (province_code) hoặc theo danh sách mã quận/huyện
(codes). Bắt buộc truyền đúng một trong hai.
Phiên bản dữ liệu
Cấp quận/huyện chỉ tồn tại ở phiên bản legacy (dữ liệu trước sáp nhập 2025).
Tham số
| Tham số | Kiểu | Bắt buộc | Mặc định | Mô tả |
|---|---|---|---|---|
province_code | string | Có¹ | — | Mã tỉnh/thành phố, 2 ký tự. Lưu ý tên tham số là province_code, không phải prov_code |
codes | string | Có¹ | — | Danh sách mã quận/huyện phân tách bằng dấu phẩy (001,002) |
fields | string | Không | xem bên dưới | Danh sách trường muốn lấy — xem Trường hỗ trợ |
include_geom | string | Không | false | true hoặc false — có trả trường geom hay không |
page | integer | Không | 1 | Số trang. Chỉ dùng được cùng province_code |
size | integer | Không | 10 | Số bản ghi mỗi trang, tối đa 50. Chỉ dùng được cùng province_code |
¹ Bắt buộc một trong hai: province_code hoặc codes — không được truyền cả hai, cũng không được
thiếu cả hai.
Trường hỗ trợ
Cột Mặc định cho biết trường có được trả về khi không truyền fields hay không.
| Trường | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
id | integer | Có | Mã nội bộ của bản ghi |
prov_code | string | Có | Mã tỉnh/thành phố chứa quận/huyện, 2 ký tự |
dist_code | string | Có | Mã quận/huyện, 3 ký tự |
prov_name | string | — | Tên ngắn gọn của tỉnh/thành phố |
dist_name | string | — | Tên ngắn gọn tiếng Việt (Ba Đình) |
dist_fname | string | Có | Tên đầy đủ tiếng Việt (Quận Ba Đình) |
dist_ne | string | — | Tên ngắn gọn tiếng Anh (Ba Dinh) |
dist_fne | string | Có | Tên đầy đủ tiếng Anh (Ba Dinh District) |
level | string | Có | Cấp hành chính (Quận, Huyện, Thị xã, Thành phố) |
region | string | Có | Vùng địa lý (Đồng bằng sông Hồng…) |
center | object | — | Toạ độ trung tâm, dạng { lat, lng } theo WGS84 (EPSG:4326) |
viewport | object | — | Khung nhìn, dạng { northeast, southwest } |
geom | object | — | Ranh giới hành chính, GeoJSON geometry |
Yêu cầu mẫu
Loading API request...
Phản hồi
{
"data": [
{
"id": 1,
"prov_code": "01",
"dist_code": "001",
"dist_fname": "Quận Ba Đình",
"dist_fne": "Ba Dinh District",
"region": "Đồng bằng sông Hồng",
"level": "Quận"
},
{
"id": 2,
"prov_code": "01",
"dist_code": "002",
"dist_fname": "Quận Hoàn Kiếm",
"dist_fne": "Hoan Kiem District",
"region": "Đồng bằng sông Hồng",
"level": "Quận"
}
],
"meta": {
"pagination": { "total": 30, "currentPage": 1, "pageSize": 2, "totalPages": 15 },
"data_version": "legacy"
},
"licence": "© GTEL Maps"
}
Lỗi thường gặp
| HTTP | Tình huống |
|---|---|
422 | Tham số không hợp lệ hoặc không khớp dữ liệu |
2. Chi tiết quận/huyện
Loading...
Trả về thông tin một quận/huyện theo mã, mặc định kèm đầy đủ dữ liệu không gian.
Phiên bản dữ liệu
Cấp quận/huyện chỉ tồn tại ở phiên bản legacy (dữ liệu trước sáp nhập 2025).
Tham số
Tham số đường dẫn
| Tham số | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
district_code | string | Có | Mã quận/huyện, 3 ký tự (ví dụ 001) |
Tham số truy vấn
| Tham số | Kiểu | Bắt buộc | Mặc định | Mô tả |
|---|---|---|---|---|
fields | string | Không | xem bên dưới | Danh sách trường muốn lấy — xem Trường hỗ trợ |
Trường hỗ trợ
Giống endpoint danh sách. Trường mặc định: id, prov_code, dist_code, dist_fname, dist_fne,
region, level, center, viewport, geom.
Yêu cầu mẫu
Loading API request...
Phản hồi
{
"status": "OK",
"data": {
"id": 1,
"dist_code": "001",
"dist_fname": "Quận Ba Đình",
"center": { "lat": 21.036069337127202, "lng": 105.82659179708153 }
},
"meta": { "data_version": "legacy" },
"licence": "© GTEL Maps"
}
Lỗi thường gặp
| HTTP | Tình huống |
|---|---|
404 | Không tồn tại mã quận/huyện |
422 | Tham số không hợp lệ |