GetEnterpriseByGuid

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

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

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

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


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

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

  • глобальный уникальный идентификатор предприятия.

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

  • данные о предприятии.

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

Объект getEnterpriseByGuidRequest

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

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

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

Объект getEnterpriseByGuidResponse

Корневой объект ответа. Содержит данные запрашиваемого предприятия.

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

Объект ..Response/enterprise

Объект описывает свойства предприятия.

Поле Описание Тип Обязательность
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
name Название предприятия. bs:String255 1
englishName Название предприятия на английском языке. bs:String255 0..1
type Тип российского предприятия. ent:EnterpriseType 0..1
numberList Список номеров предприятия. ent:EnterpriseNumberList 0..1
address Адрес предприятия. ikar:Address 0..1
activityList Виды деятелности, осуществляемые предприятием. ent:EnterpriseActivityList 0..1
owner ХС-владелец. ent:BusinessEntity 0..1

Объект ..Response/enterprise/numberList

Объект, содержащий список номеров предприятия.

Поле Описание Тип данных Обязательность
enterpriseNumber Номер предприятия. bs:String255 0..*

Объект ..Response/enterprise/address

Объект содержит информацию об адресе, представленную в виде объектов системы Икар.

Поле Описание Тип данных Обязательность
country Страна, где находится предприятие. ikar:Country 1
region Регион страны, где находится предприятие. ikar:Region 1
district Район региона. ikar:District 0..1
locality Населённый пункт. ikar:Locality 0..1
sublocality Населённый пункт, подчинённый населённому пункту. ikar:Locality 0..1
street Улица. ikar:Street 0..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 0..1
enAddressView Текстовое представление адреса на английском языке. bs:String255 0..1

Объект ..Response/enterprise/address/country

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

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

Объект ..Response/enterprise/address/region

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

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

Объект ..Response/enterprise/address/district

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

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

Объект ..Response/enterprise/address/locality

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

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

Объект ..Response/enterprise/address/sublocality

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

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

Объект ..Response/enterprise/address/street

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

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

Объект ..Response/enterprise/activityList

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

Поле Описание Тип данных Обязательность
activity Объект, описывающий вид деятельности. ent:EnterpriseActivity 0..*

Объект ..Response/enterprise/activityList/activity

Объект содержит информацию о виде деятельности предприятия.

Поле Описание Тип данных Обязательность
name Название вида деятельности предприятия. bs:String255 1