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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
м (Nikeshina-ad-171025 переименовал страницу GetBusinessEntityList v2.0 в GetBusinessEntityList v2)
 
(нет различий)

Текущая версия на 12:01, 1 июня 2023

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

Операция GetBusinessEntityList предназначена для получения списка хозяйствующих субъектов из реестра Россельхознадзора. В список попадают только актуальные записи (active = true). Поддерживается возможность постраничного вывода и фильтрации по шаблону. Выполнение операции заканчивается либо возвратом списка хозяйствующих субъектов, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса.

Входные данные

  • параметры выводимого списка;
  • поля, по которым осуществляется фильтрация хозяйствующих субъектов.

Выходные данные

  • список хозяйствующих субъектов.

Использование фильтрации в запросе

  • В спецификации перечислены поля, по которым может быть осуществлена фильтрация хозяйствующих субъектов.
  • ИНН и ОГРН не могут быть указаны вместе. Поиск может быть произведен только по одному из этих полей. Сочетания остальных полей могут быть любыми.
  • Поиск может быть осуществлен по любому из указанных элементов адреса как отдельно, так и в совокупности.

Спецификация запроса

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getBusinessEntityListRequest>
002 ···<bs:listOptions> bs:ListOptions [0..1] Параметры запрашиваемого списка.
003 ······<bs:count>10</bs:count> xs:nonNegativeInteger [0..1]

Максимальное запрашиваемое количество объектов в списке.

  • По умолчанию значение 100;
  • Максимально возможное значение 1000.
004 ······<bs:offset>2</bs:offset> xs:nonNegativeInteger [0..1]

Номер элемента, по которому осуществляется смещение первого элемента списка.

  • По умолчанию значение 0.
005 ···</bs:listOptions>
006 ···<dt:businessEntity> dt:BusinessEntity [0..1] Данные о хозяйствующем субъекте.
007 ······<bs:uuid>UUID</bs:uuid> bs:UUID [0..1] Идентификатор версии хозяйствующего субъекта.
008 ······<bs:guid>GUID</bs:guid> bs:UUID [0..1] Глобальный идентификатор хозяйствующего субъекта.
009 ······<dt:name>Наименование ХС</dt:name> bs:String255 [0..1]

Наименование хозяйствующего субъекта без указания организационно-правовой формы.

  • Указывается только для юридических лиц.
  • Для физических лиц и для индивидуальных предпринимателей поле не указывается.
010 ······<dt:fullName>Полное наименование ХС</dt:fullName> bs:String255 [0..1]

Полное наименование хозяйствующего субъекта.

  • с указанием ОПФ так, как оно значится в ЕГРЮЛ/ЕГРИП.
011 ······<dt:fio>Иванов Иван Иванович</dt:fio> bs:String255 [0..1]

ФИО физического лица или индивидуального предпринимателя.

  • Для юридических лиц поле не указывается.
012 ······<dt:inn>3312200096</dt:inn> bs:String255 [0..1] ИНН хозяйствующего субъекта.
013 ······<dt:kpp>163501001</dt:kpp> bs:String255 [0..1] Код причины постановки на учет (КПП).
014 ······<dt:ogrn>4085022240002</dt:ogrn> bs:String255 [0..1]

ОГРН или ОГРНИП.

  • Для ИП ОГРНИП может быть не указано.
015 ······<dt:juridicalAddress> dt:Address [1..1]

Юридический адрес.

  • адрес, по которому зарегистрирован хозяйствующий субъект.
016 ·········<dt:country> dt:Country [1..1] Страна.
017 ············<bs:guid>GUID</bs:guid> bs:UUID [1..1]

Глобальный идентификатор страны.

  • в соответствии со справочником РСХН.
018 ·········</dt:country>
019 ·········<dt:region> dt:Region [1..1] Регион (республика, область, край, автономная область).
020 ············<bs:guid>GUID</bs:guid> bs:UUID [1..1]

Глобальный идентификатор региона страны.

  • в соответствии со справочником РСХН.
021 ·········</dt:region>
022 ·········<dt:district> dt:Locality [0..1] Район региона.
023 ············<bs:guid>GUID</bs:guid> bs:UUID [1..1]

Глобальный идентификатор района региона.

  • в соответствии со справочником РСХН.
024 ·········</dt:district>
025 ·········<dt:locality> dt:Locality [0..1] Населённый пункт.
026 ············<bs:guid>GUID</bs:guid> bs:UUID [1..1]

Глобальный идентификатор города региона (города регионального подчинения) страны.

  • в соответствии со справочником РСХН.
027 ·········</dt:locality>
028 ·········<dt:subLocality> dt:Locality [0..1] Населённый пункт, подчиненный другогому населенному пункту (locality).
029 ············<bs:guid>GUID</bs:guid> bs:UUID [1..1]

Глобальный идентификатор населенного пункта.

  • в соответствии со справочником РСХН.
030 ·········</dt:subLocality>
031 ·········<dt:street> dt:Street [0..1] Улица.
032 ············<bs:guid>GUID</bs:guid> bs:UUID [1..1]

Глобальный идентификатор улицы города.

  • в соответствии со справочником РСХН.
033 ·········</dt:street>
034 ·········<dt:house>0</dt:house> bs:String255 [0..1] Номер дома.
035 ·········<dt:building>0</dt:building> bs:String255 [0..1] Номер строения.
036 ·········<dt:room>0</dt:room> bs:String255 [0..1] Номер квартиры / офиса.
037 ·········<dt:postIndex>000000</dt:postIndex> bs:String255 [0..1] Почтовый индекс.
038 ······</dt:juridicalAddress>
039 ···</dt:businessEntity>
040 </ws:getBusinessEntityListRequest>

Спецификация ответа

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getBusinessEntityChangesListResponse>
002 ···<dt:businessEntityList total="2" offset="0" count="2"> dt:BusinessEntityList [1..1]

Список хозяйствующих субъектов.

  • total - всего записей;
  • offset - смещение относительно первого элемента;
  • count - количество выводимых записей.
003 ······<dt:businessEntity> dt:BusinessEntity [1..1] Данные о хозяйствующем субъекте.
004 ·········<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Идентификатор версии хозяйствующего субъекта.
005 ·········<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор хозяйствующего субъекта.
006 ·········<bs:active>true</bs:active> xs:boolean [1..1]

Описывает, является ли запись активной.

  • true - запись активна;
  • false - запись не активна.
007 ·········<bs:last>true</bs:last> xs:boolean [1..1]

Описывает, является ли версия записи последней.

  • true - да;
  • false - нет.
008 ·········<bs:status>230</bs:status> bs:VersionStatus [1..1] Статус версии хозяйствующего субъекта.
009 ·········<bs:createDate>2017-07-07T12:00:00</bs:createDate> xs:DateTime [1..1] Дата создания хозяйствующего субъекта.
010 ·········<bs:updateDate>2017-07-07T12:00:00</bs:updateDate> xs:DateTime [1..1] Дата изменения хозяйствующего субъекта.
011 ·········<bs:previous>UUID</bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии записи реестра хозяйствующих субъектов.
012 ·········<dt:type>1</dt:type> dt:BusinessEntityType [1..1]

Тип создаваемого или редактируемого хозяйствующего субъекта.

  • 1 - юридическое лицо;
  • 2 - физическое лицо;
  • 3 - индивидуальный предприниматель.
013 ·········<dt:name>Наименование ХС</dt:name> bs:String255 [0..1]

Наименование хозяйствующего субъекта без указания организационно-правовой формы.

  • Возвращается только для юридических лиц.
  • Для физических лиц и для индивидуальных предпринимателей поле не возвращается.
014 ·········<dt:incorporationForm> dt:IncorporationForm [1..1] Организационно-правовая форма хозяйствующего субъекта.
015 ············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Идентификатор версии организационно-правовой формы.
016 ············<dt:name>Полное название ОПФ</dt:name> bs:String255 [1..1]

Название организационно-правовой формы предприятия.

  • согласно справочнику ОКОПФ.
017 ············<dt:code>12300</dt:code> bs:String255 [1..1]

Код организационно-правовой формы предприятия.

  • согласно справочнику ОКОПФ.
018 ············<dt:shortName>Краткое название ОПФ</dt:shortName> bs:String255 [0..1] Краткое название организационно-правовой формы предприятия.
019 ·········</dt:incorporationForm>
020 ·········<dt:fullName>Полное наименование ХС</dt:fullName> bs:String255 [0..1]

Полное наименование хозяйствующего субъекта.

  • с указанием ОПФ так, как оно значится в ЕГРЮЛ/ЕГРИП.
021 ·········<dt:fio>Иванов Иван Иванович</dt:fio> bs:String255 [0..1]

ФИО физического лица или индивидуального предпринимателя.

  • Для юридических лиц поле не возвращается.
022 ·········<dt:inn>3312200096</dt:inn> bs:String255 [0..1] ИНН хозяйствующего субъекта.
023 ·········<dt:kpp>163501001</dt:kpp> bs:String255 [0..1] Код причины постановки на учет (КПП).
024 ·········<dt:ogrn>4085022240002</dt:ogrn> bs:String255 [0..1]

ОГРН или ОГРНИП.

  • Для ИП ОГРНИП может быть не указано.
025 ·········<dt:juridicalAddress> dt:Address [1..1]

Юридический адрес.

  • адрес, по которому зарегистрирован хозяйствующий субъект.
026 ············<dt:country> dt:Country [1..1] Страна.
027 ···············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1]

Уникальный идентификатор страны.

  • в соответствии со справочником РСХН.
028 ···············<bs:guid>GUID</bs:guid> bs:UUID [1..1]

Глобальный идентификатор страны.

  • в соответствии со справочником РСХН.
029 ···············<dt:name>Страна</dt:name> bs:String255 [1..1]

Наименование страны в соответствии.

  • в соответствии со справочником РСХН.
030 ············</dt:country>
031 ············<dt:region> dt:Region [1..1] Регион.
032 ···············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1]

Уникальный идентификатор региона страны.

  • в соответствии со справочником РСХН.
033 ···············<bs:guid>GUID</bs:guid> bs:UUID [1..1]

Глобальный идентификатор региона страны.

  • в соответствии со справочником РСХН.
034 ···············<dt:name>Регион</dt:name> bs:String255 [1..1]

Наименование региона страны.

  • в соответствии со справочником РСХН.
035 ············</dt:region>
036 ············<dt:district> dt:Locality [0..1] Район региона.
037 ···············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1]

Уникальный идентификатор района региона.

  • в соответствии со справочником РСХН.
038 ···············<bs:guid>GUID</bs:guid> bs:UUID [1..1]

Глобальный идентификатор района региона.

  • в соответствии со справочником РСХН.
039 ···············<dt:name>Район</dt:name> bs:String255 [1..1]

Наименование района региона.

  • в соответствии со справочником РСХН.
040 ············</dt:district>
041 ············<dt:locality> dt:Locality [0..1] Населённый пункт.
042 ···············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1]

Уникальный идентификатор города региона (города регионального подчинения) страны.

  • в соответствии со справочником РСХН.
043 ···············<bs:guid>GUID</bs:guid> bs:UUID [1..1]

Глобальный идентификатор города региона (города регионального подчинения) страны.

  • в соответствии со справочником РСХН.
044 ···············<dt:name>Город</dt:name> bs:String255 [1..1]

Наименование города региона (города регионального подчинения) страны.

  • в соответствии со справочником РСХН.
045 ············</dt:locality>
046 ············<dt:subLocality> dt:Locality [0..1] Населённый пункт, подчиненный другогому населенному пункту (locality).
047 ···············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1]

Уникальный идентификатор населенного пункта.

  • в соответствии со справочником РСХН.
048 ···············<bs:guid>GUID</bs:guid> bs:UUID [1..1]

Глобальный идентификатор населенного пункта.

  • в соответствии со справочником РСХН.
049 ···············<dt:name>Населенный пункт</dt:name> bs:String255 [1..1]

Наименование населенного пункта.

  • в соответствии со справочником РСХН.
050 ············</dt:subLocality>
051 ············<dt:street> dt:Street [0..1] Улица.
052 ···············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1]

Уникальный идентификатор улицы города.

  • в соответствии со справочником РСХН.
053 ···············<bs:guid>GUID</bs:guid> bs:UUID [1..1]

Глобальный идентификатор улицы города.

  • в соответствии со справочником РСХН.
054 ···············<dt:name>Улица</dt:name> bs:String255 [1..1]

Наименование улицы города.

  • в соответствии со справочником РСХН.
055 ············</dt:street>
056 ············<dt:house>0</dt:house> bs:String255 [0..1] Номер дома.
057 ············<dt:building>0</dt:building> bs:String255 [0..1] Номер строения.
058 ············<dt:room>0</dt:room> bs:String255 [0..1] Номер квартиры / офиса.
059 ············<dt:postIndex>000000</dt:postIndex> bs:String255 [0..1] Почтовый индекс.
060 ············<dt:postBox>х/х 00</dt:postBox> bs:String255 [0..1] Абонентский ящик
061 ············<dt:additionalInfo>Доп. инфо</dt:additionalInfo> bs:String255 [0..1] Дополнительная информация.
062 ············<dt:addressView>Адрес</dt:addressView> bs:String255 [0..1] Строковое представление адреса.
063 ·········</dt:juridicalAddress>
064 ······</dt:businessEntity>
065 ···</dt:businessEntityList>
066 </ws:getBusinessEntityChangesListResponse>

Описание ошибок

Ошибка Описание
InternalServiceFault Внутренняя ошибка сервиса.
IncorrectRequestFault Некорректный запрос. Возникает, если запрос не соответствует требованиям указанным в xsd.
OffsetOutOfRangeFault Заданный в запросе отступ больше числа записей в результате запроса.

Примеры запросов

Поиск хозяйствующего субъекта по ИНН

Запрос хозяйствующего субъекта по ИНН 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
		  xmlns:ws="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2" 
		  xmlns:bs="http://api.vetrf.ru/schema/cdm/base" 
		  xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:getBusinessEntityListRequest>
         <dt:businessEntity>
            <dt:inn>3325009322</dt:inn>
         </dt:businessEntity>
      </ws:getBusinessEntityListRequest>
   </soapenv:Body>
</soapenv:Envelope>


Ответ на запрос.


Поиск хозяйствующих субъектов, в названии которых содержится слово "Мясокомбинат"

Поиск хозяйствующего субъекта, в названии которого содержится слово "Мясокомбинат" 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
		  xmlns:ws="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2" 
		  xmlns:bs="http://api.vetrf.ru/schema/cdm/base" 
		  xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:getBusinessEntityListRequest>
         <dt:businessEntity>
            <dt:name>Мясокомбинат</dt:name>
         </dt:businessEntity>
      </ws:getBusinessEntityListRequest>
   </soapenv:Body>
</soapenv:Envelope>


Ответ на запрос.


Поиск физических лиц и индивидуальных предпринимателей с фамилией "Иванов"

Поиск физических лиц и индивидуальных предпринимателей с фамилией "Иванов". Вывод первых трёх записей без смещения. 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
		  xmlns:ws="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2" 
		  xmlns:bs="http://api.vetrf.ru/schema/cdm/base" 
		  xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:getBusinessEntityListRequest>
         <bs:listOptions>
             <bs:count>3</bs:count>
             <bs:offset>0</bs:offset>
         </bs:listOptions>
         <dt:businessEntity>
             <dt:fio>Иванов</dt:fio>
         </dt:businessEntity>
      </ws:getBusinessEntityListRequest>
   </soapenv:Body>
</soapenv:Envelope>


Ответ на запрос.


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

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
		  xmlns:ws="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2" 
		  xmlns:bs="http://api.vetrf.ru/schema/cdm/base" 
		  xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:getBusinessEntityListRequest>
         <bs:listOptions>
            <bs:count>3</bs:count>
            <bs:offset>0</bs:offset>
         </bs:listOptions>
         <dt:businessEntity>
            <dt:juridicalAddress>
              <dt:region>
                 <bs:guid>b8837188-39ee-4ff9-bc91-fcc9ed451bb3</bs:guid>
              </dt:region>
            </dt:juridicalAddress>
         </dt:businessEntity>
      </ws:getBusinessEntityListRequest>
   </soapenv:Body>
</soapenv:Envelope>


Ответ на запрос.


Источник — http://help.vetrf.ru/index.php?title=GetBusinessEntityList_v2&oldid=37142