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

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

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

Операция 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-элемента	Тип	Обязат.	Описание (нажмите [...] для отображения дополнительного описания)
001	<ws:getBusinessEntityChangesListResponse>
002	···<dt:businessEntityList total="2" offset="0" count="2">	dt:BusinessEntityList	[1..1]	Список хозяйствующих субъектов. total - всего записей; offset - смещение относительно первого элемента; count - количество выводимых записей.
003	······<dt:businessEntity>	dt:BusinessEntity	[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>230</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:type>1</dt:type>	dt:BusinessEntityType	[1..1]	Тип создаваемого или редактируемого хозяйствующего субъекта. 1 - юридическое лицо; 2 - физическое лицо; 3 - индивидуальный предприниматель.
014	·········<dt:name>Наименование ХС</dt:name>	bs:String255	[0..1]	Наименование хозяйствующего субъекта без указания организационно-правовой формы. Возвращается только для юридических лиц. Для физических лиц и для индивидуальных предпринимателей поле не возвращается.
015	·········<dt:incorporationForm>	dt:IncorporationForm	[1..1]	Организационно-правовая форма хозяйствующего субъекта.
016	············<bs:uuid>UUID</bs:uuid>	bs:UUID	[1..1]	Идентификатор версии организационно-правовой формы.
017	············<dt:name>Название ОПФ</dt:name>	bs:String255	[1..1]	Название организационно-правовой формы предприятия. согласно справочнику ОКОПФ.
018	············<dt:code>12300</dt:code>	bs:String255	[1..1]	Код организационно-правовой формы предприятия. согласно справочнику ОКОПФ.
019	············<dt:shortName>Краткое название ОПФ</dt:shortName>	bs:String255	[0..1]	Краткое название организационно-правовой формы предприятия.
020	·········</dt:incorporationForm>
021	·········<dt:fullName>Полное наименование ХС</dt:fullName>	bs:String255	[0..1]	Полное наименование хозяйствующего субъекта. с указанием ОПФ так, как оно значится в ЕГРЮЛ/ЕГРИП.
022	·········<dt:fio>Иванов Иван Иванович</dt:fio>	bs:String255	[0..1]	ФИО физического лица или индивидуального предпринимателя. Для юридических лиц поле не возвращается.
023	·········<dt:inn>3312200096</dt:inn>	bs:String255	[0..1]	ИНН хозяйствующего субъекта.
024	·········<dt:kpp>163501001</dt:kpp>	bs:String255	[0..1]	Код причины постановки на учет (КПП).
025	·········<dt:ogrn>4085022240002</dt:ogrn>	bs:String255	[0..1]	ОГРН или ОГРНИП. Для ИП ОГРНИП может быть не указано.
026	·········<dt:juridicalAddress>	dt:Address	[1..1]	Юридический адрес. адрес, по которому зарегистрирован хозяйствующий субъект.
027	············<dt:country>	dt:Country	[1..1]	Страна.
028	···············<bs:uuid>UUID</bs:uuid>	bs:UUID	[1..1]	Уникальный идентификатор страны. в соответствии со справочником РСХН.
029	···············<bs:guid>GUID</bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор страны. в соответствии со справочником РСХН.
030	···············<dt:name>Страна</dt:name>	bs:String255	[1..1]	Наименование страны. в соответствии со справочником РСХН.
031	············</dt:country>
032	············<dt:region>	dt:Region	[1..1]	Регион.
033	···············<bs:uuid>UUID</bs:uuid>	bs:UUID	[1..1]	Уникальный идентификатор региона страны. в соответствии со справочником РСХН.
034	···············<bs:guid>GUID</bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор региона страны. в соответствии со справочником РСХН.
035	···············<dt:name>Регион</dt:name>	bs:String255	[1..1]	Наименование региона страны. в соответствии со справочником РСХН.
036	············</dt:region>
037	············<dt:district>	dt:Locality	[0..1]	Район региона.
038	···············<bs:uuid>UUID</bs:uuid>	bs:UUID	[1..1]	Уникальный идентификатор района региона. в соответствии со справочником РСХН.
039	···············<bs:guid>GUID</bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор района региона. в соответствии со справочником РСХН.
040	···············<dt:name>Район</dt:name>	bs:String255	[1..1]	Наименование района региона. в соответствии со справочником РСХН.
041	············</dt:district>
042	············<dt:locality>	dt:Locality	[0..1]	Населённый пункт.
043	···············<bs:uuid>UUID</bs:uuid>	bs:UUID	[1..1]	Уникальный идентификатор города региона (города регионального подчинения) страны. в соответствии со справочником РСХН.
044	···············<bs:guid>GUID</bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор города региона (города регионального подчинения) страны. в соответствии со справочником РСХН.
045	···············<dt:name>Город</dt:name>	bs:String255	[1..1]	Наименование города региона (города регионального подчинения) страны. в соответствии со справочником РСХН.
046	············</dt:locality>
047	············<dt:subLocality>	dt:Locality	[0..1]	Населённый пункт, подчиненный другогому населенному пункту (locality).
048	···············<bs:uuid>UUID</bs:uuid>	bs:UUID	[1..1]	Уникальный идентификатор населенного пункта. в соответствии со справочником РСХН.
049	···············<bs:guid>GUID</bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор населенного пункта. в соответствии со справочником РСХН.
050	···············<dt:name>Населенный пункт</dt:name>	bs:String255	[1..1]	Наименование населенного пункта. в соответствии со справочником РСХН.
051	············</dt:subLocality>
052	············<dt:street>	dt:Street	[0..1]	Улица.
053	···············<bs:uuid>UUID</bs:uuid>	bs:UUID	[1..1]	Уникальный идентификатор улицы города страны. в соответствии со справочником РСХН.
054	···············<bs:guid>GUID</bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор улицы города. в соответствии со справочником РСХН.
055	···············<dt:name>Улица</dt:name>	bs:String255	[1..1]	Наименование улицы города. в соответствии со справочником РСХН.
056	············</dt:street>
057	············<dt:house>0</dt:house>	bs:String255	[0..1]	Номер дома.
058	············<dt:building>0</dt:building>	bs:String255	[0..1]	Номер строения.
059	············<dt:room>0</dt:room>	bs:String255	[0..1]	Номер квартиры / офиса.
060	············<dt:postIndex>000000</dt:postIndex>	bs:String255	[0..1]	Почтовый индекс.
061	············<dt:postBox>х/х 00</dt:postBox>	bs:String255	[0..1]	Абонентский ящик.
062	············<dt:additionalInfo>Доп. инфо</dt:additionalInfo>	bs:String255	[0..1]	Дополнительная информация.
063	············<dt:addressView>Адрес</dt:addressView>	bs:String255	[0..1]	Строковое представление адреса.
064	·········</dt:juridicalAddress>
065	······</dt:businessEntity>
066	···</dt:businessEntityList>
067	</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>

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