GetRussianEnterpriseList v2

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску

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

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

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

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

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

  • список российских предприятий.

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

  • В спецификации перечислены поля, по которым может быть осуществлена фильтрация предприятий.

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

# Название XML-элемента Тип Обязат. Описание Пример
1 <ws:getRussianEnterpriseListRequest>
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:enterprise> dt:Enterprise [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>
11 ······<dt:numberList> dt:EnterpriseNumberList [0..1] Список номеров предприятия.
12 ·········<dt:enterpriseNumber> bs:String255 [1..*] Номер предприятия <dt:enterpriseNumber>RU751</dt:enterpriseNumber>
13 ······</dt:numberList>
10 ······<dt:address> dt:Address [0..1] Фактический адрес расположения поднадзорного объекта.
11 ·········<dt:country> dt:Country [0..1] Страна
12 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор страны в соответствии со справочником РСХН. <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
13 ·········</dt:country>
14 ·········<dt:region> dt:Region [0..1] Регион (республика, область, край, автономная область)
15 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор региона страны в соответствии со справочником РСХН. <bs:guid>cbdf8cb6-fb9a-4f36-36d3-04488f6d1b82</bs:guid>
16 ·········</dt:region>
17 ·········<dt:district> dt:Locality [0..1] Район региона
18 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор района региона в соответствии со справочником РСХН. <bs:guid>90d82878-431a-0cf1-0974-16d4fdff3bc8</bs:guid>
19 ·········</dt:district>
20 ·········<dt:locality> dt:Locality [0..1] Населённый пункт
21 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор города региона (города регионального подчинения) страны в соответствии со справочником РСХН. <bs:guid>a16545f3-8f9c-2778-099f-a5d302e58712</bs:guid>
22 ·········</dt:locality>
23 ·········<dt:subLocality> dt:Locality [0..1] Населённый пункт, подчиненный другогому населенному пункту (locality)
24 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор населенного пункта в соответствии со справочником РСХН. <bs:guid>9f315346-b470-3a1c-56d0-ae1afe9579df</bs:guid>
25 ·········</dt:subLocality>
26 ·········<dt:street> dt:Street [0..1] Улица
27 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор улицы города в соответствии со справочником РСХН. <bs:guid>b014d26b-5391-c852-caa4-60fc9bb0a7d4</bs:guid>
28 ·········</dt:street>
29 ·········<dt:house> bs:String255 [0..1] Номер дома. <dt:house>6</dt:house>
30 ·········<dt:building> bs:String255 [0..1] Номер строения. <dt:building>1</dt:building>
31 ·········<dt:room> bs:String255 [0..1] Номер квартиры / офиса. <dt:room>1</dt:room>
32 ·········<dt:postIndex> bs:String255 [0..1] Почтовый индекс. <dt:postIndex>600037</dt:postIndex>
33 ······</dt:address>
34 ···</dt:enterprise>
35 </ws:getRussianEnterpriseListRequest>

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

# Название XML-элемента Тип Обязат. Описание Пример
1 <ws:getRussianEnterpriseListResponse>
2 ···<dt:enterpriseList count="100" total="292706" offset="0"> dt:ActivityLocationList [1..1] Список поднадзорных объектов (площадок)
  • total - всего записей;
  • offset - смещение относительно первого элемента;
  • count - количество выводимых записей.
3 ······<dt:enterprise> dt:Enterprise [0..*] Данные о поднадзорном объекте.
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] Является ли запись активной:
  • true - запись активна;
  • false - запись не активна.
 <bs:active>true</bs:active>
7 ·········<bs:last> xs:boolean [1..1] Является ли версия записи последней:
  • true - да;
  • false - нет.
 <bs:last>true</bs:last>
8 ·········<bs:status> bs:VersionStatus [1..1] Статус версии поднадзорного объекта. <bs:status>100</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:name> bs:String255 [1..1] Полное наименование поднадзорного объекта. <dt:name>Гладиолус</dt:name>
14 ·········<dt:type> dt:EnterpriseType [1..1] Тип поднадзорного объекта:
  • 1 - предприятие;
  • 2 - рынок;
  • 3 - СББЖ;
  • 4 - судно.
 <dt:type>1</dt:type>
15 ·········<dt:numberList> dt:EnterpriseNumberList [0..1] Список номеров предприятия.
16 ············<dt:enterpriseNumber> bs:String255 [1..*] Номер предприятия <dt:enterpriseNumber>RU751</dt:enterpriseNumber>
17 ·········</dt:numberList>
18 ·········<dt:address> dt:Address [1..1] Фактический адрес расположения поднадзорного объекта.
19 ············<dt:country> dt:Country [1..1] Страна
20 ···············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор страны в соответствии со справочником РСХН. <bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
21 ···············<bs:guid> bs:UUID [1..1] Глобальный идентификатор страны в соответствии со справочником РСХН. <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
22 ···············<dt:name> bs:String255 [1..1] Наименование страны в соответствии со справочником РСХН. <dt:name>Российская Федерация</dt:name>
23 ············</dt:country>
24 ············<dt:region> dt:Region [1..1] Регион (республика, область, край, автономная область)
25 ···············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор региона страны в соответствии со справочником РСХН. <bs:uuid>e440dcdb-31d6-39a4-db63-a1c0731d61d6</bs:uuid>
26 ···············<bs:guid> bs:UUID [1..1] Глобальный идентификатор региона страны в соответствии со справочником РСХН. <bs:guid>cbdf8cb6-fb9a-4f36-36d3-04488f6d1b82</bs:guid>
27 ···············<dt:name> bs:String255 [1..1] Наименование региона страны в соответствии со справочником РСХН. <dt:name>Владимирская область</dt:name>
28 ············</dt:region>
29 ············<dt:district> dt:Locality [0..1] Район региона
30 ···············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор района региона в соответствии со справочником РСХН. <bs:uuid>3cb373d5-32f1-ac2a-754c-58d4b33825dd</bs:uuid>
31 ···············<bs:guid> bs:UUID [1..1] Глобальный идентификатор района региона в соответствии со справочником РСХН. <bs:guid>90d82878-431a-0cf1-0974-16d4fdff3bc8</bs:guid>
32 ···············<dt:name> bs:String255 [1..1] Наименование района региона в соответствии со справочником РСХН. <dt:name>Собинский район</dt:name>
33 ············</dt:district>
34 ············<dt:locality> dt:Locality [0..1] Населённый пункт
35 ···············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор города региона (города регионального подчинения) страны в соответствии со справочником РСХН. <bs:uuid>70db962b-d3f3-9a13-93d1-f83a9bc6ed80</bs:uuid>
36 ···············<bs:guid> bs:UUID [1..1] Глобальный идентификатор города региона (города регионального подчинения) страны в соответствии со справочником РСХН. <bs:guid>a16545f3-8f9c-2778-099f-a5d302e58712</bs:guid>
37 ···············<dt:name> bs:String255 [1..1] Наименование города региона (города регионального подчинения) страны в соответствии со справочником РСХН. <dt:name>Владимир г</dt:name>
38 ············</dt:locality>
39 ············<dt:subLocality> dt:Locality [0..1] Населённый пункт, подчиненный другогому населенному пункту (locality)
40 ···············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор населенного пункта в соответствии со справочником РСХН. <bs:uuid>3a7b2d0c-2ebd-0dff-9e93-341097ee1db3</bs:uuid>
41 ···············<bs:guid> bs:UUID [1..1] Глобальный идентификатор населенного пункта в соответствии со справочником РСХН. <bs:guid>9f315346-b470-3a1c-56d0-ae1afe9579df</bs:guid>
42 ···············<dt:name> bs:String255 [1..1] Наименование населенного пункта в соответствии со справочником РСХН. <dt:name>Энергетик мкрн</dt:name>
43 ············</dt:subLocality>
44 ············<dt:street> dt:Street [0..1] Улица
45 ···············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор улицы города страны в соответствии со справочником РСХН. <bs:uuid>90d82878-431a-0cf1-0974-16d4fdff3bc8</bs:uuid>
46 ···············<bs:guid> bs:UUID [1..1] Глобальный идентификатор улицы города в соответствии со справочником РСХН. <bs:guid>b014d26b-5391-c852-caa4-60fc9bb0a7d4</bs:guid>
47 ···············<dt:name> bs:String255 [1..1] Наименование улицы города в соответствии со справочником РСХН. <dt:name>Энергетиков ул</dt:name>
48 ············</dt:street>
49 ············<dt:house> bs:String255 [0..1] Номер дома. <dt:house>6</dt:house>
50 ············<dt:building> bs:String255 [0..1] Номер строения. <dt:building>1</dt:building>
51 ············<dt:room> bs:String255 [0..1] Номер квартиры / офиса. <dt:room>1</dt:room>
52 ············<dt:postIndex> bs:String255 [0..1] Почтовый индекс. <dt:postIndex>600037</dt:postIndex>
53 ············<dt:postBox> bs:String255 [0..1] Абонентский ящик <dt:postBox>а/я 56</dt:postBox>
54 ············<dt:additionalInfo> bs:String255 [0..1] Дополнительная информация. <dt:additionalInfo>Доп. инфо</dt:additionalInfo>
55 ············<dt:addressView> bs:String255 [0..1] Строковое представление адреса. <dt:addressView>Российская Федерация, Владимирская обл., г. Владимир, ул. Ленина ул., д. 44</dt:addressView>
56 ·········</dt:address>
57 ·········<dt:activityList count="1" total="1" offset="0"> dt:EnterpriseActivityList [1..1] Виды деятельности поднадзорного объекта.
58 ············<dt:activity> dt:EnterpriseActivity [1..*] Деятельность, осуществляемая предприятием, указывается согласно справочнику видов деятельности.
59 ···············<dt:name> bs:NText [0..1] Название вида деятельности. <dt:name>Реализация пищевых продуктов</dt:name>
60 ············</dt:activity>
61 ·········</dt:activityList>
62 ·········<dt:owner> dt:BusinessEntity [0..1] Собственник поднадзорного объекта.
63 ············<bs:uuid> bs:UUID [0..1] Идентификатор хозяйствующего субъекта. <bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
64 ············<bs:guid> bs:UUID [0..1] Глобальный идентификатор хозяйствующего субъекта. <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
65 ············<dt:name> bs:String255 [0..1] Наименование хозяйствующего субъекта. <dt:name>Гладиолус</dt:name>
66 ············<dt:juridicalAddress> dt:Address [0..1] Юридический адрес
67 ···············<dt:addressView> bs:String255 [0..1] Строковое представление адреса. <dt:addressView>Российская Федерация, Владимирская обл., г. Владимир, ул. Ленина ул., д. 44</dt:addressView>
68 ············</dt:juridicalAddress>
69 ·········</dt:owner>
70 ·········<dt:officialRegistration> dt:EnterpriseOfficialRegistration [0..*] Факт постановки на учёт в налоговом органе.
71 ············<dt:ID> dt:GRNType [0..1] Государственный номер регистрации ФНС. <dt:ID>6789198</dt:ID>
72 ············<dt:businessEntity> dt:BusinessEntity [1..1] Хозяйствующий субъект, поставивший площадку на учёт в налоговом органе.
73 ···············<bs:uuid> bs:UUID [1..1] Идентификатор хозяйствующего субъекта. <bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
74 ···············<bs:guid> bs:UUID [1..1] Глобальный идентификатор хозяйствующего субъекта. <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
75 ···············<dt:name> bs:String255 [0..1] Наименование хозяйствующего субъекта без указания организационно-правовой формы. <dt:name>Гладиолус</dt:name>
76 ···············<dt:inn> bs:String255 [0..1] ИНН хозяйствующего субъекта. <dt:inn>3312200096</dt:inn>
77 ···············<dt:kpp> bs:String255 [0..1] КПП хозяйствующего субъекта. <dt:kpp>163501001</dt:kpp>
78 ···············<dt:ogrn> bs:String255 [0..1] ОГРН. <dt:ogrn>4085022240002</dt:ogrn>
79 ···············<dt:juridicalAddress> dt:Address [0..1] Юридический адрес
80 ··················<dt:addressView> bs:String255 [0..1] Строковое представление адреса.
81 ···············</dt:juridicalAddress>
82 ············</dt:businessEntity>
83 ············<dt:kpp> bs:String255 [1..1] Код причины постановки на учёт (КПП). <dt:kpp>163501001</dt:kpp>
84 ·········</dt:officialRegistration>
85 ······</dt:enterprise>
86 ···</dt:enterpriseList>
87 </ws:getRussianEnterpriseListResponse>

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

Ошибка Описание
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:getRussianEnterpriseListRequest>
     	<bs:listOptions>
            <bs:count>3</bs:count>
            <bs:offset>0</bs:offset>
         </bs:listOptions>
     	<dt:enterprise>
            <dt:name>Мясокомбинат</dt:name>
        </dt:enterprise>
      </ws:getRussianEnterpriseListRequest>
   </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:getRussianEnterpriseListRequest>
     	<bs:listOptions>
            <bs:count>100</bs:count>
            <bs:offset>0</bs:offset>
         </bs:listOptions>
     	<dt:enterprise>
            <dt:address>
               <dt:region>
                  <bs:guid>b8837188-39ee-4ff9-bc91-fcc9ed451bb3</bs:guid>
               </dt:region>
            </dt:address>
        </dt:enterprise>
      </ws:getRussianEnterpriseListRequest>
   </soapenv:Body>
</soapenv:Envelope>


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


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