Tracking route OSRM¶

API path: /route/osrm.

get¶

Gets route points via OSRM API.

parameters¶

Where location described in data types description section.

examples¶

curl -X POST 'https://api.navixy.com/v2/fsm/route/osrm/get' \
    -H 'Content-Type: application/json' \ 
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "start": {"lat": 56.827001, "lng": 60.594296}, "end": {"lat": 52.835601, "lng": 60.514721}}'

response¶

{
    "success": true,
    "distance": 2546,
    "time": 194,
    "list": [{"lat": 56.827001, "lng": 60.594296}, {"lat": 52.835601, "lng": 60.514721}],
    "key_points": [{
      "id": 123,
      "lat": 56.827,
      "lng": 60.594296
    }] 
}

• distance - int. Length in meters.
• time - int. Duration in seconds.
• list - list of route points. Location objects.
• key_points - list of points corresponding to start point, waypoints and end point (in that sequence).
  • id - int. index in points list.
  • lat - float. Latitude.
  • lng - float. Longitude.

errors¶

• 215 (External service error).

• 218 (Malformed external service parameters).

  {
      "success": false,
      "status": {
          "code": 218,
          "description": "Malformed external service parameters"
      },
      "errors": [
          {
              "status": "NOT_FOUND",
              "status_code": 207,
              "message": "Cannot find route between points"
          }
      ]
  }
  

  • status - string enum.
    • NOT_FOUND – indicates at least one of the locations specified in the request's origin, destination, or waypoints could not be geocoded, or OSRM cannot find route.
    • UNKNOWN_ERROR – unexpected OSRM error code.
  • status_code - int. OSRM status code (don't rely on it).
  • message - string. OSRM error message (don't rely on it).

• 236 (Feature unavailable due to tariff restrictions) – if there is at least one tracker without "routing" tariff feature.