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

Версия 09:32, 30 ноября 2016

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

Операция GetBusinessEntityByUUID предназначена для получения версии записи хозяйствующего субъекта по её уникальному идентификатору. В общем случае запись может быть не актуальной и не последней (active=false, last=false).

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

xs (http://www.w3.org/2001/XMLSchema)
- xs:boolean
- xs:dateTime
ikar (http://api.vetrf.ru/schema/cdm/ikar)

ikar (http://api.vetrf.ru/schema/cdm/ikar)
bs (http://api.vetrf.ru/schema/cdm/base)
- bs:UUID
- bs:String255

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

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

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

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

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

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

Объект getBusinessEntityByUuidRequest

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

Поле	Описание	Тип данных	Обязательность
UUID	Идентификатор версии записи.	bs:UUID	1

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

Объект getBusinessEntityByUuidResponse

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

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

Объект ..Response/businessEntity

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

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

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

Объект содержит данные об организационно-правовой форме хозяйствующего субъекта.

Поле	Описание	Тип данных	Обязательность
UUID	Уникальный идентификатор версии записи ОПФ согласно классификатору.	bs:UUID	0..1

Объект ..Response/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/businessEntity/juridicalAddress/country

Объект, содержащий данные страны.

Поле	Описание	Тип данных	Обязательность
UUID	Уникальный идентификатор версии записи в реестре Россельхознадзора.	bs:UUID	1
GUID	Глобальный идентификатор страны в реестре Россельхознадзора.	bs:UUID	1
name	Название страны.	bs:String255	1

Объект ..Response/businessEntity/juridicalAddress/region

Объект, содержащий данные о регионе или городе федерального значения.

Поле	Описание	Тип данных	Обязательность
UUID	Уникальный идентификатор версии записи в реестре Россельхознадзора.	bs:UUID	1
GUID	Глобальный идентификатор региона или города федерального значения в реестре Россельхознадзора.	bs:UUID	1
name	Название региона или города федерального значения.	bs:String255	1

Объект ..Response/businessEntity/juridicalAddress/district

Объект, содержащий данные о районе региона.

Поле	Описание	Тип данных	Обязательность
UUID	Уникальный идентификатор версии записи в реестре Россельхознадзора.	bs:UUID	0..1
GUID	Глобальный идентификатор района в реестре Россельхознадзора.	bs:UUID	0..1
name	Название района.	bs:String255	0..1

Объект ..Response/businessEntity/juridicalAddress/locality

Объект, содержащий данные о населённом пункте региона.

Поле	Описание	Тип данных	Обязательность
GUID	Глобальный идентификатор населённого пункта в реестре Россельхознадзора.	bs:UUID	0..1
name	Название населённого пункта.	bs:String255	0..1

Объект ..Response/businessEntity/juridicalAddress/sublocality

Объект, содержащий данные о населённом пункте, подчинённом другому населённому пункту.

Поле	Описание	Тип данных	Обязательность
GUID	Глобальный идентификатор населённого пункта в реестре Россельхознадзора.	bs:UUID	0..1
name	Название населённого пункта.	bs:String255	0..1

Объект ..Response/businessEntity/juridicalAddress/street

Объект, содержащий данные об улице.

Поле	Описание	Тип данных	Обязательность
GUID	Глобальный идентификатор улицы в реестре Россельхознадзора.	bs:UUID	0..1
name	Название улицы.	bs:String255	0..1

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

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

Поле	Описание	Тип данных	Обязательность
enterprise	Объект, описывающий площадку, на которой ХС осуществляет деятельность.	ent:Enterprise	1

Объект ..Response/businessEntity/activityLocation/enterprise

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

Поле	Описание	Тип данных	Обязательность
UUID	Уникальный идентификатор версии записи предприятия в реестре Россельхознадзора.	bs:UUID	1
GUID	Уникальный глобальный идентификатор записи предприятия в реестре Россельхознадзора.	bs:UUID	1

@@ Строка 65: / Строка 65: @@
 | [[#Объект ..Response/businessEntity|'''businessEntity''']] || Объект, описывающий свойства хозяйствующего субъекта. || [[BusinessEntity|ent:BusinessEntity]] || 1
 |}
 ===Объект [[#Объект getBusinessEntityByGuidResponse|..Response]]/'''businessEntity'''===