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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 44: Строка 44:
|-
|-
|1
|1
|style="font-weight: bold; font-family: Courier;" |<ws:getEnterpriseByGuidRequest>
|style="font-weight: bold; font-family: Courier;" |<ws:getEnterpriseByUuidRequest>
|
|
|
|
Строка 51: Строка 51:
|-
|-
|2
|2
|style="font-weight: bold; font-family: Courier;" |···<bs:guid>
|style="font-weight: bold; font-family: Courier;" |···<bs:uuid>
|[[UUID|bs:UUID]]  
|[[UUID|bs:UUID]]  
|[1..1]
|[1..1]
|Глобальный идентификатор предприятия
|Идентификатор версии предприятия
|style="font-family: Courier;" |<bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid>
|style="font-family: Courier;" |<bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
|-
|-
|3
|3
|style="font-weight: bold; font-family: Courier;" |</ws:getEnterpriseByGuidRequest>
|style="font-weight: bold; font-family: Courier;" |</ws:getEnterpriseByUuidRequest>
|
|
|
|

Версия 06:13, 27 октября 2017

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

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

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

  • уникальный идентификатор версии записи предприятия.

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

  • данные о предприятии.

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

# Название XML-элемента Тип Обязат. Описание Пример
1 <ws:getEnterpriseByUuidRequest>
2 ···<bs:uuid> bs:UUID [1..1] Идентификатор версии предприятия <bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
3 </ws:getEnterpriseByUuidRequest>

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

# Название XML-элемента Тип Обязат. Описание Пример
1 <ws:getEnterpriseByGuidResponse>
2 ···<dt:enterprise> dt:Enterprise [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>200</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:name> bs:String255 [1..1] Полное наименование поднадзорного объекта. <dt:name>Гладиолус</dt:name>
13 ······<dt:type> dt:EnterpriseType [1..1] Тип поднадзорного объекта:
  • 1 - предприятие;
  • 2 - рынок;
  • 3 - СББЖ;
  • 4 - судно.
<dt:type>1</dt:type>
14 ······<dt:numberList> dt:EnterpriseNumberList [0..1] Список номеров предприятия.
15 ·········<dt:enterpriseNumber> bs:String255 [1..*] Номер предприятия <dt:enterpriseNumber>RU751</dt:enterpriseNumber>
16 ······</dt:numberList>
17 ······<dt:address> dt:Address [1..1] Фактический адрес расположения поднадзорного объекта.
18 ·········<dt:country> dt:Country [1..1] Страна
19 ············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор страны в соответствии со справочником РСХН. <bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
20 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор страны в соответствии со справочником РСХН. <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
21 ············<dt:name> bs:String255 [1..1] Наименование страны в соответствии со справочником РСХН. <dt:name>Российская Федерация</dt:name>
22 ·········</dt:country>
23 ·········<dt:region> dt:Region [1..1] Регион (республика, область, край, автономная область)
24 ············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор региона страны в соответствии со справочником РСХН. <bs:uuid>e440dcdb-31d6-39a4-db63-a1c0731d61d6</bs:uuid>
25 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор региона страны в соответствии со справочником РСХН. <bs:guid>cbdf8cb6-fb9a-4f36-36d3-04488f6d1b82</bs:guid>
26 ············<dt:name> bs:String255 [1..1] Наименование региона страны в соответствии со справочником РСХН. <dt:name>Владимирская область</dt:name>
27 ·········</dt:region>
28 ·········<dt:district> dt:Locality [0..1] Район региона
29 ············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор района региона в соответствии со справочником РСХН. <bs:uuid>3cb373d5-32f1-ac2a-754c-58d4b33825dd</bs:uuid>
30 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор района региона в соответствии со справочником РСХН. <bs:guid>90d82878-431a-0cf1-0974-16d4fdff3bc8</bs:guid>
31 ············<dt:name> bs:String255 [1..1] Наименование района региона в соответствии со справочником РСХН. <dt:name>Собинский район</dt:name>
32 ·········</dt:district>
33 ·········<dt:locality> dt:Locality [0..1] Населённый пункт
34 ············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор города региона (города регионального подчинения) страны в соответствии со справочником РСХН. <bs:uuid>70db962b-d3f3-9a13-93d1-f83a9bc6ed80</bs:uuid>
35 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор города региона (города регионального подчинения) страны в соответствии со справочником РСХН. <bs:guid>a16545f3-8f9c-2778-099f-a5d302e58712</bs:guid>
36 ············<dt:name> bs:String255 [1..1] Наименование города региона (города регионального подчинения) страны в соответствии со справочником РСХН. <dt:name>Владимир г</dt:name>
37 ·········</dt:locality>
38 ·········<dt:subLocality> dt:Locality [0..1] Населённый пункт, подчиненный другогому населенному пункту (locality)
39 ············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор населенного пункта в соответствии со справочником РСХН. <bs:uuid>3a7b2d0c-2ebd-0dff-9e93-341097ee1db3</bs:uuid>
40 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор населенного пункта в соответствии со справочником РСХН. <bs:guid>9f315346-b470-3a1c-56d0-ae1afe9579df</bs:guid>
41 ············<dt:name> bs:String255 [1..1] Наименование населенного пункта в соответствии со справочником РСХН. <dt:name>Энергетик мкрн</dt:name>
42 ·········</dt:subLocality>
43 ·········<dt:street> dt:Street [0..1] Улица
44 ············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор улицы города страны в соответствии со справочником РСХН. <bs:uuid>90d82878-431a-0cf1-0974-16d4fdff3bc8</bs:uuid>
45 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор улицы города в соответствии со справочником РСХН. <bs:guid>b014d26b-5391-c852-caa4-60fc9bb0a7d4</bs:guid>
46 ············<dt:name> bs:String255 [1..1] Наименование улицы города в соответствии со справочником РСХН. <dt:name>Энергетиков ул</dt:name>
47 ·········</dt:street>
48 ·········<dt:house> bs:String255 [0..1] Номер дома. <dt:house>6</dt:house>
49 ·········<dt:building> bs:String255 [0..1] Номер строения. <dt:building>1</dt:building>
50 ·········<dt:room> bs:String255 [0..1] Номер квартиры / офиса. <dt:room>1</dt:room>
51 ·········<dt:postIndex> bs:String255 [0..1] Почтовый индекс. <dt:postIndex>600037</dt:postIndex>
52 ·········<dt:postBox> bs:String255 [0..1] Абонентский ящик <dt:postBox>а/я 56</dt:postBox>
53 ·········<dt:additionalInfo> bs:String255 [0..1] Дополнительная информация. <dt:additionalInfo>Доп. инфо</dt:additionalInfo>
54 ·········<dt:addressView> bs:String255 [0..1] Строковое представление адреса. <dt:addressView>Российская Федерация, Владимирская обл., г. Владимир, ул. Ленина ул., д. 44</dt:addressView>
55 ······</dt:address>
56 ······<dt:activityList count="1" total="1" offset="0"> dt:EnterpriseActivityList [1..1] Виды деятельности поднадзорного объекта.
57 ·········<dt:activity> dt:EnterpriseActivity [1..*] Деятельность, осуществляемая предприятием, указывается согласно справочнику видов деятельности.
58 ············<dt:name> bs:NText [1..1] Название вида деятельности. <dt:name>Реализация пищевых продуктов</dt:name>
59 ·········</dt:activity>
60 ······</dt:activityList>
61 ······<dt:owner> dt:BusinessEntity [0..1] Собственник поднадзорного объекта.
62 ·········<bs:uuid> bs:UUID [0..1] Идентификатор хозяйствующего субъекта. <bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
63 ·········<bs:guid> bs:UUID [0..1] Глобальный идентификатор хозяйствующего субъекта. <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
64 ·········<dt:name> bs:String255 [0..1] Наименование хозяйствующего субъекта. <dt:name>Гладиолус</dt:name>
65 ·········<dt:juridicalAddress> dt:Address [0..1] Юридический адрес
66 ············<dt:addressView> bs:String255 [0..1] Строковое представление адреса. <dt:addressView>Российская Федерация, Владимирская обл., г. Владимир, ул. Ленина ул., д. 44</dt:addressView>
67 ·········</dt:juridicalAddress>
68 ······</dt:owner>
69 ······<dt:officialRegistration> dt:EnterpriseOfficialRegistration [0..*] Факт постановки на учёт в налоговом органе.
70 ·········<dt:ID> dt:GRNType [0..1] Государственный номер регистрации ФНС. <dt:ID>6789198</dt:ID>
71 ·········<dt:businessEntity> dt:BusinessEntity [1..1] Хозяйствующий субъект, поставивший площадку на учёт в налоговом органе.
72 ············<bs:uuid> bs:UUID [1..1] Идентификатор хозяйствующего субъекта. <bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
73 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор хозяйствующего субъекта. <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
74 ············<dt:name> bs:String255 [0..1] Наименование хозяйствующего субъекта. <dt:name>Гладиолус</dt:name>
75 ············<dt:inn> bs:String255 [0..1] ИНН хозяйствующего субъекта. <dt:inn>3312200096</dt:inn>
76 ············<dt:kpp> bs:String255 [0..1] КПП хозяйствующего субъекта. <dt:kpp>163501001</dt:kpp>
77 ············<dt:ogrn> bs:String255 [0..1] ОГРН. <dt:ogrn>4085022240002</dt:ogrn>
78 ············<dt:juridicalAddress> dt:Address [0..1] Юридический адрес
79 ···············<dt:addressView> bs:String255 [0..1] Строковое представление адреса.
80 ············</dt:juridicalAddress>
81 ·········</dt:businessEntity>
82 ·········<dt:kpp> bs:String255 [1..1] Код причины постановки на учёт (КПП). <dt:kpp>163501001</dt:kpp>
83 ······</dt:officialRegistration>
84 ···</dt:enterprise>
85 </ws:getEnterpriseByGuidResponse>

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

Ошибка Описание
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:getEnterpriseByGuidRequest>
         <bs:guid>d30316d4-31c9-43b8-a91d-f72d4b5d35f3</bs:guid>
      </ws:getEnterpriseByGuidRequest>
   </soapenv:Body>
</soapenv:Envelope>


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