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

Версия 21:29, 29 ноября 2016

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

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

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

xs (http://www.w3.org/2001/XMLSchema)

ent (http://api.vetrf.ru/schema/cdm/cerberus/enterprise)

bs (http://api.vetrf.ru/schema/cdm/base)

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

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

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

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

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

Объект 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	1

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

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

Поле	Описание	Тип	Обязательность
UUID	Идентификатор версии записи хозяйствующего субъекта (юридического лица).	bs:UUID	1
GUID	Глобальный идентификатор хозяйствующего субъекта в реестре Россельхознадзора.	bs:UUID	1
active	Флаг, показывающий активна ли запись.	xs:boolean	1
last	Флаг, показывающий последняя ли версия записи.	xs:boolean	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	0..1
name	Название предприятия.	bs:String255	0..1
incorporationForm	Организационно-правовая форма в соответствии с общероссийским классификатором	ent:IncorporationForm	0..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	0..1
activityLocation	Название предприятия.	ent:ActivityLocation	0..*

@@ Строка 46: / Строка 46: @@
 |}
-===Объект [[#Объект getBusinessEntityChangesListRequest|..Request]]/listOptions===
+===Объект [[#Объект getBusinessEntityChangesListRequest|..Request]]/'''listOptions'''===
 Объект содержит параметры запрашиваемого списка продукции.
@@ Строка 55: / Строка 55: @@
 | '''count''' || Количество значений в списке
 * По умолчанию значение равно 100;
-* Максимально допустимое значение равно 1000
+* Максимально допустимое значение равно 1000.
 || [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
 |-
-| '''offset''' || Смещение в списке относительно начала || [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
+| '''offset''' || Смещение в списке относительно начала. || [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
 |}
-===Объект [[#Объект getBusinessEntityChangesListRequest|..Request]]/updateDateInterval===
+===Объект [[#Объект getBusinessEntityChangesListRequest|..Request]]/'''updateDateInterval'''===
 Объект содержит данные об интервале дат, за которые происходили изменения.
@@ Строка 72: / Строка 72: @@
 |-
 | '''endDate''' || Конечная дата интервала
-* Если конечная дата не указана, то по умолчанию используется текущая дата
+* Если конечная дата не указана, то по умолчанию используется текущая дата.
 || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 0..1
 |}
@@ Строка 86: / Строка 86: @@
 ! Поле !! Описание !! Тип !! Обязательность
 |-
-| [[#Объект ..Response/businessEntityList|'''businessEntityList''']] || Объект, описывающий список хозсубъектов || [[BusinessEntityList|ent:BusinessEntityList]] || 1
+| [[#Объект ..Response/businessEntityList|'''businessEntityList''']] || Объект, описывающий список хозяйствующих субъектов. || [[BusinessEntityList|ent:BusinessEntityList]] || 1
 |}
-===Объект [[#Объект getBusinessEntityChangesListResponse|..Response]]/businessEntityList===
+===Объект [[#Объект getBusinessEntityChangesListResponse|..Response]]/'''businessEntityList'''===
-Объект, описывающий список хозяйствующих субъектов
+Объект, описывающий список хозяйствующих субъектов.
 {| class="wikitable"
@@ Строка 97: / Строка 97: @@
 ! Поле !! Описание !! Тип !! Обязательность
 |-
-| [[#Объект ..Response/businessEntityList/businessEntity|'''businessEntity''']] || Объект, описывающий хозсубъект || [[BusinessEntity|ent:BusinessEntity]] || 1
+| [[#Объект ..Response/businessEntityList/businessEntity|'''businessEntity''']] || Объект, описывающий хозсубъект. || [[BusinessEntity|ent:BusinessEntity]] || 1
 |}
-===Объект [[#Объект getBusinessEntityChangesListResponse|..Response]]/[[#Объект ..Response/businessEntityList|businessEntityList]]/businessEntity===
+===Объект [[#Объект getBusinessEntityChangesListResponse|..Response]]/[[#Объект ..Response/businessEntityList|businessEntityList]]/'''businessEntity'''===
-Объект описывает свойства хозяйствующего субъеткта
+Объект описывает свойства хозяйствующего субъекта.
 {| class="wikitable"
@@ Строка 110: / Строка 110: @@
 | '''UUID''' || Идентификатор версии записи хозяйствующего субъекта (юридического лица). || [[UUID|bs:UUID]] || 1
 |-
-| '''GUID''' || Глобальный идентификатор хозяйствующего субъекта в реестре РСХН. || [[UUID|bs:UUID]] || 1
+| '''GUID''' || Глобальный идентификатор хозяйствующего субъекта в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
 |-
 | '''active''' || Флаг, показывающий активна ли запись. || [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1