История изменения документа


№ п/п

Дата изменения

Описание изменений

1

09.11.2021

Документ создан

2

21.02.2022

Внесены изменения в следующих разделах:

  1. Структура информационного объекта ФИАС
  2. Адаптация API сервиса для регистра ФИАС
  3. Сценарии интеграционного взаимодействия с регистром ФИАС
  4. Примеры запросов

3

26.06.2022

Добавлены подразделы:

  1. Поиск КЛАДР-адреса по ФИАС (search)
  2. Поиск КЛАДР-адреса по ФИАС

4

14.07.2022

Внесены изменения в следующих разделах:

  1. Структура информационного объекта ФИАС
  2. Сценарии интеграционного взаимодействия с регистром ФИАС
  3. Примеры запросов

5

10.09.2024

Внесены изменения в следующих разделах:

  1. Сценарии интеграционного взаимодействия с регистром ФИАС
  2. Примеры запросов

Сокращения и определения


Сокращение, термин

Определение

API

Application Programming Interface
Интерфейс прикладного программирования

FHIR

Fast Healthcare Interoperability Resources
Ресурсы быстрого взаимодействия в сфере здравоохранения

GUID

Globally Unique Identifier
Глобальный уникальный идентификатор

АО

Адресный объект

БД

База данных

ЕГИСЗ

Единая государственная информационная система в сфере здравоохранения

Единичный АО

Данные АО одного уровня иерархии ФИАС

Комплексный АО

Массив иерархически связанных единичных АО

НСИ

Нормативно-справочная информация

ОКАТО

Общероссийский классификатор административно-территориальных образований

ОКТМО

Общероссийский классификатор территорий муниципальных образований

ФИАС

Федеральная информационная адресная система ФНС России

ФНС

Федеральная налоговая служба

КЛАДР

Классификатор адресов Российской Федерации

Общие сведения о регистре ФИАС

Федеральная информационная адресная система реализована в виде справочника “Реестр адресной информации ФИАС”, OID 1.2.643.2.69.1.1.1.155.

Справочник “Реестр адресной информации ФИАС”, OID 1.2.643.2.69.1.1.1.155 содержит полные адресные данные административного деления ФИАС ФНС, автоматически обновляемые данными мастер-системы https://fias.nalog.ru/.

Записью справочника является единичный АО ФИАС.

Уровень доступа справочника – публичный. Доступны данные только последней актуальной версии.

Данные справочника “Реестр адресной информации ФИАС”, OID 1.2.643.2.69.1.1.1.155 доступны в том же программном и графическом интерфейсе системы Управления НСИ, что и прочие справочники, и регистры.

Представление данных справочника “Реестр адресной информации ФИАС” как в графическом, так и в программном интерфейсах системы специально адаптировано.

Адаптация API сервиса для регистра ФИАС


Метод

Описание реализации API

ValueSet?

Без изменений

$versions

без изменений

$expand

Реализовано выполнение метода для получения записей справочника с обязательным постраничным получением данных.
Выполнение метода не поддерживает параметр "filter".

$lookup

Без изменений

$validate-code

Без изменений

search

Метод поддерживает использование атрибутов display и aoguid_parent.

Если aoguid_parent не задается, то поиск осуществляется только по массиву АО первого уровня иерархии.

Иначе - по массиву АО, для которых заданное значение aoguid_parent является родительским.

Метод поддерживает использование заданного кода родительского АО с учетом типа деления:

  • aoguid_parent – Административное деление;
  • aoguid_parent_md – Муниципальное деление.

get_resource

Метод возвращает комплексный АО по заданному коду.
Метод поддерживает параметр "division_type" (Тип деления).
Параметр необязательный.

Если параметр "division_type" не задан, то возвращаются данные в административном делении.

Если "division_type" задан, то возвращаются данные заданного типа деления.

versions_history

Выполнение метода не поддерживается.

$dictionaries

без изменений

dictionaryitemsupdate

Выполнение метода не поддерживается.

Структура информационного объекта ФИАС

Атрибутный состав справочника “Реестр адресной информации ФИАС”, OID 1.2.643.2.69.1.1.1.155 представлен в таблице:

Код

Наименование

Комментарий

code

Код

Уникальный идентификатор АО - значение параметра aoguid АО ФИАС

display

Наименование

Содержит наименование и тип адресного объекта, введенное соответствующим нормативным документом, органом исполнительной власти, решением, постановлением муниципального образования. Используется при формировании документов и почтовых отправлений.

aoid

В UI атрибут отсутствует

Содержит уникальный целочисленный идентификатор ГАР  адресного объекта АО в БД.

aoguid

Уникальный номер адреса объекта адресации в государственном адресном реестре

Содержит идентификационный код адресного объекта. Соответствует значению атрибута “code”.

aoguid_parent

Код родительского АО в административном делении

Содержит значение aoguid / code непосредственного родительского АО в административном делении

aoguid_parent_md

Код родительского АО в муниципальном делении

Содержит значение aoguid / code непосредственного родительского АО в муниципальном делении

aolevel

Уровень адресного объекта

Содержит номер уровня классификации адресных объектов.

Условно выделены следующие уровни адресных объектов:

1 – уровень региона

2 – уровень автономного округа (устаревшее)

3 – уровень района

35 – уровень городских и сельских поселений

4 – уровень города

5 – уровень внутригородской территории (устаревшее)

6 – уровень населенного пункта

65 – планировочная структура

7 – уровень улицы

75 – земельный участок

8 – здания, сооружения, объекта незавершенного строительства

9 – уровень помещения в пределах здания, сооружения

90 – уровень дополнительных территорий (устаревшее)

91 – уровень объектов на дополнительных территориях (устаревшее)

postal_index

Почтовый индекс здания/сооружения

Содержит почтовый индекс предприятия почтовой связи, обслуживающего данный адресный объект.

muni_div

Муниципальное деление

Содержит "признак адресации" определяющий, что адрес заведен в муниципальном делении.

admin_div

Административное деление

Содержит "признак адресации" определяющий, что адрес заведен в административно-территориальном делении.

okato

ОКАТО

Содержит код объекта административно-территориального деления по общероссийскому классификатору ОКАТО соответствующего уровня (от субъекта РФ до сельского населенного пункта и внутригородских районов или внутригородских округов). Длина кода – 11 разрядов (заполняются все 11 разрядов). Для адресных объектов, не включенных в классификатор ОКАТО, в этом поле указывается код ОКАТО либо старшего административно-территориального объекта, либо расположенного в непосредственной близости к адресуемому объекту административно-территориального объекта, включенного в ОКАТО.

oktmo

ОКТМО

Содержит код муниципального образования по Общероссийскому классификатору территорий муниципальных образований, на территории которого расположен адресуемый объект. Длина кода 11 байт.

ifnsfl

Код ИФНС ФЛ

Содержит код инспекции ФНС России по ведомственному ФНС России классификатору "Система обозначений налоговых органов" (СОНО), обслуживающего физических лиц на территории, на которой расположен данный адресный объект.

ifnsul

Код ИФНС ЮЛ

Содержит код инспекции ФНС России по ведомственному ФНС России классификатору "Система обозначений налоговых органов" (СОНО), обслуживающего юридических лиц на территории, на которой расположен данный адресный объект.

cadnum

Кадастровый номер

Содержит уникальный номер объекта недвижимости, присваиваемый ему при осуществлении кадастрового и технического учёта.

house

Номер здания / сооружения

Содержат номер домов, корпусов, строений.

unique_registry_number

Уникальный номер реестровой записи

Содержит уникальный номер адресообразующего элемента в государственном адресном реестре

livestatus

Статус записи

Содержит информацию о том является ли эта запись по адресному объекту актуальной на текущую дату

normdoc

Нормативный документ

Содержит внешний ключ на нормативный документ.

createdate

Дата внесения записи

Определяет дату и время внесения записи в БД.

updatedate

Дата актуализации записи


type_name

Наименование типа АО

Содержит тип адресного объекта. Используется при формировании документов и почтовых отправлений.

kladr_code

Код КЛАДР

Содержит классификатор адресов РФ.

house_corp

Корпус


house_liter

Литера


house_num

Номер дома


house_soor

Сооружение


house_stroen

Строение


Сценарии интеграционного взаимодействия с регистром ФИАС

Получение единичного АО по уникальному идентификатору (lookup)

Получение единичного АО по уникальному идентификатору осуществляется с помощью POST-запроса к справочнику “Реестр адресной информации ФИАС” по URL в формате:
[base]/term/ValueSet/$lookup?_format=[формат]

BODY-запроса:

{"resourceType": "Parameters",

  "parameter": [{

      "name": "system",

      "valueString": "1.2.643.2.69.1.1.1.155"},

    {"name": "code",

      "valueString": "[value]"}]}

Описание параметров запроса

Таблица 3. Параметры запроса

№ п/п

Контейнер

Параметр

Тип

Кратность

Описание

1            

Root





2            

/parameter


array

1..1

Параметры запроса

3           

parameter

system

string

1..1

url справочника: 1.2.643.2.69.1.1.1.155

4           

parameter

code

string

1..1

Код уникального идентификатора АО

Описание параметров ответа

Таблица 4. Параметры ответа

№ п/п

Контейнер

Параметр

Тип

Описание

1            

Root




2            

/parameter


array

Параметры ответа

3          

parameter

name

string

Наименование параметра для запрошенного кода уникального идентификатора АО

4          

parameter

valueString

string

Значение дополнительного параметра

Идентификация АО по уникальному идентификатору (validate-code)

Идентификация АО по уникальному идентификатору осуществляется с помощью POST-запроса к справочнику “Реестр адресной информации ФИАС” по URL в формате:
 [base]/term/ValueSet/$validate-code?_format=[формат]

BODY-запроса:

{"resourceType": "Parameters",

  "parameter": [{

      "name": "system",

      "valueString": "1.2.643.2.69.1.1.1.155"},

    {"name": "code",

      "valueString": "[value]"}]}

Описание параметров запроса

Таблица 5. Параметры запроса

№ п/п

Контейнер

Параметр

Тип

Кратность

Описание

1           

Root





2           

/parameter


array

1..1

Параметры запроса

3         

parameter

system

string

1..1

url справочника: 1.2.643.2.69.1.1.1.155

4         

parameter

code

string

1..1

Код уникального идентификатора АО

Описание параметров ответа

Таблица 6. Параметры ответа

№ п/п

Контейнер

Параметр

Тип

Описание

1     

Root




2  

/parameter


array

Параметры ответа

3  

parameter

name

string

Наименование параметра (result)

4  

parameter

valueBoolean

string

Результат проверки (true / false):

  1. «true» - код уникального идентификатора АО присутствует в справочнике;
  2. «false» - кода уникального идентификатора АО нет в справочнике.

Получение массива АО по идентификатору родительского АО (search)

Получение массива АО по идентификатору родительского АО осуществляется с помощью GET-запроса к справочнику “Реестр адресной информации ФИАС” по URL в формате:

Вариант 1.

[base]/term/ValueSet/1.2.643.2.69.1.1.1.155/_search?aoguid_parent=[value]&_format=[формат]

Вариант 2.

[base]/term/ValueSet/1.2.643.2.69.1.1.1.155/_search?aoguid_parent_md=[value]&_format=[формат]

либо с помощью POST-запроса в формате:

Вариант 1.

[base]/term/ValueSet/_search?_format=[формат]

BODY-запроса:

{"resourceType": "Parameters",

  "parameter": [

    {"name": "system",

      "valueString": "1.2.643.2.69.1.1.1.155"},

    {"name": "aoguid_parent",

      "valueString": "[value]"}]}

Вариант 2.

[base]/term/ValueSet/_search?_format=[формат]

BODY-запроса:

{"resourceType": "Parameters",

  "parameter": [

    {"name": "system",

      "valueString": "1.2.643.2.69.1.1.1.155"},

    {"name": "aoguid_parent_md",

      "valueString": "[value]"}]}

Особенности получения сведений ФИАС методом expand:

          Параметр aoguid_parent / aoguid_parent_md – обязательный параметр.

Описание параметров запроса

Таблица 7. Параметры запроса

№ п/п

Параметр

Тип

Кратность

Описание

1

system

string

1..1

oid справочника: 1.2.643.2.69.1.1.1.155

2

aoguid_parent

string

1..1

Глобальный идентификатор родительского адресного объекта в административном делении.

Если не задан, то возвращается массив АО первого уровня (регионы)

3

aoguid_parent_md

string

1..1

Глобальный идентификатор родительского адресного объекта в муниципальном делении.

Если не задан, то возвращается массив АО первого уровня (регионы)

4

value

string

1..1

 Искомое значение

5

_count

integer

0..1

Количество элементов (записей справочника), выводимых на одной странице результирующего ответа

6

_page

integer

0..1

Номер страницы результирующего ответа

Описание параметров ответа

Таблица 8. Параметры ответа

№ п/п

Контейнер

Тип

Описание

1.           

Root



2.           

/total

integer

Количество найденных записей

3.           

Массив JSON

array

Массив найденных АО

4.           

entry/resource

object

Найденный АО второго уровня

5.           

resource/parameter

array

Массив параметров единичного АО

6.           

aoid

guid

Уникальный номер адреса объекта

7.           

aoguid

guid

Уникальный номер адреса объекта адресации в государственном адресном реестре

8.  

aoguid_parent

guid

Уникальный номер адреса родительского объекта в административном делении

9. 

aoguid_parent_md

guid

Уникальный номер адреса родительского объекта в муниципальном делении

10.  

code

guid

Уникальный идентификатор АО - значение параметра aoguid АО ФИАС

11.

display

string

Наименование адресного объекта

12.

type_name

string

Наименование типа АО

13.

postal_index

string

Почтовый индекс здания/сооружения

14.

ifnsfl

string

Код ИФНС ФЛ

15.

ifnsul

 string

Код ИФНС ЮЛ

16.

muni_div

 string

Муниципальное деление

17.

admin_div

 string

Административное деление

18.

okato

 string

 ОКАТО

19.

oktmo

 string

 ОКТМО

20.

kladr_code

 string

 Код КЛАДР

21.

createdate

 date в формате [гггг-мм-дд]

Дата внесения записи

22.

updatedate

 date в формате [гггг-мм-дд]

Дата актуализации записи

23.

aolevel

 integer

Уровень адресного объекта

24.

livestatus

 string

Статус записи

25.

unique_registry_number

 string

Уникальный номер реестровой записи

26.

normdoc

 guid

Нормативный документ

27.

cadnum

 string

Кадастровый номер

28.

house_num

 string

Номер здания / сооружения

29.

house_corp

 string

Корпус

30.

house_stroen

 string

Строение

31.

house_soor

 string

Сооружение

32.

house_liter

 string

Литера

Контекстный поиск АО в пространстве адресных объектов заданного родительского АО (search)

Контекстный поиск АО в пространстве адресных объектов заданного родительского АО осуществляется с помощью GET-запроса к справочнику “Реестр адресной информации ФИАС” по URL в формате:

Вариант 1.

[base]/term/ValueSet/1.2.643.2.69.1.1.1.155/_search?aoguid_parent=value&display:operation=[value]&_format=[формат]

Вариант 2.

[base]/term/ValueSet/1.2.643.2.69.1.1.1.155/_search?aoguid_parent_md=value&display:operation=[value]&_format=[формат]

либо с помощью POST-запроса в формате:

Вариант 1.

[base]/term/ValueSet/_search?_format=[формат]

BODY-запроса:

{"resourceType": "Parameters",

  "parameter": [

    {"name": "system",

      "valueString": "1.2.643.2.69.1.1.1.155"},

    {"name": "aoguid_parent",

      "valueString": "[value]"},

    {"name": "display:[operation]",

      "valueString": "[value]"}]}


Вариант 2.

[base]/term/ValueSet/_search?_format=[формат]

BODY-запроса:

{"resourceType": "Parameters",

  "parameter": [

    {"name": "system",

      "valueString": "1.2.643.2.69.1.1.1.155"},

    {"name": "aoguid_parent_md",

      "valueString": "[value]"},

    {"name": "display:[operation]",

      "valueString": "[value]"}]}

Описание параметров запроса

Таблица 9. Параметры запроса

№ п/п

Параметр

Тип

Кратность

Описание

1

system

string

1..1

oid справочника: 1.2.643.2.69.1.1.1.155

aoguid_parent

string

1..1

Глобальный идентификатор родительского адресного объекта в административном делении.

Если не задан, то возвращается массив АО  первого уровня (регионы)

3

aoguid_parent_md

string

1..1

Глобальный идентификатор родительского адресного объекта в муниципальном делении.

Если не задан, то возвращается массив АО  первого уровня (регионы)

4

operation

string

1..1

Варианты поиска значения атрибута display:

  1. по вхождению подстроки без учета регистра – значение по умолчанию;
  2. по вхождению подстроки с учетом регистра «cs»;
  3. по точному вхождению строки с учетом регистра «eq»;
  4. по точному вхождению строки без учета регистра «eqncs»;
  5. расширенный контекстный поиск (поиск происходит по вхождению введенных букв и цифр*) «ext».

5

value

string

1..1

 Искомое значение

6

_count

integer

0..1

Количество элементов (записей справочника), выводимых на одной странице результирующего ответа

7

_page

integer

0..1

Номер страницы результирующего ответа

Описание параметров ответа

Параметры ответа представлены в таблице 8.

Каскадный поиск конечного АО (search)

Каскадный поиск заданного АО осуществляется последовательными вызовами метода search.

Шаг 1. Поиск по АО первого уровня (субъектам РФ) без указания кода родительского АО.

Во входных параметрах задается только поисковая строка наименования региона в атрибуте display.

GET-запрос

URL:

[base]/term/ValueSet/1.2.643.2.69.1.1.1.155/version/_search?display:operation=[value]&_format=[формат]

либо POST-запрос:

[base]/term/ValueSet/_search?_format=[формат]

BODY-запроса:

{"resourceType": "Parameters",

  "parameter": [

    {"name": "system",

      "valueString": "1.2.643.2.69.1.1.1.155"},

    {"name": "display",

      "valueString": "[value]"}]}

Шаг 2. Поиск по массиву АО второго уровня (улицам и населенным пунктам), принадлежащим АО (региону), найденном на предыдущем шаге.

          Во входных параметрах в качестве значения “aoguid_parent” / “aoguid_parent_md” необходимо задать значение “code” или “aoguid” АО, полученного на предыдущем шаге.

GET-запрос

URL:

Вариант 1.

[base]/term/ValueSet/1.2.643.2.69.1.1.1.155/version/_search?aoguid_parent=[value]&display:operation=[value]&_format=[формат]

Вариант 2.

[base]/term/ValueSet/1.2.643.2.69.1.1.1.155/version/_search?aoguid_parent_md=[value]&display:operation=[value]&_format=[формат]

либо POST-запрос:

Вариант 1.

[base]/term/ValueSet/_search?_format=[формат]

BODY-запроса:

{"resourceType": "Parameters",

  "parameter": [

    {"name": "system",

      "valueString": "1.2.643.2.69.1.1.1.155"},

    {"name": "aoguid_parent",

      "valueString": "[value]"},

    {"name": "display:[operation]",

      "valueString": "[value]"}]}

Вариант 2.

[base]/term/ValueSet/_search?_format=[формат]

BODY-запроса:

{"resourceType": "Parameters",

  "parameter": [

    {"name": "system",

      "valueString": "1.2.643.2.69.1.1.1.155"},

    {"name": "aoguid_parent_md",

      "valueString": "[value]"},

    {"name": "display:[operation]",

      "valueString": "[value]"}]}

Скопировать из полученного ответа значение “aoguid”.

Шаг 3. Поиск по массиву АО третьего уровня (строения, дома и т.п.), принадлежащим АО (улице или т.п.), найденном на предыдущем шаге.

          Во входных параметрах в качестве значения “aoguid_parent” / “aoguid_parent_md” необходимо задать значение “code” или “aoguid” АО, полученного на предыдущем шаге.

GET-запрос

URL:

Вариант 1.

[base]/term/ValueSet/1.2.643.2.69.1.1.1.155/version/_search?aoguid_parent=[value]&display=[value]&_format=[формат]

Вариант 2.

[base]/term/ValueSet/1.2.643.2.69.1.1.1.155/version/_search?aoguid_parent_md=[value]&display=[value]&_format=[формат]

либо POST-запрос:

Вариант 1.

[base]/term/ValueSet/_search?_format=[формат]

BODY-запроса:

{"resourceType": "Parameters",

  "parameter": [

    {"name": "system",

      "valueString": "1.2.643.2.69.1.1.1.155"},

    {"name": "aoguid_parent",

      "valueString": "[value]"},

    {"name": "display",

      "valueString": "[value]"}]}

Вариант 2.

[base]/term/ValueSet/_search?_format=[формат]

BODY-запроса:

{"resourceType": "Parameters",

  "parameter": [

    {"name": "system",

      "valueString": "1.2.643.2.69.1.1.1.155"},

    {"name": "aoguid_parent_md",

      "valueString": "[value]"},

    {"name": "display",

      "valueString": "[value]"}]}

Результатом данного шага является получение в ответе “aoguid” АО третьего уровня (строения/дома).

И так далее до достижения цели поиска конечного АО в цепочке иерархии.

Описание параметров запроса

Параметры ответа представлены в таблице 9.

Описание параметров ответа

Параметры ответа представлены в таблице 8.

Получение комплексного АО по уникальному идентификатору (get_resource)

Получение комплексного АО по уникальному идентификатору осуществляется с помощью GET-запроса к справочнику “Реестр адресной информации ФИАС” по URL в формате:
[base]/term/get_resource?_format=json&system=1.2.643.2.69.1.1.1.155&code=[value]

либо с помощью POST-запроса в формате:

[base]/term/get_resource?_format=json

BODY-запроса:

{"resourceType": "Parameters",

    "parameter":[

        {"name": "system",

            "valueString": "1.2.643.2.69.1.1.1.155"},

        {"name": "code",

            "valueString": "[value]"},

        {"name": "division_type",

            "valueString": "[value]"}]}

Описание параметров запроса

Таблица 10. Параметры запроса

№ п/п

Контейнер

Параметр

Тип

Кратность

Описание

1.            

Root





2.            

/parameter


array

1..1

Параметры запроса

3.            

parameter

system

string

1..1

url справочника: 1.2.643.2.69.1.1.1.155

4.            

parameter

code

string

1..1

Код уникального идентификатора АО

5.

parameter

division_type

integer

0..1

Тип деления АО

Допустимые значения "division_type":
0 – Административное деление
1 – Муниципальное деление

Описание параметров ответа

Таблица 11. Параметры ответа

№ п/п

Параметр

Тип

Описание

1.            

Массив JSON

 array

Массив единичных АО

2.            

aoid

 guid

Уникальный номер адреса объекта

3.

code

 guid

Уникальный идентификатор АО - значение параметра aoguid АО ФИАС

4.

okato

 string

 ОКАТО

5.

oktmo

 string

 ОКТМО

6.

aoguid

 guid

Уникальный номер адреса объекта адресации в государственном адресном реестре

7.

cadnum

 string

Кадастровый номер

8.

ifnsfl

 string

Код ИФНС ФЛ

9.

ifnsul

 string

Код ИФНС ЮЛ

10.

aolevel

 integer

Уровень адресного объекта

11.

display

 string

Наименование и тип адресного объекта

12.

normdoc

 guid

Нормативный документ

13.

muni_div

 string

Муниципальное деление

14.

admin_div

 string

Административное деление

15.

house_num

 string

Номер дома

16.

type_name

 string

Наименование типа АО

17.

createdate

 date в формате [гггг-мм-дд]

Дата внесения записи

18.

house_corp

 string

Корпус

19.

house_soor

 string

Сооружение

20.

kladr_code

 string

Код КЛАДР

21.

livestatus

 string

Статус записи

22.

updatedate

 date в формате [гггг-мм-дд]

Дата актуализации записи

23.

house_liter

 string

Литера

24.

house_stroen

 string

Строение

25.

postal_index

 string

Почтовый индекс здания/сооружения

26.

aoguid_parent

 guid

Уникальный номер адреса родительского объекта в административном делении

27.

aoguid_parent_md

 guid

Уникальный номер адреса родительского объекта в муниципальном делении

28.

unique_registry_number

 string

Уникальный номер реестровой записи

Получение полных сведений ФИАС (expand)

Способ 1. Метод expand

Получение сведений ФИАС осуществляется с помощью POST-запроса к справочнику “Реестр адресной информации ФИАС” по URL в формате:

[base]/term/ValueSet/$expand?_format=json

BODY-запроса:

{"resourceType": "Parameters",

            "parameter": [{

            "name": "system",

            "valueString": "1.2.643.2.69.1.1.1.155"},

        {"name": "count",

            "valueString": [value]  },

        {"name": "offset",

            "valueString": [value]  }]}

Особенности вызова метода expand:

Параметр "filter" игнорируется.

Параметры смещения – обязательные параметры.

Результат: массив объектов в соотвоответствии с заданными параметрами пагинации.

Описание параметров запроса

Таблица 12. Параметры запроса

Контейнер

Параметр

Тип

Кратность

Описание

 1

Root





2

/parameter


array

1..1

Параметры запроса

3

parameter

system

string

1..1

url справочника: 1.2.643.2.69.1.1.1.155

5

parameter

count

integer

1..1

Количество выводимых элементов на странице результата

6

parameter

offset

integer

1..1

Смещение при выводе элементов

Описание параметров ответа

См. п. 6.3.

Способ 2. Метод search

Получение сведений ФИАС выполняется последовательным каскадным поиском алгоритмом “обхода дерева” с помощью метода search. Это позволяет получать полные адресные данные заданного начального родительского АО. Например, региона “Санкт-Петербург”.

См. п. 6.4, 6.5.

Поиск КЛАДР-адреса по ФИАС (search)

Поиск КЛАДР-адреса по ФИАС реализует возможность поиска по адресной строке в формате КЛАДР и получение данных АО из адресного регистра ФИАС.

В качестве входных данных используется адресная строка с полными данными АО.

Вариант 1.

Таблица 13. Соответствие параметров КЛАДР и параметров запроса метода search

Элементы адресной цепочки

 Search-параметры 

Вес в иерархии

Регион

KLADR_Region

1

Район, область

KLADR_Area

2

Город

Внутригородской район

KLADR_City

3

Дополнительная территория

Населенный пункт

KLADR_Place

4

Улица

KLADR_Street

5

Улица на дополнительной территории

Дом

KLADR_House

6

Корпус

Строение


Алгоритм поиска КЛАДР-адреса по ФИАС:

1 шаг: проверка и поиск по KLADR_Region. Если параметр KLADR_Region не передан, либо значение для KLADR_Region не задано, то поиск прекращается. Возвращается пустое множество. Параметр KLADR_Region – обязательный.

2-n шаг: если параметр KLADR_Region задан, то поиск продолжается в порядке иерархии (см. таблицу 13).
Если какой-либо параметр не задан, либо значение для параметра не задано, то поиск не останавливается. Поиск продолжается, пока не достигнет последнего уровня иерархии, либо последнего параметра, которому задано значение для поиска.
Если на каком-либо шаге поиска результирующее множество пустое или содержит более одного элемента, то поиск прекращается, возвращается пустое множество.


Структура запросов и ответов:

Поиск значений в справочнике осуществляется с помощью GET-запроса по URL в формате:

[base]/term/ValueSet/1.2.643.2.69.1.1.1.155/_search?KLADR_Region:operation=value&KLADR_Area:operation=value&KLADR_City:operation=value&KLADR_Place:operation=value&KLADR_Street:operation=value&KLADR_House:operation=value&_format=[формат]

либо с помощью POST-запроса в формате:

[base]/term/ValueSet/_search?_format=[формат]

BODY-запроса:

{
    "resourceType": "Parameters",
    "parameter": [
        {
            "name": "system",
            "valueString": "1.2.643.2.69.1.1.1.155"
        },
        {
            "name": "KLADR_Region:[operation]",
            "valueString": "[value]"
        },
        {
            "name": "KLADR_Area:[operation]",
            "valueString": "[value]"
        },
        {
            "name": "KLADR_City:[operation]",
            "valueString": "[value]"
        },
        {
            "name": "KLADR_Place:[operation]",
            "valueString": "[value]"
        },
        {
            "name": "KLADR_Street:[operation]",
            "valueString": "[value]"
        },
        {
            "name": "KLADR_House:[operation]",
            "valueString": "[value]"
        }
    ]
}


Описание параметров запроса

Таблица 14. Параметры запроса

№ п/п

Параметр

Тип

Кратность и обязательность

Описание

1.           

system

string

1..1

oid справочника: 1.2.643.2.69.1.1.1.155

2.           

attribute

string

1..1


Код search-параметра KLADR_Region, по которому осуществляется поиск значения.

Параметр KLADR_Region – обязательный.


3.

attribute

string

0..1


Код search-параметра KLADR_Area, по которому осуществляется поиск значения.

4.

attribute

string

0..1


Код search-параметра KLADR_City, по которому осуществляется поиск значения.

5.

attribute

string

0..1


Код search-параметра KLADR_Place, по которому осуществляется поиск значения.

6.

attribute

string

0..1


Код search-параметра KLADR_Street, по которому осуществляется поиск значения.

7.

attribute

string

0..1


Код search-параметра KLADR_House, по которому осуществляется поиск значения.

8.

operation

string

0..1

  Варианты поиска значения:

  • по вхождению подстроки без учета регистра – значение по умолчанию;
  • по точному вхождению строки без учета регистра «eqncs»;
  • расширенный контекстный поиск (поиск происходит по вхождению введенных букв и цифр*) «ext».

9.           

value

string

0..1

Искомое значение

 

Описание параметров ответа

Таблица 15. Параметры ответа

№ п/п

Контейнер

Тип

Описание

1.            

Root



2.            

/total

integer

Количество найденных записей

3.            

/entry

array

Массив АО

4.            

entry/resource

object

Единичный АО

5.            

resource/parameter

array

Массив параметров единичного АО

6.            

aoid

guid

Уникальный номер адреса объекта

7.            

aoguid

guid

Уникальный номер адреса объекта адресации в государственном адресном реестре

8.  

aoguid_parent

guid

Уникальный номер адреса родительского объекта

9.

aoguid_parent_md

guid

Уникальный номер адреса родительского объекта в муниципальном делении

10.  

code

guid

Уникальный идентификатор АО - значение параметра aoguid АО ФИАС

11.

display

string

Наименование и тип адресного объекта

12.

type_name

string

Наименование типа АО

13.

postal_index

string

Почтовый индекс здания/сооружения

14.

ifnsfl

string

Код ИФНС ФЛ

15.

ifnsul

string

Код ИФНС ЮЛ

16.

muni_div

string

Муниципальное деление

17.

admin_div

string

Административное деление

18.

okato

string

 ОКАТО

19.

oktmo

string

 ОКТМО

20.

kladr_code

string

Код КЛАДР

21.

createdate

date в формате [гггг-мм-дд]

Дата внесения записи

22.

updatedate

date в формате [гггг-мм-дд]

Дата актуализации записи

23.

aolevel

integer

Уровень адресного объекта

24.

livestatus

string

Статус записи

25.

unique_registry_number

string

Уникальный номер реестровой записи

26.

normdoc

guid

Нормативный документ

27.

cadnum

string

Кадастровый номер

28.

house_num

string

Номер дома

29.

house_corp

string

Корпус

30.

house_stroen

string

Строение

31.

house_soor

string

Сооружение

32.

house_liter

string

Литера

Вариант 2.

В качестве входного параметра используется атрибут kladr_code.
Если во входных параметрах задан не только атрибут kladr_code, то прочие атрибуты игнорируются, поиск выполняется только по kladr_code.

Поиск значений в справочнике осуществляется с помощью GET-запроса по URL в формате:

[base]/term/ValueSet/1.2.643.2.69.1.1.1.155/_search?kladr_code=value&_format=[формат]

либо с помощью POST-запроса в формате:

[base]/term/ValueSet/_search?_format=[формат]

BODY-запроса:


{
    "resourceType": "Parameters",
    "parameter": [
        {
            "name": "system",
            "valueString": "1.2.643.2.69.1.1.1.155"
        },
        {
            "name": "kladr_code",
            "valueString": "[value]"
        }
    ]
}

Таблица 16. Параметры запроса

№ п/п

Контейнер

Тип

Кратность

Описание

1.            

system

string

1..1

oid справочника: 1.2.643.2.69.1.1.1.155

2.            

kladr_code

string

1..1

Код КЛАДР

3.            

value

string

1..1

Искомое значение

Описание параметров ответа

Параметры ответа представлены в таблице 8.


Примеры запросов

Получение единичного АО по уникальному идентификатору

Тип запроса: POST
URL-запроса: [base]/term/ValueSet/$lookup?_format=json

Header: Authorization: [GUID-токен]

BODY-запроса:

{"resourceType": "Parameters",
  "parameter": [{
      "name": "system",
      "valueString": "1.2.643.2.69.1.1.1.155"},
    {"name": "code",
      "valueString": "deaa69a5-634d-4662-aae7-2f0a841414c4"}]}

Пример ответа:

{"parameter": [
        {  "name": "aoid",
            "valueString": 1086332},
        {   "name": "aoguid",
            "valueString": "d72c95ed-9fdd-4f27-b94f-898fc3f1177d"},
        {   "name": "aoguid_parent",
            "valueString": "f10763dc-63e3-48db-83e1-9c566fe3092b"},
        {   "name": "code",
            "valueString": "d72c95ed-9fdd-4f27-b94f-898fc3f1177d"},
        {   "name": "display",
            "valueString": "Таганрог"},
        {   "name": "type_name",
            "valueString": "г"},
        {   "name": "postal_index",
            "valueString": ""},
        {   "name": "ifnsfl",
            "valueString": "6154"},
        {   "name": "ifnsul",
            "valueString": "6154"},
        {   "name": "muni_div",
            "valueString": ""},
        {   "name": "admin_div",
            "valueString": "Ростовская обл, Таганрог г"},
        {   "name": "okato",
            "valueString": "60437000000"},
        {   "name": "oktmo",
            "valueString": "60737000001"},
        {   "name": "kladr_code",
            "valueString": "6100001100000"},
        {   "name": "createdate",
            "valueString": ""},
        {   "name": "updatedate",
            "valueString": "2017-10-03"},
        {   "name": "aolevel",
            "valueString": 5},
        {   "name": "livestatus",
            "valueString": "true"},
        {   "name": "unique_registry_number",
            "valueString": "607370000010000000001"},
        {   "name": "normdoc",
            "valueString": ""},
        {   "name": "cadnum",
            "valueString": ""},
        {   "name": "house",
            "valueString": ""}],
    "resourceType": "Parameters"}

Идентификация АО по уникальному идентификатору

Пример запроса №1 (положительный сценарий проверки):

Тип запроса: POST
URL-запроса:

[base]/term/ValueSet/$validate-code?_format=json

Header: Authorization: [GUID-токен]

BODY-запроса:

{"resourceType": "Parameters",
  "parameter": [{
      "name": "system",
      "valueString": "1.2.643.2.69.1.1.1.155"},
    {"name": "code",
      "valueString": "fc22565a-01ee-4bae-ac14-f7f19b7d49e1"}] }

Пример ответа №1 (положительный сценарий проверки):

{"parameter": [{
            "name": "result",
            "valueBoolean": true}],
    "resourceType": "Parameters"}

Пример запроса №2 (отрицательный сценарий проверки):

Тип запроса: POST

URL-запроса:

[base]/term/ValueSet/$validate-code?_format=json

Header: Authorization: [GUID-токен]

BODY-запроса:

{"resourceType": "Parameters",
  "parameter": [{
      "name": "system",
      "valueString": "1.2.643.2.69.1.1.1.155"},
    {"name": "code",
      "valueString": "4d770761-cdc1-4cf4-ad51-4affd33dee85"}] }

Пример ответа №2 (отрицательный сценарий проверки):

{"parameter": [{
            "name": "result",
            "valueBoolean": false}],
    "resourceType": "Parameters"}


Получение массива АО по идентификатору родительского объекта

Пример №1
Поиск записей справочника 1.2.643.2.69.1.1.1.155, у которых атрибут «aoguid_parent» имеет значения eace00a3-d53c-492f-981c-4693fef5b626.

Тип запроса: GET

URL-запроса:

[base]/term/ValueSet/1.2.643.2.69.1.1.1.155/_search?_format=json&aoguid_parent=eace00a3-d53c-492f-981c-4693fef5b626

Header: Authorization: [GUID-токен]

Тип запроса: POST

URL-запроса:

[base]/term/ValueSet/_search?_format=json

Header: Authorization: [GUID-токен]

BODY-запроса:

{"resourceType": "Parameters",
  "parameter": [
    {"name": "system",
      "valueString": "1.2.643.2.69.1.1.1.155"},
    {"name": "aoguid_parent",
      "valueString": "eace00a3-d53c-492f-981c-4693fef5b626"}]}

Пример ответа:

{   "type": "searchset",
    "entry": [{
    "resource": {
    "parameter": [
     {   "name": "aoid",
         "valueString": 24143398},
     {   "name": "aoguid",
         "valueString": "c1de8890-b117-4c4a-8d77-c1b7121aacb0"},
     {   "name": "aoguid_parent",
         "valueString": "eace00a3-d53c-492f-981c-4693fef5b626"},
     {   "name": "code",
         "valueString": "c1de8890-b117-4c4a-8d77-c1b7121aacb0"},
     {   "name": "display",
         "valueString": "10Г"},
     {   "name": "type_name",
         "valueString": ""},
     {   "name": "postal_index",
         "valueString": ""},
     {   "name": "ifnsfl",
         "valueString": "1900"},
     {   "name": "ifnsul",
         "valueString": "1900"},
     {   "name": "muni_div",
         "valueString": ""},
     {   "name": "admin_div",
         "valueString": "Хакасия Респ, Бейский р-н, Бейский с/с, 10Г"},
     {   "name": "okato",
         "valueString": "95212805001"},
     {   "name": "oktmo",
         "valueString": "95612405"},
     {   "name": "kladr_code",
         "valueString": ""},
     {   "name": "createdate",
         "valueString": "2019-03-07"},
     {   "name": "updatedate",
         "valueString": "2019-03-07"},
     {   "name": "aolevel",
         "valueString": 20},
     {   "name": "livestatus",
         "valueString": "true"},
     {   "name": "unique_registry_number",
         "valueString": "956124050000000000020001000000000"},
     {   "name": "normdoc",
         "valueString": ""},
     {   "name": "cadnum",
         "valueString": ""},
     {   "name": "house",
         "valueString": "10Г"}],
     "resourceType": "Parameters"}}],
    "total": 1,
    "resourceType": "Bundle"}

Пример №2
Поиск двух записей на второй странице справочника 1.2.643.2.69.1.1.1.155, у которых атрибут «aoguid_parent» имеет значения c2deb16a-0330-4f05-821f-1d09c93331e6.

Тип запроса: GET

URL-запроса:

[base]/term/ValueSet/1.2.643.2.69.1.1.1.155/_search?_format=json&aoguid_parent=c2deb16a-0330-4f05-821f-1d09c93331e6&_count=2&_page=2

Header: Authorization: [GUID-токен]

Тип запроса: POST

URL-запроса:

[base]/term/ValueSet/_search?_format=json

Header: Authorization: [GUID-токен]

BODY-запроса:

{"resourceType": "Parameters",
  "parameter": [
    {"name": "system",
      "valueString": "1.2.643.2.69.1.1.1.155"},
    {"name": "aoguid_parent",
      "valueString": "c2deb16a-0330-4f05-821f-1d09c93331e6"},
    {"name": "_count",
      "valueString": "2"},
    {"name": "_page",
      "valueString": "2"}]}

Пример ответа:

{   "type": "searchset",
    "entry": [{
            "resource": {
                "parameter": [
                    {   "name": "aoid",
                        "valueString": 1420137},
                    {   "name": "aoguid",
                        "valueString": "e25321c8-6399-4458-aee9-6cd7ecc4abbe"},
                    {   "name": "aoguid_parent",
                        "valueString": "c2deb16a-0330-4f05-821f-1d09c93331e6"},
                    {   "name": "aoguid_parent_md",
                        "valueString": "21a1f665-5dba-4884-902b-73f519b3855a"},
                    {   "name": "code",
                        "valueString": "e25321c8-6399-4458-aee9-6cd7ecc4abbe"},
                    {   "name": "display",
                        "valueString": "10-я Советская"},
                    {   "name": "type_name",
                        "valueString": "ул"},
                    {   "name": "postal_index",
                        "valueString": ""},
                    {   "name": "ifnsfl",
                        "valueString": "7842"},
                    {   "name": "ifnsul",
                        "valueString": "7842"},
                    {   "name": "muni_div",
                        "valueString": "Санкт-Петербург г, муниципальный округ Смольнинское вн.тер.г., 10-я Советская ул"},
                    {   "name": "admin_div",
                        "valueString": "г. Санкт-Петербург, ул. 10-я Советская"},
                    {   "name": "okato",
                        "valueString": "40298564000"},
                    {   "name": "oktmo",
                        "valueString": "40911000"},
                    {   "name": "kladr_code",
                        "valueString": "78000000000000400"},
                    {   "name": "createdate",
                        "valueString": ""},
                    {   "name": "updatedate",
                        "valueString": "2011-09-14"},
                    {   "name": "aolevel",
                        "valueString": 8},
                    {   "name": "livestatus",
                        "valueString": "true"},
                    {   "name": "unique_registry_number",
                        "valueString": "409110000000000000401"},
                    {   "name": "normdoc",
                        "valueString": ""},
                    {   "name": "cadnum",
                        "valueString": ""},
                    {   "name": "house_num",
                        "valueString": ""},
                    {   "name": "house_corp",
                        "valueString": ""},
                    {   "name": "house_stroen",
                        "valueString": ""},
                    {   "name": "house_soor",
                        "valueString": ""},
                    {   "name": "house_liter",
                        "valueString": ""}],
                "resourceType": "Parameters"}},
        {   "resource": {
                "parameter": [
                    {   "name": "aoid",
                        "valueString": 1421625},
                    {   "name": "aoguid",
                        "valueString": "157719fd-0714-4a5a-b0bb-0c066a2eead9"},
                    {   "name": "aoguid_parent",
                        "valueString": "c2deb16a-0330-4f05-821f-1d09c93331e6"},
                    {   "name": "aoguid_parent_md",
                        "valueString": "2ed53f1f-0b56-4010-9bfc-9ab5723b1ff7"},
                    {   "name": "code",
                        "valueString": "157719fd-0714-4a5a-b0bb-0c066a2eead9"},
                    {   "name": "display",
                        "valueString": "11-я В.О."},
                    {   "name": "type_name",
                        "valueString": "линия"},
                    {   "name": "postal_index",
                        "valueString": ""},
                    {   "name": "ifnsfl",
                        "valueString": "7801"},
                    {   "name": "ifnsul",
                        "valueString": "7801"},
                    {   "name": "muni_div",
                        "valueString": "Санкт-Петербург г, муниципальный округ Васильевский вн.тер.г., 11-я В.О. линия"},
                    {   "name": "admin_div",
                        "valueString": "г. Санкт-Петербург, линия. 11-я В.О." },
                    {   "name": "okato",
                        "valueString": ""},
                    {   "name": "oktmo",
                        "valueString": "40307000, 40308000"},
                    {   "name": "kladr_code",
                        "valueString": "78000000000000500"},
                    {   "name": "createdate",
                        "valueString": ""},
                    {   "name": "updatedate",
                        "valueString": "2011-09-15"},
                    {   "name": "aolevel",
                        "valueString": 8},
                    {   "name": "livestatus",
                        "valueString": "true"},
                    {   "name": "unique_registry_number",
                        "valueString": "400000000000000000501"},
                    {   "name": "normdoc",
                        "valueString": ""},
                    {   "name": "cadnum",
                        "valueString": ""},
                    {   "name": "house_num",
                        "valueString": ""},
                    {   "name": "house_corp",
                        "valueString": ""},
                    {   "name": "house_stroen",
                        "valueString": ""},
                    {   "name": "house_soor",
                        "valueString": ""},
                    {   "name": "house_liter",
                        "valueString": ""}],
                "resourceType": "Parameters"}}],
    "total": 2273,
    "resourceType": "Bundle"}

Контекстный поиск АО в пространстве адресных объектов заданного родительского адресного объекта

Пример №1
Поиск записей справочника 1.2.643.2.69.1.1.1.155, у которых атрибут «aoguid_parent» имеет значения c2deb16a-0330-4f05-821f-1d09c93331e6, а атрибут «display» содержит подстроку «Аван», учитывая введенный регистр.

Тип запроса: GET

URL-запроса:

[base]/term/ValueSet/1.2.643.2.69.1.1.1.155/_search?_format=json&aoguid_parent=c2deb16a-0330-4f05-821f-1d09c93331e6&display:cs=Аван

Header: Authorization: [GUID-токен]

Тип запроса: POST

URL-запроса:

[base]/term/ValueSet/_search?_format=json

Header: Authorization: [GUID-токен]

BODY-запроса:

{"resourceType": "Parameters",
  "parameter": [
    {"name": "system",
      "valueString": "1.2.643.2.69.1.1.1.155"},
    {"name": "aoguid_parent",
      "valueString": "c2deb16a-0330-4f05-821f-1d09c93331e6"},
    {"name": "display:cs",
      "valueString": "Ава" }]}

Пример ответа:

{   "type": "searchset",
    "entry": [{
    "resource": {
    "parameter": [
     {   "name": "aoid",
         "valueString": 1419787},
     {   "name": "aoguid",
         "valueString": "fc22565a-01ee-4bae-ac14-f7f19b7d49e1"},
     {   "name": "aoguid_parent",
         "valueString": "c2deb16a-0330-4f05-821f-1d09c93331e6"},
     {   "name": "code",
         "valueString": "fc22565a-01ee-4bae-ac14-f7f19b7d49e1"},
     {   "name": "display",
         "valueString": "Авангардная"},
     {   "name": "type_name",
         "valueString": "ул"},
     {   "name": "postal_index",
         "valueString": ""},
     {   "name": "ifnsfl",
         "valueString": "7807"},
     {   "name": "ifnsul",
         "valueString": "7807"},
     {   "name": "muni_div",
         "valueString": ""},
     {   "name": "admin_div",
         "valueString": "Санкт-Петербург г, Авангардная ул"},
     {   "name": "okato",
         "valueString": "40279564000"},
     {   "name": "oktmo",
         "valueString": "40357000"},
     {   "name": "kladr_code",
         "valueString": "78000000000004400"},
     {   "name": "createdate",
         "valueString": ""},
     {   "name": "updatedate",
         "valueString": "2011-09-14"},
     {   "name": "aolevel",
         "valueString": 8},
     {   "name": "livestatus",
         "valueString": "true"},
     {   "name": "unique_registry_number",
         "valueString": "403570000000000004401"},
     {   "name": "normdoc",
         "valueString": ""},
     {   "name": "cadnum",
         "valueString": ""},
     {   "name": "house",
         "valueString": ""}],
     "resourceType": "Parameters"}}],
    "total": 1,
    "resourceType": "Bundle"}

Пример №2
Поиск 1 записи на 3 странице справочника 1.2.643.2.69.1.1.1.155, у которых атрибут «aoguid_parent» имеет значения c2deb16a-0330-4f05-821f-1d09c93331e6, а атрибут «display» содержит подстроку «1», учитывая введенный регистр.

Тип запроса: GET

URL-запроса:

[base]/term/ValueSet/1.2.643.2.69.1.1.1.155/_search?_format=json&aoguid_parent=c2deb16a-0330-4f05-821f-1d09c93331e6&display:cs=1&_count=1&_page=3

Header: Authorization: [GUID-токен]

Тип запроса: POST

URL-запроса:

[base]/term/ValueSet/_search?_format=json

Header: Authorization: [GUID-токен]

BODY-запроса:

{"resourceType": "Parameters",
  "parameter": [
    {"name": "system",
      "valueString": "1.2.643.2.69.1.1.1.155"},
    {"name": "aoguid_parent",
      "valueString": "c2deb16a-0330-4f05-821f-1d09c93331e6"},
    {"name": "display:cs",
      "valueString": "1" },
    {"name": "_count",
      "valueString": "1" },
    {"name": "_page",
      "valueString": "3" }]}

Пример ответа:

{   "type": "searchset",
    "entry": [{
            "resource": {
                "parameter": [
                    {   "name": "aoid",
                        "valueString": 1420137},
                    {   "name": "aoguid",
                        "valueString": "e25321c8-6399-4458-aee9-6cd7ecc4abbe"},
                    {   "name": "aoguid_parent",
                        "valueString": "c2deb16a-0330-4f05-821f-1d09c93331e6"},
                    {   "name": "aoguid_parent_md",
                        "valueString": "21a1f665-5dba-4884-902b-73f519b3855a"},
                    {   "name": "code",
                        "valueString": "e25321c8-6399-4458-aee9-6cd7ecc4abbe"},
                    {   "name": "display",
                        "valueString": "10-я Советская"},
                    {   "name": "type_name",
                        "valueString": "ул"},
                    {   "name": "postal_index",
                        "valueString": ""},
                    {   "name": "ifnsfl",
                        "valueString": "7842"},
                    {   "name": "ifnsul",
                        "valueString": "7842"},
                    {   "name": "muni_div",
                        "valueString": "Санкт-Петербург г, муниципальный округ Смольнинское вн.тер.г., 10-я Советская ул"},
                    {   "name": "admin_div",
                        "valueString": "Санкт-Петербург г, 10-я Советская ул"},
                    {   "name": "okato",
                        "valueString": "40298564000"},
                    {   "name": "oktmo",
                        "valueString": "40911000"},
                    {   "name": "kladr_code",
                        "valueString": "78000000000000400"},
                    {   "name": "createdate",
                        "valueString": ""},
                    {   "name": "updatedate",
                        "valueString": "2011-09-14"},
                    {   "name": "aolevel",
                        "valueString": 8},
                    {   "name": "livestatus",
                        "valueString": "true"},
                    {   "name": "unique_registry_number",
                        "valueString": "409110000000000000401"},
                    {   "name": "normdoc",
                        "valueString": ""},
                    {   "name": "cadnum",
                        "valueString": ""},
                    {   "name": "house_num",
                        "valueString": ""},
                    {   "name": "house_corp",
                        "valueString": ""},
                    {   "name": "house_stroen",
                        "valueString": ""},
                    {   "name": "house_soor",
                        "valueString": ""},
                    {   "name": "house_liter",
                        "valueString": ""}],
                "resourceType": "Parameters"}}],
    "total": 46,
    "resourceType": "Bundle"}

Каскадный поиск конечного АО

Пример искомого адреса: Санкт-Петербург город, Реки Фонтанки набережная, д. 100 А

Шаг 1.
Поиск записи справочника 1.2.643.2.69.1.1.1.155, у которой атрибут «display» имеет значения “Санкт-Петербург”, учитывая введенный регистр.

Тип запроса: GET

URL-запроса:

[base]/term/ValueSet/1.2.643.2.69.1.1.1.155/_search?_format=json&display:cs=Санкт-Петербург

Header: Authorization: [GUID-токен]

Тип запроса: POST

URL-запроса:

[base]/term/ValueSet/_search?_format=json

Header: Authorization: [GUID-токен]

BODY-запроса:

{"resourceType": "Parameters",
  "parameter": [
    {"name": "system",
      "valueString": "1.2.643.2.69.1.1.1.155"},
    {"name": "display:cs",
      "valueString": "Санкт-Петербург" }]}

Пример ответа:

{   "type": "searchset",
    "entry": [{
    "resource": {
    "parameter": [
     {   "name": "aoid",
         "valueString": 1414662},
     {   "name": "aoguid",
         "valueString": "c2deb16a-0330-4f05-821f-1d09c93331e6"},
     {   "name": "aoguid_parent",
         "valueString": null},
     {   "name": "code",
         "valueString": "c2deb16a-0330-4f05-821f-1d09c93331e6"},
     {   "name": "display",
         "valueString": "Санкт-Петербург"},
     {   "name": "type_name",
         "valueString": "г"},
     {   "name": "postal_index",
         "valueString": ""},
     {   "name": "ifnsfl",
         "valueString": "7800"},
     {   "name": "ifnsul",
         "valueString": "7800"},
     {   "name": "muni_div",
         "valueString": ""},
     {   "name": "admin_div",
         "valueString": "Санкт-Петербург г"},
     {   "name": "okato",
         "valueString": "40000000000"},
     {   "name": "oktmo",
         "valueString": "40000000"},
     {   "name": "kladr_code",
         "valueString": "7800000000000"},
     {   "name": "createdate",
         "valueString": ""},
     {   "name": "updatedate",
         "valueString": "2018-08-23"},
     {   "name": "aolevel",
         "valueString": 1},
     {   "name": "livestatus",
         "valueString": "true"},
     {   "name": "unique_registry_number",
         "valueString": "400000000000000000001"},
     {   "name": "normdoc",
         "valueString": ""},
     {   "name": "cadnum",
         "valueString": ""},
     {   "name": "house",
         "valueString": ""}],
    "resourceType": "Parameters"}}],
    "total": 1,
    "resourceType": "Bundle"}

Скопировать из полученного ответа значение атрибута “aoguid” - “c2deb16a-0330-4f05-821f-1d09c93331e6”.

Шаг 2.

Пример №1.

Поиск записей справочника 1.2.643.2.69.1.1.1.155, у которых атрибут «aoguid_parent» имеет значения c2deb16a-0330-4f05-821f-1d09c93331e6, а атрибут «display» содержит подстроку «Фонтанк», учитывая введенный регистр.

Тип запроса: GET

URL-запроса: 

[base]/term/ValueSet/1.2.643.2.69.1.1.1.155/version/_search?aoguid_parent=c2deb16a-0330-4f05-821f-1d09c93331e6&display:cs=Фонтанк&_format=json

Тип запроса: POST

[base]/term/ValueSet/_search?_format=json

BODY-запроса:

{"resourceType": "Parameters",
  "parameter": [
    {"name": "system",
      "valueString": "1.2.643.2.69.1.1.1.155"},
    {"name": "aoguid_parent",
      "valueString": "c2deb16a-0330-4f05-821f-1d09c93331e6"},
    {"name": "display:cs",
      "valueString": "Фонтанк" }]}

Пример ответа:

{   "type": "searchset",
    "entry": [{
    "resource": {
    "parameter": [
     {   "name": "aoid",
         "valueString": 1422541},
     {   "name": "aoguid",
         "valueString": "796de636-5fd9-4f3d-97ad-c865c60a024d"},
     {   "name": "aoguid_parent",
         "valueString": "c2deb16a-0330-4f05-821f-1d09c93331e6"},
     {   "name": "code",
         "valueString": "796de636-5fd9-4f3d-97ad-c865c60a024d"},
     {   "name": "display",
         "valueString": "Реки Фонтанки"},
     {   "name": "type_name",
         "valueString": "наб"},
     {   "name": "postal_index",
         "valueString": ""},
     {   "name": "ifnsfl",
         "valueString": ""},
     {   "name": "ifnsul",
         "valueString": ""},
     {   "name": "muni_div",
         "valueString": ""},
     {   "name": "admin_div",
         "valueString": "Санкт-Петербург г, Реки Фонтанки наб"},
     {   "name": "okato",
         "valueString": ""},
     {   "name": "oktmo",
         "valueString": "40301000, 40302000, 40304000, 40305000, 40306000, 40908000, 40909000, 40910000, 40913000"},
     {   "name": "kladr_code",
         "valueString": "78000000000146700"},
     {   "name": "createdate",
         "valueString": ""},
     {   "name": "updatedate",
         "valueString": "2019-12-06"},
     {   "name": "aolevel",
         "valueString": 8},
     {   "name": "livestatus",
         "valueString": "true"},
     {   "name": "unique_registry_number",
         "valueString": "400000000000000146701"},
     {   "name": "normdoc",
         "valueString": ""},
     {   "name": "cadnum",
         "valueString": ""},
     {   "name": "house",
         "valueString": ""}],
    "resourceType": "Parameters"}}],
    "total": 1,
    "resourceType": "Bundle"}

Скопировать из полученного ответа значение “aoguid” - “796de636-5fd9-4f3d-97ad-c865c60a024d”.

Пример №2.

Поиск записей справочника 1.2.643.2.69.1.1.1.155, у которых атрибут «aoguid_parent» имеет значения c2deb16a-0330-4f05-821f-1d09c93331e6, а атрибут «display» содержит подстроку «Ф», учитывая введенный регистр на странице 3.

Тип запроса: GET

URL-запроса: 

[base]/term/ValueSet/1.2.643.2.69.1.1.1.155/_search?aoguid_parent=c2deb16a-0330-4f05-821f-1d09c93331e6&display:cs=Ф&_count=3&_page=3&_format=json

Тип запроса: POST

[base]/term/ValueSet/_search?_format=json

BODY-запроса:

{   "resourceType": "Parameters",
    "parameter": [
        {   "name": "system",
            "valueString": "1.2.643.2.69.1.1.1.155"},
        {   "name": "aoguid_parent",
            "valueString": "c2deb16a-0330-4f05-821f-1d09c93331e6"},
        {   "name": "display:cs",
            "valueString": "Ф"},
        {   "name": "_count",
            "valueString": "3"},
        {   "name": "_page",
            "valueString": "3"}]}

Пример ответа:

{   "type": "searchset",
    "entry": [{
            "resource": {
                "parameter": [
                    {   "name": "aoid",
                        "valueString": 1412728},
                    {   "name": "aoguid",
                        "valueString": "4f512aba-e58a-4198-82b9-c7f1bf801ccd"},
                    {   "name": "aoguid_parent",
                        "valueString": "c2deb16a-0330-4f05-821f-1d09c93331e6"},
                    {   "name": "aoguid_parent_md",
                        "valueString": "a26a8af0-4252-42a2-85c5-1b82f639a88a"},
                    {   "name": "code",
                        "valueString": "4f512aba-e58a-4198-82b9-c7f1bf801ccd"},
                    {   "name": "display",
                        "valueString": "Ольги Форш"},
                    {   "name": "type_name",
                        "valueString": "ул"},
                    {   "name": "postal_index",
                        "valueString": ""},
                    {   "name": "ifnsfl",
                        "valueString": "7804"},
                    {   "name": "ifnsul",
                        "valueString": "7804"},
                    {   "name": "muni_div",
                        "valueString": "Санкт-Петербург г, муниципальный округ Прометей вн.тер.г., Ольги Форш ул"},
                    {   "name": "admin_div",
                        "valueString": "Санкт-Петербург г, Ольги Форш ул"},
                    {   "name": "okato",
                        "valueString": "40273567000"},
                    {   "name": "oktmo",
                        "valueString": "40334000"},
                    {   "name": "kladr_code",
                        "valueString": "78000000000094600"},
                    {   "name": "createdate",
                        "valueString": ""},
                    {   "name": "updatedate",
                        "valueString": "2011-09-14"},
                    {   "name": "aolevel",
                        "valueString": 8},
                    {   "name": "livestatus",
                        "valueString": "true"},
                    {   "name": "unique_registry_number",
                        "valueString": "403340000000000094601"},
                    {   "name": "normdoc",
                        "valueString": ""},
                    {   "name": "cadnum",
                        "valueString": ""},
                    {   "name": "house_num",
                        "valueString": ""},
                    {   "name": "house_corp",
                        "valueString": ""},
                    {   "name": "house_stroen",
                        "valueString": ""},
                    {   "name": "house_soor",
                        "valueString": ""},
                    {   "name": "house_liter",
                        "valueString": ""}],
                "resourceType": "Parameters"}},
        {   "resource": {
                "parameter": [
                    {   "name": "aoid",
                        "valueString": 1420507},
                    {   "name": "aoguid",
                        "valueString": "6e0cf8b7-f125-45b0-ae44-054be26d38bb"},
                    {   "name": "aoguid_parent",
                        "valueString": "c2deb16a-0330-4f05-821f-1d09c93331e6"},
                    {   "name": "aoguid_parent_md",
                        "valueString": "9b5e198c-7230-49f6-9102-64cee219da4d"},
                    {   "name": "code",
                        "valueString": "6e0cf8b7-f125-45b0-ae44-054be26d38bb"},
                    {   "name": "display",
                        "valueString": "Оружейника Фёдорова"},
                    {   "name": "type_name",
                        "valueString": "ул"},
                    {   "name": "postal_index",
                        "valueString": ""},
                    {   "name": "ifnsfl",
                        "valueString": "7840"},
                    {   "name": "ifnsul",
                        "valueString": "7840"},
                    {   "name": "muni_div",
                        "valueString": "Санкт-Петербург г, муниципальный округ Литейный округ вн.тер.г., Оружейника Фёдорова ул"},
                    {   "name": "admin_div",
                        "valueString": "Санкт-Петербург г, Оружейника Фёдорова ул"},
                    {   "name": "okato",
                        "valueString": "40298563000"},
                    {   "name": "oktmo",
                        "valueString": "40910000"},
                    {   "name": "kladr_code",
                        "valueString": "78000000000098600"},
                    {   "name": "createdate",
                        "valueString": ""},
                    {   "name": "updatedate",
                        "valueString": "2016-08-18"},
                    {   "name": "aolevel",
                        "valueString": 8},
                    {   "name": "livestatus",
                        "valueString": "true"},
                    {   "name": "unique_registry_number",
                        "valueString": "409100000000000098601"},
                    {   "name": "normdoc",
                        "valueString": ""},
                    {   "name": "cadnum",
                        "valueString": ""},
                    {   "name": "house_num",
                        "valueString": ""},
                    {   "name": "house_corp",
                        "valueString": ""},
                    {   "name": "house_stroen",
                        "valueString": ""},
                    {   "name": "house_soor",
                        "valueString": ""},
                    {   "name": "house_liter",
                        "valueString": ""}],
                "resourceType": "Parameters"}},
        {   "resource": {
                "parameter": [
                    {   "name": "aoid",
                        "valueString": 1422541},
                    {   "name": "aoguid",
                        "valueString": "796de636-5fd9-4f3d-97ad-c865c60a024d"},
                    {   "name": "aoguid_parent",
                        "valueString": "c2deb16a-0330-4f05-821f-1d09c93331e6"},
                    {   "name": "aoguid_parent_md",
                        "valueString": "dff01040-8bce-4bf8-a711-f46d705b4542"},
                    {   "name": "code",
                        "valueString": "796de636-5fd9-4f3d-97ad-c865c60a024d"},
                    {   "name": "display",
                        "valueString": "Реки Фонтанки"},
                    {   "name": "type_name",
                        "valueString": "наб"},
                    {   "name": "postal_index",
                        "valueString": ""},
                    {   "name": "ifnsfl",
                        "valueString": ""},
                    {   "name": "ifnsul",
                        "valueString": ""},
                    {   "name": "muni_div",
                        "valueString": "Санкт-Петербург г, муниципальный округ Владимирский округ вн.тер.г., Реки Фонтанки наб"},
                    {   "name": "admin_div",
                        "valueString": "Санкт-Петербург г, Реки Фонтанки наб"},
                    {   "name": "okato",
                        "valueString": ""},
                    {   "name": "oktmo",
                        "valueString": "40301000, 40302000, 40304000, 40305000, 40306000, 40908000, 40909000, 40910000, 40913000"},
                    {   "name": "kladr_code",
                        "valueString": "78000000000146700"},
                    {   "name": "createdate",
                        "valueString": ""},
                    {   "name": "updatedate",
                        "valueString": "2019-12-06"},
                    {   "name": "aolevel",
                        "valueString": 8},
                    {   "name": "livestatus",
                        "valueString": "true"},
                    {   "name": "unique_registry_number",
                        "valueString": "400000000000000146701"},
                    {   "name": "normdoc",
                        "valueString": ""},
                    {   "name": "cadnum",
                        "valueString": ""},
                    {   "name": "house_num",
                        "valueString": ""},
                    {   "name": "house_corp",
                        "valueString": ""},
                    {   "name": "house_stroen",
                        "valueString": ""},
                    {   "name": "house_soor",
                        "valueString": ""},
                    {   "name": "house_liter",
                        "valueString": ""}],
                "resourceType": "Parameters"}}],
    "total": 41,
    "resourceType": "Bundle"}

Скопировать из полученного ответа значение “aoguid” - “796de636-5fd9-4f3d-97ad-c865c60a024d”.

Шаг 3.

Пример №1:

Поиск записей справочника 1.2.643.2.69.1.1.1.155, у которых атрибут «aoguid_parent» имеет значения 796de636-5fd9-4f3d-97ad-c865c60a024d, а атрибут «display» содержит подстроку «100», учитывая введенный регистр.

Тип запроса: GET

URL-запроса: 

[base]/term/ValueSet/1.2.643.2.69.1.1.1.155/_search?aoguid_parent=796de636-5fd9-4f3d-97ad-c865c60a024d&display:ext=100&_format=json

Тип запроса: POST

[base]/term/ValueSet/_search?_format=json

BODY-запроса:

{   "resourceType": "Parameters",
    "parameter": [
        {   "name": "system",
            "valueString": "1.2.643.2.69.1.1.1.155"},
        {   "name": "aoguid_parent",
            "valueString": "796de636-5fd9-4f3d-97ad-c865c60a024d"},
        {   "name": "display:ext",
            "valueString": "100"}]}

Пример ответа:

{   "type": "searchset",
    "entry": [{
    "resource": {
    "parameter": [
     {   "name": "aoid",
         "valueString": 66586200},
     {   "name": "aoguid",
         "valueString": "af1660b8-4555-48b1-9d98-84a28f3b1486"},
     {   "name": "aoguid_parent",
         "valueString": "796de636-5fd9-4f3d-97ad-c865c60a024d"},
     {   "name": "code",
         "valueString": "af1660b8-4555-48b1-9d98-84a28f3b1486"},
     {   "name": "display",
         "valueString": "100 А"},
     {   "name": "type_name",
         "valueString": ""},
     {   "name": "postal_index",
         "valueString": "191180"},
     {   "name": "ifnsfl",
         "valueString": "7838"},
     {   "name": "ifnsul",
         "valueString": "7838"},
     {   "name": "muni_div",
         "valueString": ""},
     {   "name": "admin_div",
         "valueString": "Санкт-Петербург г, Реки Фонтанки наб, 100 А"},
     {   "name": "okato",
         "valueString": "40262564000"},
     {   "name": "oktmo",
         "valueString": "40304000"},
     {   "name": "kladr_code",
         "valueString": ""},
     {   "name": "createdate",
         "valueString": "2018-07-26"},
     {   "name": "updatedate",
         "valueString": "2019-02-23"},
     {   "name": "aolevel",
         "valueString": 20},
     {   "name": "livestatus",
         "valueString": "true"},
     {   "name": "unique_registry_number",
         "valueString": "400000000000000146720152000000000"},
     {   "name": "normdoc",
         "valueString": "Решение о присвоении адреса"},
     {   "name": "cadnum",
         "valueString": "78:32:0001618:1025"},
     {   "name": "house",
         "valueString": "100 А"}],
    "resourceType": "Parameters"}}],
    "total": 1,
    "resourceType": "Bundle"}

Пример №2:

Поиск записей справочника 1.2.643.2.69.1.1.1.155, у которых атрибут «aoguid_parent» имеет значения 796de636-5fd9-4f3d-97ad-c865c60a024d, а атрибут «display» содержит подстроку «10», учитывая введенный регистр, номер страницы 1 и количество выводимых АО – 1. 

Тип запроса: GET

URL-запроса: 

[base]/term/ValueSet/1.2.643.2.69.1.1.1.155/_search?aoguid_parent=796de636-5fd9-4f3d-97ad-c865c60a024d&display:ext=10&_count=1&_page=1&_format=json

Тип запроса: POST

[base]/term/ValueSet/_search?_format=json

BODY-запроса:

{"resourceType": "Parameters",
  "parameter": [
    {"name": "system",
      "valueString": "1.2.643.2.69.1.1.1.155"},
    {"name": "aoguid_parent",
      "valueString": "796de636-5fd9-4f3d-97ad-c865c60a024d"},
    {"name": "display",
      "valueString": "10" },
    {"name": "_count",
      "valueString": "1" },
    {"name": "_page",
      "valueString": "1" }]}

Пример ответа:

{   "type": "searchset",
    "entry": [{
    "resource": {
    "parameter": [
     {   "name": "aoid",
         "valueString": 66586200},
     {   "name": "aoguid",
         "valueString": "af1660b8-4555-48b1-9d98-84a28f3b1486"},
     {   "name": "aoguid_parent",
         "valueString": "796de636-5fd9-4f3d-97ad-c865c60a024d"},
     {   "name": "code",
         "valueString": "af1660b8-4555-48b1-9d98-84a28f3b1486"},
     {   "name": "display",
         "valueString": "100 А"},
     {   "name": "type_name",
         "valueString": ""},
     {   "name": "postal_index",
         "valueString": "191180"},
     {   "name": "ifnsfl",
         "valueString": "7838"},
     {   "name": "ifnsul",
         "valueString": "7838"},
     {   "name": "muni_div",
         "valueString": ""},
     {   "name": "admin_div",
         "valueString": "Санкт-Петербург г, Реки Фонтанки наб, 100 А"},
     {   "name": "okato",
         "valueString": "40262564000"},
     {   "name": "oktmo",
         "valueString": "40304000"},
     {   "name": "kladr_code",
         "valueString": ""},
     {   "name": "createdate",
         "valueString": "2018-07-26"},
     {   "name": "updatedate",
         "valueString": "2019-02-23"},
     {   "name": "aolevel",
         "valueString": 20},
     {   "name": "livestatus",
         "valueString": "true"},
     {   "name": "unique_registry_number",
         "valueString": "400000000000000146720152000000000"},
     {   "name": "normdoc",
         "valueString": "Решение о присвоении адреса"},
     {   "name": "cadnum",
         "valueString": "78:32:0001618:1025"},
     {   "name": "house",
         "valueString": "100 А"}],
    "resourceType": "Parameters"}}],
    "total": 22,
    "resourceType": "Bundle"}


Получение комплексного АО по уникальному идентификатору

Пример запроса:
Получение комплексного АО справочника 1.2.643.2.69.1.1.1.155, у которой атрибут «code» имеет значения af1660b8-4555-48b1-9d98-84a28f3b1486.

Тип запроса: GET

URL-запроса:

[base]/term/get_resource?_format=json&system=1.2.643.2.69.1.1.1.155&code=af1660b8-4555-48b1-9d98-84a28f3b1486

Header: Authorization: [GUID-токен]

Тип запроса: POST

URL-запроса:

[base]/term/get_resource?_format=json

Header: Authorization: [GUID-токен]

BODY-запроса:

{"resourceType": "Parameters",
    "parameter":[
        {"name": "system",
            "valueString": "1.2.643.2.69.1.1.1.155"},
        {"name": "code",
            "valueString": "af1660b8-4555-48b1-9d98-84a28f3b1486"}]}

Пример ответа:

[
    {
        "aoid": 1414662,
        "code": "c2deb16a-0330-4f05-821f-1d09c93331e6",
        "house": "",
        "okato": "40000000000",
        "oktmo": "40000000",
        "aoguid": "c2deb16a-0330-4f05-821f-1d09c93331e6",
        "cadnum": "",
        "ifnsfl": "7800",
        "ifnsul": "7800",
        "aolevel": 1,
        "display": "Санкт-Петербург",
        "normdoc": null,
        "muni_div": "",
        "admin_div": "Санкт-Петербург г",
        "type_name": "г",
        "createdate": null,
        "kladr_code": "7800000000000",
        "livestatus": "true",
        "updatedate": "2018-08-23",
        "postal_index": null,
        "aoguid_parent": null,
        "unique_registry_number": "400000000000000000001"
    },
    {
        "aoid": 1422541,
        "code": "796de636-5fd9-4f3d-97ad-c865c60a024d",
        "house": "",
        "okato": null,
        "oktmo": "40301000, 40302000, 40304000, 40305000, 40306000, 40908000, 40909000, 40910000, 40913000",
        "aoguid": "796de636-5fd9-4f3d-97ad-c865c60a024d",
        "cadnum": "",
        "ifnsfl": null,
        "ifnsul": null,
        "aolevel": 8,
        "display": "Реки Фонтанки",
        "normdoc": null,
        "muni_div": "",
        "admin_div": "Санкт-Петербург г, Реки Фонтанки наб",
        "type_name": "наб",
        "createdate": null,
        "kladr_code": "78000000000146700",
        "livestatus": "true",
        "updatedate": "2019-12-06",
        "postal_index": null,
        "aoguid_parent": "c2deb16a-0330-4f05-821f-1d09c93331e6",
        "unique_registry_number": "400000000000000146701"
    },
    {
        "aoid": 66586200,
        "code": "af1660b8-4555-48b1-9d98-84a28f3b1486",
        "house": "100 А",
        "okato": "40262564000",
        "oktmo": "40304000",
        "aoguid": "af1660b8-4555-48b1-9d98-84a28f3b1486",
        "cadnum": "78:32:0001618:1025",
        "ifnsfl": "7838",
        "ifnsul": "7838",
        "aolevel": 20,
        "display": "100 А",
        "normdoc": "Решение о присвоении адреса",
        "muni_div": "",
        "admin_div": "Санкт-Петербург г, Реки Фонтанки наб, 100 А",
        "type_name": "",
        "createdate": "2018-07-26",
        "kladr_code": null,
        "livestatus": "true",
        "updatedate": "2019-02-23",
        "postal_index": "191180",
        "aoguid_parent": "796de636-5fd9-4f3d-97ad-c865c60a024d",
        "unique_registry_number": "400000000000000146720152000000000"
    }
]
 

Получение полных сведений ФИАС

Тип запроса: POST

URL-запроса:

[base]/term/ValueSet/$expand?_format=json

Header: Authorization: [GUID-токен]

BODY-запроса:

{"resourceType": "Parameters",
    "parameter": [{
            "name": "system",
            "valueString": "1.2.643.2.69.1.1.1.155"},
        {"name": "count",
            "valueString": 1},
        {"name": "offset",
            "valueString": 1}]}

Пример ответа:

{   "parameter": [{
    "name": "return",
    "resource": {
        "id": "2361eadc-39c7-4eed-b69b-138ee26cf804",
        "url": "urn:oid:1.2.643.2.69.1.1.1.155",
        "meta": {
            "versionId": "20220415",
            "lastUpdated": "2022-01-19T13:11:41.093488+03:00"},
        "name": "Реестр адресной информации ФИАС",
                "status": "active",
                "contact": [{
                        "telecom": [
                            {   "value": "Netrika@Netrika.ru",
                                "system": "email"}]}],
        "version": "20220415",
        "expansion": {
        "contains": [
            {   "code": "d1116ce7-3dfc-436a-a112-71191ab6304a",
                "display": "Заря",
                "version": "20220415",
                "contains": [
                {   "code": "aoid",
                    "display": 2},
                {   "code": "aoguid",
                    "display": "d1116ce7-3dfc-436a-a112-71191ab6304a"},
                {   "code": "aoguid_parent",
                    "display": "8cfbe842-e803-49ca-9347-1ef90481dd98"},
                {   "code": "code",
                    "display": "d1116ce7-3dfc-436a-a112-71191ab6304a"},
                {   "code": "display",
                    "display": "Заря"},
                {   "code": "type_name",
                    "display": "тер. СНТ"},
                {   "code": "postal_index",
                    "display": ""},
                {   "code": "ifnsfl",
                    "display": "0100"},
                {   "code": "ifnsul",
                    "display": "0100"},
                {   "code": "muni_div",
                    "display": ""},
                {   "code": "admin_div",
                    "display": "Адыгея Респ, Адыгея Респ, Майкоп г, Майкоп г, Заря тер. СНТ, Заря тер. СНТ"},
                {   "code": "okato",
                    "display": "79401000000"},
                {   "code": "oktmo",
                    "display": "79701000001"},
                {   "code": "kladr_code",
                    "display": "01000001000075300"},
                {   "code": "createdate",
                    "display": ""},
                {   "code": "updatedate",
                    "display": "2019-03-01"},
                {   "code": "aolevel",
                    "display": 7},
                {   "code": "livestatus",
                    "display": "true"},
                {   "code": "unique_registry_number",
                    "display": "797010000010753000001"},
                {   "code": "normdoc",
                    "display": "Об утверждении реестра элементов планировочной структуры муниципального образования \"Город Майкоп\" для дальнейшего внесения в Федеральную информационную адресную систему (ФИАС)" },
                {   "code": "cadnum",
                    "display": ""},
                {   "code": "house",
                    "display": ""}}],
   "parameter": [
       {   "name": "total",
           "valueString": 31106798},
       {   "name": "version_comment",
           "valueString": ""}],
   "timestamp": "2022-07-14T11:14:43.554553+03:00"},
"publisher": "ФНС России",
"experimental": true,
"resourceType": "ValueSet"}}],
"resourceType": "Parameters"}

Поиск КЛАДР-адреса по ФИАС

Вариант 1.

Пример 1.

Искомый адрес: 198205, Санкт-Петербург г, Авангардная ул, д. 4

Элементы адресной цепочки

Пример КАДР-адреса

Search-параметры

Пример значений search-параметров

Вес в иерархии

Регион

Санкт-Петербург г

KLADR_Region

Санкт-Петербург

1

Ррайон, область


KLADR_Area

 


2

Город


Внутригородской район


KLADR_City


3

Доп. территория


Населенный пункт


KLADR_Place


4

Улица

Авангардная ул

KLADR_Street

Авангардная

5

Улица на доп. территории


Дом

д. 14

KLADR_House

14 А

6

Корпус

А

Строение



Тип запроса: GET

URL-запроса:

[base]/term/ValueSet/1.2.643.2.69.1.1.1.155/_search?KLADR_Region=Санкт-Петербург&KLADR_Street=Авангардная&KLADR_House=14 А&_format=json

Header: Authorization: [GUID-токен]


Тип запроса: POST

URL-запроса:

[base]/term/ValueSet/_search?_format=json

Header: Authorization: [GUID-токен]

BODY-запроса:

{"resourceType": "Parameters",
    "parameter": [
        {"name": "system",
         "valueString": "1.2.643.2.69.1.1.1.155"},
        {"name": "KLADR_Region",
         "valueString": "Санкт-Петербург"},
        {"name": "KLADR_Area",
         "valueString": ""},
        {"name": "KLADR_City",
         "valueString": ""},
        {"name": "KLADR_Place",
         "valueString": ""},
        {"name": "KLADR_Street",
         "valueString": "Авангардная"},
        {"name": "KLADR_House",
         "valueString": "14 А"}]}


Пример ответа:

{   "resourceType": "Bundle",
    "type": "searchset",
    "total": 1,
    "entry": [
    {   "resource": {
        "resourceType": "Parameters",
        "parameter": [
        {   "name": "aoid",
            "valueString": "82446303"},
        {   "name": "aoguid",
            "valueString": "e15fecae-5ab2-415a-b4f7-3b55193c2392"},
        {   "name": "aoguid_parent",
            "valueString": "fc22565a-01ee-4bae-ac14-f7f19b7d49e1"},
        {   "name": "code",
            "valueString": "e15fecae-5ab2-415a-b4f7-3b55193c2392"},
        {   "name": "display",
            "valueString": "14 А"},
        {   "name": "type_name"},
        {   "name": "postal_index",
            "valueString": "198205"},
        {   "name": "ifnsfl",
            "valueString": "7807"},
        {   "name": "ifnsul",
            "valueString": "7807"},
        {   "name": "muni_div"},
        {   "name": "admin_div",
            "valueString": "Санкт-Петербург г, Авангардная ул, 14 А"},
        {   "name": "okato",
            "valueString": "40279564000"},
        {   "name": "oktmo",
            "valueString": "40357000"},
        {   "name": "kladr_code"},
        {   "name": "createdate",
            "valueString": "2019-02-02"},
        {   "name": "updatedate",
            "valueString": "2019-02-23"},
        {   "name": "aolevel",
            "valueString": "20"},
        {   "name": "livestatus",
            "valueString": "true"},
        {   "name": "unique_registry_number",
            "valueString": "403570000000000004420021000000000"},
        {   "name": "normdoc",
            "valueString": "Решение о присвоении адреса"},
        {   "name": "cadnum",
            "valueString": "78:40:0845601:1042"},
        {   "name": "house",
            "valueString": "14 А"}]}}]}


 

Пример 2.

Искомый адрес: 190961, Санкт-Петербург г, 6-я Советская ул, д. 10 А

Элементы адресной цепочки

Пример КАДР-адреса

Search-параметры

Пример значений search-параметров

Вес в иерархии

Регион

Санкт-Петербург г

KLADR_Region

Санкт-Петербург

1

Ррайон, область


KLADR_Area


 

 

2

 

Город


Внутригородской район


KLADR_City

 

 

3

 

Доп. территория


Населенный пункт


KLADR_Place

 

4

Улица

6-я Советская ул

KLADR_Street

6-я Советская

5

Улица на доп. территории


Дом

д. 10

KLADR_House

10 А

6

Корпус

А

Строение



Тип запроса: GET

URL-запроса:

[base]/term/ValueSet/1.2.643.2.69.1.1.1.155/_search?KLADR_Region=Санкт-Петербург&KLADR_Street=6-я Советская&KLADR_House=10 А&_format=json

Header: Authorization: [GUID-токен]


Тип запроса: POST

URL-запроса:

[base]/term/ValueSet/_search?_format=json

Header: Authorization: [GUID-токен]

BODY-запроса:

{"resourceType": "Parameters",
    "parameter": [
        {"name": "system",
         "valueString": "1.2.643.2.69.1.1.1.155"},
        {"name": "KLADR_Region",
         "valueString": "Санкт-Петербург"},
        {"name": "KLADR_Area",
         "valueString": ""},
        {"name": "KLADR_City",
         "valueString": ""},
        {"name": "KLADR_Place",
         "valueString": ""},
        {"name": "KLADR_Street",
         "valueString": "6-я Советская"},
        {"name": "KLADR_House",
         "valueString": "10 А"}]}


Пример ответа:

{"resourceType": "Bundle",
    "type": "searchset",
    "total": 1,
    "entry": [{
            "resource": {
                "resourceType": "Parameters",
                "parameter": [
                    {"name": "aoid",
                     "valueString": "61364236"},
                    {"name": "aoguid",
                     "valueString": "d5a6655e-3579-4d18-a98b-2df086de6af2"},
                    {"name": "aoguid_parent",
                     "valueString": "990570ef-9870-4ac2-ae61-b7baff32daca"},
                    {"name": "code",
                     "valueString": "d5a6655e-3579-4d18-a98b-2df086de6af2"},
                    {"name": "display",
                     "valueString": "10 А"},
                    {"name": "type_name"},
                    {"name": "postal_index",
                     "valueString": "191036"},
                    {"name": "ifnsfl",
                     "valueString": "7842"},
                    {"name": "ifnsul",
                     "valueString": "7842"},
                    {"name": "muni_div"},
                    {"name": "admin_div",
                     "valueString": "Санкт-Петербург г, 6-я Советская ул, 10 А"},
                    {"name": "okato",
                     "valueString": "40298564000"},
                    {"name": "oktmo",
                     "valueString": "40911000"},
                    {"name": "kladr_code"},
                    {"name": "createdate",
                     "valueString": "2018-07-26"},
                    {"name": "updatedate",
                     "valueString": "2019-02-23"},
                    {"name": "aolevel",
                     "valueString": "20"},
                    {"name": "livestatus",
                     "valueString": "true"},
                    {"name": "unique_registry_number",
                     "valueString": "409110000000000130420012000000000"},
                    {"name": "normdoc",
                     "valueString": "Положение о порядке нумерации строений"},
                    {"name": "cadnum",
                     "valueString": "78:31:0001425:2005"},
                    {"name": "house",
                     "valueString": "10 А"}]}}]}


 

Пример 3.

Искомый адрес:198 326, Санкт-Петербург г, Автомобилист тер. СНТ, д. 136

Элементы адресной цепочки

Пример КАДР-адреса

Search-параметры

Пример значений search-параметров

Вес в иерархии

Регион

Санкт-Петербург г

KLADR_Region

Санкт-Петербург

1

Ррайон, область


KLADR_Area




2


Город


Внутригородской район


KLADR_City

Автомобилист

3

Доп. территория

Автомобилист тер. СНТ

Населенный пункт


KLADR_Place

 

4

Улица


KLADR_Street


5

Улица на доп. территории


Дом

д. 136

KLADR_House

136

6

Корпус


Строение



Тип запроса: GET

URL-запроса:

[base]/term/ValueSet/1.2.643.2.69.1.1.1.155/_search?KLADR_Region=Санкт-Петербург&KLADR_City=Автомобилист&KLADR_House=136&_format=json

Header: Authorization: [GUID-токен]


Тип запроса: POST

URL-запроса:

[base]/term/ValueSet/_search?_format=json

Header: Authorization: [GUID-токен]

BODY-запроса:

{"resourceType": "Parameters",
    "parameter": [
        {"name": "system",
         "valueString": "1.2.643.2.69.1.1.1.155"},
        {"name": "KLADR_Region",
         "valueString": "Санкт-Петербург"},
        {"name": "KLADR_Area",
         "valueString": ""},
        {"name": "KLADR_City",
         "valueString": "Автомобилист"},
        {"name": "KLADR_Place",
         "valueString": ""},
        {"name": "KLADR_Street",
         "valueString": ""},
        {"name": "KLADR_House",
         "valueString": "136"}]}


Пример ответа:

 {"resourceType": "Bundle",
    "type": "searchset",
    "total": 1,
    "entry": [{
            "resource": {
                "resourceType": "Parameters",
                "parameter": [
                    {"name": "aoid",
                     "valueString": "66114102"},
                    {"name": "aoguid",
                     "valueString": "cd97021f-7b2c-4402-9f36-8642bee22034"},
                    {"name": "aoguid_parent",
                     "valueString": "83ab2fc0-2c87-4305-8527-c70feb642abd"},
                    {"name": "code",
                     "valueString": "cd97021f-7b2c-4402-9f36-8642bee22034"},
                    {"name": "display",
                     "valueString": "136"},
                    {"name": "type_name"},
                    {"name": "postal_index",
                     "valueString": "198326"},
                    {"name": "ifnsfl",
                     "valueString": "7807"},
                    {"name": "ifnsul",
                     "valueString": "7807"},
                    {"name": "muni_div"},
                    {"name": "admin_div",
                     "valueString": "Санкт-Петербург г, Санкт-Петербург г, Санкт-Петербург г, Санкт-Петербург г, Автомобилист тер. СНТ, Автомобилист тер. СНТ, Автомобилист тер. СНТ, Автомобилист тер. СНТ, 136"},
                    {"name": "okato",
                     "valueString": "40279566000"},
                    {"name": "oktmo",
                     "valueString": "40359000"},
                    {"name": "kladr_code"},
                    {"name": "createdate",
                     "valueString": "2019-07-10"},
                    {"name": "updatedate",
                     "valueString": "2019-07-10"},
                    {"name": "aolevel",
                     "valueString": "20"},
                    {"name": "livestatus",
                     "valueString": "true"},
                    {"name": "unique_registry_number",
                     "valueString": "403590000002962000020068000000000"},
                    {"name": "normdoc"},
                    {"name": "cadnum"},
                    {"name": "house",
                     "valueString": "136"}]}}]}


 

Пример 4.

Искомый адрес:198326, Санкт-Петербург г, Автомобилист тер. СНТ, Центральная ул, д. 18

Элементы адресной цепочки

Пример КАДР-адреса

Search-параметры

Пример значений search-параметров

Вес в иерархии

Регион

Санкт-Петербург г

KLADR_Region

Санкт-Петербург

1

Ррайон, область


KLADR_Area


2

Город


Внутригородской район


KLADR_City

Автомобилист

3

Доп. территория

Автомобилист тер. СНТ

Населенный пункт


KLADR_Place


4

Улица


KLADR_Street

Центральная

5

Улица на доп. территории

Центральная ул

Дом

д. 18

KLADR_House

18

6

Корпус


Строение



Тип запроса: GET

URL-запроса:

[base]/term/ValueSet/1.2.643.2.69.1.1.1.155/_search?KLADR_Region=Санкт-Петербург&KLADR_City=Автомобилист&KLADR_Street=Центральная&KLADR_House:eqncs=18&_format=json

Header: Authorization: [GUID-токен]


Тип запроса: POST

URL-запроса:

[base]/term/ValueSet/_search?_format=json

Header: Authorization: [GUID-токен]

BODY-запроса:

{"resourceType": "Parameters",
    "parameter": [
        {"name": "system",
         "valueString": "1.2.643.2.69.1.1.1.155"},
        {"name": "KLADR_Region",
         "valueString": "Санкт-Петербург"},
        {"name": "KLADR_Area",
         "valueString": ""},
        {"name": "KLADR_City",
         "valueString": "Автомобилист"},
        {"name": "KLADR_Place",
         "valueString": ""},
        {"name": "KLADR_Street",
         "valueString": "Центральная"},
        {"name": "KLADR_House",
         "valueString": "18"}]}


Пример ответа:

{"resourceType": "Bundle",
    "type": "searchset",
    "total": 3,
    "entry": [{
            "resource": {
                "resourceType": "Parameters",
                "parameter": [
                    {"name": "aoid",
                     "valueString": "4029267"},
                    {"name": "aoguid",
                     "valueString": "22706fed-6426-4b2c-84fc-e8c24ad220f0"},
                    {"name": "aoguid_parent",
                     "valueString": "37beab40-33a9-476d-b1b1-07bdec4bbb40"},
                    {"name": "code",
                     "valueString": "22706fed-6426-4b2c-84fc-e8c24ad220f0"},
                    {"name": "display",
                     "valueString": "18"},
                    {"name": "type_name"},
                    {"name": "postal_index",
                     "valueString": "198326"},
                    {"name": "ifnsfl",
                     "valueString": "7807"},
                    {"name": "ifnsul",
                     "valueString": "7807"},
                    {"name": "muni_div"},
                    {"name": "admin_div",
                     "valueString": "Санкт-Петербург г, Санкт-Петербург г, Санкт-Петербург г, Санкт-Петербург г, Санкт-Петербург г, Санкт-Петербург г, Автомобилист тер. СНТ, Автомобилист тер. СНТ, Автомобилист тер. СНТ, Автомобилист тер. СНТ, Центральная ул, Центральная ул, Центральная ул, Центральная ул, 18"},
                    {"name": "okato",
                     "valueString": "40279566000"},
                    {"name": "oktmo",
                     "valueString": "40359000"},
                    {"name": "kladr_code"},
                    {"name": "createdate",
                     "valueString": "2019-07-10"},
                    {"name": "updatedate",
                     "valueString": "2019-07-10"},
                    {"name": "aolevel",
                     "valueString": "20"},
                    {"name": "livestatus",
                     "valueString": "true"},
                    {"name": "unique_registry_number",
                     "valueString": "403590000002962296520006000000000"},
                    {"name": "normdoc",
                     "valueString": "Положение о порядке нумерации строений"},
                    {"name": "cadnum"},
                    {"name": "house",
                     "valueString": "18"}]}},
        {"resource": {
                "resourceType": "Parameters",
                "parameter": [
                    {"name": "aoid",
                     "valueString": "4029682"},
                    {"name": "aoguid",
                     "valueString": "fd894f7e-1c3e-4db0-a463-bfb5037f49a8"},
                    {"name": "aoguid_parent",
                     "valueString": "37beab40-33a9-476d-b1b1-07bdec4bbb40"},
                    {"name": "code",
                     "valueString": "fd894f7e-1c3e-4db0-a463-bfb5037f49a8"},
                    {"name": "display",
                     "valueString": "18 1"},
                    {"name": "type_name"},
                    {"name": "postal_index",
                     "valueString": "198326"},
                    {"name": "ifnsfl",
                     "valueString": "7807"},
                    {"name": "ifnsul",
                     "valueString": "7807"},
                    {"name": "muni_div"},
                    {"name": "admin_div",
                     "valueString": "Санкт-Петербург г, Санкт-Петербург г, Санкт-Петербург г, Санкт-Петербург г, Санкт-Петербург г, Санкт-Петербург г, Автомобилист тер. СНТ, Автомобилист тер. СНТ, Автомобилист тер. СНТ, Автомобилист тер. СНТ, Центральная ул, Центральная ул, Центральная ул, Центральная ул, 18 1"},
                    {"name": "okato",
                     "valueString": "40279566000"},
                    {"name": "oktmo",
                     "valueString": "40359000"},
                    {"name": "kladr_code"},
                    {"name": "createdate",
                     "valueString": "2019-07-10"},
                    {"name": "updatedate",
                     "valueString": "2019-07-10"},
                    {"name": "aolevel",
                     "valueString": "20"},
                    {"name": "livestatus",
                     "valueString": "true"},
                    {"name": "unique_registry_number",
                     "valueString": "403590000002962296520022000000000"},
                    {"name": "normdoc",
                     "valueString": "решение"},
                    {"name": "cadnum"},
                    {"name": "house",
                     "valueString": "18 1"}]}},
        {"resource": {
                "resourceType": "Parameters",
                "parameter": [
                    {"name": "aoid",
                     "valueString": "4029065"},
                    {"name": "aoguid",
                     "valueString": "1bb33348-4aea-4d92-9571-5fba4ab1c2c4"},
                    {"name": "aoguid_parent",
                     "valueString": "37beab40-33a9-476d-b1b1-07bdec4bbb40"},
                    {"name": "code",
                     "valueString": "1bb33348-4aea-4d92-9571-5fba4ab1c2c4"},
                    {"name": "display",
                     "valueString": "18 А"},
                    {"name": "type_name"},
                    {"name": "postal_index",
                     "valueString": "198326"},
                    {"name": "ifnsfl",
                     "valueString": "7807"},
                    {"name": "ifnsul",
                     "valueString": "7807"},
                    {"name": "muni_div"},
                    {"name": "admin_div",
                     "valueString": "Санкт-Петербург г, Санкт-Петербург г, Санкт-Петербург г, Санкт-Петербург г, Санкт-Петербург г, Санкт-Петербург г, Автомобилист тер. СНТ, Автомобилист тер. СНТ, Автомобилист тер. СНТ, Автомобилист тер. СНТ, Центральная ул, Центральная ул, Центральная ул, Центральная ул, 18 А"},
                    {"name": "okato",
                     "valueString": "40279566000"},
                    {"name": "oktmo",
                     "valueString": "40359000"},
                    {"name": "kladr_code"},
                    {"name": "createdate",
                     "valueString": "2019-07-10"},
                    {"name": "updatedate",
                     "valueString": "2019-07-10"},
                    {"name": "aolevel",
                     "valueString": "20"},
                    {"name": "livestatus",
                     "valueString": "true"},
                    {"name": "unique_registry_number",
                     "valueString": "403590000002962296520003000000000"},
                    {"name": "normdoc",
                     "valueString": "Положение о порядке нумерации строений"},
                    {"name": "cadnum"},
                    {"name": "house",
                     "valueString": "18 А"}]}}]}


Пример 5.

Искомый адрес:198320, Санкт-Петербург г, Красное Село г, Волна тер. СНТ, 2-я линия ул, д. 13, корпус А

Элементы адресной цепочки

Пример КАДР-адреса

Search-параметры

Пример значений search-параметров

Вес в иерархии

Регион

Санкт-Петербург г

KLADR_Region

Санкт-Петербург

1

Ррайон, область


KLADR_Area

Красное Село

2

Город

Красное Село г

Внутригородской район


KLADR_City

Волна

3

Доп. территория

Волна тер. СНТ

Населенный пункт


KLADR_Place


4

Улица


KLADR_Street

2-я линия

5

Улица на доп. территории

2-я линия ул

Дом

д. 13

KLADR_House

13 А

6

Корпус

А

Строение



Тип запроса: GET

URL-запроса:

[base]/term/ValueSet/1.2.643.2.69.1.1.1.155/_search?KLADR_Region=Санкт-Петербург&KLADR_Area:eqncs=Красное Село&KLADR_City:eqncs=Волна&KLADR_Street:eqncs=2-я линия&KLADR_House=13 А&_format=json


Тип запроса: POST

URL-запроса:

[base]/term/ValueSet/_search?_format=json

Header: Authorization: [GUID-токен]

BODY-запроса:

{"resourceType": "Parameters",
    "parameter": [
        {"name": "system",
         "valueString": "1.2.643.2.69.1.1.1.155"},
        {"name": "KLADR_Region",
         "valueString": "Санкт-Петербург"},
        {"name": "KLADR_Area",
         "valueString": "Красное Село"},
        {"name": "KLADR_City",
         "valueString": "Волна"},
        {"name": "KLADR_Place",
         "valueString": ""},
        {"name": "KLADR_Street",
         "valueString": "2-я линия"},
        {"name": "KLADR_House",
         "valueString": "13 А"}]}


Пример ответа:

{"resourceType": "Bundle",
    "type": "searchset",
    "total": 1,
    "entry": [{
            "resource": {
                "resourceType": "Parameters",
                "parameter": [
                    {"name": "aoid",
                     "valueString": "43718863"},
                    {"name": "aoguid",
                     "valueString": "d13a23f7-16ab-4b81-b222-77f85be9a56d"},
                    {"name": "aoguid_parent",
                     "valueString": "dbdb79f1-5bd4-4a51-b3f1-826442dc85a3"},
                    {"name": "code",
                     "valueString": "d13a23f7-16ab-4b81-b222-77f85be9a56d"},
                    {"name": "display",
                     "valueString": "13 А"},
                    {"name": "type_name"},
                    {"name": "postal_index",
                     "valueString": "198324"},
                    {"name": "ifnsfl",
                     "valueString": "7807"},
                    {"name": "ifnsul",
                     "valueString": "7807"},
                    {"name": "muni_div"},
                    {"name": "admin_div",
                     "valueString": "Санкт-Петербург г, Санкт-Петербург г, Санкт-Петербург г, Санкт-Петербург г, Санкт-Петербург г, Санкт-Петербург г, Красное Село г, Красное Село г, Красное Село г, Красное Село г, Красное Село г, Красное Село г, Волна тер. СНТ, Волна тер. СНТ, Волна тер. СНТ, Волна тер. СНТ, 2-я линия ул, 2-я линия ул, 2-я линия ул, 2-я линия ул, 13 А"},
                    {"name": "okato",
                     "valueString": "40279501000"},
                    {"name": "oktmo",
                     "valueString": "40353000"},
                    {"name": "kladr_code"},
                    {"name": "createdate",
                     "valueString": "2018-07-26"},
                    {"name": "updatedate",
                     "valueString": "2018-07-26"},
                    {"name": "aolevel",
                     "valueString": "20"},
                    {"name": "livestatus",
                     "valueString": "true"},
                    {"name": "unique_registry_number",
                     "valueString": "403530000000000015120003000000000"},
                    {"name": "normdoc",
                     "valueString": "Решение о присвоении адреса"},
                    {"name": "cadnum"},
                    {"name": "house",
                     "valueString": "13 А"}]}}]}


Пример 6.

Искомый адрес: 196158, г. Санкт-Петербург, ул. Среднерогатская, д. 16, к. 5, стр. 1

Элементы адресной цепочки

Пример КАДР-адреса

Search-параметры

Пример значений search-параметров

Вес в иерархии

Регион

г. Санкт-Петербург

KLADR_Region

Санкт-Петербург

1

Ррайон, область

 

KLADR_Area

 

 

2

 

Город

 

Внутригородской район

 

KLADR_City

 

 

3

 

Доп. территория

 

Населенный пункт

 

KLADR_Place

 

4

Улица

ул. Среднерогатская

KLADR_Street

Среднерогатская

5

Улица на доп. территории


Дом

д. 16

KLADR_House

16 5

6

Корпус

к. 5

Строение

стр. 1


Тип запроса: GET

URL-запроса:

[base]/term/ValueSet/1.2.643.2.69.1.1.1.155/_search?KLADR_Region=Санкт-Петербург&KLADR_Street=Среднерогатская&KLADR_House:ext=16 5 1&_format=json


Тип запроса: POST

URL-запроса:

[base]/term/ValueSet/_search?_format=json

Header: Authorization: [GUID-токен]

BODY-запроса:

{"resourceType": "Parameters",
    "parameter": [
        {"name": "system",
         "valueString": "1.2.643.2.69.1.1.1.155"},
        {"name": "KLADR_Region",
         "valueString": "Санкт-Петербург"},
        {"name": "KLADR_Area",
         "valueString": ""},
        {"name": "KLADR_City",
         "valueString": ""},
        {"name": "KLADR_Place",
         "valueString": ""},
        {"name": "KLADR_Street",
         "valueString": "Среднерогатская"},
        {"name": "KLADR_House:ext",
         "valueString": "16 5 1"}]}


Пример ответа:

{"resourceType": "Bundle",
    "type": "searchset",
    "total": 1,
    "entry": [{
            "resource": {
                "resourceType": "Parameters",
                "parameter": [
                    {"name": "aoid",
                     "valueString": "38873669"},
                    {"name": "aoguid",
                     "valueString": "0e8c184e-971f-4bff-9f5c-48798be5ef81"},
                    {"name": "aoguid_parent",
                     "valueString": "9bb02016-749f-4c77-b597-728a7a3ece8e"},
                    {"name": "code",
                     "valueString": "0e8c184e-971f-4bff-9f5c-48798be5ef81"},
                    {"name": "display",
                     "valueString": "16 5 соор 1"},
                    {"name": "type_name"},
                    {"name": "postal_index",
                     "valueString": "196158"},
                    {"name": "ifnsfl",
                     "valueString": "7810"},
                    {"name": "ifnsul",
                     "valueString": "7810"},
                    {"name": "muni_div"},
                    {"name": "admin_div",
                     "valueString": "Санкт-Петербург г, Среднерогатская ул, 16 5 соор 1"},
                    {"name": "okato",
                     "valueString": "40284565000"},
                    {"name": "oktmo",
                     "valueString": "40377000"},
                    {"name": "kladr_code"},
                    {"name": "createdate",
                     "valueString": "2018-12-05"},
                    {"name": "updatedate",
                     "valueString": "2018-12-05"},
                    {"name": "aolevel",
                     "valueString": "20"},
                    {"name": "livestatus",
                     "valueString": "true"},
                    {"name": "unique_registry_number",
                     "valueString": "403770000000000281720016000000000"},
                    {"name": "normdoc"},
                    {"name": "cadnum"},
                    {"name": "house",
                     "valueString": "16 5 соор 1"}]}}]}

Вариант 2.

Искомый адрес: Санкт-Петербург г, Лисий Нос п, Большой пр-кт

Элементы адресной цепочки

Пример КАДР-адреса

Search-параметры

Пример значений search-параметров

Вес в иерархии

Регион

Санкт-Петербург

KLADR_Region

Санкт-Петербург

1

Ррайон, область

 

KLADR_Area

 

 

2

 

Город

 

Внутригородской район

 

KLADR_City

 

 

3

 

Доп. территория

 

Населенный пункт

 Лисий Нос

KLADR_Place

 Лисий Нос

4

Улица

Большой

KLADR_Street

Большой

5

Улица на доп. территории


Дом


KLADR_House


6

Корпус


Строение


Тип запроса: GET

URL-запроса:

[base]/term/ValueSet/1.2.643.2.69.1.1.1.155/_search?kladr_code=78000000016000700&_format=json


Тип запроса: POST

URL-запроса:

[base]/term/ValueSet/_search?_format=json

Header: Authorization: [GUID-токен]

BODY-запроса:

{"resourceType": "Parameters",
    "parameter": [
        {"name": "system",
         "valueString": "1.2.643.2.69.1.1.1.155"},
        {"name": "kladr_code",
         "valueString": "78000000016000700"}]}


Пример ответа:

{   "resourceType": "Bundle",
    "type": "searchset",
    "total": 1,
    "entry": [
        {   "resource": {
            "resourceType": "Parameters",
            "parameter": [
            {   "name": "aoid",
                "valueString": "1415300"},
            {   "name": "aoguid",
                "valueString": "632a4ca2-6b5a-4806-a376-29cda5bdc396"},
            {   "name": "aoguid_parent",
                "valueString": "43fdf07b-c22d-42af-9655-6684ee243c21"},
            {   "name": "code",
                "valueString": "632a4ca2-6b5a-4806-a376-29cda5bdc396"},
            {   "name": "display",
                "valueString": "Большой"},
            {   "name": "type_name",
                "valueString": "пр-кт"},
            {   "name": "postal_index"},
            {   "name": "ifnsfl",
                "valueString": "7814"},
            {   "name": "ifnsul",
                "valueString": "7814"},
            {   "name": "muni_div"},
            {   "name": "admin_div",
                "valueString": "Санкт-Петербург г, Лисий Нос п, Большой пр-кт"},
            {   "name": "okato",
                "valueString": "40270555000"},
            {   "name": "oktmo",
                "valueString": "40320000"},
            {   "name": "kladr_code",
                "valueString": "78000000016000700"},
            {   "name": "createdate"},
            {   "name": "updatedate",
                "valueString": "2015-03-18"},
            {   "name": "aolevel",
                "valueString": "8"},
            {   "name": "livestatus",
                "valueString": "true"},
            {   "name": "unique_registry_number",
                "valueString": "403200000000000000711"},
            {   "name": "normdoc"},
            {   "name": "cadnum"},
            {   "name": "house"}]}}]}
Наверх