v1

latestOpenAPI 3.0.02026-07-1419035.1 KB
Search

Along Route Search

post/search/{versionNumber}/searchAlongRoute/{query}.{ext}

Path parameters

versionNumber2 required

Service version number. The current value is 2.

querystring required

Query string. Must be properly URL encoded.

ext'json' | 'jsonp' | 'js' | 'xml' required

Expected response format.

Query parameters

maxDetourTimeinteger required

Maximum detour time

limitinteger

Maximum number of search results that will be returned.

Request body

Example request

{
  "route": {
    "points": [
      {
        "lat": 37.7524152343544,
        "lon": -122.43576049804686
      },
      {
        "lat": 37.70660472542312,
        "lon": -122.43301391601562
      },
      {
        "lat": 37.712059855877314,
        "lon": -122.36434936523438
      },
      {
        "lat": 37.75350561243041,
        "lon": -122.37396240234374
      }
    ]
  }
}

Response

OK: the search successfully returned zero or more results.