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

Версия от 08:23, 26 декабря 2024

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

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

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

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

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

Параметры

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

Ответ

Коды ответов

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

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

Объект `CountryWithRegions`

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

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

Объект `Region`

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

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

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

<{
  "countyName": "France",
  "countryCode": "FR",
  "regionCount": 2,
  "regions": [
    {
      "name": "Auvergne-Rhone-Alpes",
      "code": "ARA"
    },
    {
      "name": "Bourgogne-Franche-Comte",
      "code": "BFC"
    }
  ]
}

@@ Строка 4: / Строка 4: @@
 {| class="wikitable"
 | rowspan="2" |GET
-|Managed
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/rum/regions/{countryCode}</nowiki></code>
 |-
@@ Строка 91: / Строка 91: @@
 === JSON-модель тела ответа ===
-  <code>{
+  <{
     "countyName": "France",
     "countryCode": "FR",