Geoip (модель)

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

Версия API

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

Описание

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

Основная идея - предоставить в сжатой форме максимум человекоудобной информации, и идентификатор aoguid, по которому можно быстро загрузить полноценную модель route.

Ниже приведена структура модели geoip.

{
  "model": "geoip",
  "country": "Россия",
  "cc": "ru",
  "region": "Воронежская обл.",
  "area": "",
  "cityshort": "г.",
  "city": "Воронеж",
  "placeshort": "",
  "place": "",
  "aoguid": "5bf5ddff-6353-4a3d-80c4-6fb27f00c6c1",
  "printname": "г. Воронеж, Воронежская обл.",
  "is_federal": false,
  "timeoffset": 3
}

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

Поле Значение
model Имя модели.
country Наименование страны, в формате, удобном для вывода клиенту.
cc 2-х буквенный код страны в нижнем регистре.
region Наименование региона, или пустая строка при его отсутствии, в формате, удобном для вывода клиенту.
area Наименование района, или пустая строка при его отсутствии, в формате, удобном для вывода клиенту.
cityshort Тип населенного пункта.
city Населенный пункт.
placeshort Тип населенного пункта внутри другого населенного пункта.
place Населенный пункт.
aoguid Идентификатор населенного пункта. При необходимости, может быть использован для загрузки полной модели route по данному населённому пункту с помощью функции addr/route.
printname Полное название населенного пункта, с регионом и районом, в формате, удобном для вывода клиенту.
is_federal true - если населенный пункт является городом федерального подчинения.
timeoffset Смещение в часах относительно UTC для данного населенного пункта.

Используется