GET города страны

Материал из Документация Ключ-АСТРОМ
Версия от 17:00, 18 октября 2022; ENetrebin (обсуждение | вклад) (Новая страница: «Список регионов и городов страны. Запрос создает в качестве полезной нагрузки <code>application...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Список регионов и городов страны.

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

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

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

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

Параметры

Параметр Тип Описание In Необходимость
countryCode string Код ISO требуемой страны.

Чтобы получить список доступных кодов стран, используйте запрос 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
        }
      ]
    }
  ]
}