GetBusinessEntityList

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

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

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

xs (http://www.w3.org/2001/XMLSchema) xs:boolean xs:dateTime xs:string xs:integer xs:nonNegativeInteger

ent (http://api.vetrf.ru/schema/cdm/cerberus/enterprise) ent:BusinessEntityList ent:BusinessEntity bs (http://api.vetrf.ru/schema/cdm/base) bs:UUID bs:ListOptions

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

• параметры выводимого списка;
• поля, по которым осуществляется фильтрация хозяйствующих субъектов.

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

• список хозяйствующих субъектов.

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

Объект getBusinessEntityListRequest

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

Поле	Описание	Тип данных	Обязательность
businessEntity	Объект, содержащий в себе данные о юридическом лице.	ent:BusinessEntity	0..1

Объект ..Request/businessEntity

Объект содержащий данные о хозяйствующем субъекте. Здесь указаны только те поля, по которым может осуществляться фильтрация в сервисе. Полное описание объекта можно найти на странице BusinessEntity.

Поле	Описание	Тип	Обязательность
name	Название хозяйствующего субъекта.	bs:String255	0..1
fullName	Полное наименование хоз.субъекта с указанием ОПФ так, как оно значится в ЕГРЮЛ/ЕГРИП.	bs:String255	0..1
fio	ФИО. Обязательно при создании ИП.	bs:String255	0..1
inn	ИНН хозяйствующего субъекта.	bs:String255	0..1
ogrn	ОГРН хозяйствующего субъекта.	bs:String255	0..1

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

Объект getBusinessEntityListResponse

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

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

Объект ..Response/businessEntityList

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

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

Атрибуты списка 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
createDate	Дата создания записи.	xs:dateTime	1
updateDate	Дата обновления записи.	xs:dateTime	1
previous	Ссылка на индентификатор предыдущей версии записи.	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..*

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

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