directions

fun directions(venueId: String, origin: String, destination: String, avoid: String? = null, language: String? = null, units: UnitSystem? = null, waypoints: String? = null, optimize: Boolean? = null, mode: String? = null): DirectionsResponse

Returns the directions to go from an origin (lat,lng,level) to a destination (lat,lng,level)

Return

DirectionsResponse

Parameters

venueId

ID of the venue to get

origin

a string with the format lat,lng,level or poi_id (identifier of a POI) or ref:poi_ref (ref of a poi with starting with 'ref:')

destination

a string with the format lat,lng,level or poi_id (identifier of a poi) or ref:poi_ref (ref of a poi with starting with 'ref:')

avoid

a string with the format level;lat,lng;lat,lng;lat,lng...|level;lat,lng;lat,lng;lat,lng...

language

the language code (en, fr...)

units

available values : metric, imperial

waypoints

a list of points by which the route should pass. Ex: lat,lng,level|poi_id|lat,lng,level|ref:poi_ref

optimize

Optionally, you may pass optimize:true with the waypoints parameter. This way the provided route is optimized by rearranging the waypoints in a more efficient order

mode

the mode to use to calculate the path (depends on the modes which were used to digitize the venue)

Throws

If the request is not correctly configured

Rethrows the OkHttp execute method exception

If the API returns an informational or redirection response

ClientException

If the API returns a client error response

ServerException

If the API returns a server error response