GetBusinessEntityList
Общие сведения
Операция GetBusinessEntityList предназначена для получения списка хозяйствующих субъектов из реестра Россельхознадзора. В список попадают только актуальные записи (active = true). Поддерживается возможность постраничного вывода и фильтрации по шаблону. Выполнение операции заканчивается либо возвратом списка хозяйствующих субъектов, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса.
Используемые пространства имён и типы
|
|
|
|
Входные данные
- параметры выводимого списка;
- поля, по которым осуществляется фильтрация хозяйствующих субъектов.
Выходные данные
- список хозяйствующих субъектов.
Данные запроса
Объект getBusinessEntityListRequest
Корневой объект запроса. По умолчанию содержит описание объекта businessEntity с полями, по которым пользователь может отфильтровать список хозяйствующих объектов. Объект businessEntity с полями поиска указывается опционально.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
listOptions | Параметры запрашиваемого списка. | bs:ListOptions | 0..1 |
businessEntity | Объект, содержащий в себе данные о юридическом лице. | ent:BusinessEntity | 0..1 |
Объект ..Request/listOptions
Объект содержит параметры запрашиваемого списка хозяйствующих объектов.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
count | Количество значений в списке.
|
xs:nonNegativeInteger | 0..1 |
offset | Смещение в списке относительно начала. | xs:nonNegativeInteger | 0..1 |
Объект ..Request/businessEntity
Объект содержащий данные о хозяйствующем субъекте. Здесь указаны только те поля, по которым может осуществляться фильтрация в сервисе. Полное описание объекта можно найти на странице BusinessEntity.
Поле | Описание | Тип | Обязательность |
---|---|---|---|
UUID | Уникальный идентификатор версии записи в реестре Россельхознадзора. | bs:UUID | 0..1 |
GUID | Глобальный идентификатор записи в реестре Россельхознадзора. | bs:UUID | 0..1 |
fullName | Полное наименование хоз.субъекта с указанием ОПФ так, как оно значится в ЕГРЮЛ/ЕГРИП. | bs:String255 | 0..1 |
fio | ФИО. Указывается при поиске ИП или физического лица. | bs:String255 | 0..1 |
inn | ИНН хозяйствующего субъекта. | bs:String255 | 0..1 |
ogrn | ОГРН хозяйствующего субъекта. | bs:String255 | 0..1 |
passport | Паспорт. Указывается при поиске ИП или физического лица. | bs:String255 | 0..1 |
Данные ответа
Объект getBusinessEntityListResponse
Корневой объект ответа. Содержит список запрашиваемых хозяйствующих субъектов.
Поле | Описание | Тип | Обязательность |
---|---|---|---|
businessEntityList | Объект, описывающий список хозяйствующих субъектов. | ent:BusinessEntityList | 1 |
Объект ..Response/businessEntityList
Объект, описывающий список хозяйствующих субъектов.
Поле | Описание | Тип | Обязательность |
---|---|---|---|
businessEntity | Объект, описывающий хозяйствующий субъект. | ent:BusinessEntity | 0..* |
Атрибуты списка 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 |
status | Текущий статус версии записи хозяйствующего субъекта в реестре Россельхознадзора. | bs:VersionStatus | 1 |
createDate | Дата создания записи. | xs:dateTime | 1 |
updateDate | Дата обновления записи. Если данные объекта не менялись, то дата обновления совпадает с датой создания. | xs:dateTime | 1 |
previous | Идентификатор предыдущей версии записи. | bs:UUID | 0..1 |
type | Тип хозяйствующего субъекта.
|
ent:BusinessEntityType | 1 |
name | Название хозяйствующего субъекта (юридического лица). | bs:String255 | 0..1 |
incorporationForm | Организационно-правовая форма в соответствии с общероссийским классификатором ОПФ. | ent:IncorporationForm | 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 | 1 |
Объект ..Response/businessEntityList/businessEntity/juridicalAddress
Объект содержит адрес хозяйствующего субъекта, представленный в виде объектов системы Икар.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
country | Страна, где зарегистрирован хозяйствующий субъект. | ikar:Country | 1 |
region | Регион страны. | ikar:Region | 1 |
district | Район региона. | ikar:District | 1 |
locality | Населённый пункт. | ikar:Locality | 1 |
sublocality | Населённый пункт, подчинённый населённому пункту. | ikar:Locality | 1 |
street | Улица в населённом пункте. | ikar:Street | 1 |
house | Дом, строение. | bs:String255 | 0..1 |
building | Строение. | bs:String255 | 0..1 |
room | Помещение (офис, квартира и т.п.) | bs:String255 | 0..1 |
postIndex | Почтовый индекс. | bs:String255 | 0..1 |
postBox | Абонентский ящик. | bs:String255 | 0..1 |
addressView | Текстовое представление адреса. | bs:String255 | 1 |
enAddressView | Текстовое представление адреса на английском языке. | bs:String255 | 1 |
Объект ..Response/businessEntityList/businessEntity/juridicalAddress/country
Объект, содержащий данные страны.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
UUID | Уникальный идентификатор версии записи в реестре Россельхознадзора. | bs:UUID | 1 |
GUID | Глобальный идентификатор страны в реестре Россельхознадзора. | bs:UUID | 1 |
name | Название страны. | bs:String255 | 1 |
Объект ..Response/businessEntityList/businessEntity/juridicalAddress/region
Объект, содержащий данные о регионе или городе федерального значения.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
UUID | Уникальный идентификатор версии записи в реестре Россельхознадзора. | bs:UUID | 1 |
GUID | Глобальный идентификатор региона или города федерального значения в реестре Россельхознадзора. | bs:UUID | 1 |
name | Название региона или города федерального значения. | bs:String255 | 1 |
Объект ..Response/businessEntityList/businessEntity/juridicalAddress/district
Объект, содержащий данные о районе региона.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
UUID | Уникальный идентификатор версии записи в реестре Россельхознадзора. | bs:UUID | 0..1 |
GUID | Глобальный идентификатор района в реестре Россельхознадзора. | bs:UUID | 0..1 |
name | Название района. | bs:String255 | 0..1 |
Объект ..Response/businessEntityList/businessEntity/juridicalAddress/locality
Объект, содержащий данные о населённом пункте региона.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
GUID | Глобальный идентификатор населённого пункта в реестре Россельхознадзора. | bs:UUID | 0..1 |
name | Название населённого пункта. | bs:String255 | 0..1 |
Объект ..Response/businessEntityList/businessEntity/juridicalAddress/sublocality
Объект, содержащий данные о населённом пункте, подчинённом другому населённому пункту.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
GUID | Глобальный идентификатор населённого пункта в реестре Россельхознадзора. | bs:UUID | 0..1 |
name | Название населённого пункта. | bs:String255 | 0..1 |
Объект..Response/businessEntityList/businessEntity/juridicalAddress/street
Объект, содержащий данные о улице.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
GUID | Глобальный идентификатор улицы в реестре Россельхознадзора. | bs:UUID | 0..1 |
name | Название улицы. | bs:String255 | 0..1 |
Описание ошибок
Ошибка | Описание |
---|---|
InternalServiceFault | Внутренняя ошибка сервиса. |
IncorrectRequestFault | Некорректный запрос. Возникает, если запрос не соответствует требованиям указанным в xsd. |
OffsetOutOfRangeFault | Заданный в запросе отступ больше числа записей в результате запроса. |
Пример запроса
Запрос первых трёх элементов списка хозяйствующих субъектов, без смещения.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://api.vetrf.ru/schema/cdm/cerberus/business-entity/ws-definitions"
xmlns:base="http://api.vetrf.ru/schema/cdm/base" xmlns:ent="http://api.vetrf.ru/schema/cdm/cerberus/enterprise"
xmlns:ikar="http://api.vetrf.ru/schema/cdm/ikar">
<soapenv:Header/>
<soapenv:Body>
<ws:getBusinessEntityListRequest>
<base:listOptions>
<base:count>3</base:count>
<base:offset>0</base:offset>
</base:listOptions>
</ws:getBusinessEntityListRequest>
</soapenv:Body>
</soapenv:Envelope>
Ответ на запрос.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<ws:getBusinessEntityListResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base"
xmlns:ikar="http://api.vetrf.ru/schema/cdm/ikar"
xmlns:ent="http://api.vetrf.ru/schema/cdm/cerberus/enterprise"
xmlns:ws="http://api.vetrf.ru/schema/cdm/cerberus/business-entity/ws-definitions">
<ent:businessEntityList count="3" total="119299" offset="0">
<ent:businessEntity>
<bs:uuid>04ac9102-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
<bs:guid>fcbeefad-218a-11e2-a69b-b499babae7ea</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2008-12-03T11:57:30+03:00</bs:createDate>
<bs:updateDate>2008-12-03T11:57:30+03:00</bs:updateDate>
<ent:type>1</ent:type>
<ent:incorporationForm/>
<ent:fullName>ООО "СовМясТорг"</ent:fullName>
<ent:inn>7801259544</ent:inn>
<ent:juridicalAddress>
<ikar:country>
<bs:uuid>72a84b51-5c5e-11e1-b9b7-001966f192f1</bs:uuid>
<bs:guid>74a3cbb1-56fa-94f3-ab3f-e8db4940d96b</bs:guid>
<ikar:name>Российская Федерация</ikar:name>
</ikar:country>
<ikar:region>
<bs:uuid>aad1469e-54ff-4605-af4f-f016c75b84d2</bs:uuid>
<bs:guid>c2deb16a-0330-4f05-821f-1d09c93331e6</bs:guid>
<ikar:name>г. Санкт-Петербург</ikar:name>
</ikar:region>
<ikar:district/>
<ikar:locality/>
<ikar:subLocality/>
<ikar:street/>
<ikar:addressView>199406, Санкт-Петербург, ул. Нахимова, д. 8/2</ikar:addressView>
</ent:juridicalAddress>
</ent:businessEntity>
<ent:businessEntity>
<bs:uuid>04ac931e-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
<bs:guid>fcbef34b-218a-11e2-a69b-b499babae7ea</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2008-12-03T16:45:02+03:00</bs:createDate>
<bs:updateDate>2008-12-03T16:45:02+03:00</bs:updateDate>
<ent:type>1</ent:type>
<ent:incorporationForm/>
<ent:fullName>ООО "Продсервис"</ent:fullName>
<ent:inn>7729432185</ent:inn>
<ent:juridicalAddress>
<ikar:country>
<bs:uuid>72a84b51-5c5e-11e1-b9b7-001966f192f1</bs:uuid>
<bs:guid>74a3cbb1-56fa-94f3-ab3f-e8db4940d96b</bs:guid>
<ikar:name>Российская Федерация</ikar:name>
</ikar:country>
<ikar:region>
<bs:uuid>5c8b06f1-518e-496e-b683-7bf917e0d70b</bs:uuid>
<bs:guid>0c5b2444-70a0-4932-980c-b4dc0d3f02b5</bs:guid>
<ikar:name>г. Москва</ikar:name>
</ikar:region>
<ikar:district/>
<ikar:locality/>
<ikar:subLocality/>
<ikar:street/>
<ikar:addressView>г. Москва, пр-т Вернадского, д.36</ikar:addressView>
</ent:juridicalAddress>
</ent:businessEntity>
<ent:businessEntity>
<bs:uuid>04ac940e-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
<bs:guid>fcbef59e-218a-11e2-a69b-b499babae7ea</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2008-12-03T17:37:55+03:00</bs:createDate>
<bs:updateDate>2008-12-03T17:37:55+03:00</bs:updateDate>
<ent:type>1</ent:type>
<ent:incorporationForm/>
<ent:fullName>ЗАО "Митлэнд"</ent:fullName>
<ent:inn>7816358675</ent:inn>
<ent:kpp/>
<ent:ogrn/>
<ent:juridicalAddress>
<ikar:country>
<bs:uuid>72a84b51-5c5e-11e1-b9b7-001966f192f1</bs:uuid>
<bs:guid>74a3cbb1-56fa-94f3-ab3f-e8db4940d96b</bs:guid>
<ikar:name>Российская Федерация</ikar:name>
</ikar:country>
<ikar:region>
<bs:uuid>aad1469e-54ff-4605-af4f-f016c75b84d2</bs:uuid>
<bs:guid>c2deb16a-0330-4f05-821f-1d09c93331e6</bs:guid>
<ikar:name>г. Санкт-Петербург</ikar:name>
</ikar:region>
<ikar:district/>
<ikar:locality/>
<ikar:subLocality/>
<ikar:street/>
<ikar:addressView>192236, Санкт-Петербург, ул. Софийская, д. 6, корп. 2, лит. А</ikar:addressView>
</ent:juridicalAddress>
</ent:businessEntity>
</ent:businessEntityList>
</ws:getBusinessEntityListResponse>
</S:Body>
</soapenv:Envelope>