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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 123: Строка 123:
| [[#Объект ..Response/enterprise/address/street|'''street''']] || Улица. || [[Street|ikar:Street]] || 0..1
| [[#Объект ..Response/enterprise/address/street|'''street''']] || Улица. || [[Street|ikar:Street]] || 0..1
|-
|-
| '''house''']] || Дом.|| [[String255|bs:String255]] || 0..1
| '''house''' || Дом.|| [[String255|bs:String255]] || 0..1
|-
|-
| '''building''']] || Строение. || [[String255|bs:String255]] || 0..1
| '''building'''|| Строение. || [[String255|bs:String255]] || 0..1
|-
|-
| '''room''']] || Помещение, квартира, офис. || [[String255|bs:String255]] || 0..1
| '''room''' || Помещение, квартира, офис. || [[String255|bs:String255]] || 0..1
|-
|-
| '''postIndex''']] || Почтовый индекс. || [[String255|bs:String255]] || 0..1
| '''postIndex''' || Почтовый индекс. || [[String255|bs:String255]] || 0..1
|-
|-
| '''postBox''']] || Абонентский ящик. || [[String255|bs:String255]] || 0..1
| '''postBox'''|| Абонентский ящик. || [[String255|bs:String255]] || 0..1
|-
|-
| '''addressView''']] || Текстовое представление адреса. || [[String255|bs:String255]] || 0..1
| '''addressView''' || Текстовое представление адреса. || [[String255|bs:String255]] || 0..1
|-
|-
| '''enAddressView''']] || Текстовое представление адреса на английском языке. || [[String255|bs:String255]] || 0..1
| '''enAddressView''' || Текстовое представление адреса на английском языке. || [[String255|bs:String255]] || 0..1
|}
|}

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

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

Операция 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