GET api/address/FindAddress?searchString={searchString}&level={level}&count={count}&parentGuid={parentGuid}

Поиск объектов адреса.

Информация о запросе

URI параметры

НазваниеОписаниеТипДоп. информация
searchString

Подсткрока названия. Можно оставить пустой, чтобы получить все объекты.

string

Required

level

Уровень, на котором надо искать объекты. Можно написать null, чтобы искать без этого ограничения.

integer

Required

count

Максимальное число возращаемых объектов. Если указать null, будет использовано значение по умолчанию.

integer

Required

parentGuid

ФИАС ГУИД родительского объекта. Если указать null, искать будем тех, у кого родителей нет.

globally unique identifier

Required

Body параметры

Нет

Форматы запроса

text/json

Пример:
http://localhost:5450/api/address/FindAddress?searchString=&level=&count=5&parentGuid=6f2cbfd8-692a-4ee4-9b16-067210bde3fc

Формат ответа

Описание данных

Collection of SimpleAddressJsonModel
НазваниеОписаниеТипДоп. информация
fiasGuid

ФИАС ГУИД

globally unique identifier

Нет

formalName

Название

string

Нет

shortName

Сокращение

string

Нет

Error

string

Нет

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

text/json, application/json

Пример:
[
    {
        "fiasGuid": "a3a5b457-d5d4-48d1-9d60-9647c14a9411",
        "formalName": "Чишминский",
        "shortName": "р-н"
    }, {
        "fiasGuid": "58e4f3d4-a14b-4ab9-a1b9-b701f2c0cc53",
        "formalName": "Караидельский",
        "shortName": "р-н"
    }, {
        "fiasGuid": "20ea0299-9cb6-495a-899f-7f456a4a62a5",
        "formalName": "Федоровский",
        "shortName": "р-н"
    }, {
        "fiasGuid": "72a1f943-170b-4dde-bcaf-0b0cc04c7006",
        "formalName": "Татышлинский",
        "shortName": "р-н"
    }, {
        "fiasGuid": "93192537-d4cb-4d65-8201-8a1877bdb61d",
        "formalName": "Куюргазинский",
        "shortName": "р-н"
    }
]