Chuyển tới nội dung chính
Phiên bản: v1.0

Administrative API

Administrative API GTEL MAPS cung cấp dữ liệu về các đơn vị hành chính, bao gồm quốc gia, tỉnh/thành phố, quận/huyện, phường/xã và các hình dạng địa lý của địa điểm cụ thể.


Administrative API chi tiết cấp tỉnh/thành phố

Loading...
Tham số bắt buộcKiểu dữ liệuMô tả
codestringMã của cấp tỉnh/thành phố.
Tham số tuỳ chọnKiểu dữ liệuMô tả
fieldsstringDanh sách các trường thông tin cần lấy, cách nhau bằng dấu phẩy:
- id (default): Mã định danh duy nhất.
- geom: Trường tọa độ.
- prov_code (default): Mã tỉnh/thành phố.
- prov_name: Tên tỉnh/thành phố.
- prov_fname (default): Tên đầy đủ tỉnh/thành phố (tiếng Việt).
- prov_ne: Tên tỉnh/thành phố (tiếng Anh).
- prov_fne (default): Tên đầy đủ tỉnh/thành phố (tiếng Anh).
- level (default): Cấp tỉnh/thành phố.
- region (default): Khu vực địa lý.

Yêu cầu và phản hồi mẫu: Administrative API chi tiết cấp tỉnh/thành phố

Loading...
{
"status": "OK",
"data": {
"id": 1,
"prov_fname": "Thành phố Hà Nội",
"center": {
"lat": 20.998961324401755,
"lng": 105.70001502466181
},
"viewport": {
"northeast": {
"lat": 21.385227280614572,
"lng": 105.28812508560429
},
"southwest": {
"lat": 20.564474152560138,
"lng": 106.02005107259896
}
}
},
"licence": "© GTEL Maps"
}

Administrative API chi tiết cấp quận/huyện

Loading...
Tham số bắt buộcKiểu dữ liệuMô tả
codestringMã của cấp quận/huyện.
Tham số tuỳ chọnKiểu dữ liệuMô tả
fieldsstringDanh sách các trường thông tin cần lấy, cách nhau bằng dấu phẩy:
- id (default): Mã định danh duy nhất.
- geom: Trường tọa độ.
- prov_code (default): Mã tỉnh/thành phố.
- dist_code (default): Mã quận/huyện.
- prov_fname: Tên đầy đủ tỉnh/thành phố.
- dist_name: Tên quận/huyện.
- dist_fname (default): Tên đầy đủ quận/huyện (tiếng Việt).
- dist_ne: Tên quận/huyện (tiếng Anh).
- dist_fne: Tên đầy đủ quận/huyện (tiếng Anh).
- level (default): Cấp quận/huyện.
- region (default): Khu vực địa lý.

Yêu cầu và phản hồi mẫu: Administrative API chi tiết cấp quận/huyện

Loading...
{
"status": "OK",
"data": {
"id": 1,
"dist_fname": "Quận Ba Đình",
"center": {
"lat": 21.036069337127202,
"lng": 105.82659179708153
},
"viewport": {
"northeast": {
"lat": 21.05437666435165,
"lng": 105.80134683998472
},
"southwest": {
"lat": 21.01612669549064,
"lng": 105.8563471478027
}
}
},
"licence": "© GTEL Maps"
}

Administrative API chi tiết cấp phường/xã

Loading...
Tham số bắt buộcKiểu dữ liệuMô tả
codestringMã của cấp phường/xã.
Tham số tuỳ chọnKiểu dữ liệuMô tả
fieldsstringDanh sách các trường thông tin cần lấy, cách nhau bằng dấu phẩy:
- id (default): Mã định danh duy nhất.
- geom: Trường tọa độ.
- prov_code (default): Mã tỉnh/thành phố.
- dist_code (default): Mã quận/huyện.
- ward_code (default): Mã phường/xã.
- prov_fname: Tên đầy đủ tỉnh/thành phố.
- dist_fname: Tên đầy đủ quận/huyện.
- ward_name: Tên phường/xã.
- ward_fname (default): Tên đầy đủ phường/xã (tiếng Việt).
- ward_ne: Tên phường/xã (tiếng Anh).
- ward_fne (default): Tên đầy đủ phường/xã (tiếng Anh).
- level (default): Cấp phường/xã.
- region (default): Khu vực địa lý.

Yêu cầu và phản hồi mẫu: Administrative API chi tiết cấp phường/xã

Loading...
{
"status": "OK",
"data": {
"id": 3,
"ward_fname": "Phường Phúc Xá",
"center": {
"lat": 21.046696200845993,
"lng": 105.8495030642856
},
"viewport": {
"northeast": {
"lat": 21.05437666435165,
"lng": 105.84211069725092
},
"southwest": {
"lat": 21.040231766582792,
"lng": 105.8563471478027
}
}
},
"licence": "© GTEL Maps"
}

Administrative API danh sách cấp tỉnh/thành phố

Loading...
Tham số tuỳ chọnKiểu dữ liệuMô tả
codesstringDanh sách mã tỉnh/thành phố, phân tách bằng dấu phẩy (01,02,03).
Nếu không truyền codes sẽ trả về danh sách tỉnh/thành phố
fieldsstringDanh sách các trường thông tin cần lấy, cách nhau bằng dấu phẩy:
- id (default): Mã định danh duy nhất.
- geom: Trường tọa độ.
- prov_code (default): Mã tỉnh/thành phố.
- prov_name: Tên tỉnh/thành phố.
- prov_fname (default): Tên đầy đủ tỉnh/thành phố (tiếng Việt).
- prov_ne: Tên tỉnh/thành phố (tiếng Anh).
- prov_fne (default): Tên đầy đủ tỉnh/thành phố (tiếng Anh).
- level (default): Cấp tỉnh/thành phố.
- region (default): Khu vực địa lý.
include_geombooleanTrả về trường geom nếu giá trị là true mặc định là false.

Yêu cầu và phản hồi mẫu: Administrative API danh sách tỉnh/thành phố

Loading...
{
"data": [
{
"id": 1,
"prov_code": "01",
"prov_fname": "Thành phố Hà Nội",
"prov_fne": "Ha Noi City",
"region": "Đồng bằng sông Hồng",
"level": "Thành phố Trung ương"
},
{
"id": 2,
"prov_code": "02",
"prov_fname": "Tỉnh Hà Giang",
"prov_fne": "Ha Giang Province",
"region": "Trung du và Miền núi phía Bắc",
"level": "Tỉnh"
}
],
"licence": "© GTEL Maps"
}

Administrative API danh sách cấp quận/huyện

Loading...
Tham số bắt buộcKiểu dữ liệuMô tả
codesstringDanh sách mã quận/huyện, phân tách bằng dấu phẩy (001,002,003). codesprovince_code không được truyền cùng lúc.
province_codestringMã tỉnh/thành phố (nếu không truyền codes).
Tham số tuỳ chọnKiểu dữ liệuMô tả
fieldsstringDanh sách các trường thông tin cần lấy, cách nhau bằng dấu phẩy:
- id (default): Mã định danh duy nhất.
- geom: Trường tọa độ.
- prov_code (default): Mã tỉnh/thành phố.
- dist_code (default): Mã quận/huyện.
- prov_fname: Tên đầy đủ tỉnh/thành phố.
- dist_name: Tên quận/huyện.
- dist_fname (default): Tên đầy đủ quận/huyện (tiếng Việt).
- dist_ne: Tên quận/huyện (tiếng Anh).
- dist_fne: Tên đầy đủ quận/huyện (tiếng Anh).
- level (default): Cấp quận/huyện.
- region (default): Khu vực địa lý.
include_geombooleanTrả về trường geom nếu giá trị là true mặc định là false.
pageintegerSố trang (mặc định 1)
sizeintegerSố lượng bản ghi trên mỗi trang (mặc định 10)

Yêu cầu và phản hồi mẫu: Administrative API danh sách cấp quận/huyện

Loading...
{
"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"
}
],
"licence": "© GTEL Maps"
}

Administrative API danh sách cấp phường/xã

Loading...
Tham số bắt buộcKiểu dữ liệuMô tả
codesstringDanh sách mã phường/xã, phân tách bằng dấu phẩy (00001,00004). codesdistrict_code không được truyền cùng lúc.
district_codestringMã quận/huyện (nếu không truyền codes).
Tham số tuỳ chọnKiểu dữ liệuMô tả
fieldsstringDanh sách các trường thông tin cần lấy, cách nhau bằng dấu phẩy:
- id (default): Mã định danh duy nhất.
- geom: Trường tọa độ.
- prov_code (default): Mã tỉnh/thành phố.
- dist_code (default): Mã quận/huyện.
- ward_code (default): Mã phường/xã.
- prov_fname: Tên đầy đủ tỉnh/thành phố.
- dist_fname: Tên đầy đủ quận/huyện.
- ward_name: Tên phường/xã.
- ward_fname (default): Tên đầy đủ phường/xã (tiếng Việt).
- ward_ne: Tên phường/xã (tiếng Anh).
- ward_fne (default): Tên đầy đủ phường/xã (tiếng Anh).
- level (default): Cấp phường/xã.
- region (default): Khu vực địa lý.
include_geombooleanTrả về trường geom nếu giá trị là true mặc định là false.
pageintegerSố trang (mặc định 1)
sizeintegerSố lượng bản ghi trên mỗi trang (mặc định 10)

Yêu cầu và phản hồi mẫu: Administrative API danh sách phường/xã

Loading...
{
"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"
}
],
"licence": "© GTEL Maps"
}