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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
 
(не показана 1 промежуточная версия этого же участника)
Строка 281: Строка 281:
===Объект [[#Объект getRussianEnterpriseChangesListResponse|..Response]]/[[#Объект ..Response/enterpriseList|enterpriseList]]/[[#Объект ..Response/enterpriseList|enterprise]]/'''owner'''===
===Объект [[#Объект getRussianEnterpriseChangesListResponse|..Response]]/[[#Объект ..Response/enterpriseList|enterpriseList]]/[[#Объект ..Response/enterpriseList|enterprise]]/'''owner'''===


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


{| class="wikitable"
{{Ветис.API EnterpriseService BusinessEntity}}
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Уникальный идентификатор версии записи хозяйствующего субъекта. || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор записи хозяйствующего субъекта в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|}


==Описание ошибок==
==Описание ошибок==
Строка 451: Строка 444:
</div>
</div>
</div>
</div>
[[Category:Ветис.API]]
[[Category:EnterpriseService]]
[[Category:Реестры]]

Текущая версия на 14:35, 20 декабря 2016

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

Операция GetRussianEnterpriseChangesList предназначена для получения изменений в списке российских предприятий за указанный период времени. В общем случае могут быть возвращены не последние и/или не актуальные записи (active=false, last=false). Поддерживается постраничный вывод. Выполнение операции заканчивается либо возвратом списка предприятий, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса.

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


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

  • параметры запрашиваемого списка;
  • интервал дат, за которые запрашиваются изменения.

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

  • список изменённых за период времени предприятий.

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

Объект getRussianEnterpriseChangesListRequest

Корневой объект запроса. Содержит параметры запрашиваемого списка.

Поле Описание Тип данных Обязательность
listOptions Параметры запрашиваемого списка. bs:ListOptions 0..1
updateDateInterval Интервал дат, за который выбираются изменения. bs:DateInterval 1

Объект ..Request/listOptions

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

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

Объект ..Request/updateDateInterval

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

Поле Описание Тип данных Обязательность
beginDate Начальная дата интервала. xs:dateTime 1
endDate Конечная дата интервала.
  • Если конечная дата не указана, то по умолчанию используется текущая дата.
 xs:dateTime 0..1

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

Объект getRussianEnterpriseChangesListResponse

Корневой объект ответа. Содержит список предприятий.

Поля Описание Тип данных Обязательность
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
next Идентификатор следующей версии записи предприятия в реестре Россельхознадзора. 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 0..1
locality Населённый пункт. ikar:Locality 0..1
sublocality Населённый пункт, подчинённый населённому пункту. ikar:Locality 0..1
street Улица в населённом пункте. ikar:Street 0..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 1
GUID Глобальный идентификатор района в реестре Россельхознадзора. bs:UUID 1
name Название района. bs:String255 1

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

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

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

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

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

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

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

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

Поле Описание Тип данных Обязательность
GUID Глобальный идентификатор улицы в реестре Россельхознадзора. bs:UUID 1
name Название улицы. bs:String255 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 Заданный в запросе отступ больше числа записей в результате запроса.

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

Запрос первых трех российских предприятий, измененных за период с 01.06.2016 по текущий день. 

<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">
  <soapenv:Header/>
  <soapenv:Body>
    <ws:getRussianEnterpriseChangesListRequest>
      <base:listOptions>
        <base:count>3</base:count>
        <base:offset>10</base:offset>
      </base:listOptions>
      <base:updateDateInterval>
        <base:beginDate>2016-06-01</base:beginDate>
        <base:endDate></base:endDate>
      </base:updateDateInterval>
    </ws:getRussianEnterpriseChangesListRequest>
  </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:getRussianEnterpriseChangesListResponse 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="3" total="2135" offset="10">
        <ent:enterprise>
          <bs:uuid>07613e3e-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
          <bs:guid>eab504b6-68b7-e76e-bbcc-3c82f9127e87</bs:guid>
          <bs:active>false</bs:active>
          <bs:last>false</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2010-11-09T13:04:58+03:00</bs:createDate>
          <bs:updateDate>2016-10-26T11:36:39+03:00</bs:updateDate>
          <bs:next>6ccd6be7-e0c7-4be6-8b22-2f123e76abf6</bs:next>
          <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>8bbaf531-2d1e-47fb-adb3-58b3edacd97c</bs:uuid>
              <bs:guid>0c089b04-099e-4e0e-955a-6bf1ce525f1a</bs:guid>
              <ikar:name>Республика Татарстан</ikar:name>
            </ikar:region>
            <ikar:district/>
            <ikar:locality/>
            <ikar:subLocality/>
            <ikar:street/>
            <ikar:addressView>г. Набережные Челны, Промкомзона А-2</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>076226c8-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
               <bs:guid>f1ad5e24-502a-dde4-1d36-f499c0a438e8</bs:guid>
               <bs:active>false</bs:active>
               <bs:last>false</bs:last>
               <bs:status>100</bs:status>
               <bs:createDate>2010-11-17T11:55:30+03:00</bs:createDate>
               <bs:updateDate>2016-06-23T09:35:32+03:00</bs:updateDate>
               <bs:next>fd5ebae9-7ad3-4d2a-ab32-223cf754b039</bs:next>
               <ent:name>ОАО "Рыбообрабатывающий комбинат № 1"</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/>
                 <ikar:subLocality/>
                 <ikar:street/>
                 <ikar:addressView>Санкт-Петербург, Элеваторная пл., д. 16, к. 7</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>07635958-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
              <bs:guid>20ab1a6f-4d93-dacf-64c8-6feb828f32ba</bs:guid>
              <bs:active>false</bs:active>
              <bs:last>false</bs:last>
              <bs:status>100</bs:status>
              <bs:createDate>2010-11-29T09:43:07+03:00</bs:createDate>
              <bs:updateDate>2016-06-27T11:32:55+03:00</bs:updateDate>
              <bs:next>18ba3445-f2c1-4843-85ef-de3aeb6c820c</bs:next>
              <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/>
                <ikar:subLocality/>
                <ikar:street/>
                <ikar:addressView>Санкт-Петербург, ул. Арсенальная, д. 1, корп. 2</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:getRussianEnterpriseChangesListResponse>
   </S:Body>
</soapenv:Envelope>
Источник — http://help.vetrf.ru/index.php?title=GetRussianEnterpriseChangesList&oldid=19369