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) в адресах необходимо указывать первые три уровня в виде адресных объектов. Остальную адресную информацию можно также указать в виде объектов, но также поддерживается и текстовое представление адреса. Ниже рассмотрены возможные случаи представления адресов.

1. Адрес в городе федерального значения (Москва, Санкт-Петербург, Севастополь).

Структура адресного объекта для города федерального значения.

<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></ikar:house>
  <ikar:building></ikar:building>
  <ikar:room></ikar:room>
  <ikar:postIndex></ikar:postIndex>
  <ikar:postBox></ikar:postBox>
  <ikar:addressView>Российская Федерация, Санкт-Петербург, ул.Малая Морская</ikar:addressView>
</ent:Address>

1. Адрес в городе регионального подчинения (например, в Кемерово)

Структура адресного объекта для города регионального подчинения.

<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></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>