GET регионы: различия между версиями

Материал из Документация Ключ-АСТРОМ
(Новая страница: «Список стран и их регионов. Запрос создает в качестве полезной нагрузки <code>application/json</code>...»)
 
 
Строка 32: Строка 32:
=== Объекты тела ответа ===
=== Объекты тела ответа ===


==== Объект _ <code>CountryListWithRegions</code> ====
==== Объект <code>CountryListWithRegions</code> ====
Список стран с их регионами.
Список стран с их регионами.
{| class="wikitable"
{| class="wikitable"

Текущая версия на 16:56, 18 октября 2022

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

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

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

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

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

Параметры

Запрос не предоставляет никаких настраиваемых параметров.

Ответ

Коды ответов

Код Тип Описание
200 CountryListWithRegions Успех. Ответ содержит список стран с региональными подразделениями.

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

Объект CountryListWithRegions

Список стран с их регионами.

Элемент Тип Описание
countryCount integer Количество стран.
countries CountryRegions[] Список стран.

Объект CountryRegions

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

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

Объект Region

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

Элемент Тип Описание
name string Название региона.
code string Код региона.

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

{
  "countryCount": 252,
  "countries": [
    {
      "name": "France",
      "code": "FR",
      "regionCount": 2,
      "regions": [
        {
          "name": "Auvergne-Rhone-Alpes",
          "code": "ARA"
        },
        {
          "name": "Bourgogne-Franche-Comte",
          "code": "BFC"
        }
      ]
    },
    {
      "name": "Belgium",
      "code": "BE",
      "regionCount": 2,
      "regions": [
        {
          "name": "Antwerp Province",
          "code": "01"
        },
        {
          "name": "Brussels Captial",
          "code": "11"
        }
      ]
    }
  ]
}