IkarService
Общие сведения
АИС «ИКАР» используется в качестве хранилища адресных справочников в структуре автоматизированных информационных систем платформы «Ветис». Адресация российских адресных объектов основывается на Федеральной информационной адресной системе.
На данный момент адресные объекты используются в основном в объектах, описывающих хозяйствующие субъекты и предприятия.
Список операций
- GetAllCountryList - получение списка всех стран
- GetCountryByGuid - получение информации о стране по её глобальному идентификатору
- GetCountryByUuid - получение данных о стране по её идентификатору (одна из версий записи)
- GetCountryChangesList - получение изменений в списке стран за указанный период
- GetRegionListByCountry - получение списка регионов по идентификатору страны
- GetRegionByUUID - получение версии записи региона по идентификатору
- GetRegionByGUID - получение регина по глобальному идентификатору
- GetRegionChangesList - получение списка изменений в записях регионов за период времени
- GetDistrictListByRegion - получение списка районов определённого региона
- GetDistrictByGuid - получение района по его глобальному идентификатору
- GetDistrictChangesList - получение списка изменений районов
- GetLocalityListByDistrict - получение списка населённых пунктов по идентификатору района
- GetLocalityListByLocality - получение списка населённых пунктов по идентификатору населённого пункта
- GetLocalityListByRegion - получение списка населённых пунктов по глобальному идентификатору региона
- FindLocalityListByName - получение списка населённых пунктов по имени или его части
- FindStreetListByName - получение списка улиц по названию или его части и идентификатору населённого пункта
- GetStreetListByLocality - получение списка улиц по идентификаору населённого пункта
Описание адресного объекта
Структура адресного объекта
Общая структура адресного объекта имеет вид, приведённый ниже. Основной объект указан в виде типа Address, поскольку в разных запросах этот объект может иметь разные наименования.
Структура адресного объекта
<ent:Address>
<ikar:country>
<bs:uuid>uuid</bs:uuid>
<bs:guid>guid</bs:guid>
<ikar:name>name</ikar:name>
</ikar:country>
<ikar:region>
<bs:uuid>uuid</bs:uuid>
<bs:guid>guid</bs:guid>
<ikar:name>name</ikar:name>
</ikar:region>
<ikar:district>
<bs:uuid>uuid</bs:uuid>
<bs:guid>guid</bs:guid>
<ikar:name>name</ikar:name>
</ikar:district>
<ikar:locality>
<bs:guid>guid</bs:guid>
<ikar:name>name</ikar:name>
</ikar:locality>
<ikar:subLocality>
<bs:guid>guid</bs:guid>
<ikar:name>name</ikar:name>
</ikar:sublocality>
<ikar:street>
<bs:guid>guid</bs:guid>
<ikar:name>name</ikar:name>
</ikar:street>
<ikar:house></ikar:house>
<ikar:building></ikar:building>
<ikar:room></ikar:room>
<ikar:postIndex></ikar:postIndex>
<ikar:postBox></ikar:postBox>
<ikar:addressView>текстовое представление адреса</ikar:addressView>
</ent:Address>Возможные варианты представления адресов
В зависимости от регистрации хозяйствующего субъекта и расположения площадки возможны различные представления адресов в запросах и ответах сервиса. На данный момент при создании объектов через веб-сервисы (шлюз Ветис.API) в адресах необходимо указывать первые три уровня в виде адресных объектов. Остальную адресную информацию рекомендуется также указать в виде объектов, но пока поддерживается и текстовое представление адреса.
Для зарубежных юридических лиц, в том числе для стран Таможенного союза, предусмотрены только два уровня указания адреса: страна (Country) и регион (Region). Остальную информацию можно указать в поле addressView, если требуется.
Ниже рассмотрены возможные случаи представления адресов.
Адрес в городе федерального значения (Москва, Санкт-Петербург, Севастополь).
Структура адресного объекта для города федерального значения.
<ent:Address>
<ikar:country>
<bs:uuid>uuid</bs:uuid>
<bs:guid>guid</bs:guid>
<ikar:name>Российская Федерация</ikar:name>
</ikar:country>
<ikar:region />
<ikar:district />
<ikar:locality>
<bs:guid>guid</bs:guid>
<ikar:name>Санкт-Петербург</ikar:name>
</ikar:locality>
<ikar:subLocality />
<ikar:street>
<bs:guid>guid</bs:guid>
<ikar:name>Малая Морская</ikar:name>
</ikar:street>
<ikar:house>x</ikar:house>
<ikar:building></ikar:building>
<ikar:room>y</ikar:room>
<ikar:postIndex></ikar:postIndex>
<ikar:postBox></ikar:postBox>
<ikar:addressView>Российская Федерация, Санкт-Петербург, ул.Малая Морская, д.x, y</ikar:addressView>
</ent:Address>Адрес в городе регионального подчинения (например, в Кемерово)
Структура адресного объекта для города регионального подчинения.
<ent:Address>
<ikar:country>
<bs:uuid>uuid</bs:uuid>
<bs:guid>guid</bs:guid>
<ikar:name>Российская Федерация</ikar:name>
</ikar:country>
<ikar:region>
<bs:uuid>uuid</bs:uuid>
<bs:guid>guid</bs:guid>
<ikar:name>Кемеровская область</ikar:name>
</ikar:region>
<ikar:district />
<ikar:locality>
<bs:guid>guid</bs:guid>
<ikar:name>Кемерово</ikar:name>
</ikar:locality>
<ikar:subLocality />
<ikar:street>
<bs:guid></bs:guid>
<ikar:name>name</ikar:name>
</ikar:street>
<ikar:house>x</ikar:house>
<ikar:building></ikar:building>
<ikar:room>y</ikar:room>
<ikar:postIndex></ikar:postIndex>
<ikar:postBox></ikar:postBox>
<ikar:addressView>Российская Федерация, Кемеровская область, Кемерово, ул.name, д.x, y</ikar:addressView>
</ent:Address>Адрес в городе районного подчинения (например, в Меленках)
Структура адресного объекта для города районного подчинения.
<ent:Address>
<ikar:country>
<bs:uuid>uuid</bs:uuid>
<bs:guid>guid</bs:guid>
<ikar:name>Российская Федерация</ikar:name>
</ikar:country>
<ikar:region>
<bs:uuid>uuid</bs:uuid>
<bs:guid>guid</bs:guid>
<ikar:name>Владимирская область</ikar:name>
</ikar:region>
<ikar:district>
<bs:guid>guid</bs:guid>
<ikar:name>Меленковский район</ikar:name>
</ikar:district>
<ikar:locality>
<bs:guid>guid</bs:guid>
<ikar:name>name</ikar:name>
</ikar:locality>
<ikar:subLocality />
<ikar:street>
<bs:guid></bs:guid>
<ikar:name>name</ikar:name>
</ikar:street>
<ikar:house>x</ikar:house>
<ikar:building></ikar:building>
<ikar:room>y</ikar:room>
<ikar:postIndex></ikar:postIndex>
<ikar:postBox></ikar:postBox>
<ikar:addressView>Российская Федерация, Владимирская область, Меленковский р-н, г.name, ул.name, д.x, y</ikar:addressView>
</ent:Address>Адрес в населённом пункте, подчиняющемся другому населённому пункту. Часто встречается у городов федерального значения. В данном случае рассмотрено на г.Пушкин, который подчиняется г.Санкт-Петербург. В данном случае г.Пушкин можно заполнить и в текстовой строке, но рекомендуется весь адрес представлять в виде объектов АИС Икар.
Структура адресного объекта для города регионального подчинения.
<ent:Address>
<ikar:country>
<bs:uuid>uuid</bs:uuid>
<bs:guid>guid</bs:guid>
<ikar:name>Российская Федерация</ikar:name>
</ikar:country>
<ikar:region />
<ikar:district />
<ikar:locality>
<bs:guid>guid</bs:guid>
<ikar:name>Санкт-Петербург</ikar:name>
</ikar:locality>
<ikar:subLocality>
<bs:guid></bs:guid>
<ikar:name>г.Пушкин</ikar:name>
</ikar:subLocality>
<ikar:street>
<bs:guid></bs:guid>
<ikar:name>name</ikar:name>
</ikar:street>
<ikar:house>x</ikar:house>
<ikar:building></ikar:building>
<ikar:room>y</ikar:room>
<ikar:postIndex></ikar:postIndex>
<ikar:postBox></ikar:postBox>
<ikar:addressView>Российская Федерация, г.Санкт-Петербург, г.Пушкин, ул.name, д.x, y</ikar:addressView>
</ent:Address>