Города
Города
Список городов (localisation/city)
Метод позволяет получить список всех городов зарегистрированных в системе. Данный метод можно использовать например, что-бы отфильтровать список отделений по городам.
URL запроса: https://api.multi-point.net/index.php?route=localisation/city&api_key=XXX
(где XXX, ключ API сгенерированный в панели управления поставщика ПВЗ).
Тип запроса: GET
В методах получения списков используется пагинация и параметры page и limit, в случае отсутствия значения / параметра в запросе ответ приходит по умолчанию со следующими значениями:
page = 1
limit = 20
Параметры URL запроса
Параметр | Описание | Формат | Обязательно |
api_key | Ключ API сгенерированный в панели управления поставщика ПВЗ | строка | Да |
region_id | Идентификатор региона в системе Multi Point | целое число | Нет |
name | Название города | строка | Нет |
page | Страница, значение по умолчанию 1 | целое число | Нет |
limit | Лимит (кол-во) возвращаемых значений на страницу, по умолчанию 20 | целое число | Нет |
Пример реализации запроса на PHP с помощью CURL
$url = 'http://api.multi-point.net/index.php?route=localisation/city&api_key=XXX®ion_id=55&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 ( [cities] => Array // Массив городов ( [0] => Array ( [region_id] => 55 // Идентификатор региона в системе [region] => Ростовская область // Название региона [city_id] => 200 // Идентификатор города в системе [name] => Азов // Название города [coords] => 47.112442, 39.423581 // Координаты города ) ) [total_cities] => 1 // Общее количество регионов найденных по результату запроса [total_pages] => 1 // Общее количество страниц по результату запроса )
Результат примера выполненный с ошибкой авторизации
Array ( [error] => Array // Массив ошибок
( [warning] => У Вас нет прав для просмотра списка городов! // Ключ = строковый код ошибки, значение = текст ошибки
) )