GetBusinessEntityByUUID

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

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

Операция 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 Флаг, показывающий последняя ли версия записи. 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
type Тип хозяйствующего субъекта.
  • 1 - юридическое лицо;
  • 2 - физическое лицо;
  • 3 - индивидуальный предприниматель.
 ent:BusinessEntityType 1
name Название хозяйствующего субъекта (юридического лица). bs:String255 0..1
incorporationForm Организационно-правовая форма в соответствии с общероссийским классификатором ОПФ. ent:IncorporationForm 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 1

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

Описание ошибок

Ошибка Описание
InternalServiceFault Внутренняя ошибка сервиса.
IncorrectRequestFault Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям, указанным в xsd.
EntityNotFoundFault Объект с заданными параметрами не найден в базе.

Пример запроса

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
                  xmlns:ws="http://api.vetrf.ru/schema/cdm/cerberus/business-entity/ws-definitions" 
                  xmlns:base="http://api.vetrf.ru/schema/cdm/base">
  <soapenv:Header/>
  <soapenv:Body>
    <ws:getBusinessEntityByUuidRequest>
      <base:uuid>b1571269-9970-48e6-94d8-746bbe2ca295</base:uuid>
    </ws:getBusinessEntityByUuidRequest>
  </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:getBusinessEntityByUuidResponse 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/business-entity/ws-definitions">
      <ent:businessEntity>
        <bs:uuid>b1571269-9970-48e6-94d8-746bbe2ca295</bs:uuid>
        <bs:guid>fd464254-218a-11e2-a69b-b499babae7ea</bs:guid>
        <bs:active>true</bs:active>
        <bs:last>true</bs:last>
        <bs:status>200</bs:status>
        <bs:createDate>2016-10-05T09:48:07+03:00</bs:createDate>
        <bs:updateDate>2016-10-05T09:48:07+03:00</bs:updateDate>
        <bs:previous>05582fbc-053d-11e1-99b4-d8d385fbc9e8</bs:previous>
        <ent:type>1</ent:type>
        <ent:incorporationForm>
          <bs:uuid>f381ed23-8afd-447b-8c45-652a1d6c2d0b</bs:uuid>
        </ent:incorporationForm>
        <ent:fullName>ООО "САНТА+"</ent:fullName>
        <ent:inn>7814124079</ent:inn>
        <ent:kpp/>
        <ent:ogrn>1027807565961</ent:ogrn>
        <ent:juridicalAddress>
          <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>
            <ikar:name/>
          </ikar:locality>
          <ikar:subLocality>
            <ikar:name/>
          </ikar:subLocality>
          <ikar:street>
            <bs:guid>372c6c6b-6ccd-4d5e-af34-d95ee77c7e25</bs:guid>
            <ikar:name>Генерала Хрулева ул.</ikar:name>
          </ikar:street>
          <ikar:house/>
          <ikar:building/>
          <ikar:room/>
          <ikar:postIndex/>
          <ikar:postBox/>
          <ikar:addressView>Российская Федерация, г. Санкт-Петербург, Генерала Хрулева ул.</ikar:addressView>
        </ent:juridicalAddress>
        <ent:activityLocation>
          <ent:enterprise>
            <bs:uuid>0762aa12-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
            <bs:guid>3560d237-8c42-abce-9bb3-d4d48b4d2130</bs:guid>
          </ent:enterprise>
        </ent:activityLocation>
      </ent:businessEntity>
    </ws:getBusinessEntityByGuidResponse>
  </S:Body>
</soapenv:Envelope>
Источник — http://help.vetrf.ru/index.php?title=GetBusinessEntityByUUID&oldid=19233