GetBusinessEntityByUUID v2

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

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

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

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

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

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

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

Спецификация запроса

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getBusinessEntityByUuidRequest>
002 ···<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Идентификатор версии хозяйствующего субъекта.
003 </ws:getBusinessEntityByUuidRequest>

Спецификация ответа

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getBusinessEntityByUuidResponse>
002 ···<dt:businessEntity> dt:BusinessEntity [1..1] Данные о хозяйствующем субъекте.
003 ······<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Идентификатор версии хозяйствующего субъекта.
004 ······<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор хозяйствующего субъекта.
005 ······<bs:active>true</bs:active> xs:boolean [1..1]

Описывает, является ли запись активной.

  • true - запись активна;
  • false - запись не активна.
006 ······<bs:last>true</bs:last> xs:boolean [1..1]

Описывает, является ли версия записи последней.

  • true - да;
  • false - нет.
007 ······<bs:status>230</bs:status> bs:VersionStatus [1..1] Статус версии хозяйствующего субъекта.
008 ······<bs:createDate>2017-07-07T12:00:00</bs:createDate> xs:DateTime [1..1] Дата создания хозяйствующего субъекта.
009 ······<bs:updateDate>2017-07-07T12:00:00</bs:updateDate> xs:DateTime [1..1] Дата изменения хозяйствующего субъекта.
010 ······<bs:previous>UUID</bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии записи реестра хозяйствующих субъектов.
011 ······<bs:next>UUID</bs:next> bs:UUID [0..1] Идентификатор следующей версии записи реестра хозяйствующих субъектов.
012 ······<dt:type>1</dt:type> dt:BusinessEntityType [1..1]

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

  • 1 - юридическое лицо;
  • 2 - физическое лицо;
  • 3 - индивидуальный предприниматель.
013 ······<dt:name>Наименование ХС</dt:name> bs:String255 [0..1]

Наименование хозяйствующего субъекта без указания организационно-правовой формы.

  • Возвращается только для юридических лиц.
  • Для физических лиц и для индивидуальных предпринимателей поле не возвращается.
014 ······<dt:incorporationForm> dt:IncorporationForm [1..1] Организационно-правовая форма хозяйствующего субъекта.
015 ·········<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Идентификатор версии организационно-правовой формы.
016 ·········<dt:name>Название ОПФ</dt:name> bs:String255 [1..1]

Название организационно-правовой формы предприятия.

  • согласно справочнику ОКОПФ.
017 ·········<dt:code>12300</dt:code> bs:String255 [1..1]

Код организационно-правовой формы предприятия.

  • согласно справочнику ОКОПФ.
018 ·········<dt:shortName>Краткое название ОПФ</dt:shortName> bs:String255 [0..1] Краткое название организационно-правовой формы предприятия.
019 ······</dt:incorporationForm>
020 ······<dt:fullName>Полное наименование ХС</dt:fullName> bs:String255 [0..1]

Полное наименование хозяйствующего субъекта.

  • с указанием ОПФ так, как оно значится в ЕГРЮЛ/ЕГРИП.
021 ······<dt:fio>Иванов Иван Иванович</dt:fio> bs:String255 [0..1]

ФИО физического лица или индивидуального предпринимателя.

  • Для юридических лиц поле не возвращается.
022 ······<dt:inn>3312200096</dt:inn> bs:String255 [0..1] ИНН хозяйствующего субъекта.
023 ······<dt:kpp>163501001</dt:kpp> bs:String255 [0..1] Код причины постановки на учет (КПП).
024 ······<dt:ogrn>4085022240002</dt:ogrn> bs:String255 [0..1]

ОГРН или ОГРНИП.

  • Для ИП ОГРНИП может быть не указано.
025 ······<dt:juridicalAddress> dt:Address [1..1]

Юридический адрес.

  • адрес, по которому зарегистрирован хозяйствующий субъект.
026 ·········<dt:country> dt:Country [1..1] Страна.
027 ············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1]

Уникальный идентификатор страны.

  • в соответствии со справочником РСХН.
028 ············<bs:guid>GUID</bs:guid> bs:UUID [1..1]

Глобальный идентификатор страны.

  • в соответствии со справочником РСХН.
029 ············<dt:name>Страна</dt:name> bs:String255 [1..1]

Наименование страны.

  • в соответствии со справочником РСХН.
030 ·········</dt:country>
031 ·········<dt:region> dt:Region [1..1] Регион.
032 ············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1]

Уникальный идентификатор региона страны.

  • в соответствии со справочником РСХН.
033 ············<bs:guid>GUID</bs:guid> bs:UUID [1..1]

Глобальный идентификатор региона страны.

  • в соответствии со справочником РСХН.
034 ············<dt:name>Регион</dt:name> bs:String255 [1..1]

Наименование региона страны.

  • в соответствии со справочником РСХН.
035 ·········</dt:region>
036 ·········<dt:district> dt:Locality [0..1] Район региона.
037 ············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1]

Уникальный идентификатор района региона.

  • в соответствии со справочником РСХН.
038 ············<bs:guid>GUID</bs:guid> bs:UUID [1..1]

Глобальный идентификатор района региона.

  • в соответствии со справочником РСХН.
039 ············<dt:name>Район</dt:name> bs:String255 [1..1]

Наименование района региона.

  • в соответствии со справочником РСХН.
040 ·········</dt:district>
041 ·········<dt:locality> dt:Locality [0..1] Населённый пункт.
042 ············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1]

Уникальный идентификатор города региона (города регионального подчинения) страны.

  • в соответствии со справочником РСХН.
043 ············<bs:guid>GUID</bs:guid> bs:UUID [1..1]

Глобальный идентификатор города региона (города регионального подчинения) страны.

  • в соответствии со справочником РСХН.
044 ············<dt:name>Город</dt:name> bs:String255 [1..1]

Наименование города региона (города регионального подчинения) страны.

  • в соответствии со справочником РСХН.
045 ·········</dt:locality>
046 ·········<dt:subLocality> dt:Locality [0..1] Населённый пункт, подчиненный другогому населенному пункту (locality).
047 ············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1]

Уникальный идентификатор населенного пункта.

  • в соответствии со справочником РСХН.
048 ············<bs:guid>GUID</bs:guid> bs:UUID [1..1]

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

  • в соответствии со справочником РСХН.
049 ············<dt:name>Населенный пункт</dt:name> bs:String255 [1..1]

Наименование населенного пункта.

  • в соответствии со справочником РСХН.
050 ·········</dt:subLocality>
051 ·········<dt:street> dt:Street [0..1] Улица.
052 ············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1]

Уникальный идентификатор улицы города страны.

  • в соответствии со справочником РСХН.
053 ············<bs:guid>GUID</bs:guid> bs:UUID [1..1]

Глобальный идентификатор улицы города.

  • в соответствии со справочником РСХН.
054 ············<dt:name>Улица</dt:name> bs:String255 [1..1]

Наименование улицы города.

  • в соответствии со справочником РСХН.
055 ·········</dt:street>
056 ·········<dt:house>6</dt:house> bs:String255 [0..1] Номер дома.
057 ·········<dt:building>1</dt:building> bs:String255 [0..1] Номер строения.
058 ·········<dt:room>1</dt:room> bs:String255 [0..1] Номер квартиры / офиса.
059 ·········<dt:postIndex>000000</dt:postIndex> bs:String255 [0..1] Почтовый индекс.
060 ·········<dt:postBox>х/х 00</dt:postBox> bs:String255 [0..1] Абонентский ящик.
061 ·········<dt:additionalInfo>Доп. инфо</dt:additionalInfo> bs:String255 [0..1] Дополнительная информация.
062 ·········<dt:addressView>Адрес</dt:addressView> bs:String255 [0..1] Строковое представление адреса.
063 ······</dt:juridicalAddress>
064 ···</dt:businessEntity>
065 </ws:getBusinessEntityByUuidResponse>

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

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

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

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
		  xmlns:ws="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2" 
		  xmlns:bs="http://api.vetrf.ru/schema/cdm/base">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:getBusinessEntityByUuidRequest>
         <bs:uuid>b18dcbea-6f58-4728-bb66-d545347dcf5a</bs:uuid>
      </ws:getBusinessEntityByUuidRequest>
   </soapenv:Body>
</soapenv:Envelope>


Ответ на запрос.

Источник — http://help.vetrf.ru/index.php?title=GetBusinessEntityByUUID_v2&oldid=37138