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

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


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


===Используемые пространства имён и типы===
===Используемые пространства имён и типы===
Строка 10: Строка 10:
** [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
** [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
** [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime]
** [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime]
 
*[[NameSpaces#http://api.vetrf.ru/schema/cdm/ikar|ikar]] (<nowiki>http://api.vetrf.ru/schema/cdm/ikar</nowiki>)
**[[Address|ikar:Address]]
**[[Country|ikar:Country]]
**[[Region|ikar:Region]]
{{столбец}}
*[[NameSpaces#http://api.vetrf.ru/schema/cdm/ikar|ikar]] (<nowiki>http://api.vetrf.ru/schema/cdm/ikar</nowiki>)
**[[District|ikar:District]]
**[[Locality|ikar:Locality]]
**[[Street|ikar:Street]]
* [[NameSpaces#http://api.vetrf.ru/schema/cdm/base|bs]] (<nowiki>http://api.vetrf.ru/schema/cdm/base</nowiki>)
** [[UUID|bs:UUID]]
** [[String255|bs:String255]]


{{столбец}}
{{столбец}}
Строка 16: Строка 27:
** [[BusinessEntity|ent:BusinessEntity]]
** [[BusinessEntity|ent:BusinessEntity]]
** [[ActivityLocation|ent:ActivityLocation]]
** [[ActivityLocation|ent:ActivityLocation]]
{{столбец}}
** [[BusinessEntityType|ent:BusinessEntityType]]
* [[NameSpaces#http://api.vetrf.ru/schema/cdm/base|bs]] (<nowiki>http://api.vetrf.ru/schema/cdm/base</nowiki>)
** [[IncorporationForm|ent:IncorporationForm]]
** [[UUID|bs:UUID]]
** [[ActivityLocation|ent:ActivityLocation]]
** [[Enterprise|ent:Enterprise]]
{{столбцы/конец}}
 
===[[#Объект getBusinessEntityByUuidRequest|Входные данные]]===
* уникальный идентификатор версии записи хозяйствующего субъекта.
 
===[[#Объект getBusinessEntityByUuidResponse|Выходные данные]]===
* хозяйствующий субъект с указанным уникальным идентификатором версии записи.


*[[NameSpaces#http://api.vetrf.ru/schema/cdm/ikar|ikar]] (<nowiki>http://api.vetrf.ru/schema/cdm/ikar</nowiki>)
**[[Address|ikar:Address]]
{{столбцы/конец}}


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


===Объект getBusinessEntityByGuidRequest===
===Объект getBusinessEntityByUuidRequest===


Корневой объект запроса. Содержит уникальный глобальный идентификатор хозяйствующего субъекта.
Корневой объект запроса. Содержит уникальный глобальный идентификатор хозяйствующего субъекта.
Строка 47: Строка 63:
! Поле !! Описание !! Тип !! Обязательность
! Поле !! Описание !! Тип !! Обязательность
|-
|-
| [[#Объект ..Response/businessEntity|'''businessEntity''']] || Объект, описывающий свойства хозяйствующего субъекта || [[BusinessEntity|ent:BusinessEntity]] || 1
| [[#Объект ..Response/businessEntity|'''businessEntity''']] || Объект, описывающий свойства хозяйствующего субъекта. || [[BusinessEntity|ent:BusinessEntity]] || 1
|}
|}




===Объект [[#Объект getBusinessEntityByGuidResponse|..Response]]/businessEntity===
===Объект [[#Объект getBusinessEntityByGuidResponse|..Response]]/'''businessEntity'''===


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


{| class="wikitable"
{| class="wikitable"
Строка 61: Строка 77:
| '''UUID''' || Идентификатор версии записи хозяйствующего субъекта (юридического лица). || [[UUID|bs:UUID]] || 1
| '''UUID''' || Идентификатор версии записи хозяйствующего субъекта (юридического лица). || [[UUID|bs:UUID]] || 1
|-
|-
| '''GUID''' || Глобальный идентификатор хозяйствующего субъекта в реестре РСХН. || [[UUID|bs:UUID]] || 1
| '''GUID''' || Глобальный идентификатор хозяйствующего субъекта в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|-
|-
| '''active''' || Флаг, показывающий активна ли запись. || [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 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
| '''last''' || Флаг, показывающий последняя ли версия записи.  
* В данной операции всегда true.
|| [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
|-
|-
| '''createDate''' || Дата создания записи. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
| '''createDate''' || Дата создания записи. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
Строка 71: Строка 89:
| '''updateDate''' || Дата обновления записи. Если данные объекта не менялись, то дата обновления совпадает с датой создания. || [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
| '''previous''' || Ссылка на идентификатор предыдущей версии записи. || [[UUID|bs:UUID]] || 0..1
|-
| '''next''' || Сссылка на идентификатор следующей версии записи || [[UUID|bs:UUID]] || 0..1
|-
|-
| '''type''' || Тип предприятия.  
| '''type''' || Тип хозяйствующего субъекта.  
* 1 - юридическое лицо
* 1 - юридическое лицо
* 2 - физическое лицо
* 2 - физическое лицо
* 3 - индивидуальный предприниматель
* 3 - индивидуальный предприниматель.
|| [[BusinessEntityType|ent:BusinessEntityType]] || 0..1
|| [[BusinessEntityType|ent:BusinessEntityType]] || 0..1
|-
|-
| '''name''' || Название предприятия. || [[String255|bs:String255]] || 0..1
| '''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
| '''fullName''' || Полное наименование хоз.субъекта с указанием ОПФ так, как оно значится в ЕГРЮЛ/ЕГРИП. || [[String255|bs:String255]] || 0..1
|-
|-
| '''fio''' || ФИО. Указывается при создании индивидуального предпринимателя || [[String255|bs:String255]] || 0..1
| '''fio''' || ФИО. Указывается при создании индивидуального предпринимателя. || [[String255|bs:String255]] || 0..1
|-
|-
| '''passport''' || Номер паспорта. || [[String255|bs:String255]] || 0..1
| '''passport''' || Номер паспорта. || [[String255|bs:String255]] || 0..1
Строка 97: Строка 113:
| '''ogrn''' || ОГРН субъекта. || [[String255|bs:String255]] || 0..1
| '''ogrn''' || ОГРН субъекта. || [[String255|bs:String255]] || 0..1
|-
|-
| '''juridicalAddress''' || Юридический адрес. Обязательным является указание идентификатора страны, региона и текстового представления адреса. Желательным является указание адреса в виде идентификаторов компонентов адреса: страна, регион, район, населенный пункт, улица.. || [[Address|ikar:Address]] || 0..1
| [[#Объект ..Response/businessEntity/juridicalAddress|'''juridicalAddress''']] || Юридический адрес. Возвращается в виде объектов системы Икар. || [[Address|ikar:Address]] || 0..1
|-
| [[#Объект ..Response/businessEntity/activityLocation|'''activityLocation''']] || Предприятие, на котором ХС осуществляет свою деятельность. || [[ActivityLocation|ent:ActivityLocation]] || 0..*
|}
 
===Объект [[#Объект getBusinessEntityByUuidResponse|..Response]]/[[#Объект ..Response/businessEntity|businessEntity]]/'''incorporationForm'''===
 
Объект содержит данные об организационно-правовой форме хозяйствующего субъекта.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Уникальный идентификатор версии записи ОПФ согласно классификатору. || [[UUID|bs:UUID]] || 0..1
|}
 
===Объект [[#Объект getBusinessEntityByUuidResponse|..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/locality|'''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
|}
 
===Объект [[#Объект getBusinessEntityByUuidResponse|..Response]]/[[#Объект ..Response/businessEntity|businessEntity]]/[[#Объект ..Response/businessEntity/juridicalAddress|juridicalAddress]]/'''country'''===
 
Объект, содержащий данные страны.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Уникальный идентификатор версии записи в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор страны в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|-
| '''name''' || Название страны. || [[String255|bs:String255]] || 1
|}
 
===Объект [[#Объект getBusinessEntityByUuidResponse|..Response]]/[[#Объект ..Response/businessEntity|businessEntity]]/[[#Объект ..Response/businessEntity/juridicalAddress|juridicalAddress]]/'''region'''===
 
Объект, содержащий данные о регионе или городе федерального значения.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Уникальный идентификатор версии записи в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор региона или города федерального значения в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|-
| '''name''' || Название региона или города федерального значения. || [[String255|bs:String255]] || 1
|}
 
===Объект [[#Объект getBusinessEntityByUuidResponse|..Response]]/[[#Объект ..Response/businessEntity|businessEntity]]/[[#Объект ..Response/businessEntity/juridicalAddress|juridicalAddress]]/'''district'''===
 
Объект, содержащий данные о районе региона.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Уникальный идентификатор версии записи в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 0..1
|-
| '''GUID''' || Глобальный идентификатор района в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 0..1
|-
| '''name''' || Название района. || [[String255|bs:String255]] || 0..1
|}
 
===Объект [[#Объект getBusinessEntityByUuidResponse|..Response]]/[[#Объект ..Response/businessEntity|businessEntity]]/[[#Объект ..Response/businessEntity/juridicalAddress|juridicalAddress]]/'''locality'''===
 
Объект, содержащий данные о населённом пункте региона.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''GUID''' || Глобальный идентификатор населённого пункта в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 0..1
|-
| '''name''' || Название населённого пункта. || [[String255|bs:String255]] || 0..1
|}
 
===Объект [[#Объект getBusinessEntityByUuidResponse|..Response]]/[[#Объект ..Response/businessEntity|businessEntity]]/[[#Объект ..Response/businessEntity/juridicalAddress|juridicalAddress]]/'''sublocality'''===
 
Объект, содержащий данные о населённом пункте, подчинённом другому населённому пункту.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''GUID''' || Глобальный идентификатор населённого пункта в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 0..1
|-
| '''name''' || Название населённого пункта. || [[String255|bs:String255]] || 0..1
|}
 
===Объект [[#Объект getBusinessEntityByUuidResponse|..Response]]/[[#Объект ..Response/businessEntity|businessEntity]]/[[#Объект ..Response/businessEntity/juridicalAddress|juridicalAddress]]/'''street'''===
 
Объект, содержащий данные об улице.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''GUID''' || Глобальный идентификатор улицы в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 0..1
|-
| '''name''' || Название улицы. || [[String255|bs:String255]] || 0..1
|}
 
===Объект [[#Объект getBusinessEntityByUuidResponse|..Response]]/[[#Объект ..Response/businessEntity|businessEntity]]/'''activityLocation'''===
Объект содержит данные о предприятии, на котором осуществляет свою деятельность хозяйствующий субъект.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Response/businessEntity/activityLocation/enterprise|'''enterprise''']] || Объект, описывающий площадку, на которой ХС осуществляет деятельность. || [[Enterprise|ent:Enterprise]] || 1
|}
 
===Объект [[#Объект getBusinessEntityByUuidResponse|..Response]]/[[#Объект ..Response/businessEntity|businessEntity]]/[[#Объект ..Response/businessEntity/activityLocation|activityLocation]]/'''enterprise'''===
Объект содержит идентификаторы записей площадки (предприятия), на которой хозяйствующий субъект осуществляет деятельность.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Уникальный идентификатор версии записи предприятия в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|-
|-
| '''activityLocation''' || Название предприятия. || [[ActivityLocation|ent:ActivityLocation]] || 0..*
| '''GUID''' || Уникальный глобальный идентификатор записи предприятия в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|}
|}

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

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

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

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

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

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

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

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


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

Объект 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
Источник — http://help.vetrf.ru/index.php?title=GetBusinessEntityByUUID&oldid=18768