Описание классов API
Описание классов API
AddressResult
| Тип данных | Параметр | Описание |
|---|---|---|
| String | code | Код ошибки или состояния, 1 – успешное выполнение |
| String | message | Текст сообщения об ошибке |
| IEnumerable<AddressItem> | addressItems | Список объектов типа AddressItem |
AddressItem
| Тип данных | Параметр | Описание |
|---|---|---|
| String | value | Наименование части адреса и тип |
| String | fullValue | Полное наименование адреса |
| String | postIndex | Почтовый индекс |
| String | regionCode | Код региона |
| IEnumerable<AddressPart> | addressParts | Список объектов типа AddressPart |
AddressPart
| Тип данных | Параметр | Описание |
|---|---|---|
| Int | level | Уровень части адреса по ФИАС |
| String | name | Наименование части адреса |
| String | type | Наименование типа части адреса |
| String | shortType | Сокращенное наименование типа части адреса |
| String | fiasGuid | Уникальный идентификатор адресного объекта по ФИАС |
| String | parentFiasGuid | Уникальный идентификатор адресного объекта предка по ФИАС |
| String | kladrCode | Код по КЛАДР |
| String | oktmo | Код ОКТМО |
| Int | centerStatus | Признак центра - определяет, является ли данный адресный объект центром административно -
территориального образования: столицей республики, центром края, области, района и т.п. 0 – объект не является центром административно-территориального образования; 1 – объект является центром района; 2 – объект является центром (столицей) региона; 3 – объект является одновременно и центром района и центром региона. |
AddressObjectResult
| Тип данных | Параметр | Описание |
|---|---|---|
| String | code | Код ошибки или состояния, 1 – успешное выполнение |
| String | message | Текст сообщения об ошибке |
| AddressObject | addressObject | Объект адреса |
AddressObject
| Тип данных | Параметр | Описание |
|---|---|---|
| String | fiasGuid | Уникальный идентификатор адресного объекта по ФИАС. |
| String | postIndex | Почтовый индекс |
| String | regionCode | Код региона |
| AddressItem | addressItem | Объект AddressItem |
| HouseItem | houseItem | Объект HouseItem или null |
| SteadItem | steadItem | Объект SteadItem или null |
| RoomItem | roomItem | Объект RoomItem или null |
AddressInfoResult
| Тип данных | Параметр | Описание |
|---|---|---|
| String | code | Код ошибки или состояния, 1 – успешное выполнение |
| String | message | Текст сообщения об ошибке |
| AddressInfo | addressInfo | Дополнительная информация адреса |
AddressInfo
| Тип данных | Параметр | Описание |
|---|---|---|
| String | fiasGuid | Уникальный идентификатор адресного объекта по ФИАС. |
| String | parentFiasGuid | Уникальный идентификатор адресного объекта предка по ФИАС. |
| String | postIndex | Почтовый индекс |
| String | regionCode | Код региона |
| String | address | Адрес в административном формате |
| String | munAddress | Адрес в муниципальном формате |
| String | postAddress | Адрес в формате Почты России |
| String | insertDate | Дата добавления объекта в ФИАС |
| String | updateDate | Дата обновления объекта в ФИАС |
| String | region | Наименование региона |
| String | area | Наименование района |
| String | munDistrict | Муниципальный район или Городской округ |
| String | munSettlement | Поселение |
| String | city | Наименование города |
| String | place | Наименование населённого пункта |
| String | plan | Наименование элемента планировочной структуры |
| String | street | Наименование улицы |
| String | house | Номер дома |
| String | build | Номер корпуса |
| String | structure | Номер строения |
| String | room | Помещение или комната |
| String | stead | Номер земельного участка |
| String | oktmo | Код ОКТМО |
| String | okato | Код ОКАТО |
| String | cadNum | Кадастровый номер |
| String | ifnsFl | ИФНСФЛ |
| String | ifnsUl | ИФНСЮЛ |
| String | terrIfnsFl | Территориальный ИФНСФЛ |
| String | terrIfnsUl | Территориальный ИФНСЮЛ |
| String | normDoc | Нормативный документ или его guid из ФИАС |
| Int | divType | Тип деления по ФИАС 0 – не определено 1 – муниципальное 2 – административное |
| String | operStatus | Причина обновления объекта в ФИАС |
| String | hStatus | Состояние объекта |
| String | estStatus | Признак владения |
| String | strStatus | Признак строения |
| Int | centerStatus | Признак центра (см. AddressPart) |
HouseResult
HouseItem
| Тип данных | Параметр | Описание |
|---|---|---|
| String | value | Номер дома и/или корпуса и/или строения |
| String | postIndex | Почтовый индекс |
| String | fiasGuid | Уникальный идентификатор адресного объекта по ФИАС. Может принимать значение null, если такой объект (номер дома) существует только с указанием корпуса и/или строения |
| Int | buildCount | Кол-во корпусов |
| Int | structureCount | Кол-во строений |
SteadResult
SteadItem
| Тип данных | Параметр | Описание |
|---|---|---|
| String | value | Номер участка |
| String | postIndexe | Почтовый индекс |
| String | fiasGuid | Уникальный идентификатор адресного объекта по ФИАС. |
RoomResult
RoomItem
| Тип данных | Параметр | Описание |
|---|---|---|
| String | value | Номер помещения / квартиры |
| String | postIndex | Почтовый индекс |
| String | fiasGuid | Уникальный идентификатор адресного объекта по ФИАС. |