GetBusinessEntityList v2: различия между версиями
Строка 888: | Строка 888: | ||
<div class = "mw-collapsible-content"> | <div class = "mw-collapsible-content"> | ||
<syntaxhighlight lang="xml"> | <syntaxhighlight lang="xml"> | ||
<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> | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</div> | </div> | ||
Строка 902: | Строка 914: | ||
</div> | </div> | ||
<br /> | <br /> | ||
===Поиск физических лиц и индивидуальных предпринимателей с фамилией "Иванов"=== | ===Поиск физических лиц и индивидуальных предпринимателей с фамилией "Иванов"=== | ||
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%"> | <div class="toccolours mw-collapsible mw-collapsed" style="width:100%"> |
Версия 05:46, 27 октября 2017
Общие сведения
Операция GetBusinessEntityList предназначена для получения списка хозяйствующих субъектов из реестра Россельхознадзора. В список попадают только актуальные записи (active = true). Поддерживается возможность постраничного вывода и фильтрации по шаблону. Выполнение операции заканчивается либо возвратом списка хозяйствующих субъектов, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса.
Входные данные
- параметры выводимого списка;
- поля, по которым осуществляется фильтрация хозяйствующих субъектов.
Выходные данные
- список хозяйствующих субъектов.
Использование фильтрации в запросе
- В спецификации перечислены поля, по которым может быть осуществлена фильтрация хозяйствующих субъектов.
- ИНН и ОГРН не могут быть указаны вместе. Поиск может быть произведен только по одному из этих полей. Сочетания остальных полей могут быть любыми.
- Поиск может быть осуществлен по любому из указанных элементов адреса как отдельно, так и в совокупности.
Спецификация запроса
# | Название XML-элемента | Тип | Обязат. | Описание | Пример |
---|---|---|---|---|---|
1 | <ws:getBusinessEntityListRequest> | ||||
2 | ···<bs:listOptions> | bs:ListOptions | [0..1] | Параметры запрашиваемого списка. | |
3 | ······<bs:count> | xs:nonNegativeInteger | [0..1] | Максимальное запрашиваемое количество объектов в списке.
|
<bs:count>10</bs:count> |
4 | ······<bs:offset> | xs:nonNegativeInteger | [0..1] | Номер элемента, по которому осуществляется смещение первого элемента списка.
|
<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:Locality | [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:Locality | [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:Locality | [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> |
Спецификация ответа
# | Название XML-элемента | Тип | Обязат. | Описание | Пример |
---|---|---|---|---|---|
1 | <ws:getBusinessEntityChangesListResponse> | ||||
2 | ···<dt:businessEntityList count="10" total="1000" offset="0"> | dt:BusinessEntityList | [1..1] | Список хозяйствующих субъектов
|
|
3 | ······<dt:businessEntity> | dt:BusinessEntity | [1..1] | Данные о хозяйствующем субъекте. | |
4 | ·········<bs:uuid> | bs:UUID | [1..1] | Идентификатор версии хозяйствующего субъекта. | <bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid> |
5 | ·········<bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор хозяйствующего субъекта. | <bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid> |
6 | ·········<bs:active> | xs:boolean | [1..1] | Является ли запись активной:
|
<bs:active>true</bs:active> |
7 | ·········<bs:last> | xs:boolean | [1..1] | Является ли версия записи последней:
|
<bs:last>true</bs:last> |
8 | ·········<bs:status> | bs:VersionStatus | [1..1] | Статус версии хозяйствующего субъекта. | <bs:status>230</bs:status> |
9 | ·········<bs:createDate> | xs:DateTime | [1..1] | Дата создания хозяйствующего субъекта. | <bs:createDate>2017-07-07T12:00:00</bs:createDate> |
10 | ·········<bs:updateDate> | xs:DateTime | [1..1] | Дата изменения хозяйствующего субъекта. | <bs:updateDate>2017-07-07T12:00:00</bs:updateDate> |
11 | ·········<bs:previous> | bs:UUID | [0..1] | Идентификатор предыдущей версии записи реестра хозяйствующих субъектов. | <bs:previous>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous> |
12 | ·········<bs:next> | bs:UUID | [0..1] | Идентификатор следующей версии записи реестра хозяйствующих субъектов. | <bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next> |
13 | ·········<dt:type> | dt:BusinessEntityType | [1..1] | Тип создаваемого или редактируемого хозяйствующего субъекта:
|
<dt:type>1</dt:type> |
14 | ·········<dt:name> | bs:String255 | [0..1] | Наименование хозяйствующего субъекта без указания организационно-правовой формы.
|
<dt:name>Гладиолус</dt:name> |
15 | ·········<dt:incorporationForm> | dt:IncorporationForm | [1..1] | Организационно-правовая форма хозяйствующего субъекта. | |
16 | ············<bs:uuid> | bs:UUID | [1..1] | Идентификатор версии организационно-правовой формы | <bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid> |
17 | ············<dt:name> | bs:String255 | [1..1] | Название организационно-правовой формы предприятия согласно справочнику ОКОПФ. | <dt:name>Общество с ограниченной ответственностью</dt:name> |
18 | ············<dt:code> | bs:String255 | [1..1] | Код организационно-правовой формы предприятия согласно справочнику ОКОПФ. | <dt:code>12300</dt:code> |
19 | ············<dt:shortName> | bs:String255 | [0..1] | Краткое название организационно-правовой формы предприятия. | <dt:shortName>ООО</dt:shortName> |
20 | ·········</dt:incorporationForm> | ||||
21 | ·········<dt:fullName> | bs:String255 | [0..1] | Полное наименование хозяйствующего субъекта с указанием ОПФ так, как оно значится в ЕГРЮЛ/ЕГРИП. | <dt:fullName>Общество с ограниченной ответственностью "Гладиолус"</dt:fullName> |
22 | ·········<dt:fio> | bs:String255 | [0..1] | ФИО физического лица или индивидуального предпринимателя.
|
<dt:fio>Иванов Сергей Петрович</dt:fio> |
23 | ·········<dt:inn> | bs:String255 | [0..1] | ИНН хозяйствующего субъекта. | <dt:inn>3312200096</dt:inn> |
24 | ·········<dt:kpp> | bs:String255 | [0..1] | Код причины постановки на учет (КПП). | <dt:kpp>163501001</dt:kpp> |
25 | ·········<dt:ogrn> | bs:String255 | [0..1] | ОГРН или ОГРНИП.
|
<dt:ogrn>4085022240002</dt:ogrn> |
26 | ·········<dt:juridicalAddress> | dt:Address | [1..1] | Юридический адрес - адрес, по которому зарегистрирован хозяйствующий субъект. | |
27 | ············<dt:country> | dt:Country | [1..1] | Страна | |
28 | ···············<bs:uuid> | bs:UUID | [1..1] | Уникальный идентификатор страны в соответствии со справочником РСХН. | <bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid> |
29 | ···············<bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор страны в соответствии со справочником РСХН. | <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid> |
30 | ···············<dt:name> | bs:String255 | [1..1] | Наименование страны в соответствии со справочником РСХН. | <dt:name>Российская Федерация</dt:name> |
31 | ············</dt:country> | ||||
32 | ············<dt:region> | dt:Region | [1..1] | Регион | |
33 | ···············<bs:uuid> | bs:UUID | [1..1] | Уникальный идентификатор региона страны в соответствии со справочником РСХН. | <bs:uuid>e440dcdb-31d6-39a4-db63-a1c0731d61d6</bs:uuid> |
34 | ···············<bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор региона страны в соответствии со справочником РСХН. | <bs:guid>cbdf8cb6-fb9a-4f36-36d3-04488f6d1b82</bs:guid> |
35 | ···············<dt:name> | bs:String255 | [1..1] | Наименование региона страны в соответствии со справочником РСХН. | <dt:name>Владимирская область</dt:name> |
36 | ············</dt:region> | ||||
37 | ············<dt:district> | dt:Locality | [0..1] | Район региона | |
38 | ···············<bs:uuid> | bs:UUID | [1..1] | Уникальный идентификатор района региона в соответствии со справочником РСХН. | <bs:uuid>3cb373d5-32f1-ac2a-754c-58d4b33825dd</bs:uuid> |
39 | ···············<bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор района региона в соответствии со справочником РСХН. | <bs:guid>90d82878-431a-0cf1-0974-16d4fdff3bc8</bs:guid> |
40 | ···············<dt:name> | bs:String255 | [1..1] | Наименование района региона в соответствии со справочником РСХН. | <dt:name>Собинский район</dt:name> |
41 | ············</dt:district> | ||||
42 | ············<dt:locality> | dt:Locality | [0..1] | Населённый пункт | |
43 | ···············<bs:uuid> | bs:UUID | [1..1] | Уникальный идентификатор города региона (города регионального подчинения) страны в соответствии со справочником РСХН. | <bs:uuid>70db962b-d3f3-9a13-93d1-f83a9bc6ed80</bs:uuid> |
44 | ···············<bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор города региона (города регионального подчинения) страны в соответствии со справочником РСХН. | <bs:guid>a16545f3-8f9c-2778-099f-a5d302e58712</bs:guid> |
45 | ···············<dt:name> | bs:String255 | [1..1] | Наименование города региона (города регионального подчинения) страны в соответствии со справочником РСХН. | <dt:name>Владимир г</dt:name> |
46 | ············</dt:locality> | ||||
47 | ············<dt:subLocality> | dt:Locality | [0..1] | Населённый пункт, подчиненный другогому населенному пункту (locality) | |
48 | ···············<bs:uuid> | bs:UUID | [1..1] | Уникальный идентификатор населенного пункта в соответствии со справочником РСХН. | <bs:uuid>3a7b2d0c-2ebd-0dff-9e93-341097ee1db3</bs:uuid> |
49 | ···············<bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор населенного пункта в соответствии со справочником РСХН. | <bs:guid>9f315346-b470-3a1c-56d0-ae1afe9579df</bs:guid> |
50 | ···············<dt:name> | bs:String255 | [1..1] | Наименование населенного пункта в соответствии со справочником РСХН. | <dt:name>Энергетик мкрн</dt:name> |
51 | ············</dt:subLocality> | ||||
52 | ············<dt:street> | dt:Street | [0..1] | Улица | |
53 | ···············<bs:uuid> | bs:UUID | [1..1] | Уникальный идентификатор улицы города страны в соответствии со справочником РСХН. | <bs:uuid>90d82878-431a-0cf1-0974-16d4fdff3bc8</bs:uuid> |
54 | ···············<bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор улицы города в соответствии со справочником РСХН. | <bs:guid>b014d26b-5391-c852-caa4-60fc9bb0a7d4</bs:guid> |
55 | ···············<dt:name> | bs:String255 | [1..1] | Наименование улицы города в соответствии со справочником РСХН. | <dt:name>Энергетиков ул</dt:name> |
56 | ············</dt:street> | ||||
57 | ············<dt:house> | bs:String255 | [0..1] | Номер дома. | <dt:house>6</dt:house> |
58 | ············<dt:building> | bs:String255 | [0..1] | Номер строения. | <dt:building>1</dt:building> |
59 | ············<dt:room> | bs:String255 | [0..1] | Номер квартиры / офиса. | <dt:room>1</dt:room> |
60 | ············<dt:postIndex> | bs:String255 | [0..1] | Почтовый индекс. | <dt:postIndex>600037</dt:postIndex> |
61 | ············<dt:postBox> | bs:String255 | [0..1] | Абонентский ящик | <dt:postBox>а/я 56</dt:postBox> |
62 | ············<dt:additionalInfo> | bs:String255 | [0..1] | Дополнительная информация. | <dt:additionalInfo>Доп. инфо</dt:additionalInfo> |
63 | ············<dt:addressView> | bs:String255 | [0..1] | Строковое представление адреса. | <dt:addressView>Российская Федерация, Владимирская обл., г. Владимир, ул. Ленина ул., д. 44</dt:addressView> |
64 | ·········</dt:juridicalAddress> | ||||
65 | ······</dt:businessEntity> | ||||
66 | ···</dt:businessEntityList> | ||||
67 | </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>
Ответ на запрос.
Поиск физических лиц и индивидуальных предпринимателей с фамилией "Иванов"
Поиск физических лиц и индивидуальных предпринимателей с фамилией "Иванов"
Ответ на запрос.
Поиск хозяйствующих субъектов, расположенных на территории Владимирской области
Поиск хозяйствующих субъектов, расположенных на территории Владимирской области
Ответ на запрос.