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

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


===Объект [[#Объект getBusinessEntityResponse|..Response]]/[[#Объект ..Response/businessEntityList|businessEntityList]]/businessEntity===
===Объект [[#Объект getBusinessEntityResponse|..Response]]/[[#Объект ..Response/businessEntityList|businessEntityList]]/businessEntity===
Объект описывает свойства хозяйствующего субъеткта
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''UUID''' || Идентификатор версии записи хозяйствующего субъекта (юридического лица). || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор хозяйствующего субъекта в реестре РСХН. || [[UUID|bs:UUID]] || 1
|-
| '''active''' || Флаг, показывающий активна ли запись. || [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
|-
| '''last''' || Флаг, показывающий последняя ли версия записи. || [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
|-
| '''createDate''' || Дата создания записи. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
|-
| '''updateDate''' || Дата обновления записи. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
|-
| '''previous''' || Ссылка на индентификатор предыдущей версии записи  || [[UUID|bs:UUID]] || 0..1
|-
| '''next''' || Сссылка на идентификатор следующей версии записи || [[UUID|bs:UUID]] || 0..1
|-
| '''type''' || Тип предприятия.
* 1 - юридическое лицо
* 2 - физическое лицо
* 3 - индивидуальный предприниматель
|| [[BusinessEntityType|ent:BusinessEntityType]] || 0..1
|-
| '''name''' || Название предприятия. || [[String255|bs:String255]] || 0..1
|-
| '''incorporationForm''' || Организационно-правовая форма в соответствии с общероссийским классификатором || [[IncorporationForm|ent:IncorporationForm]] || 0..1
|-
| '''fullName''' || Полное наименование хоз.субъекта с указанием ОПФ так, как оно значится в ЕГРЮЛ/ЕГРИП. || [[String255|bs:String255]] || 0..1
|-
| '''fio''' || ФИО. Обязательно при создании ИП || [[String255|bs:String255]] || 0..1
|-
| '''passport''' || Номер паспорта. || [[String255|bs:String255]] || 0..1
|-
| '''inn''' ||ИНН субъекта. || [[String255|bs:String255]] || 0..1
|-
| '''kpp''' || КПП субъекта. || [[String255|bs:String255]] || 0..1
|-
| '''ogrn''' || ОГРН субъекта. || [[String255|bs:String255]] || 0..1
|-
| '''juridicalAddress''' || Юридический адрес. Обязательным является указание идентификатора страны, региона и текстового представления адреса. Желательным является указание адреса в виде идентификаторов компонентов адреса: страна, регион, район, населенный пункт, улица.. || [[Address|ikar:Address]] || 0..1
|-
| '''activityLocation''' || Название предприятия. || [[ActivityLocation|ent:ActivityLocation]] || 0..*
|}

Версия 14:59, 28 октября 2016

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

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

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

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

Объект getBusinessEntityListRequest

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

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


Объект ..Request/businessEntity

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

Поле Описание Тип Обязательность
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
inn ИНН субъекта. bs:String255 0..1
ogrn ОГРН субъекта. bs:String255 0..1
juridicalAddress Юридический адрес. Обязательным является указание идентификатора страны, региона и текстового представления адреса. Желательным является указание адреса в виде идентификаторов компонентов адреса: страна, регион, район, населенный пункт, улица.. ikar:Address 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..*