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