GetEnterpriseByUuid
Общие сведения
Операция GetEnterpriseByUuid предназначена для получения версии записи предприятия по её уникальному идентификатору. В общем случае запись может быть не последней и/или не активной (last=false, active=false). Выполнение операции заканчивается либо возвратом записи предприятия, либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
Используемые пространства имён и типы
|
|
Входные данные
- уникальный идентификатор версии записи предприятия.
Выходные данные
- данные о предприятии.
Данные запроса
Объект getEnterpriseByUuidRequest
Корневой объект запроса. Содержит уникальный идентификатор версии записи предприятия.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
UUID | Уникальный идентификатор версии записи предприятия в реестре Россельхознадзора. | bs:UUID | 1 |
Данные ответа
Объект getEnterpriseByUuidResponse
Корневой объект ответа. Содержит список запрашиваемое предприятие.
Поле | Описание | Тип | Обязательность |
---|---|---|---|
enterprise | Объект, описывающий свойства предприятия. | ent:Enterprise | 1 |
Объект ..Response/enterprise
Объект описывает свойства предприятия.
Поле | Описание | Тип | Обязательность |
---|---|---|---|
UUID | Идентификатор версии записи предприятия. | bs:UUID | 1 |
GUID | Глобальный идентификатор предприятия в реестре Россельхознадзора. | bs:UUID | 1 |
active | Флаг, показывающий активна ли запись. | xs:boolean | 1 |
last | Флаг, показывающий является ли версия записи последней. | xs:boolean | 1 |
status | Статус версии записи. | bs:VersionStatus | 1 |
createDate | Дата создания записи. | xs:dateTime | 1 |
updateDate | Дата обновления записи. Если данные объекта не менялись, то дата обновления совпадает с датой создания. | xs:dateTime | 1 |
previous | Идентификатор предыдущей версии записи. | bs:UUID | 0..1 |
next | Идентификатор следующей версии записи. | bs:UUID | 0..1 |
name | Название предприятия. | bs:String255 | 1 |
englishName | Название предприятия на английском языке. | bs:String255 | 0..1 |
type | Тип предприятия согласно классификации в Меркурии:
|
ent:EnterpriseType | 1 |
numberList | Список номеров предприятия. | ent:EnterpriseNumberList | 0..1 |
address | Адрес предприятия. | ikar:Address | 1 |
activityList | Виды деятельности, осуществляемые предприятием. | ent:EnterpriseActivityList | 1 |
owner | ХС-владелец. | ent:BusinessEntity | 0..1 |
Объект ..Response/enterprise/numberList
Объект, содержащий список номеров предприятия.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
enterpriseNumber | Номер предприятия. | bs:String255 | 0..* |
Атрибуты списка numberList
Атрибут | Описание | Тип данных | Обязательность |
---|---|---|---|
count | Количество элементов списка, запрашиваемое или переданное. | xs:int | 1 |
total | Общий размер списка. | xs:long | 1 |
offset | Смещение первого элемента списка относительно его начала. | xs:int | 1 |
Объект ..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 |
Объект ..Response/enterprise/owner
Объект содержит идентификаторы хозяйствующего субъекта-собственника площадки.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
UUID | Уникальный идентификатор версии записи хозяйствующего субъекта. | bs:UUID | 1 |
GUID | Глобальный идентификатор записи хозяйствующего субъекта в реестре Россельхознадзора. | bs:UUID | 1 |
Описание ошибок
Ошибка | Описание |
---|---|
InternalServiceFault | Внутренняя ошибка сервиса. |
IncorrectRequestFault | Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям, указанным в xsd. |
EntityNotFoundFault | Объект с заданными параметрами не найден в базе. |
Пример запроса
Запрос предприятия по уникальному идентификатору версии записи.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://api.vetrf.ru/schema/cdm/cerberus/enterprise/ws-definitions"
xmlns:base="http://api.vetrf.ru/schema/cdm/base">
<soapenv:Header/>
<soapenv:Body>
<ws:getEnterpriseByUuidRequest>
<base:uuid>6f15ad56-0a28-4678-a8ef-a182a3fbf449</base:uuid>
</ws:getEnterpriseByUuidRequest>
</soapenv:Body>
</soapenv:Envelope>
Ответ на запрос.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<ws:getEnterpriseByUuidResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base"
xmlns:ikar="http://api.vetrf.ru/schema/cdm/ikar"
xmlns:ent="http://api.vetrf.ru/schema/cdm/cerberus/enterprise"
xmlns:ws="http://api.vetrf.ru/schema/cdm/cerberus/enterprise/ws-definitions">
<ent:enterprise>
<bs:uuid>6f15ad56-0a28-4678-a8ef-a182a3fbf449</bs:uuid>
<bs:guid>06922180-9bb4-437a-a103-7ee253d11e93</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2016-11-16T10:31:49+03:00</bs:createDate>
<bs:updateDate>2016-11-16T10:31:49+03:00</bs:updateDate>
<ent:name>Совунья</ent:name>
<ent:type>1</ent:type>
<ent:address>
<ikar:country>
<bs:uuid>72a84b51-5c5e-11e1-b9b7-001966f192f1</bs:uuid>
<bs:guid>74a3cbb1-56fa-94f3-ab3f-e8db4940d96b</bs:guid>
<ikar:name>Российская Федерация</ikar:name>
</ikar:country>
<ikar:region>
<bs:uuid>aad1469e-54ff-4605-af4f-f016c75b84d2</bs:uuid>
<bs:guid>c2deb16a-0330-4f05-821f-1d09c93331e6</bs:guid>
<ikar:name>г. Санкт-Петербург</ikar:name>
</ikar:region>
<ikar:district/>
<ikar:locality>
<bs:guid>3c2827f3-63f3-4692-8c74-c1318ee524fd</bs:guid>
<ikar:name>г. Ломоносов</ikar:name>
</ikar:locality>
<ikar:subLocality/>
<ikar:street>
<bs:guid>cc9376fe-cc18-4b29-b5ae-40996a9fd769</bs:guid>
<ikar:name>Зеленая ул.</ikar:name>
</ikar:street>
<ikar:house>5</ikar:house>
<ikar:building/>
<ikar:room/>
<ikar:postIndex/>
<ikar:postBox/>
<ikar:addressView>Российская Федерация, г. Санкт-Петербург, г. Ломоносов, Зеленая ул., д. 5</ikar:addressView>
</ent:address>
<ent:activityList count="1" total="1" offset="0">
<ent:activity>
<ent:name>тестирование сов</ent:name>
</ent:activity>
</ent:activityList>
</ent:enterprise>
</ws:getEnterpriseByUuidResponse>
</S:Body>
</soapenv:Envelope>