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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
 
(не показано 14 промежуточных версий 2 участников)
Строка 1: Строка 1:
==Общие сведения==
==Общие сведения==
Операция '''GetBusinessEntityChangesList''' предназначена для получения списка ХС, изменённых в указанный период времени. В общем случае в список могут попасть не актуальные и не последние записи (active=false, last=false). Метод поддерживает возможность постраничного вывода и фильтрации по шаблону.  
Операция '''GetBusinessEntityChangesList''' предназначена для получения списка хозяйствующих субъектов, изменённых в указанный период времени. В общем случае в список могут попасть не актуальные и/или не последние записи (active=false, last=false). Поддерживается возможность постраничного вывода и фильтрации по шаблону. Выполнение операции заканчивается либо возвратом списка хозяйствующих субъектов, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса.


===Используемые пространства имён и типы===
===Используемые пространства имён и типы===
Строка 64: Строка 64:
! Поле !! Описание !! Тип данных !! Обязательность
! Поле !! Описание !! Тип данных !! Обязательность
|-
|-
| '''count''' || Количество значений в списке
| '''count''' || Количество значений в списке.
* По умолчанию значение равно 100;
* По умолчанию значение равно 100;
* Максимально допустимое значение равно 1000.
* Максимально допустимое значение равно 1000.
Строка 80: Строка 80:
! Поле !! Описание !! Тип данных !! Обязательность
! Поле !! Описание !! Тип данных !! Обязательность
|-
|-
| '''beginDate''' || Начальная дата интервала || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
| '''beginDate''' || Начальная дата интервала. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
|-
|-
| '''endDate''' || Конечная дата интервала  
| '''endDate''' || Конечная дата интервала.
* Если конечная дата не указана, то по умолчанию используется текущая дата.
* Если конечная дата не указана, то по умолчанию используется текущая дата.
|| [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 0..1
|| [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 0..1
Строка 110: Строка 110:
| [[#Объект ..Response/businessEntityList/businessEntity|'''businessEntity''']] || Объект, описывающий поля хозяйствующего субъекта. || [[BusinessEntity|ent:BusinessEntity]] || 0..*
| [[#Объект ..Response/businessEntityList/businessEntity|'''businessEntity''']] || Объект, описывающий поля хозяйствующего субъекта. || [[BusinessEntity|ent:BusinessEntity]] || 0..*
|}
|}
'''Атрибуты списка businessEntityList'''
{{Ветис.API EntityList Attributes}}


===Объект [[#Объект getBusinessEntityChangesListResponse|..Response]]/[[#Объект ..Response/businessEntityList|businessEntityList]]/'''businessEntity'''===
===Объект [[#Объект getBusinessEntityChangesListResponse|..Response]]/[[#Объект ..Response/businessEntityList|businessEntityList]]/'''businessEntity'''===
Строка 115: Строка 118:
Объект описывает свойства хозяйствующего субъекта.
Объект описывает свойства хозяйствующего субъекта.


{| class="wikitable"
{{Ветис.API EnterpriseService BusinessEntity|1}}
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''UUID''' || Идентификатор версии записи хозяйствующего субъекта (юридического лица). || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор хозяйствующего субъекта в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|-
| '''active''' || Флаг, показывающий активна ли запись. || [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
|-
| '''last''' || Флаг, показывающий последняя ли версия записи. || [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
|-
| '''createDate''' || Дата создания записи. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
|-
| '''updateDate''' || Дата обновления записи. Если данные объекта не менялись, то дата обновления совпадает с датой создания. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
|-
| '''previous''' || Ссылка на индентификатор предыдущей версии записи.  || [[UUID|bs:UUID]] || 0..1
|-
| '''next''' || Сссылка на идентификатор следующей версии записи. || [[UUID|bs:UUID]] || 0..1
|-
| '''type''' || Тип хозяйствующего субъекта.
* 1 - юридическое лицо
* 2 - физическое лицо
* 3 - индивидуальный предприниматель
|| [[BusinessEntityType|ent:BusinessEntityType]] || 0..1
|-
| '''name''' || Название хозяйствующего субъекта (юридического лица). || [[String255|bs:String255]] || 0..1
|-
| [[#Объект ..Response/businessEntityList/businessEntity/incorporationForm|'''incorporationForm''']] || Организационно-правовая форма в соответствии с общероссийским классификатором ОПФ, || [[IncorporationForm|ent:IncorporationForm]] || 0..1
|-
| '''fullName''' || Полное наименование хоз.субъекта с указанием ОПФ так, как оно значится в ЕГРЮЛ/ЕГРИП. || [[String255|bs:String255]] || 0..1
|-
| '''fio''' || ФИО. Указывается при создании индивидуального предпринимателя или физического лица. || [[String255|bs:String255]] || 0..1
|-
| '''passport''' || Номер паспорта. Указывается при создании ИП или физического лица.|| [[String255|bs:String255]] || 0..1
|-
| '''inn''' || ИНН субъекта. || [[String255|bs:String255]] || 0..1
|-
| '''kpp''' || КПП субъекта. || [[String255|bs:String255]] || 0..1
|-
| '''ogrn''' || ОГРН субъекта. || [[String255|bs:String255]] || 0..1
|-
| [[#Объект ..Response/businessEntityList/businessEntity/juridicalAddress|'''juridicalAddress''']] || Юридический адрес. Обязательным является указание идентификатора страны, региона и текстового представления адреса. Желательным является указание адреса в виде идентификаторов компонентов адреса: страна, регион, район, населенный пункт, улица.. || [[Address|ikar:Address]] || 0..1
|}
 
===Объект [[#Объект getBusinessEntityChangesListResponse|..Response]]/[[#Объект ..Response/businessEntityList|businessEntityList]]/[[#Объект ..Response/businessEntityList/businessEntity|businessEntity]]/'''incorporationForm'''===
 
Объект содержит данные об организационно-правовой форме хозяйствующего субъекта.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Уникальный идентификатор версии записи ОПФ согласно классификатору. || [[UUID|bs:UUID]] || 0..1
|-
| '''name''' || Название организационно-правовой формы. || [[String255|bs:String255]] || 0..1
|}


===Объект [[#Объект getBusinessEntityChangesListResponse|..Response]]/[[#Объект ..Response/businessEntityList|businessEntityList]]/[[#Объект ..Response/businessEntityList/businessEntity|businessEntity]]/'''juridicalAddress'''===
===Объект [[#Объект getBusinessEntityChangesListResponse|..Response]]/[[#Объект ..Response/businessEntityList|businessEntityList]]/[[#Объект ..Response/businessEntityList/businessEntity|businessEntity]]/'''juridicalAddress'''===
Строка 276: Строка 224:
|}
|}


===Объект[[#Объект getBusinessEntityChangesListResponse|..Response]]/[[#Объект ..Response/businessEntityList|businessEntityList]]/[[#Объект ..Response/businessEntityList/businessEntity|businessEntity]]/[[#Объект ..Response/businessEntityList/businessEntity/juridicalAddress|juridicalAddress]]/'''street'''===
===Объект [[#Объект getBusinessEntityChangesListResponse|..Response]]/[[#Объект ..Response/businessEntityList|businessEntityList]]/[[#Объект ..Response/businessEntityList/businessEntity|businessEntity]]/[[#Объект ..Response/businessEntityList/businessEntity/juridicalAddress|juridicalAddress]]/'''street'''===


Объект, содержащий данные об улице.
Объект, содержащий данные об улице.
Строка 303: Строка 251:
==Пример запроса==
==Пример запроса==
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Запрос списка хозяйствующих субъектов.
Запрос на получение данных о трех первых хозяйствующих субъектах, изменённых за период с 01.06.2016 по текущий день, без смещения.
<div class = "mw-collapsible-content">
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<syntaxhighlight lang="xml">
Строка 439: Строка 387:
</div>
</div>
</div>
</div>
[[Category:Ветис.API]]
[[Category:EnterpriseService]]
[[Category:Реестры]]

Текущая версия на 08:36, 16 декабря 2016

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

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

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

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

  • параметры выводимого списка;
  • период, за который необходимо получить изменения.

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

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

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

Объект getBusinessEntityChangesListRequest

Корневой объект запроса. По умолчанию содержит параметры запрашиваемого списка.

Поле Описание Тип данных Обязательность
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

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

Объект getBusinessEntityChangesListResponse

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

Поле Описание Тип Обязательность
businessEntityList Объект, описывающий список хозяйствующих субъектов. ent:BusinessEntityList 1

Объект ..Response/businessEntityList

Объект, описывающий свойства хозяйствующего субъекта.

Поле Описание Тип Обязательность
businessEntity Объект, описывающий поля хозяйствующего субъекта. ent:BusinessEntity 0..*

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

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

Объект ..Response/businessEntityList/businessEntity

Объект описывает свойства хозяйствующего субъекта.

Поле Описание Тип Обязательность
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
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

Объект ..Response/businessEntityList/businessEntity/juridicalAddress

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

Поле Описание Тип данных Обязательность
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
enAddressView Текстовое представление адреса на английском языке. bs:String255 1

Объект ..Response/businessEntityList/businessEntity/juridicalAddress/country

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

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

Объект ..Response/businessEntityList/businessEntity/juridicalAddress/region

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

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

Объект ..Response/businessEntityList/businessEntity/juridicalAddress/district

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

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

Объект ..Response/businessEntityList/businessEntity/juridicalAddress/locality

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

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

Объект ..Response/businessEntityList/businessEntity/juridicalAddress/sublocality

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

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

Объект ..Response/businessEntityList/businessEntity/juridicalAddress/street

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

Поле Описание Тип данных Обязательность
GUID Глобальный идентификатор улицы в реестре Россельхознадзора. bs:UUID 0..1
name Название улицы. bs:String255 0..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/business-entity/ws-definitions" 
                  xmlns:base="http://api.vetrf.ru/schema/cdm/base">
  <soapenv:Header/>
  <soapenv:Body>
    <ws:getBusinessEntityChangesListRequest>
      <base:listOptions>
        <base:count>3</base:count>
        <base:offset>0</base:offset>
      </base:listOptions>
      <base:updateDateInterval>
        <base:beginDate>2016-06-01</base:beginDate>
        <base:endDate></base:endDate>
      </base:updateDateInterval>
    </ws:getBusinessEntityChangesListRequest>
  </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:getBusinessEntityChangesListResponse 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/business-entity/ws-definitions">
      <ent:businessEntityList count="3" total="1403" offset="0">
        <ent:businessEntity>
          <bs:uuid>05582fbc-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
          <bs:guid>fd464254-218a-11e2-a69b-b499babae7ea</bs:guid>
          <bs:active>false</bs:active>
          <bs:last>false</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2010-11-24T14:38:17+03:00</bs:createDate>
          <bs:updateDate>2016-10-05T09:48:07+03:00</bs:updateDate>
          <bs:next>b1571269-9970-48e6-94d8-746bbe2ca295</bs:next>
          <ent:type>1</ent:type>
          <ent:incorporationForm/>
          <ent:fullName>ООО "САНТА+"</ent:fullName>
          <ent:inn>7814124079</ent:inn>
          <ent:juridicalAddress>
            <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>Санкт-Петербург, ул. Генерала Хрулева, д. 7</ikar:addressView>
          </ent:juridicalAddress>
        </ent:businessEntity>
        <ent:businessEntity>
          <bs:uuid>0592d090-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
          <bs:guid>fd832e24-218a-11e2-a69b-b499babae7ea</bs:guid>
          <bs:active>false</bs:active>
          <bs:last>false</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2011-04-09T20:41:54+03:00</bs:createDate>
          <bs:updateDate>2016-11-28T10:54:42+03:00</bs:updateDate>
          <bs:next>07bdb89a-8780-4427-a741-edf22b44185a</bs:next>
          <ent:type>1</ent:type>
          <ent:name>"Восток Бизнес Trade"</ent:name>
          <ent:incorporationForm/>
          <ent:juridicalAddress>
            <ikar:country>
              <bs:uuid>546d3d07-45bc-7195-b725-07d6e837929d</bs:uuid>
              <bs:guid>d90bf64b-8f06-9921-7964-97e08b7114af</bs:guid>
              <ikar:name>Казахстан</ikar:name>
            </ikar:country>
            <ikar:region>
              <bs:uuid>95e29810-947d-1028-9e20-7b3a2c050981</bs:uuid>
              <bs:guid>78ea28ed-724d-f28a-f070-c3a74918c66b</bs:guid>
              <ikar:name>Восточно-Казахстанская область</ikar:name>
            </ikar:region>
            <ikar:district/>
            <ikar:locality/>
            <ikar:subLocality/>
            <ikar:street/>
            <ikar:addressView>Р.Казахстан ВКО г.Усть-Каменогорск ул.Кирова 44</ikar:addressView>
          </ent:juridicalAddress>
        </ent:businessEntity>
        <ent:businessEntity>
          <bs:uuid>05d628f4-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
          <bs:guid>fdd7fd3f-218a-11e2-a69b-b499babae7ea</bs:guid>
          <bs:active>false</bs:active>
          <bs:last>false</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2011-09-23T13:59:00+03:00</bs:createDate>
          <bs:updateDate>2016-11-22T14:19:44+03:00</bs:updateDate>
          <bs:next>e2147a65-35ea-4308-8639-9130c9295e45</bs:next>
          <ent:type>1</ent:type>
          <ent:incorporationForm/>
          <ent:fullName>ООО "Дымовское колбасное производство"</ent:fullName>
          <ent:inn>7731178578</ent:inn>
          <ent:kpp>774850001</ent:kpp>
          <ent:ogrn>1027700053446</ent:ogrn>
          <ent:juridicalAddress>
            <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>5c8b06f1-518e-496e-b683-7bf917e0d70b</bs:uuid>
              <bs:guid>0c5b2444-70a0-4932-980c-b4dc0d3f02b5</bs:guid>
              <ikar:name>г. Москва</ikar:name>
            </ikar:region>
            <ikar:district/>
            <ikar:locality/>
            <ikar:subLocality/>
            <ikar:street/>
            <ikar:addressView>121614, ул. Крылатская, д.37</ikar:addressView>
          </ent:juridicalAddress>
        </ent:businessEntity>
      </ent:businessEntityList>
    </ws:getBusinessEntityChangesListResponse>
  </S:Body>
</soapenv:Envelope>
Источник — http://help.vetrf.ru/index.php?title=GetBusinessEntityChangesList&oldid=19219