com.nbmap.api.optimization.v1

Interface OptimizationService

public interface OptimizationService

Interface that defines the Optimization service (v1).

Since:

2.1.0

Method Summary

Modifier and Type

Method and Description

retrofit2.Call<OptimizationResponse>

getCall(java.lang.String userAgent, java.lang.String user, java.lang.String profile, java.lang.String coordinates, java.lang.String accessToken, java.lang.Boolean roundTrip, java.lang.String radiuses, java.lang.String bearings, java.lang.Boolean steps, java.lang.String overview, java.lang.String geometries, java.lang.String annotations, java.lang.String destination, java.lang.String source, java.lang.String language, java.lang.String distributions)

Method Detail

getCall

@GET(value="optimized-trips/v1/{user}/{profile}/{coordinates}")
retrofit2.Call<OptimizationResponse> getCall(@Header(value="User-Agent")
                                                                                                             java.lang.String userAgent,
                                                                                                             @Path(value="user")
                                                                                                             java.lang.String user,
                                                                                                             @Path(value="profile")
                                                                                                             java.lang.String profile,
                                                                                                             @Path(value="coordinates")
                                                                                                             java.lang.String coordinates,
                                                                                                             @Query(value="key")
                                                                                                             java.lang.String accessToken,
                                                                                                             @Query(value="roundtrip")
                                                                                                             java.lang.Boolean roundTrip,
                                                                                                             @Query(value="radiuses")
                                                                                                             java.lang.String radiuses,
                                                                                                             @Query(value="bearings")
                                                                                                             java.lang.String bearings,
                                                                                                             @Query(value="steps")
                                                                                                             java.lang.Boolean steps,
                                                                                                             @Query(value="overview")
                                                                                                             java.lang.String overview,
                                                                                                             @Query(value="geometries")
                                                                                                             java.lang.String geometries,
                                                                                                             @Query(value="annotations")
                                                                                                             java.lang.String annotations,
                                                                                                             @Query(value="destination")
                                                                                                             java.lang.String destination,
                                                                                                             @Query(value="source")
                                                                                                             java.lang.String source,
                                                                                                             @Query(value="language")
                                                                                                             java.lang.String language,
                                                                                                             @Query(value="distributions")
                                                                                                             java.lang.String distributions)

Parameters:

userAgent - the application information

user - the user which the OSRM engine should run on, typically Nbmap

profile - the profile optimization should use

coordinates - the coordinates used to calculate the trip

accessToken - valid nbmap access token

roundTrip - returned route is a round trip (route returns to first location). Allowed values are: true (default) or false

radiuses - maximum distance in meters that each coordinate is allowed to move when snapped to a nearby road segment. There must be as many radiuses as there are coordinates in the request. Values can be any number greater than 0 or they can be the string unlimited. If no routable road is found within the radius, a NoSegment error is returned

bearings - used to filter the road segment the waypoint will be placed on by direction and dictates the angle of approach

steps - define if you'd like the route steps inside the response

overview - route geometry can be simplified or full

geometries - route geometry

annotations - an annotations object that contains additional details about each line segment along the route geometry. Each entry in an annotations field corresponds to a coordinate along the route geometry

destination - returned route ends at any or last coordinate. Allowed values are: any (default) or last

source - returned route starts at any or first coordinate. Allowed values are: any (default) or first

language - language of returned turn-by-turn text instructions

distributions - specify pick-up and drop-off locations

Returns:

The OptimizationResponse in a Call wrapper

Since:

2.1.0