GET города региона

Перечисляет города региона.

Запрос создает в качестве полезной нагрузки application/jsonформат.

GET	Managed	https://{your-domain}/e/{your-environment-id}/api/v2/rum/cities/{countryCode}/{regionCode}
	Среда АктивногоШлюза	https://{your-activegate-domain}/e/{your-environment-id}/api/v2/rum/cities/{countryCode}/{regionCode}

Аутентификация

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия « Чтение географических регионов » ( geographicRegions.read) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Параметр	Тип	Описание	In	Необходимость
countryCode	string	Код ISO требуемой страны. Чтобы получить список доступных кодов стран, используйте запрос GET для всех стран .	path	требуется
regionCode	string	Код нужного региона. Чтобы получить список доступных кодов регионов, используйте регионы GET запроса страны.	path	требуется

Ответ

Коды ответов

Код	Тип	Описание
200	CountryWithRegionsWithCities	Успех. Ответ содержит список городов области.
404	ErrorEnvelope	Не удалось. Запрошенный ресурс не существует.

Объекты тела ответа

Объект CountryWithRegionsWithCities

Информация о стране.

Элемент	Тип	Описание
countryName	string	Название страны.
countryCode	string	Код ISO страны.
regionCount	integer	Количество регионов в стране.
regions	RegionWithCities[]	Список регионов страны.

Объект RegionWithCities

Информация о регионе страны и его городах.

Элемент	Тип	Описание
name	string	Название региона.
code	string	Код региона.
cityCount	integer	Количество городов в регионе страны.
cities	City[]	Список городов области.

Объект City

Информация о городе.

Элемент	Тип	Описание
name	string	Название города.
latitude	number	Широта города.
longitude	number	Долгота города.

JSON-модель тела ответа

{
  "countryName": "France",
  "countryCode": "FR",
  "regionCount": 13,
  "regions": [
    {
      "name": "Auvergne-Rhone-Alpes",
      "code": "ARA",
      "cityCount": 4,
      "cities": [
        {
          "name": "Abondance",
          "latitude": 46.2806,
          "longitude": 6.7217
        },
        {
          "name": "Abrest",
          "latitude": 46.1008,
          "longitude": 3.4463
        }
      ]
    }
  ]
}