Get potential recalculation gain for tour

Request

Get potential recalculation gain for tour - how much time could be save, if instead of a fixed optimisation sequence update a full optimsation sequence update is done instead. Recommended for tours with “fixed” and “use provided” optimization only; ensure to have a destination set on the tour beforehand.

Security

ApiKeyAuth

Path

tourIdstring, (uuid)required

Unique tour identifier (generated by Better Route backend)

Example:3fa85f64-5717-4562-b3fc-2c963f66afa6

Query

latnumber, (double)required

lonnumber, (double)required

curl -i -X GET \
  'https://dev.routes.bettermile.com/v1/tours/3fa85f64-5717-4562-b3fc-2c963f66afa6/potential-recalc-gain?lat=0.1&lon=0.1' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Potential recalculation gain - how much time can be saved after tour recalculation.

Bodyapplication/json

dataobject(PotentialRecalcGainResponse)

Result of requesting for potential recalculation gain

Example:

{
  "potentialGainInSeconds": 420
}

Response

{
  "data": {
    "potentialGainInSeconds": 420
  }
}