User Manual - Vietbando Partner Portal

1. AutoSuggestSearch

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.

2. BatchReverseGeocoding

2.1. Structure

SingleResponse<BatchReverGeocodingResult> BatchReverseGeocoding(Point[] Points, double Radius);

2.2. Usage

Get administrative boundary information from the radius to a given set of points

2.3. Input

Points

Data type: Point[].
Meaning: List of points that passed into (maximum 100 points).

Radius

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

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

Data type: BatchReverGeocodingResult.
Meaning: Information on administrative border.

3. GetNearestObjects

3.1. Structure

MultipleResponse<VietBandoPOI> GetNearestObjects(double Longitude, double Latitude, double Radius, int Limit);

3.2. Usage

Search locations around a point (Longitude, Latitude) with given radius.

3.3. Input

Longitude

Data type: double.
Meaning: Longitude of point.

Latitude

Data type: double.
Meaning: Latitude of point.

Radius

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

Limit

Data type: int.
Meaning: Limit returned results (maximum 20 points).

3.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: VietBandoPOI[].
Meaning: List of places.

TotalCount

Data type: int.
Meaning: Total of 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

Data type: ReverseGeocodeResult.
Meaning: Return information.

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

Data type: VietBandoPOI[].
Meaning: List of POIs.

TotalCount

Data type: int.
Meaning: Total result count.

6.1. Structure

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

6.2. Usage

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

6.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)..

CategoryCode

Data type: int.
Meaning: category code. If CategoryCode="Null", SearchAllWithCategoryFilter function will be the same as SearchAll function.

6.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: VietBandoPOI[].
Meaning: List of POIs.

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

Data type: VietBandoPOI[].
Meaning: List of POIs.

TotalCount

Data type: int.
Meaning: Total result count.

8. WhatHere

8.1. Structure

SingleResponse<VietBandoPOI> WhatHere(double Longitude, double Latitude);

8.2. Usage

Get information by radius from a given point (Longitude, Latitude). If the given point is near POI (location, shop, business...) then return POI information, otherwise get administrative boundary information.

8.3. Input

Longitude

Data type: double.
Meaning: Longitude.

Latitude

Data type: double.
Meaning: Latitude.

8.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

Data type: VietBandoPOI.
Meaning: List of POIs.

1. CheckPointInShape

1.1. Structure

SingleResponse<bool> CheckPointInShape(Point Point, double Radius, Point[] Shape);

1.2. Usage

Check if the point is in the shape:

If shape has a point, check if the given point coincide with this point.
If the shape has 2 or more points and the starting point does not match the end point, check if the given point is on this polyline.
If the shape has 2 or more points and the starting point is identical to the end point, check if the given point is on this ring.

1.3. Input

Point

Data type: Point.
Meaning: Given point.

Radius

Data type: double.
Meaning: Radius of error.

Shape

Data type: Point[].
Meaning: List of points used to check (up to 20 elements).

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.

Value

Data type: bool.
Meaning: Gets a value indicating whether the point is in the shape.

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

Data type: TransportType.
Meaning: Vehicle type.

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

Data type: DirectionResult.
Meaning: Path finding results.

3. FindShortestPathOrderFull

3.1. Structure

SingleResponse<FindShortestPathOrderResult> FindShortestPathOrderFull(Point[] Points, TransportType TransportType, bool AlleyAvoidance);

3.2. Usage

Find the shortest path that rearranges the order of the given points.

3.3. Input

Points

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

TransportType

Data type: TransportType.
Meaning: Vehicle type.

AlleyAvoidance

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

3.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

Data type: FindShortestPathOrderResult.
Meaning: Path finding results.

4. FindShortestWithBarriers

4.1. Structure

SingleResponse<ShortestPathWithBarriersResult> FindShortestWithBarriers(Point[] Points, string[] Barriers, double DepartureTime, double[][] TimeRanges, TransportType TransportType, double VehicleWeight);

4.2. Usage

Find the shortest path with constraints on barriers.

4.3. Input

Points

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

Barriers

Data type: string[].
Meaning: List the barriers (sequence of coordinates in WKT format).

DepartureTime

Data type: double.
Meaning: Departure time.

TimeRanges

Data type: double[][].
Meaning: Effective time of the barriers.

TransportType

Data type: TransportType.
Meaning: Vehicle type.

VehicleWeight

Data type: double.
Meaning: Vehicle weight.

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

Data type: ShortestPathWithBarriersResult.
Meaning: Path finding results.

5. GetDistances

5.1. Structure

SingleResponse<double[][]> GetDistances(Point[] Sources, Point[] Destinations, TransportType TransportType, bool AlleyAvoidance);

5.2. Usage

Take the distances from the source points to the destination points.

5.3. Input

Sources

Data type: Point[].
Meaning: List of starting points.

Destinations

Data type: Point[].
Meaning: List of end points.

TransportType

Data type: TransportType.
Meaning: Vehicle type.

AlleyAvoidance

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

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.

Value

Data type: double[][].
Meaning: Distances array (two-dimensional) with the line index corresponding to the index of the starting points array, the column index corresponds to the index of the destination points array.

Ex:
- Starting points array: sources [P1, P2];
- Destination points array: destinations[P3, P4];

When calling GetDistances, the system returns the array M as follows:
M[0,0]=P1P3 (distance between P1 and P3);
M[0,1]=P1P4 (distance between P1 and P4);
M[1,0]=P2P3 (distance between P2 and P3);
M[1,1]=P2P4 (distance between P2 and P4);

Note: If no path is found between source and destination, the value is -1. Ex: M[0,0] = P1P3 = -1, means that no path is found between P1 and P3.

6. GetDistancesOnPaths

6.1. Structure

SingleResponse<double[]> GetDistancesOnPaths(Point Source, Point[] Destinations, TransportType TransportType, bool AlleyAvoidance, bool IsReverse);

6.2. Usage

Take the distances from a source point to the destination points.

6.3. Input

Source

Data type: Point.
Meaning: Starting point.

Destinations

Data type: Point[].
Meaning: List of end points (maximum 20 points).

TransportType

Data type: TransportType.
Meaning: Vehicle points.

AlleyAvoidance

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

IsReverse

Data type: bool.
Meaning: A value indicating whether find the reverse path.

6.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

Data type: double[].
Meaning: List of distance corresponds to the list of destination points and vice versa.

7. SnapToStreet

7.1. Structure

SingleResponse<Point[]> SnapToStreet(Point[] Points);

7.2. Usage

Snap set of given points to street (route simulation).

7.3. Input

Points

Data type: Point[].
Meaning: Loist of points (maximum 100 points).

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.

Value

Data type: Point[].
Meaning: List of snapped points.

8. ViaRoute

8.1. Structure

SingleResponse<ViaRouteResult> ViaRoute(Point[] Points, VehicleType VehicleType, RouteCriteria RouteCriteria, int Alternative, bool Geometry, bool Instructions, bool Distance, bool Duration, bool Uturn);

8.2. Usage

Provides route optimization queries with multiple via locations that support alternative routes and real-time traffic conditions (currently not accurate because the data is in the process of completion). Please note that due to combinatorial problem, alternative routes are not computed for queries with more than two input coordinates. Even then, a result cannot be guaranteed, as the algorithm does not return an improbable alternative route. Please note that the unit of measurement is always meters for distance, and seconds for duration.

8.3. Input

Points

Data type: Point[].
Meaning: List of points that passed into (maximum 100 points).

VehicleType

Data type: VehicleType.
Meaning: Vehicle type. Currently only supports walking, motorcycles, motorcars and trucks.

RouteCriteria

Data type: RouteCriteria.
Meaning: Criteria to optimize routes (fastest routes, shortest routes and traffic conditions).

Alternative

Data type: int.
Meaning: Expected alternative routes (values from 0 to 2). Although this can not be guaranteed, because the algorithm only returns if the route is reasonable. Ignored if more than two coordinates in Points.

Geometry

Data type: bool.
Meaning: Return route geometry.

Instructions

Data type: bool.
Meaning: Return route instructions.

Distance

Data type: bool.
Meaning: Return travel distance at each via location and turning point.

Duration

Data type: bool.
Meaning: Return travel time duration at each via location and turning point.

Uturn

Data type: bool.
Meaning: Allows U-turns at all via points.

8.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

Data type: ViaRouteResult.
Meaning: List of routes.

1. BatchGetRoadSpeed

1.1. Structure

SingleResponse<BatchGetRoadSpeedReult> BatchGetRoadSpeed(double[] Headings, Point[] Points, double[] Speeds, TransportTypeSpeed[] TransportTypes, int Radius);

1.2. Usage

Get the speed information on the road segments corresponding to a given set of points.

1.3. Input

Headings

Data type: double[].
Meaning: The direction of the device on the current road segment.

Points

Data type: Point[].
Meaning: List of points that passed into (maximum 100 points).

Speeds

Data type: double[].
Meaning: Speed on current road segment.

TransportTypes

Data type: TransportTypeSpeed[].
Meaning: The corresponding vehicle types.

Radius

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

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.

Value

Data type: BatchGetRoadSpeedReult.
Meaning: Speed information of the device.

2. ForecastRoadsByTrafficSign

2.1. Structure

SingleResponse<ForecastTrackingGeoReturn> ForecastRoadsByTrafficSign(Point Point, double Speed, double Heading, TransportTypeSpeed TransportType, int Distance);

2.2. Usage

Get information, speed signs of the current road segment and the road segments will meet in given radius.

2.3. Input

Point

Data type: Point.
Meaning: Coordinates of the point to get information.

Speed

Data type: double.
Meaning: Speed on current road segment.

Heading

Data type: double.
Meaning: The direction of the device on the current road segment.

TransportType

Data type: TransportTypeSpeed.
Meaning: Vehicle type is defined in TransportTypeSpeed.

Distance

Data type: int.
Meaning: Given radius.

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

Data type: ForecastTrackingGeoReturn.
Meaning: Return information.

3. GetRoadSpeed

3.1. Structure

SingleResponse<GetRoadSpeedReult> GetRoadSpeed(double Heading, Point Point, double Speed, int Radius);

3.2. Usage

Get speed information of the vehicle types on the current road segment from a point.

3.3. Input

Heading

Data type: double.
Meaning: Direction of vehicle on the current road segment.

Point

Data type: Point.
Meaning: Cordinate of vehicle.

Speed

Data type: double.
Meaning: Speed of the vehicle.

Radius

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

3.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

Data type: GetRoadSpeedReult.
Meaning: Returned result.

4. GetTrackingInformation

4.1. Structure

SingleResponse<TrackingInformationResult> GetTrackingInformation(Point PrePoint, Point CurPoint, TransportTypeSpeed TransportType, double Radius);

4.2. Usage

Get information, speed signs of the current road segment.

4.3. Input

PrePoint

Data type: Point.
Meaning: Previous point.

CurPoint

Data type: Point.
Meaning: Current point.

TransportType

Data type: TransportTypeSpeed.
Meaning: Vehicle types .

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

Data type: TrackingInformationResult.
Meaning: Return information.

1. GetAllGroupCategories

1.1. Structure

MultipleResponse<GroupCategory> GetAllGroupCategories(bool IsGetCategory);

1.2. Usage

Get all category groups of the system.

1.3. Input

IsGetCategory

Data type: bool.
Meaning: A value indicating whether get categories.

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: GroupCategory[].
Meaning: List of returned groups.

TotalCount

Data type: int.
Meaning: Totals result count.

2. GetCategoriesInGroup

2.1. Structure

MultipleResponse<Category> GetCategoriesInGroup(int GroupCode);

2.2. Usage

Get all the categories in the given group.

2.3. Input

GroupCode

Data type: int.
Meaning: Group code.

2.4. Output

Error

Data type: Error.
Meaning: Error information.

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: Category[].
Meaning: List of returned catagories.

TotalCount

Data type: int.
Meaning: Total result count.

3. GetCategoryDetail

3.1. Structure

SingleResponse<Category> GetCategoryDetail(int CategoryCode);

3.2. Usage

Get details of a category.

3.3. Input

CategoryCode

Data type: int.
Meaning: Catagory code.

3.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

Data type: Category.
Meaning: Detailed information of a category.

4. GetGroupCategoryDetail

4.1. Structure

SingleResponse<GroupCategory> GetGroupCategoryDetail(int GroupCode, bool IsGetCategory);

4.2. Usage

Get details of a category group.

4.3. Input

GroupCode

Data type: int.
Meaning: Group code.

IsGetCategory

Data type: bool.
Meaning: A value indicating whether get categories.

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

Data type: GroupCategory.
Meaning: Details information of a group.

1. GetCentroidOfRegion

1.1. Structure

SingleResponse<Point> GetCentroidOfRegion(string Code);

1.2. Usage

Take the center of the administrative boundary from an administrative unit code. Refer to the administrative unit code at http://www.gso.gov.vn/dmhc2015/.

1.3. Input

Code

Data type: string.
Meaning: National administrative unit code.

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.

Value

Data type: Point.
Meaning: Center of the administrative boundary.

2. GetMBROfRegion

2.1. Structure

SingleResponse<MBROfRegionResult> GetMBROfRegion(string Code);

2.2. Usage

Take the MBR (minimum bounding rectangle) of the administrative boundary from an administrative unit code. Refer to the administrative unit code at http://www.gso.gov.vn/dmhc2015/.

2.3. Input

Code

Data type: string.
Meaning: National administrative unit code.

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

Data type: MBROfRegionResult.
Meaning: MBR of the administrative boundary..

3. GetNameOfRegion

3.1. Structure

SingleResponse<string> GetNameOfRegion(string Code);

3.2. Usage

Take name of the administrative boundary from an administrative unit code. Refer to the administrative unit code at http://www.gso.gov.vn/dmhc2015/.

3.3. Input

Code

Data type: string.
Meaning: National administrative unit code.

3.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

Data type: string.
Meaning: Name of the administrative boundary.

4. GetSubRegionCodesOfRegion

4.1. Structure

SingleResponse<string[]> GetSubRegionCodesOfRegion(string Code);

4.2. Usage

Get list of national administrative unit codes by region from an administrative unit code. Refer to the administrative unit code at http://www.gso.gov.vn/dmhc2015/.

4.3. Input

Code

Data type: string.
Meaning: National administrative unit code.

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

Data type: string[].
Meaning: List of sub national administrative unit codes.

5. GetSubRegionNameCodesOfRegion

5.1. Structure

SingleResponse<SubRegionNameCodesResult> GetSubRegionNameCodesOfRegion(string Code);

5.2. Usage

Get list of national administrative unit codes (and names) by region from an administrative unit code. Refer to the administrative unit code at http://www.gso.gov.vn/dmhc2015/.

5.3. Input

Code

Data type: string.
Meaning: National administrative unit code.

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.

Value

Data type: SubRegionNameCodesResult.
Meaning: List of sub national administrative unit codes (and names).

6. GetSubRegionNamesOfRegion

6.1. Structure

SingleResponse<string[]> GetSubRegionNamesOfRegion(string Code);

6.2. Usage

Get list of national administrative unit names by region from an administrative unit code. Refer to the administrative unit code at http://www.gso.gov.vn/dmhc2015/.

6.3. Input

Code

Data type: string.
Meaning: National administrative unit code.

6.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

Data type: string[].
Meaning: List of sub national administrative unit names.

7. GetThumbnailOfRegion

7.1. Structure

SingleResponse<byte[]> GetThumbnailOfRegion(string Code, int Width, int Height, RegionColor RegionColor, int DefaultColor, int ImgType);

7.2. Usage

Get thumbnail of an administrative boundaries.

7.3. Input

Code

Data type: string.
Meaning: National administrative unit code. Refer to the administrative unit code at http://www.gso.gov.vn/dmhc2015/.

Width

Data type: int.
Meaning: Image width (<=128).

Height

Data type: int.
Meaning: Image height (<=128).

RegionColor

Data type: RegionColor.
Meaning: Color of administrative boundaries.

DefaultColor

Data type: int.
Meaning: Default color (1: use default color, 0: use given color).

ImgType

Data type: int.
Meaning: Image type (0: png, 1: jpg, 2: bmp).

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.

Value

Data type: byte[].
Meaning: Image buffer.

I. Search

1. AutoSuggestSearch

1.1. Structure

1.2. Usage

1.3. Input

1.4. Output

2. BatchReverseGeocoding

2.1. Structure

2.2. Usage

2.3. Input

2.4. Output

3. GetNearestObjects

3.1. Structure

3.2. Usage

3.3. Input

3.4. Output

4. ReverseGeoCoding

4.1. Structure

4.2. Usage

4.3. Input

4.4. Output

5. SearchAll

5.1. Structure

5.2. Usage

5.3. Input

5.4. Output

6. SearchAllWithCategoryFilter

6.1. Structure

6.2. Usage

6.3. Input

6.4. Output

7. SearchNearBy

7.1. Structure

7.2. Usage

7.3. Input

7.4. Output

8. WhatHere

8.1. Structure

8.2. Usage

8.3. Input

8.4. Output

II. Directions

1. CheckPointInShape

1.1. Structure

1.2. Usage

1.3. Input

1.4. Output

2. FindShortestPath

2.1. Structure

2.2. Usage

2.3. Input

2.4. Output

3. FindShortestPathOrderFull

3.1. Structure

3.2. Usage

3.3. Input

3.4. Output

4. FindShortestWithBarriers

4.1. Structure

4.2. Usage

4.3. Input

4.4. Output

5. GetDistances

5.1. Structure

5.2. Usage

5.3. Input

5.4. Output

6. GetDistancesOnPaths

6.1. Structure

6.2. Usage

6.3. Input

6.4. Output

7. SnapToStreet

7.1. Structure

7.2. Usage

7.3. Input

7.4. Output

8. ViaRoute

8.1. Structure

8.2. Usage