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

Версия 23:08, 29 ноября 2016

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

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

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

xs (http://www.w3.org/2001/XMLSchema)
- xs:boolean
- xs:dateTime

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

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

ikar (http://api.vetrf.ru/schema/cdm/ikar)
- ikar:Address

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

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

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

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

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

Объект getBusinessEntityByGuidRequest

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

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

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

Объект getBusinessEntityByGuidResponse

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

Поле	Описание	Тип	Обязательность
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

@@ Строка 87: / Строка 87: @@
 | '''name''' || Название хозяйствующего субъекта. || [[String255|bs:String255]] || 0..1
 |-
-| '''incorporationForm''' || Организационно-правовая форма в соответствии с общероссийским классификатором ОПФ. || [[IncorporationForm|ent:IncorporationForm]] || 0..1
+| [[#Объект ..Response/businessEntity/incorporationForm|'''incorporationForm''']] || Организационно-правовая форма в соответствии с общероссийским классификатором ОПФ. || [[IncorporationForm|ent:IncorporationForm]] || 0..1
 |-
 | '''fullName''' || Полное наименование хоз.субъекта с указанием ОПФ так, как оно значится в ЕГРЮЛ/ЕГРИП. || [[String255|bs:String255]] || 0..1
@@ Строка 101: / Строка 101: @@
 | '''ogrn''' || ОГРН субъекта. || [[String255|bs:String255]] || 0..1
 |-
-| '''juridicalAddress''' || Юридический адрес. Обязательным является указание идентификатора страны, региона и текстового представления адреса. Желательным является указание адреса в виде идентификаторов компонентов адреса: страна, регион, район, населенный пункт, улица. || [[Address|ikar:Address]] || 0..1
+| [[#Объект ..Response/businessEntity/juridicalAddress|'''juridicalAddress''']] || Юридический адрес. Возвращается в виде объектов системы Икар. || [[Address|ikar:Address]] || 0..1
 |-
-| '''activityLocation''' || Список площадок, на которых ХС осуществляет свою деятельность. || [[ActivityLocation|ent:ActivityLocation]] || 0..*
+| [[#Объект ..Response/businessEntity/activityLocation|'''activityLocation''']] || Предприятие, на котором ХС осуществляет свою деятельность. || [[ActivityLocation|ent:ActivityLocation]] || 0..*
 |}