I. Search

BatchReverGeocodingResult

ArrDistrict

• Data type: string[].
• Meaning: Set of district names.

ArrDistrictID

• Data type: string[].
• Meaning: Set of district administrative unit codes.

ArrProvince

• Data type: string[].
• Meaning: Set of province/city names.

ArrProvinceID

• Data type: string[].
• Meaning: Set of city (province) administrative unit codes.

ArrStreet

• Data type: string[].
• Meaning: Set of street names.

ArrWard

• Data type: string[].
• Meaning: Set of ward names.

ArrWardID

• Data type: string[].
• Meaning: Set of ward administrative unit codes.

Error

ExceptionType

• Data type: string.
• Meaning: Error type.

Message

• Data type: string.
• Meaning: Detailed error information.

Point

Longitude

• Data type: double.
• Meaning: Longitude.

Latitude

• Data type: double.
• Meaning: Latitude.

ReverseGeocodeResult

District

• Data type: string.
• Meaning: Set of district names.

DistrictId

• Data type: string.
• Meaning: Set of district administrative unit codes.

Province

• Data type: string.
• Meaning: Set of province/city names.

ProvinceId

• Data type: string.
• Meaning: Set of city (province) administrative unit codes.

Street

• Data type: string.
• Meaning: Set of street names.

Ward

• Data type: string.
• Meaning: Set of ward names.

WardId

• Data type: string.
• Meaning: Set of ward administrative unit codes.

VietBandoPOI

VietbandoId

• Data type: string.
• Meaning: Id of POI.

Name

• Data type: string.
• Meaning: Name of POI.

GroupCode

• Data type: int.
• Meaning: Group code.

CategoryCode

• Data type: int.
• Meaning: Category code.

Room

• Data type: string.
• Meaning: Room number.

Floor

• Data type: string.
• Meaning: Floor number.

Building

• Data type: string.
• Meaning: Building name.

Number

• Data type: string.
• Meaning: Address number of POI.

Street

• Data type: string.
• Meaning: Street name of POI.

Ward

• Data type: string.
• Meaning: Ward name of POI.

District

• Data type: string.
• Meaning: District name of POI.

Province

• Data type: string.
• Meaning: Province name of POI.

Phone

• Data type: string.
• Meaning: Phone number of POI.

Fax

• Data type: string.
• Meaning: Fax number of POI.

Longitude

• Data type: double.
• Meaning: Longitude of POI.

Latitude

• Data type: double.
• Meaning: Latitude of POI.

II. Directions

DirectionResult

FullPath

• Data type: double[].
• Meaning: List of coordinates of the points that the route goes through.

PathLength

• Data type: double.
• Meaning: Length of the route.

RealPlaces

• Data type: double[].
• Meaning: List of points that pass into.

ResultScript

• Data type: ShortestPath[].
• Meaning: Detailed instructions for the route.

Segments

• Data type: int[].
• Meaning: Corresponding length of each segment on the route.

Dir

• 0: Head.
• 1: Turn left on.
• 2: Turn right on.
• 3: Continue to follow.
• 4: At the roundabout.
• 5: Turn to.
• 6: At.
• 7: Pass over.

FindShortestPathOrderResult

Coors

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

Indices

• Data type: int[].
• Meaning: Array of indexes of input point after sorting.

InstructionDirs

• Data type: int[].
• Meaning: Array of route directions.

InstructionDistances

• Data type: double[].
• Meaning: Array of distances between segments.

InstructionNames

• Data type: string[].
• Meaning: List of road names that the route goes through.

RealPlaces

• Data type: double[].
• Meaning: List of points that pass into.

Leg

EndX

• Data type: double.
• Meaning: Longitude of the ending point corresponds to leg in the route.

EndY

• Data type: double.
• Meaning: Latitude of the ending point corresponds to leg in the route.

Found

• Data type: bool.
• Meaning: A value indicating whether the path has found.

Len

• Data type: double.
• Meaning: Length of leg.

StartX

• Data type: double.
• Meaning: Longitude of the starting point corresponds to leg in the route.

StartY

• Data type: double.
• Meaning: Latitude of the starting point corresponds to leg in the route.

Step

• Data type: Step[].
• Meaning: List of steps in leg.

Route

Via_Distances

• Data type: int[].
• Meaning: Array of travel distances (the unit of measurement is meters). Via_Distances[i] denotes the travel distance from Via_Points[0] to Via_Points[i]. Distance between Via_Points[i] and Via_Points[i + 1] can be computed simply by subtracting. Available only if Distance = true.

Via_Durations

• Data type: int[].
• Meaning: Array of travel time durations (the unit of measurement is seconds). Via_Durations[i] denotes the travel time duration from Via_Durations[0] to Via_Durations[i]. Time duration between Via_Durations[i] and Via_Durations[i + 1] can be computed simply by subtracting. Available only if Duration = true.

Via_Indices

• Data type: int[].
• Meaning: Array of indices. Via_Indices[i] denotes the index to the list of coordinates represented by the decompressed Geometry that Via_Points[i] corresponds to. Available only if Geometry = true.

Geometry

• Data type: string.
• Meaning: An encoded string describing the route geometry compressed as polyline with 6 decimals, by Encoded Polyline Algorithm (how to decode please see here). Available only if Geometry = true.

Steps

• Data type: Steps.
• Meaning: The turn-by-turn instructions. Available only if Instructions = true.

RouteCriteria

• Duration = 0: Fastest.
• Distance = 1: Shortest.
• Traffic = 2: Traffic conditions.

ShortestPath

Leg

• Data type: Leg[].
• Meaning: List of legs.

Len

• Data type: double.
• Meaning: Length of the route.

ShortestPathWithBarriersResult

ArrivalTime

• Data type: double.
• Meaning: Expected arrival time.

Coors

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

Indices

• Data type: int[].
• Meaning: Array of indexes of input point after sorting.

InstructionDirs

• Data type: int[].
• Meaning: Number of instruction directions in the route.

PathLength

• Data type: double.
• Meaning: Length of the route.

RealPlaces

• Data type: double[].
• Meaning: List of points that pass into.

Script

• Data type: string.
• Meaning: Route description.

Step

Angle

• Data type: int.
• Meaning: Angle of the turn direction.

Dir

• Data type: Dir.
• Meaning: Direction of step.

Len

• Data type: double.
• Meaning: Length of step.

Name

• Data type: string.
• Meaning: Name of step.

Start

• Data type: int.
• Meaning: Index of the starting point corresponds to step in each leg.

X

• Data type: double.
• Meaning: Longitude of the starting point corresponds to step in each leg.

Y

• Data type: double.
• Meaning: Latitude of the starting point corresponds to step in each leg.

Steps

Turns

• Data type: TurnInstruction[].
• Meaning: Array of TurnInstruction codes.

Names

• Data type: string[].
• Meaning: Array of street names along which travel proceeds.

Indices

• Data type: int[].
• Meaning: Array of indices to the list of coordinates represented by the decompressed Geometry. Available only if Geometry = true.

Distances

• Data type: int[].
• Meaning: Array of integers, each one is the travel distance from the maneuver to the subsequent step. Available only if Distance = true.

Durations

• Data type: int[].
• Meaning: Array of integers, each one is the travel time duration from the maneuver to the subsequent step. Available only if Duration = true.

Example:

{
    ...
    "Steps": {
        "Turns": [
                    10,
                    11,
                    12,
                    7,
                    3,
                    15
                    ],
        "Names": [
                    "Đường Cách Mạng Tháng Tám",
                    "Vòng Xoay Công Trường Dân Chủ",
                    "Đường Cách Mạng Tháng Tám",
                    "Đường Nguyễn Thị Minh Khai",
                    "Đường Nam Kỳ Khởi Nghĩa",
                    ""
                    ],
        "Indices": [
                    0,
                    7,
                    37,
                    61,
                    77,
                    79
                    ],
        "Distances": [
                    279,
                    92,
                    944,
                    903,
                    180,
                    0
                    ],
        "Durations": [
                    37,
                    35,
                    114,
                    109,
                    20,
                    0
                    ]
                    }
}

Each instruction can be interpreted using this simple format:

TransportType

• Walk = 0: Walk
• Bike = 1: Bike.
• Car = 2: Car.
• Truck = 3: Truck.
• Emergency = 5: Emergency.

TransportTypeSpeed

• 0: Unknown.
• 1: Passenger car.
• 2: Truck.
• 3: Motorcycle.
• 4: Bus.
• 5: Container trailer.
• 6: Specialized vehicle.
• 7: Motobike.
• 8: Rickshaw.
• 9: Passenger car over 9 seats.
• 10: Passenger car over 30 seats.
• 11: Truck over 3.5 tonnes.
• 12: Double-decker passenger car with bed.
• 13: Specialized motorbike, construction motorcycle, agricultural/forestry vehicles, other special-purpose vehicles used for defense and security purposes are involved in road traffic.

TurnInstruction

• NoTurn = 0: No turn.
• GoStraight = 1: Go straight.
• TurnSlightRight = 2: Turn slight right.
• TurnRight = 3: Turn right.
• TurnSharpRight = 4: Turn sharp right.
• UTurn = 5: U turn.
• TurnSharpLeft = 6: Turn sharp left.
• TurnLeft = 7: Turn left.
• TurnSlightLeft = 8: Turn slight left.
• ReachViaLocation = 9: Reach via location.
• HeadOn = 10: Head on.
• EnterRoundAbout = 11: Enter round about.
• LeaveRoundAbout = 12: Leave round about.
• ChangeLane = 13: Change lane.
• StartAtEndOfStreet = 14: Start at end of street.
• ReachedYourDestination = 15: Reached your destination.
• ChangeLaneRight = 16: Change lane right.
• ChangeLaneLeft = 17: Change lane left.

VehicleType

• (Currently only supports walking (Foot = 0), motorcycles (Motorcycle = 2), motorcars (Motorcar = 3) and trucks (Hgv = 5)).
• Foot = 0: Walking.
• Bicycle = 1: Bicycle.
• Motorcycle = 2: Motorcycle.
• Motorcar = 3: Motorcar.
• Goods = 4: Light Commercial Vehicles (<= 3.5 tons).
• Hgv = 5: Heavy Goods Vehicles (> 3.5 tons); e.g. trucks, lorries.
• Lhv = 6: Longer Heavier Vehicles (<= 44 tons).
• Bdouble = 7: Road Train B-double.
• Roadtrain = 8: Road Train in general.
• Psv = 9: Public Service Vehicle, e.g. buses, coaches.
• Emergency = 10: e.g. ambulance, fire truck, police car...

ViaRouteResult

Routes

• Data type: Route[].
• Meaning: Array of Route objects, ordered by descending recommendation rank.

Via_Points

• Data type: Point[].
• Meaning: Array of Point objects representing snapped coordinates in order.

III. Road information

BatchGetRoadSpeedReult

MaxSpeeds

• Data type: double[].
• Meaning: Set of the corresponding maximum speed values.

MinSpeeds

• Data type: double[].
• Meaning: Set of the corresponding minimum speed values.

ForecastTrackingGeoReturn

DistrictId

• Data type: string.
• Meaning: District administrative unit code of the current location.

DistrictName

• Data type: string.
• Meaning: District name of the current location.

ForcastSignIDs

• Data type: string[].
• Meaning: Array of speed sign ids respectively in RoadNames.

ForcastingDistance

• Data type: double[].
• Meaning: Array of respective distances from the current location to the roads in RoadNames.

Longitudes

• Data type: double[].
• Meaning: Array of longitude of the points corresponding to the signs (the bend).

Latitudes

• Data type: double[].
• Meaning: Array of latitude of the points corresponding to the signs (the bend).

MaxSpeeds

• Data type: double[].
• Meaning: Array of respective maximum speed values in RoadNames.

MinSpeeds

• Data type: double[].
• Meaning: Array of respective minimum speed values in RoadNames.

ProvinceId

• Data type: string.
• Meaning: Province (city) administrative unit code of the current location.

ProvinceName

• Data type: string.
• Meaning: Province (city) name of the current location.

RoadNames

• Data type: string[].
• Meaning: List of road names will meet.

SnapX

• Data type: double.
• Meaning: Longitude of point after snapped to street (avoid equipment error).

SnapY

• Data type: double.
• Meaning: Latitude of point after snapped to street (avoid equipment error).

SpeedMax

• Data type: double.
• Meaning: Maximum speed allowed on the current road.

SpeedMin

• Data type: double.
• Meaning: Mniimum speed allowed on the current road.

Street

• Data type: string.
• Meaning: Current road name.

WardId

• Data type: string.
• Meaning: Ward administrative unit code of the current location.

WardName

• Data type: string.
• Meaning: Ward name of current location.

GetRoadSpeedReult

DistrictId

• Data type: string.
• Meaning: District administrative unit code of the current location.

DistrictName

• Data type: string.
• Meaning: District name of the current location.

MaxSpeeds

• Data type: double[].
• Meaning: Set of the corresponding maximum speed values, vehicle types are defined in TransportTypeSpeed. Vehicle type code corresponds to the index in MaxSpeeds array. Ex: MaxSpeeds[1] = 80, that means the maximum speed of passenger cars running on this road is 80 km/h.

MinSpeeds

• Data type: double[].
• Meaning: Meaning: Set of the corresponding minimum speed values, vehicle types are defined in TransportTypeSpeed. Vehicle type code corresponds to the index in MinSpeeds array. Ex: MinSpeeds[2] = 20, that means the minimum speed of the truck running on this road is 20 km/h.

ProvinceId

• Data type: string.
• Meaning: Province (city) administrative unit code of the current location.

ProvinceName

• Data type: string.
• Meaning: Province (city) name of the current location.

SnapX

• Data type: double.
• Meaning: Longitude of point after snapped to street (avoid equipment error).

SnapY

• Data type: double.
• Meaning: Latitude of point after snapped to street (avoid equipment error).

Street

• Data type: string.
• Meaning: Current road name.

WardId

• Data type: string.
• Meaning: Ward administrative unit code of the current location.

WardName

• Data type: string.
• Meaning: Ward name of current location.

TrackingInformationResult

DistrictId

• Data type: string.
• Meaning: District administrative unit code of the current location.

DistrictName

• Data type: string.
• Meaning: District name of the current location.

MaxSpeed

• Data type: double.
• Meaning: Max speed.

MinSpeed

• Data type: double.
• Meaning: Min speed.

ProvinceId

• Data type: string.
• Meaning: Province (city) administrative unit code of the current location.

ProvinceName

• Data type: string.
• Meaning: Province (city) name of the current location.

SnapX

• Data type: double.
• Meaning: Longitude of point after snapped to street (avoid equipment error).

SnapY

• Data type: double.
• Meaning: Latitude of point after snapped to street (avoid equipment error).

Street

• Data type: string.
• Meaning: Current road name.

WardId

• Data type: string.
• Meaning: Ward administrative unit code of the current location.

WardName

• Data type: string.
• Meaning: Ward name of the current location.

IV. Category

GroupCategory

Categories

• Data type: Category[].
• Meaning: List of categories in the group (if IsGetCategory="True").

GroupCode

• Data type: int.
• Meaning: Group code.

GroupV

• Data type: string.
• Meaning: Vietnamese name of the group.

GroupE

• Data type: string.
• Meaning: English name of the group.

Category

CategoryCode

• Data type: int.
• Meaning: Catagory code.

GroupCode

• Data type: int.
• Meaning: Group code.

NameV

• Data type: string.
• Meaning: Vietnamese name of the catagory.

NameE

• Data type: string.
• Meaning: English name of the catagory.

V. Administrative unit

MBROfRegionResult

Bottom

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

Left

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

Right

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

Top

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

RegionColor

BorderColor

• Data type: int.
• Meaning: Border color of the administrative boundary.

BorderWidth

• Data type: int.
• Meaning: Border width of the administrative boundary (>=1).

FillColor

• Data type: int.
• Meaning: Fill color of the administrative boundary.

SubRegionNameCodesResult

ArrSubCode

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

ArrName

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