GetActivityLocationList v2

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

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

Операция GetActivityLocationList предназначена для получения списка поднадзорных объектов (площадок), связанных с заданным хозяйствующим субъектом. В список попадают только актуальные записи (active = true).

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

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

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

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getActivityLocationListRequest>
002 ···<bs:listOptions> bs:ListOptions [0..1] Параметры запрашиваемого списка.
003 ······<bs:count>10</bs:count> xs:nonNegativeInteger [0..1]

Максимальное запрашиваемое количество объектов в списке.

  • По умолчанию значение 100;
  • Максимально возможное значение 1000.
004 ······<bs:offset>2</bs:offset> xs:nonNegativeInteger [0..1]

Номер элемента, по которому осуществляется смещение первого элемента списка.

  • По умолчанию значение 0.
005 ···</bs:listOptions>
006 ···<dt:businessEntity> dt:BusinessEntity [1..1] Данные о хозяйствующем субъекте.
007 ······<bs:guid>GUID</bs:guid> bs:UUID [1..1]

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

<bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid>
008 ···</dt:businessEntity>
009 </ws:getActivityLocationListRequest>

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getActivityLocationListResponse>
002 ···<dt:activityLocationList count="23" total="23" offset="0"> dt:ActivityLocationList [1..1] Список сведений о предприятиях хозяйствующего субъекта.
003 ······<dt:location> dt:BusinessMember [0..*] Сведения о предприятии хозяйствующего субъекта.
004 ·········<dt:businessEntity> dt:BusinessEntity [1..1] Хозяйствующий субъект.
005 ············<bs:uuid>UUID</bs:guid> bs:UUID [1..1] Идентификатор версии хозяйствующего субъекта.
006 ············<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор хозяйствующего субъекта.
007 ·········</dt:businessEntity>
008 ·········<dt:enterprise> dt:Enterprise [1..1] Данные о поднадзорном объекте.
009 ············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Идентификатор версии предприятия.
010 ············<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор предприятия.
011 ············<bs:active>true</bs:active> xs:boolean [1..1]

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

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

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

  • true - да;
  • false - нет.
013 ············<bs:status>100</bs:status> bs:VersionStatus [1..1] Статус версии предприятия.
014 ············<bs:createDate>2017-07-07T12:00:00</bs:createDate> xs:DateTime [1..1] Дата создания записи.
015 ············<bs:updateDate>2017-07-07T12:00:00</bs:updateDate> xs:DateTime [1..1] Дата изменения записи.
016 ············<bs:previous>UUID</bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии записи.
017 ············<bs:next>UUID</bs:next> bs:UUID [0..1] Идентификатор следующей версии записи.
018 ············<dt:name>Наименование</dt:name> bs:String255 [1..1] Полное наименование поднадзорного объекта.
019 ············<dt:type>1</dt:type> dt:EnterpriseType [1..1]

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

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

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

  • UNVERIFIED - Не подтверджен (не в реестре).
  • VERIFIED - Подтвержден (включен в реестр).
  • CANCELED - Исключен из реестра.
  • DELETED - Удален.
081 ·········</dt:enterprise>
082 ·········<dt:globalID>4607009526782</dt:globalID> dt:GLNType [0..*]

Global Location Number - уникальный номер площадки хозяйствующего субъекта.

См. http://www.gs1.org/gln.
083 ······</dt:location>
084 ···</dt:activityLocationList>
085 </ws:getActivityLocationListResponse>

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

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

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

Запрос первых 100 элементов списка без смещения. 

<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" 
                  xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:getActivityLocationListRequest>
         <bs:listOptions>
            <bs:count>100</bs:count>
            <bs:offset>0</bs:offset>
         </bs:listOptions>
         <dt:businessEntity>
            <bs:guid>67b170ec-1484-4eba-a9b8-3008b5a3db32</bs:guid>
         </dt:businessEntity>
      </ws:getActivityLocationListRequest>
   </soapenv:Body>
</soapenv:Envelope>


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

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