Обзор

Сервис поиска адресов в Федеральной информационной адресной системе http://fias.nalog.ru/ version: "1.0.0"

Схема URI

Узел : api.rnis.mosreg.ru

Пути

Получение записи по идентификатору

GET /com.rnis.fias.action.get

Параметры

Тип Имя Схема

Body

body
обязательно

body

body

Имя Схема

headers
обязательно

RequestHeaders

payload
обязательно

FiasGetPayload

Ответы

HTTP код Описание Схема

200

Успешный запрос

Ответ 200

default

Возникновение ошибки

ErrorResponse

Ответ 200

Имя Описание Схема

headers
обязательно

ResponseHeaders

payload
обязательно

Fias

success
обязательно

true

boolean

Теги

  • Action

  • Fias

Поиск по ФИАС

GET /com.rnis.fias.action.search

Параметры

Тип Имя Схема

Body

body
обязательно

body

body

Имя Схема

headers
обязательно

RequestHeaders

payload
обязательно

FiasSearchPayload

Ответы

HTTP код Описание Схема

200

Успешный запрос

Ответ 200

default

Возникновение ошибки

ErrorResponse

Ответ 200

Имя Описание Схема

headers
обязательно

ResponseHeaders

payload
обязательно

FiasResponsePayload

success
обязательно

true

boolean

Теги

  • Action

  • Fias

Определения

ColumnSearch

Имя Описание Схема

column
обязательно

Ключ столбца

string

value
обязательно

Значение для поиска

string

EmptyPayload

Тип : object

Error

Имя Описание Схема

code
обязательно

Код ошибки

string

data
необязательно

Дополнительные данные ошибки

< string > array

text
обязательно

Текст ошибки

string

ErrorResponse

Имя Описание Схема

errors
обязательно

< Error > array

success
обязательно

false

boolean

Fias

Имя Описание Схема

aoguid
обязательно

Идентификатор

string

aolevel
обязательно

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

string

name
обязательно

Название

string

okato
обязательно

ОКАТО

string

oktmo
обязательно

ОКТМО

string

parentguid
обязательно

Идентификатор родительского объекта

string

postalcode
обязательно

Почтовый индекс

string

FiasGetPayload

Имя Описание Схема

aoguid
обязательно

Идентификатор

string

houseguid
обязательно

Идентификатор дома

string

FiasResponsePayload

Имя Схема

items
обязательно

< Fias > array

FiasSearchPayload

Имя Описание Схема

level
обязательно

Уровень поиска

enum (area, locality, street, house)

parentguid
обязательно

Идентификатор родительского объекта

string

scan
обязательно

Строка поиска

string

Order

Имя Описание Схема

column
обязательно

Ключ столбца

string

direction
обязательно

Направление сортировки

enum (asc, desc)

Pagination

Имя Описание Схема

currentPage
обязательно

Текущая страница

integer

perPage
обязательно

Документов на страницу

integer

total
обязательно

Кол-во документов

integer

totalPages
обязательно

Кол-во страниц

integer

PaginationRequest

Имя Описание Схема

limit
обязательно

Количество записей на страницу

integer

page
обязательно

Запрашиваемая страница

integer

RequestHeaders

Имя Описание Схема

ip
необязательно

IP-адрес пользователя

string

meta
необязательно

RequestMeta

requester
обязательно

Наименование сервиса, инициировавшего запрос

string

timestamp
обязательно

Timestamp создания запроса

integer

token
необязательно

JWT-токен

string

version
обязательно

Версия API

string

RequestMeta

Имя Описание Схема

column_search
необязательно

< ColumnSearch > array

filters
необязательно

< string > array

order
необязательно

Order

pagination
необязательно

PaginationRequest

search
необязательно

Глобальный поиск по сущностям

string

ResponseHeaders

Имя Схема

meta
необязательно

ResponseMeta

ResponseMeta

Имя Схема

orders
необязательно

< Order > array

pagination
необязательно

Pagination