GetRussianEnterpriseList

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

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

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

Используемые пространства имён и типы

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

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

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

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

Данные запроса

Объект getRussianEnterpriseListRequest

Корневой объект запроса. Содержит информацию о параметрах запрашиваемого списка и поля фильтрации предприятия.

Поле Описание Тип данных Обязательность
listOptions Параметры выводимого списка. bs:ListOptions 0..1
enterprise Объект, описывающий предприятие. Содержит поля, по которым доступна фильтрация. ent:Enterprise 0..*

Объект ..Request/listOptions

Объект содержит параметры выводимого списка.

Поле Описание Тип данных Обязательность
count Количество значений в списке.
  • По умолчанию значение равно 100;
  • Максимально допустимое значение равно 1000.
 xs:nonNegativeInteger 0..1
offset Смещение в списке относительно начала. xs:nonNegativeInteger 0..1

Объект ..Request/enterprise

Объект, описывающий предприятие. Здесь приведены только те его поля, по которым допустима фильтрация в методе. Полный список полей можно посмотреть в описании типа Enterprise.

Поле Описание Тип данных Обязательность
UUID Уникальный идентификатор версии записи предприятия в реестре Россельхознадзора. bs:UUID 0..1
GUID Уникальный глобальный идентификатор в реестре Россельхознадзора. bs:UUID 0..1
name Название предприятия. bs:String255 0..1
address Адрес предприятия. ikar:Address 0..1

Объект ..Request/enterprise/address

Объект содержит описание адреса предприятия. Описаны только поля, по которым производится фильтрация. Полный набор полей можно посмотреть в описании типа Address.

Поле Описание Тип данных Обязательность
region Регион Российской Федерации. ikar:Region 0..1
district Район региона Российской Федерации.
  • При поиске по району указывать регион не обязательно.
 ikar:District 0..1
locality Населённый пункт регионального подчинения.
  • По населённым пунктам районного подчинения поиск не осуществляется;
  • При поиске обязательно также указывать регион.
 ikar:Locality 0..1

Объект ..Request/enterprise/address/region

Объект содержит данные региона. Фильтрация предприятий в операции осуществляется только при использовании GUID и UUID. Остальные поля описаны в типе данных Region.

Поле Описание Тип данных Обязательность
UUID Уникальный идентификатор версии записи региона. bs:UUID 1 - обязательно указать один из идентификаторов. При указании обоих приоритет будет за UUID.
GUID Глобальный идентификатор региона. bs:UUID

Объект ..Request/enterprise/address/district

Объект содержит данные района. Фильтрация предприятий в операции осуществляется только при использовании GUID и UUID. Остальные поля описаны в типе данных District.

Поле Описание Тип данных Обязательность
UUID Уникальный идентификатор версии записи района. bs:UUID 1 - обязательно указать один из идентификаторов. При указании обоих приоритет будет за UUID.
GUID Глобальный идентификатор района. bs:UUID

Объект ..Request/enterprise/address/locality

Объект содержит данные населённого пункта. Фильтрация предприятий в операции осуществляется только при использовании GUID и UUID. Остальные поля описаны в типе данных Locality.

Поле Описание Тип данных Обязательность
UUID Уникальный идентификатор версии записи населённого пункта. bs:UUID 1 - обязательно указать один из идентификаторов. При указании обоих приоритет будет за UUID.
GUID Глобальный идентификатор населённого пункта. bs:UUID

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

Объект getRussianEnterpriseListResponse

Корневой объект ответа. Содержит информацию о списке возвращаемых предприятий.

Поле Описание Тип данных Обязательность
enterpriseList Объект описывает список возвращаемых предприятий. ent:EnterpriseList 1

Объект ..Response/enterpriseList

Объект содержит список предприятий, возвращаемых в результате выполнения операции.

Поле Описание Тип данных Обязательность
enterprise Объект, описывающий предприятие. ent:Enterprise 0..*

Атрибуты списка enterpriseList

Атрибут Описание Тип данных Обязательность
count Количество элементов списка, запрашиваемое или переданное. xs:int 1
total Общий размер списка. xs:long 1
offset Смещение первого элемента списка относительно его начала. xs:int 1

Объект ..Response/enterpriseList/enterprise

Объект содержит сведения о предприятии.

Поле Описание Тип данных Обязательность
UUID Уникальный идентификатор версии записи предприятия. bs:UUID 1
GUID Глобальный идентификатор предприятия в реестре Россельхознадзора. bs:UUID 1
active Флаг, указывающий на то, активно ли предприятие. xs:boolean 1
last Флаг, указывающий на то, последняя ли запись. xs:boolean 1
status Статус версии записи. bs:VersionStatus 1
createDate Дата создания записи предприятия в реестре Россельхознадзора. xs:dateTime 1
updateDate Дата последнего обновления записи предприятия в реестре Россельхознадзора. xs:dateTime 1
previous Идентификатор предыдущей версии записи предприятия в реестре Россельхощнадзора. bs:UUID 0..1
name Название предприятия. bs:String255 1
type Тип предприятия согласно классификации в Меркурии:
  • 1 - предприятие;
  • 2 - рынок;
  • 3 - СББЖ;
  • 4 - судно.
 ent:EnterpriseType 1
address Фактический адрес предприятия. ikar:Address 1
activityList Список видов деятельности предприятия. ent:EnterpriseActivtyList 1
owner ХС-владелец. ent:BusinessEntity 1

Объект ..Response/enterpriseList/enterprise/address

Объект, описывающий содержимое адреса предприятия.

Поле Описание Тип данных Обязательность
country Страна, где находится предприятие. ikar:Country 1
region Регион страны. В данной операции, это один из регионов России или город федерального значения. ikar:Region 1
district Район региона. ikar:District 1
locality Населённый пункт. ikar:Locality 1
sublocality Населённый пункт, подчинённый населённому пункту. ikar:Locality 1
street Улица. ikar:Street 1
house Дом. bs:String255 0..1
building Строение. bs:String255 0..1
room Помещение (офис, квартира и т.п.). bs:String255 0..1
postIndex Почтовый индекс. bs:String255 0..1
postBox Абонентский ящик. bs:String255 0..1
addressView Текстовое представление адреса. bs:String255 1

Объект ..Response/enterpriseList/enterprise/address/country

Объект, содержащий данные страны.

Поле Описание Тип данных Обязательность
UUID Уникальный идентификатор версии записи в реестре Россельхознадзора. bs:UUID 1
GUID Глобальный идентификатор страны в реестре Россельхознадзора. bs:UUID 1
name Название страны. bs:String255 1

Объект ..Response/enterpriseList/enterprise/address/region

Объект, содержащий данные о регионе или городе федерального значения.

Поле Описание Тип данных Обязательность
UUID Уникальный идентификатор версии записи в реестре Россельхознадзора. bs:UUID 1
GUID Глобальный идентификатор региона или города федерального значения в реестре Россельхознадзора. bs:UUID 1
name Название региона или города федерального значения. bs:String255 1

Объект ..Response/enterpriseList/enterprise/address/district

Объект, содержащий данные о районе региона.

Поле Описание Тип данных Обязательность
UUID Уникальный идентификатор версии записи в реестре Россельхознадзора. bs:UUID 0..1
GUID Глобальный идентификатор района в реестре Россельхознадзора. bs:UUID 0..1
name Название района. bs:String255 0..1

Объект ..Response/enterpriseList/enterprise/address/locality

Объект, содержащий данные о населённом пункте региона.

Поле Описание Тип данных Обязательность
GUID Глобальный идентификатор населённого пункта в реестре Россельхознадзора. bs:UUID 0..1
name Название населённого пункта. bs:String255 0..1

Объект ..Response/enterpriseList/enterprise/address/sublocality

Объект, содержащий данные о населённом пункте, подчинённом другому населённому пункту.

Поле Описание Тип данных Обязательность
GUID Глобальный идентификатор населённого пункта в реестре Россельхознадзора. bs:UUID 0..1
name Название населённого пункта. bs:String255 0..1

Объект ..Response/enterpriseList/enterprise/address/street

Объект, содержащий данные об улице.

Поле Описание Тип данных Обязательность
GUID Глобальный идентификатор улицы в реестре Россельхознадзора. bs:UUID 0..1
name Название улицы. bs:String255 0..1

Объект ..Response/enterpriseList/enterprise/activityList

Список видов деятельности предприятия.

Поле Описание Тип данных Обязательность
activity Описание вида деятельности предприятия. ent:EnterpriseActivity 0..*

Атрибуты списка enterpriseActivity

Атрибут Описание Тип данных Обязательность
count Количество элементов списка, запрашиваемое или переданное. xs:int 1
total Общий размер списка. xs:long 1
offset Смещение первого элемента списка относительно его начала. xs:int 1

Объект ..Response/enterpriseList/enterprise/activityList/activity

Название вида деятельности предприятия.

Поле Описание Тип данных Обязательность
name Название вида деятельности предприятия. bs:String255 0..1


Объект ..Response/enterpriseList/enterprise/owner

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

Поле Описание Тип Обязательность
UUID Уникальный идентификатор версии записи хозяйствующего субъекта в реестре Россельхознадзора. bs:UUID 1
GUID Глобальный идентификатор хозяйствующего субъекта в реестре Россельхознадзора. bs:UUID 1
active Флаг, показывающий активна ли запись. xs:boolean 1
last Флаг, показывающий последняя ли версия записи. xs:boolean 1
status Текущий статус версии записи хозяйствующего субъекта в реестре Россельхознадзора. bs:VersionStatus 1
createDate Дата создания записи. xs:dateTime 1
updateDate Дата обновления записи. Если данные объекта не менялись, то дата обновления совпадает с датой создания. xs:dateTime 1
previous Идентификатор предыдущей версии записи. bs:UUID 0..1
type Тип хозяйствующего субъекта.
  • 1 - юридическое лицо;
  • 2 - физическое лицо;
  • 3 - индивидуальный предприниматель.
 ent:BusinessEntityType 1
name Название хозяйствующего субъекта (юридического лица). bs:String255 0..1
incorporationForm Организационно-правовая форма в соответствии с общероссийским классификатором ОПФ. ent:IncorporationForm 1
fullName Полное наименование хоз.субъекта с указанием ОПФ так, как оно значится в ЕГРЮЛ/ЕГРИП. bs:String255 0..1
fio ФИО. Указывается при создании индивидуального предпринимателя или физического лица. bs:String255 0..1
passport Номер паспорта. Указывается при создании ИП или физического лица. bs:String255 0..1
inn ИНН субъекта. bs:String255 0..1
kpp КПП субъекта. bs:String255 0..1
ogrn ОГРН субъекта. bs:String255 0..1
juridicalAddress Юридический адрес. Возвращается в виде объектов системы Икар. ikar:Address 1

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

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

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

Запрос списка первых двух предприятий, в названии которых встречается "Совунья". 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
                  xmlns:ws="http://api.vetrf.ru/schema/cdm/cerberus/enterprise/ws-definitions" 
                  xmlns:base="http://api.vetrf.ru/schema/cdm/base" 
                  xmlns:ent="http://api.vetrf.ru/schema/cdm/cerberus/enterprise" 
                  xmlns:ikar="http://api.vetrf.ru/schema/cdm/ikar">
  <soapenv:Header/>
  <soapenv:Body>
    <ws:getRussianEnterpriseListRequest>
      <base:listOptions>
        <base:count>2</base:count>
        <base:offset>0</base:offset>
      </base:listOptions>
      <ent:enterprise>
        <ent:name>Совунья</ent:name>
      </ent:enterprise>
    </ws:getRussianEnterpriseListRequest>
  </soapenv:Body>
</soapenv:Envelope>


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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Body xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <ws:getRussianEnterpriseListResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base" 
                                         xmlns:ikar="http://api.vetrf.ru/schema/cdm/ikar" 
                                         xmlns:ent="http://api.vetrf.ru/schema/cdm/cerberus/enterprise" 
                                         xmlns:ws="http://api.vetrf.ru/schema/cdm/cerberus/enterprise/ws-definitions">
      <ent:enterpriseList count="2" total="2" offset="0">
        <ent:enterprise>
          <bs:uuid>6f15ad56-0a28-4678-a8ef-a182a3fbf449</bs:uuid>
          <bs:guid>06922180-9bb4-437a-a103-7ee253d11e93</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2016-11-16T10:31:49+03:00</bs:createDate>
          <bs:updateDate>2016-11-16T10:31:49+03:00</bs:updateDate>
          <ent:name>Совунья</ent:name>
          <ent:type>1</ent:type>
          <ent:address>
            <ikar:country>
              <bs:uuid>72a84b51-5c5e-11e1-b9b7-001966f192f1</bs:uuid>
              <bs:guid>74a3cbb1-56fa-94f3-ab3f-e8db4940d96b</bs:guid>
              <ikar:name>Российская Федерация</ikar:name>
            </ikar:country>
            <ikar:region>
              <bs:uuid>aad1469e-54ff-4605-af4f-f016c75b84d2</bs:uuid>
              <bs:guid>c2deb16a-0330-4f05-821f-1d09c93331e6</bs:guid>
              <ikar:name>г. Санкт-Петербург</ikar:name>
            </ikar:region>
            <ikar:district/>
            <ikar:locality>
              <bs:guid>3c2827f3-63f3-4692-8c74-c1318ee524fd</bs:guid>
              <ikar:name>г. Ломоносов</ikar:name>
            </ikar:locality>
            <ikar:subLocality/>
            <ikar:street>
              <bs:guid>cc9376fe-cc18-4b29-b5ae-40996a9fd769</bs:guid>
              <ikar:name>Зеленая ул.</ikar:name>
            </ikar:street>
            <ikar:house>5</ikar:house>
            <ikar:building/>
            <ikar:room/>
            <ikar:postIndex/>
            <ikar:postBox/>
            <ikar:addressView>Российская Федерация, г. Санкт-Петербург, г. Ломоносов, Зеленая ул., д. 5</ikar:addressView>
          </ent:address>
          <ent:activityList count="1" total="1" offset="0">
            <ent:activity>
             <ent:name>тестирование сов</ent:name>
            </ent:activity>
          </ent:activityList>
        </ent:enterprise>
        <ent:enterprise>
          <bs:uuid>a6e98b84-ebc7-435c-b903-89fec4f356e8</bs:uuid>
          <bs:guid>52a37069-53bf-4910-b011-ca4ed1e35d21</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2016-11-16T10:48:21+03:00</bs:createDate>
          <bs:updateDate>2016-11-16T10:48:21+03:00</bs:updateDate>
          <ent:name>Совунья-2</ent:name>
          <ent:type>1</ent:type>
          <ent:address>
            <ikar:country>
              <bs:uuid>72a84b51-5c5e-11e1-b9b7-001966f192f1</bs:uuid>
              <bs:guid>74a3cbb1-56fa-94f3-ab3f-e8db4940d96b</bs:guid>
              <ikar:name>Российская Федерация</ikar:name>
            </ikar:country>
            <ikar:region>
              <bs:uuid>132989b8-cfb5-4573-bf19-4b3d9ac121af</bs:uuid>
              <bs:guid>844a80d6-5e31-4017-b422-4d9c01e9942c</bs:guid>
              <ikar:name>Амурская область</ikar:name>
            </ikar:region>
            <ikar:district/>
            <ikar:locality>
              <bs:guid>8f41253d-6e3b-48a9-842a-25ba894bd093</bs:guid>
              <ikar:name>г. Благовещенск</ikar:name>
            </ikar:locality>
            <ikar:subLocality>
              <bs:guid>9804b8e6-ee37-437e-85c1-e5dd9127d845</bs:guid>
              <ikar:name>с. Плодопитомник</ikar:name>
            </ikar:subLocality>
            <ikar:street>
              <bs:guid>4ee904be-178f-416b-b0f9-9cbea059a711</bs:guid>
              <ikar:name>Абрикосовая ул.</ikar:name>
            </ikar:street>
            <ikar:house/>
            <ikar:building/>
            <ikar:room/>
            <ikar:postIndex/>
            <ikar:postBox/>
            <ikar:addressView>Российская Федерация, Амурская обл., г. Благовещенск, с. Плодопитомник, Абрикосовая ул.</ikar:addressView>
          </ent:address>
          <ent:activityList count="1" total="1" offset="0">
            <ent:activity>
              <ent:name>разведение сов</ent:name>
            </ent:activity>
          </ent:activityList>
        </ent:enterprise>
      </ent:enterpriseList>
    </ws:getRussianEnterpriseListResponse>
  </S:Body>
</soapenv:Envelope>
Источник — http://help.vetrf.ru/index.php?title=GetRussianEnterpriseList&oldid=19367