目录

Response Parameters

Cell

Parameter

Mandatory

Type

Description

status

Yes

int

Result code for route calculation between the departure place and destination. For details, please refer to Result Codes.

distance

No

double

Route distance, in meters.

distanceText

No

String

Distance description.

duration

No

double

Journey time, in seconds.

durationText

No

String

Journey time description.

CoordinateBounds

Parameter

Mandatory

Type

Description

northeast

Yes

Coordinate

Coordinates of the northeast corner.

southwest

Yes

Coordinate

Coordinates of the southwest corner.

Dataset

Parameter

Mandatory

Type

Description

id

Yes

String

Custom data ID.

minLength: 32

maxLength: 36

Example: 28f61af50fc9452aa0ed5ea25c3cc3d3

type

Yes

String

Data type.

minLength: 2

maxLength: 64

fileNum

Yes

integer

Number of files.

fileSize

Yes

integer

File size, in KBs.

recordNum

No

integer

Number of records. This parameter is supported only for vector data.

uploadDuration

Yes

integer

Time required for upload, in seconds.

createdTime

Yes

integer

Creation time.

modifiedTime

No

integer

Last modification time.

Dict

Parameter

Mandatory

Type

Description

distance

No

double

Route distance, in meters.

status

No

int

Traffic status. The options are as follows:

  • 0: unknown
  • 1: smooth
  • 2: slow
  • 3: congested
  • 4: extremely congested

polyline

No

Coordinate[]

A series of coordinates of a road section.

ElevationResult

Parameter

Mandatory

Type

Description

elevation

Yes

Number

Altitude, in meters.

location

Yes

Coordinate

Longitude and latitude.

resolution

Yes

Number

Maximum distance between elevation data points, in meters.

NaviSnappedPoint

Parameter

Mandatory

Type

Description

lat

Yes

double

Latitude.

lng

Yes

double

Longitude.

roadID

Yes

String

ID of a road.

Path

Parameter

Mandatory

Type

Description

steps

Yes

Step[]

Route section information.

distance

No

double

Route distance, in meters.

distanceText

No

String

Distance description.

duration

No

double

Journey time, in seconds.

durationText

No

String

Journey time description.

durationInTraffic

No

double

Journey time calculated based on the real-time traffic condition, in seconds.

durationInTrafficText

No

String

Description of the journey time calculated based on the real-time traffic condition.

startLocation

Yes

Coordinate

Longitude and latitude of the departure place.

startAddress

No

String

Departure place details.

endLocation

Yes

Coordinate

Longitude and latitude of the destination.

endAddress

No

String

Destination details.

viaWaypoints

No

ViaWayPoints[]

Waypoint information.

Route

Parameter

Mandatory

Type

Description

Value

paths

Yes

Path[]

Planned routes.

-

optimizedWaypoints

No

int[]

Optimized waypoint index. This parameter is available only when viaType is set to false and optimize is set to true.

-

bounds

No

CoordinateBounds

Route bounds.

-

hasRestrictedRoad

No

int

Indicates whether the route includes private or restricted roads.

  • 0: no
  • 1: yes

dstInRestrictedArea

No

int

Indicates whether the destination is in a restricted area.

crossCountry

No

int

Indicates whether the route crosses a country boundary. (Learn about the COVID-19 restriction policies before departure.)

crossMultiCountries

No

int

Indicates whether the route crosses multiple country boundaries.

hasRoughRoad

No

int

Indicates whether the route includes rough roads.

dstInDiffTimeZone

No

int

Indicates whether the time zone of the destination is different from that of the departure place.

hasFerry

No

int

Indicates whether the route includes ferry.

hasTrafficLight

No

int

Indicates whether the route has traffic lights.

hasTolls

No

int

Indicates whether the route includes toll gates.

hasStairs

No

int

Indicates whether the route has stairs.

trafficLightNum

No

int

Number of traffic lights.

-

Row

Parameter

Mandatory

Type

Description

cells

Yes

Cell[]

Information about each cell in the distance matrix.

Step

Parameter

Mandatory

Type

Description

distance

No

double

Route distance, in meters.

distanceText

No

String

Distance description.

duration

No

double

Journey time, in seconds.

durationText

No

String

Journey time description.

startLocation

No

Coordinate

Longitude and latitude of the departure place.

endLocation

No

Coordinate

Longitude and latitude of the destination.

action

No

String

Operation to be performed in the current step. The options are as follows:

  • TURN_SLIGHT_LEFT
  • TURN_SHARP_LEFT
  • UTURN_LEFT
  • TURN_LEFT
  • TURN_SLIGHT_RIGHT
  • TURN_SHARP_RIGHT
  • UTURN_RIGHT
  • TURN_RIGHT
  • STRAIGHT
  • RAMP_LEFT
  • RAMP_RIGHT
  • MERGE
  • FORK_LEFT
  • FORK_RIGHT
  • FERRY (not supported currently)
  • FERRY_TRAIN (not supported currently)
  • ROUNDABOUT_LEFT
  • ROUNDABOUT_RIGHT
  • END

polyline

No

Coordinate[]

A series of coordinates of a road section (including coordinates of the departure place and destination).

roadName

No

String

Road name.

orientation

No

int

Road direction. The options are as follows:

  • 0: bidirectional
  • 1: forward direction
  • 2: reverse direction

instruction

No

String

Text instruction.

traffic

No

Dict[]

Traffic information.

ViaWayPoints

Parameter

Mandatory

Type

Description

location

Yes

Coordinate

Longitude and latitude of the waypoint.

stepIndex

Yes

int

Waypoint index in the Step array.

TileLayer

Parameter

Mandatory

Type

Description

id

Yes

String

Layer ID.

name

Yes

String

Layer name.

description

No

String

Layer description.

type

Yes

String

Layer type.

  • VECTOR
  • RASTER

features

Yes

LayerFeature[]

Layer feature. Only one feature can be configured for a raster map.

TileLayerJob

Parameter

Mandatory

Type

Description

layerId

Yes

String

Layer ID.

jobId

Yes

String

Task ID.

status

Yes

String

Task status. The options are as follows:

  • WAIT_PUBLISH: to be released
  • PUBLISHING: being released
  • SUCCESS_PUBLISH: released successfully
  • FAIL_PUBLISH: failed to be released
  • SUCCESS_COMPILE: compiled successfully

failReason

No

String

Compilation failure reason.

tileSize

No

integer

Total size of compiled tiles returned after compilation success, in KBs.

tileNum

No

integer

Number of compiled tiles returned after compilation success.

compileDuration

No

integer

Time required for compilation, which is returned after compilation success, in seconds.

saveDuration

No

integer

Time required for saving compiled tiles, which is returned after compilation success, in seconds.

publishBeginTime

No

integer

Release start time.

publishEndTime

No

integer

Release end time.

TileLayerTask

Parameter

Mandatory

Type

Description

id

Yes

String

Layer ID.

type

Yes

String

Layer type.

  • VECTOR
  • RASTER

name

Yes

String

Layer name.

description

No

String

Layer description.

task

No

String

Layer status. The options are as follows:

  • WAIT_PUBLISH: to be released
  • PUBLISHING: being released
  • SUCCESS_PUBLISH: released successfully
  • FAIL_PUBLISH: failed to be released
  • SUCCESS_COMPILE: compiled successfully

createdTime

Yes

integer

Creation time.

modifiedTime

No

integer

Last modification time.