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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 26: Строка 26:
==Данные запроса==
==Данные запроса==


===Объект getBusinessEntityListRequest===
===Объект getBusinessEntityChangesListRequest===


Корневой объект запроса. По умолчанию содержит описание объекта busineeEntity с полями, по которым пользователь может отфильтровать список хозяйствующих объектов. Объект businessEntity может и не указываться.
Корневой объект запроса. По умолчанию содержит параметры запрашиваемого списка.


{| class="wikitable"
{| class="wikitable"
Строка 34: Строка 34:
! Поле !! Описание !! Тип данных !! Обязательность
! Поле !! Описание !! Тип данных !! Обязательность
|-
|-
| '''businessEntity''' || Объект, содержащий в себе данные о юридическом лице || [[BusinessEntity|ent:BusinessEntity]] || 0..1
| [[#Объект ..Request/listOptions|'''listOptions''']] || Параметры запрашиваемого списка. || [[ListOptions|bs:ListOptions]] || 0..1
|-
| [[#Объект ..Request/updateDateInterval|'''updateDateInterval''']] || Интервал дат, за который выбираются изменения. || [[DateInterval|bs:DateInterval]] || 1
|}
|}




===Объект [[#Объект getBusinessEntityListRequest|..Request]]/businessEntity===
===Объект [[#Объект getBusinessEntityChangesListRequest|..Request]]/listOptions===
 
Объект содержащий данные о хозяйствующем субъекте. Здесь указаны только те поля, по которым может осуществляться фильтрация в сервисе. Полное описание объекта можно найти либо в ответе, либо на странице [[BusinessEntity]]


Объект содержит параметры запрашиваемого списка продукции.
{| class="wikitable"
{| class="wikitable"
|-
|-
! Поле !! Описание !! Тип !! Обязательность
! Поле !! Описание !! Тип данных !! Обязательность
|-
|-
| '''type''' || Тип предприятия.
| '''count''' || Количество значений в списке
* 1 - юридическое лицо
* По умолчанию значение равно 100;
* 2 - физическое лицо
* Максимально допустимое значение равно 1000
* 3 - индивидуальный предприниматель
|| [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
|| [[BusinessEntityType|ent:BusinessEntityType]] || 0..1
|-
|-
| '''name''' || Название предприятия. || [[String255|bs:String255]] || 0..1
| '''offset''' || Смещение в списке относительно начала || [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
|}
 
===Объект [[#Объект getBusinessEntityChangesListRequest|..Request]]/'''updateDateInterval'''===
 
Объект содержит данные об интервале дат, за которые происходили изменения.
 
{| class="wikitable"
|-
|-
| '''incorporationForm''' || Организационно-правовая форма в соответствии с общероссийским классификатором || [[IncorporationForm|ent:IncorporationForm]] || 0..1
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''fullName''' || Полное наименование хоз.субъекта с указанием ОПФ так, как оно значится в ЕГРЮЛ/ЕГРИП. || [[String255|bs:String255]] || 0..1
|-
| '''fio''' || ФИО. Обязательно при создании ИП || [[String255|bs:String255]] || 0..1
|-
|-
| '''inn''' ||ИНН субъекта. || [[String255|bs:String255]] || 0..1
| '''beginDate''' || Начальная дата интервала || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
|-
|-
| '''ogrn''' || ОГРН субъекта. || [[String255|bs:String255]] || 0..1
| '''endDate''' || Конечная дата интервала
|-
* Если конечная дата не указана, то по умолчанию используется текущая дата
| '''juridicalAddress''' || Юридический адрес. Обязательным является указание идентификатора страны, региона и текстового представления адреса. Желательным является указание адреса в виде идентификаторов компонентов адреса: страна, регион, район, населенный пункт, улица.. || [[Address|ikar:Address]] || 0..1
|| [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 0..1
|}
|}


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

Версия 15:44, 28 октября 2016

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

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

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

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

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

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

Объект getBusinessEntityListResponse

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

Поле Описание Тип Обязательность
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..*
Источник — http://help.vetrf.ru/index.php?title=GetBusinessEntityChangesList&oldid=17826