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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 43: Строка 43:
! Тип
! Тип
! Обязат.
! Обязат.
! Описание
! Описание (нажмите [...] для отображения дополнительного описания)
! Пример
|-
|-
|1
|001
|style="font-weight: bold; font-family: Courier;" |<ws:getBusinessEntityByUuidRequest>
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getBusinessEntityByUuidRequest>'''}}
|
|
|
|
|
| style="width:52em;"|  
|style="font-family: Courier;" |
|-
|-
|2
|002
|style="font-weight: bold; font-family: Courier;" |···<bs:uuid>
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|bs:}}uuid>'''}}{{color|#131313|UUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}uuid>'''}}
|[[UUID|bs:UUID]]  
|[[UUID|bs:UUID]]  
|[1..1]
|[1..1]
|Идентификатор версии хозяйствующего субъекта
| style="width:52em;"| Идентификатор версии хозяйствующего субъекта.
|style="font-family: Courier;" |<bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
|-
|-
|3
|003
|style="font-weight: bold; font-family: Courier;" |</ws:getBusinessEntityByUuidRequest>
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getBusinessEntityByUuidRequest>'''}}
|
|
|
|
|
|style="font-family: Courier;" |
| style="width:52em;"|  
|-
|-
|}
|}

Версия 14:56, 8 ноября 2020

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

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

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

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

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

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

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

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

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

# Название XML-элемента Тип Обязат. Описание Пример
1 <ws:getBusinessEntityByGuidResponse>
2 ···<dt:businessEntity> dt:BusinessEntity [1..1] Данные о хозяйствующем субъекте.
3 ······<bs:uuid> bs:UUID [1..1] Идентификатор версии хозяйствующего субъекта. <bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
4 ······<bs:guid> bs:UUID [1..1] Глобальный идентификатор хозяйствующего субъекта. <bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid>
5 ······<bs:active> xs:boolean [1..1] Является ли запись активной:
  • true - запись активна;
  • false - запись не активна.
<bs:active>true</bs:active>
6 ······<bs:last> xs:boolean [1..1] Является ли версия записи последней:
  • true - да;
  • false - нет.
<bs:last>true</bs:last>
7 ······<bs:status> bs:VersionStatus [1..1] Статус версии хозяйствующего субъекта. <bs:status>230</bs:status>
8 ······<bs:createDate> xs:DateTime [1..1] Дата создания хозяйствующего субъекта. <bs:createDate>2017-07-07T12:00:00</bs:createDate>
9 ······<bs:updateDate> xs:DateTime [1..1] Дата изменения хозяйствующего субъекта. <bs:updateDate>2017-07-07T12:00:00</bs:updateDate>
10 ······<bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии записи реестра хозяйствующих субъектов. <bs:previous>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous>
11 ······<bs:next> bs:UUID [0..1] Идентификатор следующей версии записи реестра хозяйствующих субъектов. <bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next>
12 ······<dt:type> dt:BusinessEntityType [1..1] Тип создаваемого или редактируемого хозяйствующего субъекта:
  • 1 - юридическое лицо;
  • 2 - физическое лицо;
  • 3 - индивидуальный предприниматель.
<dt:type>1</dt:type>
13 ······<dt:name> bs:String255 [0..1] Наименование хозяйствующего субъекта без указания организационно-правовой формы.
  • Возвращается только для юридических лиц.
  • Для физических лиц и для индивидуальных предпринимателей поле не возвращается.
<dt:name>Гладиолус</dt:name>
14 ······<dt:incorporationForm> dt:IncorporationForm [1..1] Организационно-правовая форма хозяйствующего субъекта.
15 ·········<bs:uuid> bs:UUID [1..1] Идентификатор версии организационно-правовой формы <bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
16 ·········<dt:name> bs:String255 [1..1] Название организационно-правовой формы предприятия согласно справочнику ОКОПФ. <dt:name>Общество с ограниченной ответственностью</dt:name>
17 ·········<dt:code> bs:String255 [1..1] Код организационно-правовой формы предприятия согласно справочнику ОКОПФ. <dt:code>12300</dt:code>
18 ·········<dt:shortName> bs:String255 [0..1] Краткое название организационно-правовой формы предприятия. <dt:shortName>ООО</dt:shortName>
19 ······</dt:incorporationForm>
20 ······<dt:fullName> bs:String255 [0..1] Полное наименование хозяйствующего субъекта с указанием ОПФ так, как оно значится в ЕГРЮЛ/ЕГРИП. <dt:fullName>Общество с ограниченной ответственностью "Гладиолус"</dt:fullName>
21 ······<dt:fio> bs:String255 [0..1] ФИО физического лица или индивидуального предпринимателя.
  • Для юридических лиц поле не возвращается.
<dt:fio>Иванов Сергей Петрович</dt:fio>
22 ······<dt:inn> bs:String255 [0..1] ИНН хозяйствующего субъекта. <dt:inn>3312200096</dt:inn>
23 ······<dt:kpp> bs:String255 [0..1] Код причины постановки на учет (КПП). <dt:kpp>163501001</dt:kpp>
24 ······<dt:ogrn> bs:String255 [0..1] ОГРН или ОГРНИП.
  • Для ИП ОГРНИП может быть не указано.
<dt:ogrn>4085022240002</dt:ogrn>
25 ······<dt:juridicalAddress> dt:Address [1..1] Юридический адрес - адрес, по которому зарегистрирован хозяйствующий субъект.
26 ·········<dt:country> dt:Country [1..1] Страна
27 ············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор страны в соответствии со справочником РСХН. <bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
28 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор страны в соответствии со справочником РСХН. <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
29 ············<dt:name> bs:String255 [1..1] Наименование страны в соответствии со справочником РСХН. <dt:name>Российская Федерация</dt:name>
30 ·········</dt:country>
31 ·········<dt:region> dt:Region [1..1] Регион
32 ············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор региона страны в соответствии со справочником РСХН. <bs:uuid>e440dcdb-31d6-39a4-db63-a1c0731d61d6</bs:uuid>
33 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор региона страны в соответствии со справочником РСХН. <bs:guid>cbdf8cb6-fb9a-4f36-36d3-04488f6d1b82</bs:guid>
34 ············<dt:name> bs:String255 [1..1] Наименование региона страны в соответствии со справочником РСХН. <dt:name>Владимирская область</dt:name>
35 ·········</dt:region>
36 ·········<dt:district> dt:Locality [0..1] Район региона
37 ············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор района региона в соответствии со справочником РСХН. <bs:uuid>3cb373d5-32f1-ac2a-754c-58d4b33825dd</bs:uuid>
38 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор района региона в соответствии со справочником РСХН. <bs:guid>90d82878-431a-0cf1-0974-16d4fdff3bc8</bs:guid>
39 ············<dt:name> bs:String255 [1..1] Наименование района региона в соответствии со справочником РСХН. <dt:name>Собинский район</dt:name>
40 ·········</dt:district>
41 ·········<dt:locality> dt:Locality [0..1] Населённый пункт
42 ············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор города региона (города регионального подчинения) страны в соответствии со справочником РСХН. <bs:uuid>70db962b-d3f3-9a13-93d1-f83a9bc6ed80</bs:uuid>
43 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор города региона (города регионального подчинения) страны в соответствии со справочником РСХН. <bs:guid>a16545f3-8f9c-2778-099f-a5d302e58712</bs:guid>
44 ············<dt:name> bs:String255 [1..1] Наименование города региона (города регионального подчинения) страны в соответствии со справочником РСХН. <dt:name>Владимир г</dt:name>
45 ·········</dt:locality>
46 ·········<dt:subLocality> dt:Locality [0..1] Населённый пункт, подчиненный другогому населенному пункту (locality)
47 ············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор населенного пункта в соответствии со справочником РСХН. <bs:uuid>3a7b2d0c-2ebd-0dff-9e93-341097ee1db3</bs:uuid>
48 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор населенного пункта в соответствии со справочником РСХН. <bs:guid>9f315346-b470-3a1c-56d0-ae1afe9579df</bs:guid>
49 ············<dt:name> bs:String255 [1..1] Наименование населенного пункта в соответствии со справочником РСХН. <dt:name>Энергетик мкрн</dt:name>
50 ·········</dt:subLocality>
51 ·········<dt:street> dt:Street [0..1] Улица
52 ············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор улицы города страны в соответствии со справочником РСХН. <bs:uuid>90d82878-431a-0cf1-0974-16d4fdff3bc8</bs:uuid>
53 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор улицы города в соответствии со справочником РСХН. <bs:guid>b014d26b-5391-c852-caa4-60fc9bb0a7d4</bs:guid>
54 ············<dt:name> bs:String255 [1..1] Наименование улицы города в соответствии со справочником РСХН. <dt:name>Энергетиков ул</dt:name>
55 ·········</dt:street>
56 ·········<dt:house> bs:String255 [0..1] Номер дома. <dt:house>6</dt:house>
57 ·········<dt:building> bs:String255 [0..1] Номер строения. <dt:building>1</dt:building>
58 ·········<dt:room> bs:String255 [0..1] Номер квартиры / офиса. <dt:room>1</dt:room>
59 ·········<dt:postIndex> bs:String255 [0..1] Почтовый индекс. <dt:postIndex>600037</dt:postIndex>
60 ·········<dt:postBox> bs:String255 [0..1] Абонентский ящик <dt:postBox>а/я 56</dt:postBox>
61 ·········<dt:additionalInfo> bs:String255 [0..1] Дополнительная информация. <dt:additionalInfo>Доп. инфо</dt:additionalInfo>
62 ·········<dt:addressView> bs:String255 [0..1] Строковое представление адреса. <dt:addressView>Российская Федерация, Владимирская обл., г. Владимир, ул. Ленина ул., д. 44</dt:addressView>
63 ······</dt:juridicalAddress>
64 ···</dt:businessEntity>
65 </ws:getBusinessEntityByGuidResponse>

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

Ошибка Описание
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>


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