I. Tìm kiếm

1. AutoSuggestSearch

1.1. Cấu trúc

MultipleResponse<string> AutoSuggestSearch(string Keyword);

1.2. Chức năng hàm

AutoSuggestSearch là hàm tự động tìm kiếm các gợi ý theo từ khóa truyền vào.

1.3. Input

Keyword

• Kiểu dữ liệu: string.
• Ý nghĩa biến: Từ khóa tìm kiếm (Lưu ý: Keyword có độ dài ít nhất 3 ký tự).

1.4. Output

Error

• Kiểu dữ liệu: Error.
• Ý nghĩa biến: Thông tin lỗi (nếu có).

IsSuccess

• Kiểu dữ liệu: bool.
• Ý nghĩa biến: Trạng thái cho biết gọi hàm có thành công không.

ResponseTime

• Kiểu dữ liệu: date.
• Ý nghĩa biến: Thời điểm hệ thống trả kết quả.

HasMoreItem

• Kiểu dữ liệu: bool.
• Ý nghĩa biến: Trạng thái cho biết còn phần tử nào trong danh sách nữa không.

List

• Kiểu dữ liệu: string[].
• Ý nghĩa biến: Danh sách các gợi ý trả về.

TotalCount

• Kiểu dữ liệu: int.
• Ý nghĩa biến: Tổng số vị trí thỏa điều kiện tìm kiếm.

4. ReverseGeoCoding

4.1. Cấu trúc

SingleResponse<ReverseGeocodeResult> ReverseGeocoding(double Longitude, double Latitude, double Radius);

4.2. Chức năng hàm

ReverseGeoCoding là hàm lấy lấy thông tin về ranh giới hành chính theo bán kính từ một điểm truyền vào.

4.3. Input

Longitude

• Kiểu dữ liệu: double.
• Ý nghĩa biến: Kinh độ.

Latitude

• Kiểu dữ liệu: double.
• Ý nghĩa biến: Vĩ độ.

Radius

• Kiểu dữ liệu: int.
• Ý nghĩa biến: Bán kính (tính theo mét, tối đa 30m).

4.4. Output

Error

• Kiểu dữ liệu: Error.
• Ý nghĩa biến: Thông tin lỗi (nếu có).

IsSuccess

• Kiểu dữ liệu: bool.
• Ý nghĩa biến: Trạng thái cho biết gọi hàm có thành công không.

ResponseTime

• Kiểu dữ liệu: date.
• Ý nghĩa biến: Thời điểm hệ thống trả kết quả.

Value

• Kiểu dữ liệu: ReverseGeocodeResult.
• Ý nghĩa biến: Thông tin ranh giới hành chính trả về.

1. SearchAll

1. Cấu trúc

MultipleResponse<VietBandoPOI> SearchAll(string Keyword, int Page, int PageSize, double Lx, double Ly, double Rx, double Ry, bool IsOrder);

1.2. Chức năng hàm

SearchAll là hàm tìm kiếm theo từ khóa và kết quả trả về thuộc khung bao được hiển thị trên các trang kết quả đầu tiên.

1.3. Input

Keyword

• Kiểu dữ liệu: string.
• Ý nghĩa biến: Từ khóa tìm kiếm.

Page

• Kiểu dữ liệu: int.
• Ý nghĩa biến: Thứ tự trang kết quả trả về.

PageSize

• Kiểu dữ liệu: int.
• Ý nghĩa biến: Số kết quả hiển thị trên một trang (tối đa 10).

Lx

• Kiểu dữ liệu: double.
• Ý nghĩa biến: Tọa độ trái X của khung bao.

Ly

• Kiểu dữ liệu: double.
• Ý nghĩa biến: Tọa độ trái Y của khung bao.

Rx

• Kiểu dữ liệu: double.
• Ý nghĩa biến: Tọa độ phải X của khung bao.

Ry

• Kiểu dữ liệu: double.
• Ý nghĩa biến: Tọa độ phải Y của khung bao.

IsOrder

• Kiểu dữ liệu: bool.
• Ý nghĩa biến: ưu tiên vùng tìm kiếm. Nếu IsOrder="False" thì chỉ tìm kiếm trong khung bao, ngược lại IsOrder="True" thì tìm mọi nơi nhưng những kết quả nằm trong khung bao sẽ được ưu tiên hiển thị trên các trang kết quả đầu tiên (điều kiện: Lx, Ly, Rx, Ry phải khác 0).

1.4. Output

Error

• Kiểu dữ liệu: Error.
• Ý nghĩa biến: Thông tin lỗi (nếu có).

IsSuccess

• Kiểu dữ liệu: bool.
• Ý nghĩa biến: Trạng thái cho biết gọi hàm có thành công không.

ResponseTime

• Kiểu dữ liệu: date.
• Ý nghĩa biến: Thời điểm hệ thống trả kết quả.

HasMoreItem

• Kiểu dữ liệu: bool.
• Ý nghĩa biến: Trạng thái cho biết còn phần tử nào trong danh sách nữa không.

List

• Kiểu dữ liệu: VietBandoPOI[].
• Ý nghĩa biến: Danh sách các POI trả về.

TotalCount

• Kiểu dữ liệu: int.
• Ý nghĩa biến: Tổng số vị trí thỏa điều kiện tìm kiếm.

2. SearchNearBy

2.1. Cấu trúc

MultipleResponse<VietBandoPOI> SearchNearBy(string Keyword, Point Point, double Radius, int Page, int PageSize);

2.2. Chức năng hàm

SearchNearBy là hàm tìm kiếm POI (địa điểm, cửa hàng, cơ sở kinh doanh...) theo từ khóa (Keyword) tại vị trí (Point) với bán kính (Radius) nhập vào.

2.3. Input

Keyword

• Kiểu dữ liệu: string.
• Ý nghĩa biến: Từ khóa tìm kiếm.

Point

• Kiểu dữ liệu: Point.
• Ý nghĩa biến: Vị trí cần tìm kiếm.

Radius

• Kiểu dữ liệu: double.
• Ý nghĩa biến: Bán kính (tính theo mét, tối đa 30m).

Page

• Kiểu dữ liệu: int.
• Ý nghĩa biến: Thứ tự trang kết quả trả về.

PageSize

• Kiểu dữ liệu: int.
• Ý nghĩa biến: Số kết quả hiển thị trên một trang (tối đa 10).

2.4. Output

Error

• Kiểu dữ liệu: Error.
• Ý nghĩa biến: Thông tin lỗi (nếu có).

IsSuccess

• Kiểu dữ liệu: bool.
• Ý nghĩa biến: Trạng thái cho biết gọi hàm có thành công không.

ResponseTime

• Kiểu dữ liệu: date.
• Ý nghĩa biến: Thời điểm hệ thống trả kết quả.

HasMoreItem

• Kiểu dữ liệu: bool.
• Ý nghĩa biến: Trạng thái cho biết còn phần tử nào trong danh sách nữa không.

List

• Kiểu dữ liệu: VietBandoPOI[].
• Ý nghĩa biến: Danh sách các POI trả về.

TotalCount

• Kiểu dữ liệu: int.
• Ý nghĩa biến: Tổng số vị trí thỏa điều kiện tìm kiếm.

II. Tìm đường

2. FindShortestPath

2.1. Cấu trúc

SingleResponse<DirectionResult> FindShortestPath(Point[] Points, TransportType TransportType, bool AlleyAvoidance);

2.2. Chức năng hàm

FindShortestPath là hàm tìm đường đi ngắn nhất theo thứ tự các điểm truyền vào.

2.3. Input

Points

• Kiểu dữ liệu: Point[].
• Ý nghĩa biến: Danh sách các điểm mà lộ trình cần đi qua.

TransportType

• Kiểu dữ liệu: TransportType.
• Ý nghĩa biến: Loại phương tiện.

AlleyAvoidance

• Kiểu dữ liệu: bool.
• Ý nghĩa biến: Trạng thái cho biết lộ trình có tránh hẻm không.

2.4. Output

Error

• Kiểu dữ liệu: Error.
• Ý nghĩa biến: Thông tin lỗi (nếu có).

IsSuccess

• Kiểu dữ liệu: bool.
• Ý nghĩa biến: Trạng thái cho biết gọi hàm có thành công không.

ResponseTime

• Kiểu dữ liệu: date.
• Ý nghĩa biến: Thời điểm hệ thống trả kết quả.

Value

• Kiểu dữ liệu: DirectionResult.
• Ý nghĩa biến: Kết quả tìm đường.