IkarService

Общие сведения

АИС «ИКАР» используется в качестве хранилища адресных справочников в структуре автоматизированных информационных систем платформы «Ветис». Адресация российских адресных объектов основывается на Федеральной информационной адресной системе.

На данный момент адресные объекты используются в основном в объектах, описывающих хозяйствующие субъекты и предприятия.

Список операций

1. GetAllCountryList - получение списка всех стран
2. GetCountryByGuid - получение информации о стране по её глобальному идентификатору
3. GetCountryByUuid - получение данных о стране по её идентификатору (одна из версий записи)
4. GetCountryChangesList - получение изменений в списке стран за указанный период
5. GetRegionListByCountry - получение списка регионов по идентификатору страны
6. GetRegionByUUID - получение версии записи региона по идентификатору
7. GetRegionByGUID - получение регина по глобальному идентификатору
8. GetRegionChangesList - получение списка изменений в записях регионов за период времени
9. GetDistrictListByRegion - получение списка районов определённого региона
10. GetDistrictByGuid - получение района по его глобальному идентификатору
11. GetDistrictChangesList - получение списка изменений районов
12. GetLocalityListByDistrict - получение списка населённых пунктов по идентификатору района
13. GetLocalityListByLocality - получение списка населённых пунктов по идентификатору населённого пункта
14. GetLocalityListByRegion - получение списка населённых пунктов по глобальному идентификатору региона
15. FindLocalityListByName - получение списка населённых пунктов по имени или его части
16. FindStreetListByName - получение списка улиц по названию или его части и идентификатору населённого пункта
17. 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>72a84b51-5c5e-11e1-b9b7-001966f192f1</bs:uuid>
    <bs:guid>74a3cbb1-56fa-94f3-ab3f-e8db4940d96b</bs:guid>
    <ikar:name>Российская Федерация</ikar:name>
  </ikar:country>
  <ikar:region />
  <ikar:district />
  <ikar:locality>
    <bs:guid>c2deb16a-0330-4f05-821f-1d09c93331e6</bs:guid>
    <ikar:name>Санкт-Петербург</ikar:name>
  </ikar:locality>
  <ikar:subLocality />
  <ikar:street>
    <bs:guid>0a846740-6cb0-475e-bc2b-27e67d83f9af</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>72a84b51-5c5e-11e1-b9b7-001966f192f1</bs:uuid>
    <bs:guid>74a3cbb1-56fa-94f3-ab3f-e8db4940d96b</bs:guid>
    <ikar:name>Российская Федерация</ikar:name>
  </ikar:country>
  <ikar:region>
    <bs:uuid>eab9fe2f-bb3e-4497-99fd-458961f92ec9</bs:uuid>
    <bs:guid>393aeccb-89ef-4a7e-ae42-08d5cebc2e30</bs:guid>
    <ikar:name>Кемеровская область</ikar:name>
  </ikar:region>
  <ikar:district />
  <ikar:locality>
    <bs:guid>94bb19a3-c1fa-410b-8651-ac1bf7c050cd</bs:guid>
    <ikar:name>Кемерово</ikar:name>
  </ikar:locality>
  <ikar:subLocality />
  <ikar:street>
    <bs:guid>8eba8248-f6d6-4a47-87fa-52093e9fe544</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>72a84b51-5c5e-11e1-b9b7-001966f192f1</bs:uuid>
    <bs:guid>74a3cbb1-56fa-94f3-ab3f-e8db4940d96b</bs:guid>
    <ikar:name>Российская Федерация</ikar:name>
  </ikar:country>
  <ikar:region>
    <bs:uuid>18489346-08c0-41f4-9a46-b9d1f5a819d9</bs:uuid>
    <bs:guid>b8837188-39ee-4ff9-bc91-fcc9ed451bb3</bs:guid>
    <ikar:name>Владимирская область</ikar:name>
  </ikar:region>
  <ikar:district>
    <bs:guid>5bcb047e-0bf0-403d-84a9-1aaf5cbf4f87</bs:guid>
    <ikar:name>Меленковский район</ikar:name>
  </ikar:district>
  <ikar:locality>
    <bs:guid>710f2d29-5c22-4d4d-be27-04713381c676</bs:guid>
    <ikar:name>Меленки</ikar:name>
  </ikar:locality>
  <ikar:subLocality />
  <ikar:street>
    <bs:guid>02fae1ce-5cfe-4e85-a572-6ac432a7e858</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>72a84b51-5c5e-11e1-b9b7-001966f192f1</bs:uuid>
    <bs:guid>74a3cbb1-56fa-94f3-ab3f-e8db4940d96b</bs:guid>
    <ikar:name>Российская Федерация</ikar:name>
  </ikar:country>
  <ikar:region />
  <ikar:district />
  <ikar:locality>
    <bs:guid>c2deb16a-0330-4f05-821f-1d09c93331e6</bs:guid>
    <ikar:name>Санкт-Петербург</ikar:name>
  </ikar:locality>
  <ikar:subLocality>
    <bs:guid>110d6ad9-0b64-47cf-a2ee-7e935228799c</bs:guid>
    <ikar:name>г.Пушкин</ikar:name>
  </ikar:subLocality>
  <ikar:street>
    <bs:guid>8fc4b152-8d92-4ddd-a439-027bdaada93d</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>