Get the province/state for locations

Request

Get a list of provinces/states, for locations available to the user, with filtering on businesses, countries, or a search text

Security

X-API-KEY or Authorization

Query

businessIdsArray of strings

Get the provinces / states of locations associated with specific Business Id(s)

countriesArray of strings

Get provinces / states for locations in a country

querystring

Restricts the response to the provinces/states that contain this text, for example 'indi' would return 'Indiana' when appropriate.

maxinteger, (int64)

Maximum number of items to return

offsetinteger, (int64)

Offset used for pagination. Default: 0

curl -i -X GET \
  'https://uberall.com/api/locations/provinces?businessIds=string&countries=string&query=string&max=0&offset=0' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Provinces successfully retrieved

Body*/*

statusstringrequired

Enum:"SUCCESS""PENDING""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER"

messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

Provinces response model

Response

{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "provinces": [
      "Province1",
      "Province2"
    ]
  }
}