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

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

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

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

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

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

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

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

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

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

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

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getRussianEnterpriseListRequest>
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:enterprise> dt:Enterprise [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:numberList> dt:EnterpriseNumberList [0..1] Список номеров предприятия.
011 ·········<dt:enterpriseNumber>RU751</dt:enterpriseNumber> bs:String255 [1..*] Номер предприятия.
012 ······</dt:numberList>
013 ······<dt:address> dt:Address [0..1] Фактический адрес расположения поднадзорного объекта.
014 ·········<dt:country> dt:Country [0..1] Страна.
015 ············<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор страны в соответствии со справочником РСХН.
016 ·········</dt:country>
017 ·········<dt:region> dt:Region [0..1] Регион (республика, область, край, автономная область).
018 ············<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор региона в соответствии со справочником РСХН.
019 ·········</dt:region>
020 ·········<dt:district> dt:Locality [0..1] Район региона.
021 ············<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор района в соответствии со справочником РСХН.
022 ·········</dt:district>
023 ·········<dt:locality> dt:Locality [0..1] Населённый пункт.
024 ············<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор города в соответствии со справочником РСХН.
025 ·········</dt:locality>
026 ·········<dt:subLocality> dt:Locality [0..1] Населённый пункт, подчиненный другогому населенному пункту (locality).
027 ············<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор населенного пункта в соответствии со справочником РСХН.
028 ·········</dt:subLocality>
029 ·········<dt:street> dt:Street [0..1] Улица.
030 ············<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор улицы в соответствии со справочником РСХН.
031 ·········</dt:street>
032 ·········<dt:house>6</dt:house> bs:String255 [0..1] Номер дома.
033 ·········<dt:building>1</dt:building> bs:String255 [0..1] Номер строения.
034 ·········<dt:room>1</dt:room> bs:String255 [0..1] Номер квартиры / офиса.
035 ·········<dt:postIndex>600037</dt:postIndex> bs:String255 [0..1] Почтовый индекс.
036 ······</dt:address>
037 ···</dt:enterprise>
038 </ws:getRussianEnterpriseListRequest>

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

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

Список поднадзорных объектов (площадок).

  • total - всего записей;
  • offset - смещение относительно первого элемента;
  • count - количество выводимых записей.
003 ······<dt:enterprise> dt:Enterprise [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>100</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 ·········<bs:next>UUID</bs:next> bs:UUID [0..1] Идентификатор следующей версии записи.
013 ·········<dt:name>Наименование</dt:name> bs:String255 [1..1] Полное наименование поднадзорного объекта.
014 ·········<dt:type>1</dt:type> dt:EnterpriseType [1..1]

Тип поднадзорного объекта.

  • 1 - предприятие;
  • 2 - рынок;
  • 3 - СББЖ;
  • 4 - судно.
015 ·········<dt:numberList> dt:EnterpriseNumberList [0..1] Список номеров предприятия.
016 ············<dt:enterpriseNumber>RU751</dt:enterpriseNumber> bs:String255 [1..*] Номер предприятия.
017 ·········</dt:numberList>
018 ·········<dt:address> dt:Address [1..1] Фактический адрес расположения поднадзорного объекта.
019 ············<dt:country> dt:Country [1..1] Страна.
020 ···············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Уникальный идентификатор страны в соответствии со справочником РСХН.
021 ···············<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор страны в соответствии со справочником РСХН.
022 ···············<dt:name>Российская Федерация</dt:name> bs:String255 [1..1] Наименование страны в соответствии со справочником РСХН.
023 ············</dt:country>
024 ············<dt:region> dt:Region [1..1] Регион (республика, область, край, автономная область).
025 ···············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Уникальный идентификатор региона в соответствии со справочником РСХН.
026 ···············<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор региона в соответствии со справочником РСХН.
027 ···············<dt:name>Владимирская область</dt:name> bs:String255 [1..1] Наименование региона страны в соответствии со справочником РСХН.
028 ············</dt:region>
029 ············<dt:district> dt:Locality [0..1] Район региона.
030 ···············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Уникальный идентификатор района в соответствии со справочником РСХН.
031 ···············<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор района в соответствии со справочником РСХН.
032 ···············<dt:name>Собинский район</dt:name> bs:String255 [1..1] Наименование района региона в соответствии со справочником РСХН.
033 ············</dt:district>
034 ············<dt:locality> dt:Locality [0..1] Населённый пункт.
035 ···············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Уникальный идентификатор города в соответствии со справочником РСХН.
036 ···············<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор города в соответствии со справочником РСХН.
037 ···············<dt:name>Владимир г</dt:name> bs:String255 [1..1] Наименование города в соответствии со справочником РСХН.
038 ············</dt:locality>
039 ············<dt:subLocality> dt:Locality [0..1] Населённый пункт, подчиненный другогому населенному пункту (locality).
040 ···············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Уникальный идентификатор населенного пункта в соответствии со справочником РСХН.
041 ···············<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор населенного пункта в соответствии со справочником РСХН.
042 ···············<dt:name>Энергетик мкрн</dt:name> bs:String255 [1..1] Наименование населенного пункта в соответствии со справочником РСХН.
043 ············</dt:subLocality>
044 ············<dt:street> dt:Street [0..1] Улица.
045 ···············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Уникальный идентификатор улицы в соответствии со справочником РСХН.
046 ···············<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор улицы в соответствии со справочником РСХН.
047 ···············<dt:name>Энергетиков ул</dt:name> bs:String255 [1..1] Наименование улицы в соответствии со справочником РСХН.
048 ············</dt:street>
049 ············<dt:house>6</dt:house> bs:String255 [0..1] Номер дома.
050 ············<dt:building>1</dt:building> bs:String255 [0..1] Номер строения.
051 ············<dt:room>1</dt:room> bs:String255 [0..1] Номер квартиры / офиса.
052 ············<dt:postIndex>600037</dt:postIndex> bs:String255 [0..1] Почтовый индекс.
053 ············<dt:postBox>а/я 56</dt:postBox> bs:String255 [0..1] Абонентский ящик
054 ············<dt:additionalInfo>Доп. инфо</dt:additionalInfo> bs:String255 [0..1] Дополнительная информация.
055 ············<dt:addressView>Текстовый адрес</dt:addressView> bs:String255 [0..1] Строковое представление адреса.
056 ·········</dt:address>
057 ·········<dt:activityList count="1" total="1" offset="0"> dt:EnterpriseActivityList [0..1] Виды деятельности поднадзорного объекта.
058 ············<dt:activity> dt:EnterpriseActivity [1..*] Деятельность, осуществляемая предприятием.
059 ···············<dt:name>Реализация пищевых продуктов</dt:name> bs:NText [1..1] Название вида деятельности.
060 ············</dt:activity>
061 ·········</dt:activityList>
062 ·········<dt:owner> dt:BusinessEntity [0..1] ХС-владелец поднадзорного объекта.
063 ············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Идентификатор хозяйствующего субъекта.
064 ············<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор хозяйствующего субъекта.
065 ············<dt:juridicalAddress> dt:Address [0..1] Юридический адрес.
066 ···············<dt:addressView>Текстовый адрес</dt:addressView> bs:String255 [0..1] Строковое представление адреса.
067 ············</dt:juridicalAddress>
068 ·········</dt:owner>
069 ·········<dt:officialRegistration> dt:EnterpriseOfficialRegistration [0..*] Факт постановки на учёт в налоговом органе.
070 ············<dt:businessEntity> dt:BusinessEntity [1..1] Хозяйствующий субъект, поставивший площадку на учёт в налоговом органе.
071 ···············<dt:inn>7103016446</dt:inn> bs:String255 [1..1] ИНН хозяйствующего субъекта.
072 ············</dt:businessEntity>
073 ············<dt:kpp>123456789</dt:kpp> bs:String255 [1..1] Код причины постановки на учёт (КПП).
074 ·········</dt:officialRegistration>
075 ·········<dt:registryStatus>VERIFIED</dt:registryStatus> dt:EnterpriseStatus [0..1]

(v2.1) Статус предприятия в реестре ИС Цербер.

  • UNVERIFIED - Не подтверджен (не в реестре).
  • VERIFIED - Подтвержден (включен в реестр).
  • CANCELED - Исключен из реестра.
  • DELETED - Удален.
076 ······</dt:enterprise>
077 ···</dt:enterpriseList>
078 </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>3</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=37150