LMS (метод)

Материал из post-API.ru
Перейти к: навигация, поиск

Данный метод (аббр. - List of Metro Stations) предназначен для загрузки в поля выбора станции метро. Преимущества использования этого метода для Интернет-магазина:

  • Гибкая возможность загрузки перечня станций в разных форматах (с именем линии, без линии, плоская таблица, иерархическая таблица).
  • Возврат цвета линии и имени линии дает практически неограниченные возможности кастомизации.
  • Возможность вернуть координаты станций в формате GPS.
  • Работа с метро двух городов: Москва, Санкт-Петербург.


Версия API

 Версия 2.0

Вызов

 http://post-api.ru/api/v2/lms.php?apikey=dev&d=1&city=spb&type=1&colors=1&coords=0

Параметры

Ключ Обязательный Описание
city О Код города, для которого загружаются данные. Должен принимать одно из двух значений: "msk" (Москва) или "spb" (Санкт-Петербург).
type О Тип выборки. Принимает значения от 0 до 2. "0" - возвращаются только названия станций. "1" - возвращается иерархическая структура, состоящая из названия линии метро, каждая из которых содержит массив входящих в нее названий станций. "2" - возвращается "плоская" таблица, где каждый элемент массива содержит и название станции, и название линии.
colors Н Если ключ установлен в "1", то каждая станция будет дополнена информацией о цвете линии метро, на которой она расположена.
coords Н Если ключ установлен в "1", то каждая станция будет дополнена информацией о географических координатах GPS, в которых она расположена.
apikey О Ключ доступа к API.
d Н Отладочный режим.


Возвращаемое значение

С этим методом связаны следующие массивы-ответы: LMSv2_content_type_0, LMSv2_content_type_1, LMSv2_content_type_2.

При успешном выполнении запроса возвращается следующий массив-ответ.

   [id] => LMS                        // Тип результирующей структуры
   [api_ver] => 2.0                   // Входит в семейство методов версии 2.0
   [status] => ok                     // Результат вызова метода. Может быть error и ok
   [access] => active                 // Статус ключа доступа к post-API.ru
   [access_status] => ok              // Статус доступа с использованием ключа
   [executed_time] => 0.05159         // Время исполнения скрипта (без учета сетевых задержек)
   [source] => Array                  // Исходные данные, передаваемый в базу данных (контроль)
       (
           [city] => spb
           [type] => 1
           [colors] => 1
           [coords] => 0
       )
   [content] =>                       // структура LMSv2_content_type_0, LMSv2_content_type_1, LMSv2_content_type_2.

При не успешном выполнении метода возвращается массив-ответ с ошибкой

   [id] => LMS
   [api_ver] => 2.0
   [access] => active
   [access_status] => ok
   [executed_time] => 0
   [status] => error
   [content] => Array
       (
           [msg] => Тип выборки должен принимать значения 0, 1 или 2
           [err] => lms_typeunknown
       )


Особенности

  1. См. описание соответствующих структур
  2. С тестовым ключом "apikey=dev" количество возвращаемых значений ограничено 20.

Обсуждение

 Форум для обсуждения метода LMS

Примеры использования

  • нет

Фрагменты кода

нет

История

  • 20.06.2013 - Метод создан