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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
м (Nikeshina-ad-171025 переименовал страницу GetEnterpriseByUuid v2.0 в GetEnterpriseByUuid v2)
 
(нет различий)

Текущая версия на 12:01, 1 июня 2023

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

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

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

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

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

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

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getEnterpriseByUuidRequest>
002 ···<bs:uuid>UUID</bs:uuid> bs:UUID [1..1]

Идентификатор версии предприятия

<bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
003 </ws:getEnterpriseByUuidRequest>

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getEnterpriseByUuidResponse>
002 ···<dt:enterprise> dt:Enterprise [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>100</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:name>Наименование</dt:name> bs:String255 [1..1] Полное наименование поднадзорного объекта.
013 ······<dt:type>1</dt:type> dt:EnterpriseType [1..1]

Тип поднадзорного объекта.

  • 1 - предприятие;
  • 2 - рынок;
  • 3 - СББЖ;
  • 4 - судно.
014 ······<dt:numberList> dt:EnterpriseNumberList [0..1] Список номеров предприятия.
015 ·········<dt:enterpriseNumber>RU751</dt:enterpriseNumber> bs:String255 [1..*] Номер предприятия.
016 ······</dt:numberList>
017 ······<dt:address> dt:Address [1..1] Фактический адрес расположения поднадзорного объекта.
018 ·········<dt:country> dt:Country [1..1] Страна.
019 ············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Уникальный идентификатор страны в соответствии со справочником РСХН.
020 ············<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор страны в соответствии со справочником РСХН.
021 ············<dt:name>Российская Федерация</dt:name> bs:String255 [1..1] Наименование страны в соответствии со справочником РСХН.
022 ·········</dt:country>
023 ·········<dt:region> dt:Region [1..1] Регион (республика, область, край, автономная область).
024 ············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Уникальный идентификатор региона в соответствии со справочником РСХН.
025 ············<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор региона в соответствии со справочником РСХН.
026 ············<dt:name>Владимирская область</dt:name> bs:String255 [1..1] Наименование региона страны в соответствии со справочником РСХН.
027 ·········</dt:region>
028 ·········<dt:district> dt:Locality [0..1] Район региона.
029 ············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Уникальный идентификатор района в соответствии со справочником РСХН.
030 ············<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор района в соответствии со справочником РСХН.
031 ············<dt:name>Собинский район</dt:name> bs:String255 [1..1] Наименование района региона в соответствии со справочником РСХН.
032 ·········</dt:district>
033 ·········<dt:locality> dt:Locality [0..1] Населённый пункт.
034 ············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Уникальный идентификатор города в соответствии со справочником РСХН.
035 ············<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор города в соответствии со справочником РСХН.
036 ············<dt:name>Владимир г</dt:name> bs:String255 [1..1] Наименование города в соответствии со справочником РСХН.
037 ·········</dt:locality>
038 ·········<dt:subLocality> dt:Locality [0..1] Населённый пункт, подчиненный другогому населенному пункту (locality).
039 ············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Уникальный идентификатор населенного пункта в соответствии со справочником РСХН.
040 ············<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор населенного пункта в соответствии со справочником РСХН.
041 ············<dt:name>Энергетик мкрн</dt:name> bs:String255 [1..1] Наименование населенного пункта в соответствии со справочником РСХН.
042 ·········</dt:subLocality>
043 ·········<dt:street> dt:Street [0..1] Улица.
044 ············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Уникальный идентификатор улицы в соответствии со справочником РСХН.
045 ············<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор улицы в соответствии со справочником РСХН.
046 ············<dt:name>Энергетиков ул</dt:name> bs:String255 [1..1] Наименование улицы в соответствии со справочником РСХН.
047 ·········</dt:street>
048 ·········<dt:house>6</dt:house> bs:String255 [0..1] Номер дома.
049 ·········<dt:building>1</dt:building> bs:String255 [0..1] Номер строения.
050 ·········<dt:room>1</dt:room> bs:String255 [0..1] Номер квартиры / офиса.
051 ·········<dt:postIndex>600037</dt:postIndex> bs:String255 [0..1] Почтовый индекс.
052 ·········<dt:postBox>а/я 56</dt:postBox> bs:String255 [0..1] Абонентский ящик
053 ·········<dt:additionalInfo>Доп. инфо</dt:additionalInfo> bs:String255 [0..1] Дополнительная информация.
054 ·········<dt:addressView>Текстовый адрес</dt:addressView> bs:String255 [0..1] Строковое представление адреса.
055 ······</dt:address>
056 ······<dt:activityList count="1" total="1" offset="0"> dt:EnterpriseActivityList [0..1] Виды деятельности поднадзорного объекта.
057 ·········<dt:activity> dt:EnterpriseActivity [1..*] Деятельность, осуществляемая предприятием.
058 ············<dt:name>Реализация пищевых продуктов</dt:name> bs:NText [1..1] Название вида деятельности.
059 ·········</dt:activity>
060 ······</dt:activityList>
061 ······<dt:owner> dt:BusinessEntity [0..1] ХС-владелец поднадзорного объекта.
062 ·········<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Идентификатор хозяйствующего субъекта.
063 ·········<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор хозяйствующего субъекта.
064 ·········<dt:juridicalAddress> dt:Address [0..1] Юридический адрес.
065 ············<dt:addressView>Текстовый адрес</dt:addressView> bs:String255 [0..1] Строковое представление адреса.
066 ·········</dt:juridicalAddress>
067 ······</dt:owner>
068 ······<dt:officialRegistration> dt:EnterpriseOfficialRegistration [0..*] Факт постановки на учёт в налоговом органе.
069 ·········<dt:businessEntity> dt:BusinessEntity [1..1] Хозяйствующий субъект, поставивший площадку на учёт в налоговом органе.
070 ············<dt:inn>7103016446</dt:inn> bs:String255 [1..1] ИНН хозяйствующего субъекта.
071 ·········</dt:businessEntity>
072 ·········<dt:kpp>123456789</dt:kpp> bs:String255 [1..1] Код причины постановки на учёт (КПП).
073 ······</dt:officialRegistration>
074 ······<dt:registryStatus>VERIFIED</dt:registryStatus> dt:EnterpriseStatus [0..1]

(v2.1) Статус предприятия в реестре ИС Цербер.

  • UNVERIFIED - Не подтверджен (не в реестре).
  • VERIFIED - Подтвержден (включен в реестр).
  • CANCELED - Исключен из реестра.
  • DELETED - Удален.
075 ···</dt:enterprise>
076 </ws:getEnterpriseByUuidResponse>

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

Ошибка Описание
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:getEnterpriseByUuidRequest>
         <bs:uuid>6ff1caf2-90c7-48c9-80b0-0571b3b5a96d</bs:uuid>
      </ws:getEnterpriseByUuidRequest>
   </soapenv:Body>
</soapenv:Envelope>


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

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