Find provider locations

post

Search for locations and groups that match a query, where there are at least one active provider in good health. The match algorithm accounts for typos and misspelling, and the tolerance can be tuned in the input. Note that a location or group will need to be mapped to an actual provider using /network/find-providers.

Body

querystringOptional

max_distance_fractionnumberOptional

enable_max_distance_fractionbooleanOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /network/find-provider-locations HTTP/1.1
Host: api.bringyour.com
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "query": "text",
  "max_distance_fraction": 1,
  "enable_max_distance_fraction": true
}

200Success

{
  "specs": [
    {
      "location_id": "text",
      "location_group_id": "text",
      "client_id": "text",
      "best_available": true
    }
  ],
  "groups": [
    {
      "location_group_id": "text",
      "name": "text",
      "provider_count": 1,
      "promoted": true,
      "match_distance": 1
    }
  ],
  "locations": [
    {
      "location_id": "text",
      "location_type": "city",
      "name": "text",
      "city": "text",
      "city_location_id": "text",
      "region": "text",
      "region_location_id": "text",
      "country": "text",
      "country_location_id": "text",
      "country_code": "text",
      "provider_count": 1,
      "match_distance": 1
    }
  ],
  "devices": [
    {
      "client_id": "text",
      "device_name": "text"
    }
  ]
}