ИнтеграцияИнтеграция по APIРабота с регионами

Работа с регионами

Получение списка регионов

Общее описание

Функция GET /v6/api/regionManagement/regions позволяет получить список регионов.

Параметры вызова

Функция не имеет дополнительных параметров.

Результат выполнения

Функция возвращает массив структур со следующими параметрами регионов:

Параметр Описание
regionID ИД региона
name Название региона
parentID ИД родительского региона
timeOffset Разница во времени между часовым поясом региона и нулевым часовым поясом (UTC)

Формат запроса

GET /v6/api/regionManagement/regions HTTP/1.1
Host: host		
Authorization: Bearer token

Пример запроса

GET /v6/api/regionManagement/regions HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Формат ответа

[
    \{
        "regionID": integer,
        "name": "string",
        "parentID": integer,
        "timeOffset": integer
    },
    \{
        "regionID": integer,
        "name": "string",
        "parentID": integer,
        "timeOffset": integer
    }
]

Пример ответа

[
    \{
        "regionID": 0,
        "name": "Москва и Московский регион",
        "parentID": -1,
        "timeOffset": 180
    },
    \{
        "regionID": 1,
        "name": "Санкт-Петербург и Ленинградская область",
        "parentID": 61,
        "timeOffset": 180
    }
]