IkarService: различия между версиями

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 22: Строка 22:
# [[FindStreetListByName]] - получение списка улиц по названию или его части и идентификатору населённого пункта
# [[FindStreetListByName]] - получение списка улиц по названию или его части и идентификатору населённого пункта
# [[GetStreetListByLocality]] - получение списка улиц по идентификаору населённого пункта
# [[GetStreetListByLocality]] - получение списка улиц по идентификаору населённого пункта
==Описание адресного объекта==
===Струткура адресного объекта===
На данный момент адресные объекты используются в основном в объектах, описывающих [[BusinessEntity|хозяйствующие субъекты]] и [[Enterprise|предприятия]].
Общая структура адресного объекта имеет вид, приведённый ниже. Осноной объект указан в виде типа [[Address]], поскольку в разных запросах этот объект может иметь разные наименования.
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Структура адресного объекта
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<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:uuid>uuid</bs:uuid>
    <bs:guid>guid</bs:guid>
    <ikar:name>name</ikar:name>
  </ikar:locality>
  <ikar:subLocality>
    <bs:uuid>uuid</bs:uuid>
    <bs:guid>guid</bs:guid>
    <ikar:name>name</ikar:name>
  </ikar:sublocality>
  <ikar:street>
    <bs:uuid>uuid</bs:uuid>
    <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>
</syntaxhighlight>
</div>
</div>

Версия от 12:19, 1 ноября 2016

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

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

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

  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:uuid>uuid</bs:uuid>
    <bs:guid>guid</bs:guid>
    <ikar:name>name</ikar:name>
  </ikar:locality>
  <ikar:subLocality>
    <bs:uuid>uuid</bs:uuid>
    <bs:guid>guid</bs:guid>
    <ikar:name>name</ikar:name>
  </ikar:sublocality>
  <ikar:street>
    <bs:uuid>uuid</bs:uuid>
    <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>