Get Route Path

Trip Management’s Get Route Path gets the Lat/Lon coordinates that the InProgress or Completed route takes from origin to destination.

The following two variations of requests are supported for this functionality:

GET /trip/{tripId}/routePath

Request Fields

FieldDescriptionTypeRequired
tripIdThe alkTripId returned when you planned the trip.integerYes

GET /trip/routePath?tripId={tripId}

Request Fields

FieldDescriptionTypeRequired
tripIdThe alkTripId returned when you planned the trip or the tmsTripId in your planning system.
Note: Only one can be used when making a request through the URL. The search logic will check for the user’s trips with matching tmsTripId. If no trips are found with provided tmsTripId, then the check will continue for trips with matching alkTripId. If no trip is found matching with either of the Trip IDs, then no trip found response will be returned.
integer or stringYes

Response Fields

Same response for both the types of requests

FieldDescriptionType
TypeThe type of the GetRoutePath response.string
TMinutesThe total duration of the trip, in minutesinteger
TDistanceThe total distance of the trip in the distance units specified by the trip’s options (Miles or KM).integer
GeometryContains the Coordinate points along the route.GeoJsonGeometry object
Geometry/typeThe type of the geometric object.string
Geometry/coordinatesAn array of latitude and longitude coordinates along the route.Array <double>

Example

Sample Response

{
  "type": "Feature",
  "geometry": {
    "type": "MultiLineString",
    "coordinates": [
      [
        [-74.59927, 40.360399],
        [-74.599225, 40.360364],
        [-74.599295, 40.36029],
        [-74.599365, 40.363488]
      ]
    ]
  },
  "tMinutes": 1,
  "tDistance": 0.905
}