I. Search

1.1. Structure

MultipleResponse<string> AutoSuggestSearch(string Keyword);

1.2. Usage

Search for suggestions using keyword passed into.

1.3. Input

Keyword

  • Data type: string.
  • Meaning: Search keyword (Note: Keyword is at least three characters).

1.4. Output

Error

  • Data type: Error.
  • Meaning: Error information (If any).

IsSuccess

  • Data type: bool.
  • Meaning: Status of operation.

ResponseTime

  • Data type: date.
  • Meaning: Response time.

HasMoreItem

  • Data type: bool.
  • Meaning: Gets a value indicating whether the list has more items.

List

  • Data type: string[].
  • Meaning: List of results.

TotalCount

  • Data type: int.
  • Meaning: Total result count.


4. ReverseGeoCoding

4.1. Structure

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

4.2. Usage

Get information about administrative boundaries by radius from a given point.

4.3. Input

Longitude

  • Data type: double.
  • Meaning: Longitude.

Latitude

  • Data type: double.
  • Meaning: Latitude.

Radius

  • Data type: int.
  • Meaning: Radius (in meters, maximum 30 meters).

4.4. Output

Error

  • Data type: Error.
  • Meaning: Error information (if any).

IsSuccess

  • Data type: bool.
  • Meaning: Status of operation.

ResponseTime

  • Data type: date.
  • Meaning: Response time.

Value


5. SearchAll

5.1. Structure

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

5.2. Usage

Search by keyword and results are ranked according to the boundary.

5.3. Input

Keyword

  • Data type: string.
  • Meaning: Search keyword.

Page

  • Data type: int.
  • Meaning: Page index.

PageSize

  • Data type: int.
  • Meaning: Page size (up to 10).

Lx

  • Data type: double.
  • Meaning: The upper left coordinate of the boundary.

Ly

  • Data type: double.
  • Meaning: The bottom left coordinate of the boundary.

Rx

  • Data type: double.
  • Meaning: The upper right coordinate of the boundary.

Ry

  • Data type: double.
  • Meaning: The bottom right coordinate of the boundary.

IsOrder

  • Data type: bool.
  • Meaning: Prioritize the search area. If IsOrder="False", search only in boundary, on the contrary, if IsOrder="True", search everywhere, but the results within the boundary will be shown prominently on the first result page (condition: Lx, Ly, Rx, Ry must be different from 0)..

5.4. Output

Error

  • Data type: Error.
  • Meaning: Error information (if any).

IsSuccess

  • Data type: bool.
  • Meaning: Status of operation.

ResponseTime

  • Data type: date.
  • Meaning: Response time.

HasMoreItem

  • Data type: bool.
  • Meaning: Gets a value indicating whether the list has more items.

List

TotalCount

  • Data type: int.
  • Meaning: Total result count.


7. SearchNearBy

7.1. Structure

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

7.2. Usage

Search for POIs (location, shop, business ...) by keyword at given point with given radius.

7.3. Input

Keyword

  • Data type: string.
  • Meaning: Search keyword.

Point

  • Data type: Point.
  • Meaning: Location to search.

Radius

  • Data type: double.
  • Meaning: Radius (in meters, maximum 30 meters).

Page

  • Data type: int.
  • Meaning: Page index.

PageSize

  • Data type: int.
  • Meaning: Page size (up to 10).

7.4. Output

Error

  • Data type: Error.
  • Meaning: Error information (if any).

IsSuccess

  • Data type: bool.
  • Meaning: Status of operation.

ResponseTime

  • Data type: date.
  • Meaning: Response time.

HasMoreItem

  • Data type: bool.
  • Meaning: Gets a value indicating whether the list has more items.

List

TotalCount

  • Data type: int.
  • Meaning: Total result count.


II. Directions

2. FindShortestPath

2.1. Structure

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

2.2. Usage

Find the shortest path in the order of the given points.

2.3. Input

Points

  • Data type: Point[].
  • Meaning: List the points that the route needs to go through.

TransportType

AlleyAvoidance

  • Data type: bool.
  • Meaning: A value indicating whether avoid the alley.

2.4. Output

Error

  • Data type: Error.
  • Meaning: Error information (If any).

IsSuccess

  • Data type: bool.
  • Meaning: Status of operation.

ResponseTime

  • Data type: date.
  • Meaning: Response time.

Value