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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
(Новая страница: «==Общие сведения== Операция '''GetBusinessEntityList''' предназначена для получения списка хозяйству…»)
 
Строка 41: Строка 41:
* список хозяйствующих субъектов.
* список хозяйствующих субъектов.


==Данные запроса==
==Спецификация запроса==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание
! Пример
|-
|1
|style="font-weight: bold; font-family: Courier;" |<ws:getBusinessEntityListRequest>
|
|
|
|style="font-family: Courier;" |
|-
|2
|style="font-weight: bold; font-family: Courier;" |···<bs:listOptions>
|[[ListOptions|bs:ListOptions]]
|[0..1]
|Параметры запрашиваемого списка.
|style="font-family: Courier;" |
|-
|3
|style="font-weight: bold; font-family: Courier;" |······<bs:count>
|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
|[0..1]
|Максимальное запрашиваемое количество объектов в списке.
* По умолчанию значение 100;
* Максимально возможное значение 1000.
|style="font-family: Courier;" |<bs:count>10</bs:count>
|-
|4
|style="font-weight: bold; font-family: Courier;" |······<bs:offset>
|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
|[0..1]
|Номер элемента, по которому осуществляется смещение первого элемента списка.
* По умолчанию значение 0.
|style="font-family: Courier;" |<bs:offset>2</bs:offset>
|-
|5
|style="font-weight: bold; font-family: Courier;" |···</bs:listOptions>
|
|
|
|style="font-family: Courier;" |
|-
|6
|style="font-weight: bold; font-family: Courier;" |···&lt;dt:businessEntity>
|[[BusinessEntity_v2.0|dt:BusinessEntity]]
|[0..1]
|Данные о хозяйствующем субъекте.
|style="font-family: Courier;" |
|-
|7
|style="font-weight: bold; font-family: Courier;" |······<bs:uuid>
|[[UUID|bs:UUID]]
|[0..1]
|Идентификатор версии хозяйствующего субъекта.
|style="font-family: Courier;" |<bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
|-
|8
|style="font-weight: bold; font-family: Courier;" |······<bs:guid>
|[[UUID|bs:UUID]]
|[0..1]
|Глобальный идентификатор хозяйствующего субъекта.
|style="font-family: Courier;" |<bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid>
|-
|9
|style="font-weight: bold; font-family: Courier;" |······&lt;dt:name>
|[[String255|bs:String255]]
|[0..1]
|Наименование хозяйствующего субъекта без указания организационно-правовой формы.
* Возвращается только для юридических лиц.
* Для физических лиц и для индивидуальных предпринимателей поле не возвращается.
|style="font-family: Courier;" |&lt;dt:name>Гладиолус</dt:name>
|-
|10
|style="font-weight: bold; font-family: Courier;" |······&lt;dt:fullName>
|[[String255|bs:String255]]
|[0..1]
|Полное наименование хозяйствующего субъекта с указанием ОПФ так, как оно значится в ЕГРЮЛ/ЕГРИП.
|style="font-family: Courier;" |&lt;dt:fullName>Общество с ограниченной ответственностью "Гладиолус"</dt:fullName>
|-
|11
|style="font-weight: bold; font-family: Courier;" |······&lt;dt:fio>
|[[String255|bs:String255]]
|[0..1]
|ФИО физического лица или индивидуального предпринимателя.
* Для юридических лиц поле не возвращается.
|style="font-family: Courier;" |&lt;dt:fio>Иванов Сергей Петрович</dt:fio>
|-
|12
|style="font-weight: bold; font-family: Courier;" |······&lt;dt:inn>
|[[String255|bs:String255]]
|[0..1]
|ИНН хозяйствующего субъекта.
|style="font-family: Courier;" |&lt;dt:inn>3312200096</dt:inn>
|-
|13
|style="font-weight: bold; font-family: Courier;" |······&lt;dt:kpp>
|[[String255|bs:String255]]
|[0..1]
|Код причины постановки на учет (КПП).
|style="font-family: Courier;" |&lt;dt:kpp>163501001</dt:kpp>
|-
|14
|style="font-weight: bold; font-family: Courier;" |······&lt;dt:ogrn>
|[[String255|bs:String255]]
|[0..1]
|ОГРН или ОГРНИП.
* Для ИП ОГРНИП может быть не указано.
|style="font-family: Courier;" |&lt;dt:ogrn>4085022240002</dt:ogrn>
|-
|15
|style="font-weight: bold; font-family: Courier;" |······&lt;dt:juridicalAddress>
|[[Address_v2.0|dt:Address]]
|[1..1]
|Юридический адрес - адрес, по которому зарегистрирован хозяйствующий субъект.
|style="font-family: Courier;" |
|-
|16
|style="font-weight: bold; font-family: Courier;" |·········&lt;dt:country>
|[[Country_v2.0|dt:Country]]
|[1..1]
|Страна
|style="font-family: Courier;" |
|-
|17
|style="font-weight: bold; font-family: Courier;" |············<bs:guid>
|[[UUID|bs:UUID]]
|[1..1]
|Глобальный идентификатор страны в соответствии со справочником РСХН.
|style="font-family: Courier;" |<bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
|-
|18
|style="font-weight: bold; font-family: Courier;" |·········</dt:country>
|
|
|
|style="font-family: Courier;" |
|-
|19
|style="font-weight: bold; font-family: Courier;" |·········&lt;dt:region>
|[[Region_v2.0|dt:Region]]
|[1..1]
|Регион (республика, область, край, автономная область)
|style="font-family: Courier;" |
|-
|20
|style="font-weight: bold; font-family: Courier;" |············<bs:guid>
|[[UUID|bs:UUID]]
|[1..1]
|Глобальный идентификатор региона страны в соответствии со справочником РСХН.
|style="font-family: Courier;" |<bs:guid>cbdf8cb6-fb9a-4f36-36d3-04488f6d1b82</bs:guid>
|-
|21
|style="font-weight: bold; font-family: Courier;" |·········</dt:region>
|
|
|
|style="font-family: Courier;" |
|-
|22
|style="font-weight: bold; font-family: Courier;" |·········&lt;dt:district>
|[[Localilty_v2.0|dt:Localilty]]
|[0..1]
|Район региона
|style="font-family: Courier;" |
|-
|23
|style="font-weight: bold; font-family: Courier;" |············<bs:guid>
|[[UUID|bs:UUID]]
|[1..1]
|Глобальный идентификатор района региона в соответствии со справочником РСХН.
|style="font-family: Courier;" |<bs:guid>90d82878-431a-0cf1-0974-16d4fdff3bc8</bs:guid>
|-
|24
|style="font-weight: bold; font-family: Courier;" |·········</dt:district>
|
|
|
|style="font-family: Courier;" |
|-
|25
|style="font-weight: bold; font-family: Courier;" |·········&lt;dt:locality>
|[[Localilty_v2.0|dt:Localilty]]
|[0..1]
|Населённый пункт
|style="font-family: Courier;" |
|-
|26
|style="font-weight: bold; font-family: Courier;" |············<bs:guid>
|[[UUID|bs:UUID]]
|[1..1]
|Глобальный идентификатор города региона (города регионального подчинения) страны в соответствии со справочником РСХН.
|style="font-family: Courier;" |<bs:guid>a16545f3-8f9c-2778-099f-a5d302e58712</bs:guid>
|-
|27
|style="font-weight: bold; font-family: Courier;" |·········</dt:locality>
|
|
|
|style="font-family: Courier;" |
|-
|28
|style="font-weight: bold; font-family: Courier;" |·········&lt;dt:subLocality>
|[[Localilty_v2.0|dt:Localilty]]
|[0..1]
|Населённый пункт, подчиненный другогому населенному пункту (locality)
|style="font-family: Courier;" |
|-
|29
|style="font-weight: bold; font-family: Courier;" |············<bs:guid>
|[[UUID|bs:UUID]]
|[1..1]
|Глобальный идентификатор населенного пункта в соответствии со справочником РСХН.
|style="font-family: Courier;" |<bs:guid>9f315346-b470-3a1c-56d0-ae1afe9579df</bs:guid>
|-
|30
|style="font-weight: bold; font-family: Courier;" |·········</dt:subLocality>
|
|
|
|style="font-family: Courier;" |
|-
|31
|style="font-weight: bold; font-family: Courier;" |·········&lt;dt:street>
|[[Street_v2.0|dt:Street]]
|[0..1]
|Улица
|style="font-family: Courier;" |
|-
|32
|style="font-weight: bold; font-family: Courier;" |············<bs:guid>
|[[UUID|bs:UUID]]
|[1..1]
|Глобальный идентификатор улицы города в соответствии со справочником РСХН.
|style="font-family: Courier;" |<bs:guid>b014d26b-5391-c852-caa4-60fc9bb0a7d4</bs:guid>
|-
|33
|style="font-weight: bold; font-family: Courier;" |·········</dt:street>
|
|
|
|style="font-family: Courier;" |
|-
|34
|style="font-weight: bold; font-family: Courier;" |·········&lt;dt:house>
|[[String255|bs:String255]]
|[0..1]
|Номер дома.
|style="font-family: Courier;" |&lt;dt:house>6</dt:house>
|-
|35
|style="font-weight: bold; font-family: Courier;" |·········&lt;dt:building>
|[[String255|bs:String255]]
|[0..1]
|Номер строения.
|style="font-family: Courier;" |&lt;dt:building>1</dt:building>
|-
|36
|style="font-weight: bold; font-family: Courier;" |·········&lt;dt:room>
|[[String255|bs:String255]]
|[0..1]
|Номер квартиры / офиса.
|style="font-family: Courier;" |&lt;dt:room>1</dt:room>
|-
|37
|style="font-weight: bold; font-family: Courier;" |·········&lt;dt:postIndex>
|[[String255|bs:String255]]
|[0..1]
|Почтовый индекс.
|style="font-family: Courier;" |&lt;dt:postIndex>600037</dt:postIndex>
|-
|38
|style="font-weight: bold; font-family: Courier;" |······</dt:juridicalAddress>
|
|
|
|style="font-family: Courier;" |
|-
|39
|style="font-weight: bold; font-family: Courier;" |···</dt:businessEntity>
|
|
|
|style="font-family: Courier;" |
|-
|40
|style="font-weight: bold; font-family: Courier;" |</ws:getBusinessEntityListRequest>
|
|
|
|style="font-family: Courier;" |
|-
|}


==Данные ответа==
==Данные ответа==

Версия 05:12, 27 октября 2017

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

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

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

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

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

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

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

# Название XML-элемента Тип Обязат. Описание Пример
1 <ws:getBusinessEntityListRequest>
2 ···<bs:listOptions> bs:ListOptions [0..1] Параметры запрашиваемого списка.
3 ······<bs:count> xs:nonNegativeInteger [0..1] Максимальное запрашиваемое количество объектов в списке.
  • По умолчанию значение 100;
  • Максимально возможное значение 1000.
 <bs:count>10</bs:count>
4 ······<bs:offset> xs:nonNegativeInteger [0..1] Номер элемента, по которому осуществляется смещение первого элемента списка.
  • По умолчанию значение 0.
 <bs:offset>2</bs:offset>
5 ···</bs:listOptions>
6 ···<dt:businessEntity> dt:BusinessEntity [0..1] Данные о хозяйствующем субъекте.
7 ······<bs:uuid> bs:UUID [0..1] Идентификатор версии хозяйствующего субъекта. <bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
8 ······<bs:guid> bs:UUID [0..1] Глобальный идентификатор хозяйствующего субъекта. <bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid>
9 ······<dt:name> bs:String255 [0..1] Наименование хозяйствующего субъекта без указания организационно-правовой формы.
  • Возвращается только для юридических лиц.
  • Для физических лиц и для индивидуальных предпринимателей поле не возвращается.
 <dt:name>Гладиолус</dt:name>
10 ······<dt:fullName> bs:String255 [0..1] Полное наименование хозяйствующего субъекта с указанием ОПФ так, как оно значится в ЕГРЮЛ/ЕГРИП. <dt:fullName>Общество с ограниченной ответственностью "Гладиолус"</dt:fullName>
11 ······<dt:fio> bs:String255 [0..1] ФИО физического лица или индивидуального предпринимателя.
  • Для юридических лиц поле не возвращается.
 <dt:fio>Иванов Сергей Петрович</dt:fio>
12 ······<dt:inn> bs:String255 [0..1] ИНН хозяйствующего субъекта. <dt:inn>3312200096</dt:inn>
13 ······<dt:kpp> bs:String255 [0..1] Код причины постановки на учет (КПП). <dt:kpp>163501001</dt:kpp>
14 ······<dt:ogrn> bs:String255 [0..1] ОГРН или ОГРНИП.
  • Для ИП ОГРНИП может быть не указано.
 <dt:ogrn>4085022240002</dt:ogrn>
15 ······<dt:juridicalAddress> dt:Address [1..1] Юридический адрес - адрес, по которому зарегистрирован хозяйствующий субъект.
16 ·········<dt:country> dt:Country [1..1] Страна
17 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор страны в соответствии со справочником РСХН. <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
18 ·········</dt:country>
19 ·········<dt:region> dt:Region [1..1] Регион (республика, область, край, автономная область)
20 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор региона страны в соответствии со справочником РСХН. <bs:guid>cbdf8cb6-fb9a-4f36-36d3-04488f6d1b82</bs:guid>
21 ·········</dt:region>
22 ·········<dt:district> dt:Localilty [0..1] Район региона
23 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор района региона в соответствии со справочником РСХН. <bs:guid>90d82878-431a-0cf1-0974-16d4fdff3bc8</bs:guid>
24 ·········</dt:district>
25 ·········<dt:locality> dt:Localilty [0..1] Населённый пункт
26 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор города региона (города регионального подчинения) страны в соответствии со справочником РСХН. <bs:guid>a16545f3-8f9c-2778-099f-a5d302e58712</bs:guid>
27 ·········</dt:locality>
28 ·········<dt:subLocality> dt:Localilty [0..1] Населённый пункт, подчиненный другогому населенному пункту (locality)
29 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор населенного пункта в соответствии со справочником РСХН. <bs:guid>9f315346-b470-3a1c-56d0-ae1afe9579df</bs:guid>
30 ·········</dt:subLocality>
31 ·········<dt:street> dt:Street [0..1] Улица
32 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор улицы города в соответствии со справочником РСХН. <bs:guid>b014d26b-5391-c852-caa4-60fc9bb0a7d4</bs:guid>
33 ·········</dt:street>
34 ·········<dt:house> bs:String255 [0..1] Номер дома. <dt:house>6</dt:house>
35 ·········<dt:building> bs:String255 [0..1] Номер строения. <dt:building>1</dt:building>
36 ·········<dt:room> bs:String255 [0..1] Номер квартиры / офиса. <dt:room>1</dt:room>
37 ·········<dt:postIndex> bs:String255 [0..1] Почтовый индекс. <dt:postIndex>600037</dt:postIndex>
38 ······</dt:juridicalAddress>
39 ···</dt:businessEntity>
40 </ws:getBusinessEntityListRequest>

Данные ответа

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

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

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

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


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

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