List cities.

GET

/api/web/custom/countries/{country_code}/states/{state_code}/cities/{prefix}

curl --request GET \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/web/custom/countries/example/states/example/cities/example \
  --header 'Authorization: <Authorization>'

• F5 Distributed Cloud Console

Returns a list of known cities of a country/state.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

country_code

required

string

Country code 2 characters country code as described in https://en.wikipedia.org/wiki/ISO_3166-1, column alpha-2

state_code

required

string

State code 2 characters country code as described in https://en.wikipedia.org/wiki/ISO_3166-2:US/CA/IN, column code, excluding the leading country code.

prefix

required

string

Prefix first two or more characters of the city you look for (can be upper or lower case)

Responses

200

A successful response.

Media typeapplication/json

City list response

ListCitiesResponse contains a list of cities (for a country) supported by the platform.

object

cities

available cities in the country

List of all cities in.

Array<object>

City item

CityItem contains a single element of city list response.

object

additional_info

additional information

Any additional information related to the city.

object

city_name

city name

Name of the city in the human readable form (can be used as a description)

string

<= 1024 characters

error_code

string

default: EUNKNOWN

Allowed values: EUNKNOWN ETOKEN_OK ETOKEN_FAILED ETOKEN_NOTFOUND ETOKEN_USED ETOKEN_EXPIRED EUSER_OK EUSER_EXISTS EUSER_FAILED ECONTACT_VALIDATE_OK ECONTACT_EMPTY_COUNTRY ECONTACT_EMPTY_ZIP_CODE ECONTACT_UNKNOWN_COUNTRY ECONTACT_INVALID_ZIP EOK ENO_STATES ENO_CITIES

Example

{
  "error_code": "EUNKNOWN"
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example