Список регионов (localisation/region)

Метод позволяет получить список всех регионов зарегистрированных в системе. Данный метод можно использовать например, что-бы отфильтровать список городов или список отделений по регионам.

URL запроса: https://api.multi-point.net/index.php?route=localisation/region&api_key=XXX

(где XXX, ключ API сгенерированный в панели управления поставщика ПВЗ).

Тип запроса: GET

В методах получения списков используется пагинация и параметры page и limit, в случае отсутствия значения / параметра в запросе ответ приходит по умолчанию со следующими значениями:

page = 1

limit = 20

Параметры URL запроса

Параметр	Описание	Формат	Обязательно
api_key	Ключ API сгенерированный в панели управления поставщика ПВЗ	строка	Да
name	Название региона	строка	Нет
code	Код региона согласно стандарту ISO 3166-2 без приставки RU- например: MOW для Москвы	строка	Нет
page	Страница, значение по умолчанию 1	целое число	Нет
limit	Лимит (кол-во) возвращаемых значений на страницу, по умолчанию 20	целое число	Нет

Пример реализации запроса на PHP с помощью CURL

    $url = 'https://api.multi-point.net/index.php?route=localisation/region&api_key=XXX&code=MOW&page=1&limit=20';
    
    $ch = curl_init();
    
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
    
    $response = curl_exec($ch);
    
    curl_close($ch);
    
    $result = json_decode($response, true);

    return $result;

Успешный результат выполнения примера 

    Array
    (
        [regions] => Array // Массив регионов
            (
                [0] => Array
                    (
                        [region_id] => 39 // Идентификатор региона в системе
                        [name] => Москва // Название региона
                        [code] => MOW // Код региона согласно стандарту ISO 3166-2 без приставки RU-
                        [coords] => 55.755814, 37.617635 // Координаты региона
                    )
            )
        [total_regions] => 1 // Общее количество регионов найденных по результату запроса
        [total_pages] => 1 // Общее количество страниц по результату запроса
    )

Результат примера выполненный с ошибкой авторизации

    Array
    (
        [error] => Array // Массив ошибок
         (
            [warning] => У Вас нет прав для просмотра списка регионов! // Ключ = строковый код ошибки, значение = текст ошибки
         )
    )