Route (версия 2)

Материал из post-API.ru
Перейти к: навигация, поиск
Модель с этим именем использовалась в предыдущих версиях API. См. route.

Описание

Структура route описывает цепочку адресов "область - автономная область - район - город". Используется:

 [route] => Array
   (
      [region] => Array                   // Область, край
         (
            [aoguid] => 0c5b2444-70a0-4932-980c-b4dc0d3f02b5
            [formalname] => Московская    // Имя области для поиска
            [shortname] => обл.           // Тип адресного объекта
            [offname] => Московская       // Официальное название (может включать "ё")
            [aolevel] => 1                // Уровень адресного объекта
            [order] => ord_s ord_f        // Правило сортировки объекта
         )
      [reserved1] => Array                // Зарезервировано под уровень адресного объекта "2"
         (
            [aoguid] =>
            [formalname] => 
            [shortname] => 
            [offname] => 
            [aolevel] =>
            [order] => ord_s ord_f
         )
      [area] => Array                     // Район
         (
            [aoguid] =>
            [formalname] => Пушкинский
            [shortname] => р-н
            [offname] => Пушкинский
            [aolevel] => 3
            [order] => ord_s ord_f
         )
      [city] => Array                     // Город, село, деревня
         (
            [aoguid] => 6d5b4298-71b0-1034-950c-b9daed3b03b0
            [formalname] => Ивантеевка 
            [shortname] => г.
            [offname] => Ивантеевка
            [aolevel] => 5
            [order] => ord_s ord_f
         )
   )

Особенности

  • Поле city может быть заполнено не всегда. Если при выполнении какого-либо метода возвращается два города (чаще - села), то структура city будет пустой.
  • Структура route всегда содержит все индексы (formalname, shortname, offname, aolevel), независимо от того, есть соответствующие поля в базе данных или нет. Другими словами, проверка на наличие полей функцией isset не требуется.


История

  • 12.08.2013 Теперь для каждого элемента массива всегда присутствует aoguid для перекрестных ссылок внутри различных баз данных других проектов на базе ФИАС
  • 14.04.2013 Название элемента массива ["route"]["autonom"] изменено на ["route"]["reserved1"]