Route/region

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

Версия API

 Версия 5.0 (общее описание).

Описание

Модель region является частью модели route, и описывает географический объект - область, республика, край. В случае города федерального значения является пустой.

Ниже приведена структура модели на route/region на примере Воронежской области.

"route":
{
    "region": 
    {
       "type": "region",
       "aoguid": "b756fe6b-bbd3-44d5-9302-5bfcc740f46e",
       "formalname": "Воронежская",
       "shortname": "обл.",
       "longshortname": "область",
       "typename": "Область",
       "fullname": "Воронежская Область",
       "order": true,
       "aolevel": 1,
       "postalcode": "",
       "location": [ 40.233395, 50.970898 ],
       "upper": [ 42.947304, 52.103502 ],
       "lower": [ 38.138676, 49.556986 ]
    }
}

Значения полей модели route/region представлено в следующей таблице.

Поле Значение
type Наименование модели. Для модели route/region - всегда принимает значение region.
aoguid Идентификатор географического объекта (в данном случае - Воронежская область) в формате ФИАС.
formalname Наименование географического объекта без указания его типа
shortname Тип географического объекта в сокращенной форме, допускающий ее показ клиенту. Например, обл., респ.. край - не сокращается.
longshortname Тип географического объекта в полной форме, например, область, республика.
typename Тип географического объекта в полной форме, записанный в соответствии с таблицей socrbase ФИАС.
fullname Полное наименование географического объекта, составленное из formalname и typename, с учетом параметра order.
order Флаг, определяющий положение shortname, longshortname и typename относительно formalname. Если значение данного поля равно true, то тип объекта должен ставиться после наименования объекта (например, "Воронежская область"). Если значение данного поля равно false, то тип объекта должен ставиться перед наименованием объекта (например, "Республика Татарстан").
aolevel Уровень географического объекта, в соответствии с ФИАС.
postalcode Индекс данного географического объекта, в случае, если за данным географическим объектом закреплен единственный индекс. Если данное поле не пустое - его можно показывать клиенту как почтовый индекс введенного им адреса. Если поле пустое, то существует неоднозначность. Чтобы вывести клиенту список индексов (например, для выбора нужного), необходимо использовать метод TBD/TBD.
location Географические координаты географического объекта, в формате [ long, lat ].
upper Географические координаты верхнего левого угла условного квадрата, описывающего географический объект, в формате [ long, lat ].
lower Географические координаты правого нижнего угла условного квадрата, описывающего географический объект, в формате [ long, lat ].