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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 47: Строка 47:
! Тип
! Тип
! Обязат.
! Обязат.
! Описание
! Описание (нажмите [...] для отображения дополнительного описания)
! Пример
|-
|-
|1
|001
|style="font-weight: bold; font-family: Courier;" |<ws:getBusinessEntityChangesListRequest>
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getBusinessEntityChangesListRequest>'''}}
|
|
|
|
|
| style="width:52em;"|  
|style="font-family: Courier;" |
|-
|-
|2
|002
|style="font-weight: bold; font-family: Courier;" |···<bs:listOptions>
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|bs:}}listOptions>'''}}
|[[ListOptions|bs:ListOptions]]
|[[ListOptions|bs:ListOptions]]
|[0..1]
|[0..1]
|Параметры запрашиваемого списка.
| style="width:52em;"| Параметры запрашиваемого списка.
|style="font-family: Courier;" |
|-
|-
|3
|003
|style="font-weight: bold; font-family: Courier;" |······<bs:count>
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}count>'''}}{{color|#131313|10}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}count>'''}}
|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
|[0..1]
|[0..1]
|Максимальное запрашиваемое количество объектов в списке.
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Максимальное запрашиваемое количество объектов в списке.
</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* По умолчанию значение 100;
* По умолчанию значение 100;
* Максимально возможное значение 1000.
* Максимально возможное значение 1000.</div>
|style="font-family: Courier;" |<bs:count>10</bs:count>
</div>
|-
|-
|4
|004
|style="font-weight: bold; font-family: Courier;" |······<bs:offset>
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}offset>'''}}{{color|#131313|2}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}offset>'''}}
|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
|[0..1]
|[0..1]
|Номер элемента, по которому осуществляется смещение первого элемента списка.  
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
* По умолчанию значение 0.
<span style="white-space:nowrap; font-weight: normal;">Номер элемента, по которому осуществляется смещение первого элемента списка.  
|style="font-family: Courier;" |<bs:offset>2</bs:offset>
</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* По умолчанию значение 0.</div>
</div>
|-
|-
|5
|005
|style="font-weight: bold; font-family: Courier;" |···</bs:listOptions>
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|bs:}}listOptions>'''}}
|
|
|
|
|
|style="font-family: Courier;" |
| style="width:52em;"|  
|-
|-
|6
|006
|style="font-weight: bold; font-family: Courier;" |···<bs:updateDateInterval>
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|bs:}}updateDateInterval>'''}}
|[[DataInterval|bs:DataInterval]]
|[[DataInterval|bs:DataInterval]]
|[1..1]
|[1..1]
| Интервал времени обновления.  
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
* В список попадают все записи, дата обновлений которых попадает в указанный интервал.
<span style="white-space:nowrap; font-weight: normal;"> Интервал времени обновления.  
|style="font-family: Courier;" |
</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* В список попадают все записи, дата обновлений которых попадает в указанный интервал.</div>
</div>
|-
|-
|7
|007
|style="font-weight: bold; font-family: Courier;" |······<bs:beginDate>
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}beginDate>'''}}{{color|#131313|2017-07-07T00:00:00}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}beginDate>'''}}
|[http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime]
|[http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime]
|[1..1]
|[1..1]
| Начало временного интервала.
| style="width:52em;"| Начало временного интервала.
|style="font-family: Courier;" |<bs:beginDate>2017-07-07T00:00:00</bs:beginDate>
|-
|-
|8
|008
|style="font-weight: bold; font-family: Courier;" |······<bs:endDate>
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}endDate>'''}}{{color|#131313|2017-07-25T00:00:00}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}endDate>'''}}
|[http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime]
|[http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime]
|[0..1]
|[0..1]
|Конец временного интервала.
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
* Текущий день, если не указано
<span style="white-space:nowrap; font-weight: normal;">Конец временного интервала.
|style="font-family: Courier;" |<bs:endDate>2017-07-25T00:00:00</bs:endDate>
</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* Текущий день, если не указано.</div>
</div>
|-
|-
|9
|009
|style="font-weight: bold; font-family: Courier;" |···</bs:updateDateInterval>
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|bs:}}updateDateInterval>'''}}
|
|
|
|
|
|style="font-family: Courier;" |
| style="width:52em;"|  
|-
|-
|10
|010
|style="font-weight: bold; font-family: Courier;" |</ws:getBusinessEntityChangesListRequest>
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getBusinessEntityChangesListRequest>'''}}
|
|
|
|
|
|style="font-family: Courier;" |
| style="width:52em;"|  
|-
|-
|}
|}

Версия 14:51, 8 ноября 2020

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

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

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

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

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

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

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getBusinessEntityChangesListRequest>
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 ···<bs:updateDateInterval> bs:DataInterval [1..1]

Интервал времени обновления.

  • В список попадают все записи, дата обновлений которых попадает в указанный интервал.
007 ······<bs:beginDate>2017-07-07T00:00:00</bs:beginDate> xs:dateTime [1..1] Начало временного интервала.
008 ······<bs:endDate>2017-07-25T00:00:00</bs:endDate> xs:dateTime [0..1]

Конец временного интервала.

  • Текущий день, если не указано.
009 ···</bs:updateDateInterval>
010 </ws:getBusinessEntityChangesListRequest>

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

# Название XML-элемента Тип Обязат. Описание Пример
1 <ws:getBusinessEntityChangesListResponse>
2 ···<dt:businessEntityList count="10" total="1000" offset="0"> dt:BusinessEntityList [1..1] Список хозяйствующих субъектов
  • total - всего записей;
  • offset - смещение относительно первого элемента;
  • count - количество выводимых записей.
3 ······<dt:businessEntity> dt:BusinessEntity [1..1] Данные о хозяйствующем субъекте.
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>230</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:type> dt:BusinessEntityType [1..1] Тип создаваемого или редактируемого хозяйствующего субъекта:
  • 1 - юридическое лицо;
  • 2 - физическое лицо;
  • 3 - индивидуальный предприниматель.
<dt:type>1</dt:type>
14 ·········<dt:name> bs:String255 [0..1] Наименование хозяйствующего субъекта без указания организационно-правовой формы.
  • Возвращается только для юридических лиц.
  • Для физических лиц и для индивидуальных предпринимателей поле не возвращается.
<dt:name>Гладиолус</dt:name>
15 ·········<dt:incorporationForm> dt:IncorporationForm [1..1] Организационно-правовая форма хозяйствующего субъекта.
16 ············<bs:uuid> bs:UUID [1..1] Идентификатор версии организационно-правовой формы <bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
17 ············<dt:name> bs:String255 [1..1] Название организационно-правовой формы предприятия согласно справочнику ОКОПФ. <dt:name>Общество с ограниченной ответственностью</dt:name>
18 ············<dt:code> bs:String255 [1..1] Код организационно-правовой формы предприятия согласно справочнику ОКОПФ. <dt:code>12300</dt:code>
19 ············<dt:shortName> bs:String255 [0..1] Краткое название организационно-правовой формы предприятия. <dt:shortName>ООО</dt:shortName>
20 ·········</dt:incorporationForm>
21 ·········<dt:fullName> bs:String255 [0..1] Полное наименование хозяйствующего субъекта с указанием ОПФ так, как оно значится в ЕГРЮЛ/ЕГРИП. <dt:fullName>Общество с ограниченной ответственностью "Гладиолус"</dt:fullName>
22 ·········<dt:fio> bs:String255 [0..1] ФИО физического лица или индивидуального предпринимателя.
  • Для юридических лиц поле не возвращается.
<dt:fio>Иванов Сергей Петрович</dt:fio>
23 ·········<dt:inn> bs:String255 [0..1] ИНН хозяйствующего субъекта. <dt:inn>3312200096</dt:inn>
24 ·········<dt:kpp> bs:String255 [0..1] Код причины постановки на учет (КПП). <dt:kpp>163501001</dt:kpp>
25 ·········<dt:ogrn> bs:String255 [0..1] ОГРН или ОГРНИП.
  • Для ИП ОГРНИП может быть не указано.
<dt:ogrn>4085022240002</dt:ogrn>
26 ·········<dt:juridicalAddress> dt:Address [1..1] Юридический адрес - адрес, по которому зарегистрирован хозяйствующий субъект.
27 ············<dt:country> dt:Country [1..1] Страна
28 ···············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор страны в соответствии со справочником РСХН. <bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
29 ···············<bs:guid> bs:UUID [1..1] Глобальный идентификатор страны в соответствии со справочником РСХН. <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
30 ···············<dt:name> bs:String255 [1..1] Наименование страны в соответствии со справочником РСХН. <dt:name>Российская Федерация</dt:name>
31 ············</dt:country>
32 ············<dt:region> dt:Region [1..1] Регион
33 ···············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор региона страны в соответствии со справочником РСХН. <bs:uuid>e440dcdb-31d6-39a4-db63-a1c0731d61d6</bs:uuid>
34 ···············<bs:guid> bs:UUID [1..1] Глобальный идентификатор региона страны в соответствии со справочником РСХН. <bs:guid>cbdf8cb6-fb9a-4f36-36d3-04488f6d1b82</bs:guid>
35 ···············<dt:name> bs:String255 [1..1] Наименование региона страны в соответствии со справочником РСХН. <dt:name>Владимирская область</dt:name>
36 ············</dt:region>
37 ············<dt:district> dt:Locality [0..1] Район региона
38 ···············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор района региона в соответствии со справочником РСХН. <bs:uuid>3cb373d5-32f1-ac2a-754c-58d4b33825dd</bs:uuid>
39 ···············<bs:guid> bs:UUID [1..1] Глобальный идентификатор района региона в соответствии со справочником РСХН. <bs:guid>90d82878-431a-0cf1-0974-16d4fdff3bc8</bs:guid>
40 ···············<dt:name> bs:String255 [1..1] Наименование района региона в соответствии со справочником РСХН. <dt:name>Собинский район</dt:name>
41 ············</dt:district>
42 ············<dt:locality> dt:Locality [0..1] Населённый пункт
43 ···············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор города региона (города регионального подчинения) страны в соответствии со справочником РСХН. <bs:uuid>70db962b-d3f3-9a13-93d1-f83a9bc6ed80</bs:uuid>
44 ···············<bs:guid> bs:UUID [1..1] Глобальный идентификатор города региона (города регионального подчинения) страны в соответствии со справочником РСХН. <bs:guid>a16545f3-8f9c-2778-099f-a5d302e58712</bs:guid>
45 ···············<dt:name> bs:String255 [1..1] Наименование города региона (города регионального подчинения) страны в соответствии со справочником РСХН. <dt:name>Владимир г</dt:name>
46 ············</dt:locality>
47 ············<dt:subLocality> dt:Locality [0..1] Населённый пункт, подчиненный другогому населенному пункту (locality)
48 ···············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор населенного пункта в соответствии со справочником РСХН. <bs:uuid>3a7b2d0c-2ebd-0dff-9e93-341097ee1db3</bs:uuid>
49 ···············<bs:guid> bs:UUID [1..1] Глобальный идентификатор населенного пункта в соответствии со справочником РСХН. <bs:guid>9f315346-b470-3a1c-56d0-ae1afe9579df</bs:guid>
50 ···············<dt:name> bs:String255 [1..1] Наименование населенного пункта в соответствии со справочником РСХН. <dt:name>Энергетик мкрн</dt:name>
51 ············</dt:subLocality>
52 ············<dt:street> dt:Street [0..1] Улица
53 ···············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор улицы города страны в соответствии со справочником РСХН. <bs:uuid>90d82878-431a-0cf1-0974-16d4fdff3bc8</bs:uuid>
54 ···············<bs:guid> bs:UUID [1..1] Глобальный идентификатор улицы города в соответствии со справочником РСХН. <bs:guid>b014d26b-5391-c852-caa4-60fc9bb0a7d4</bs:guid>
55 ···············<dt:name> bs:String255 [1..1] Наименование улицы города в соответствии со справочником РСХН. <dt:name>Энергетиков ул</dt:name>
56 ············</dt:street>
57 ············<dt:house> bs:String255 [0..1] Номер дома. <dt:house>6</dt:house>
58 ············<dt:building> bs:String255 [0..1] Номер строения. <dt:building>1</dt:building>
59 ············<dt:room> bs:String255 [0..1] Номер квартиры / офиса. <dt:room>1</dt:room>
60 ············<dt:postIndex> bs:String255 [0..1] Почтовый индекс. <dt:postIndex>600037</dt:postIndex>
61 ············<dt:postBox> bs:String255 [0..1] Абонентский ящик <dt:postBox>а/я 56</dt:postBox>
62 ············<dt:additionalInfo> bs:String255 [0..1] Дополнительная информация. <dt:additionalInfo>Доп. инфо</dt:additionalInfo>
63 ············<dt:addressView> bs:String255 [0..1] Строковое представление адреса. <dt:addressView>Российская Федерация, Владимирская обл., г. Владимир, ул. Ленина ул., д. 44</dt:addressView>
64 ·········</dt:juridicalAddress>
65 ······</dt:businessEntity>
66 ···</dt:businessEntityList>
67 </ws:getBusinessEntityChangesListResponse>

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

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

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

Запрос на получение данных о 100 первых хозяйствующих субъектах, изменённых за период с 20.10.2017 по текущий день без смещения.

<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">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:getBusinessEntityChangesListRequest>
         <bs:listOptions>
            <bs:count>100</bs:count>
            <bs:offset>0</bs:offset>
         </bs:listOptions>
         <bs:updateDateInterval>
            <bs:beginDate>2017-10-20T00:00:00</bs:beginDate>
         </bs:updateDateInterval>    
      </ws:getBusinessEntityChangesListRequest>
   </soapenv:Body>
</soapenv:Envelope>


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