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

Версия 23:09, 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

Объект ..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

@@ Строка 113: / Строка 113: @@
 |-
 | '''UUID''' || Уникальный идентификатор версии записи ОПФ согласно классификатору. || [[UUID|bs:UUID]] || 0..1
+|}
+===Объект [[#Объект getBusinessEntityByGuidResponse|..Response]]/[[#Объект ..Response/businessEntity|businessEntity]]/'''juridicalAddress'''===
+Объект содержит адрес хозяйствующего субъекта, представленный в виде объектов системы Икар.
+{| class="wikitable"
+|-
+! Поле !! Описание !! Тип данных !! Обязательность
+|-
+| [[#Объект ..Response/businessEntity/juridicalAddress/country|'''country''']] || Страна, где зарегистрирован хозяйствующий субъект. || [[Country|ikar:Country]] || 1
+|-
+| [[#Объект ..Response/businessEntity/juridicalAddress/region|'''region''']] || Регион страны.  || [[Region|ikar:Region]] || 1
+|-
+| [[#Объект ..Response/businessEntity/juridicalAddress/district|'''district''']] || Район региона. || [[District|ikar:District]] || 1
+|-
+| [[#Объект ..Response/businessEntity/juridicalAddress/locaity|'''locality''']] || Населённый пункт. || [[Locality|ikar:Locality]] || 1
+|-
+| [[#Объект ..Response/businessEntity/juridicalAddress/sublocality|'''sublocality''']] || Населённый пункт, подчинённый населённому пункту. || [[Locality|ikar:Locality]] || 1
+|-
+| [[#Объект ..Response/businessEntity/juridicalAddress/street|'''street''']] || Улица в населённом пункте. || [[Street|ikar:Street]] || 1
+|-
+| '''house''' || Дом, строение. || [[String255|bs:String255]] || 0..1
+|-
+| '''building''' || Строение. || [[String255|bs:String255]] || 0..1
+|-
+| '''room''' || Помещение (офис, квартира и т.п.) || [[String255|bs:String255]] || 0..1
+|-
+| '''postIndex''' || Почтовый индекс. || [[String255|bs:String255]] || 0..1
+|-
+| '''postBox''' || Абонентский ящик. || [[String255|bs:String255]] || 0..1
+|-
+| '''addressView''' || Текстовое представление адреса. || [[String255|bs:String255]] || 1
+|-
+| '''enAddressView''' || Текстовое представление адреса на английском языке. || [[String255|bs:String255]] || 1
 |}