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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 1211: Строка 1211:
[[Category:Ветис.API_v2]]
[[Category:Ветис.API_v2]]
[[Category:EnterpriseService_v2]]
[[Category:EnterpriseService_v2]]
[[Category:Реестры_v2]]

Версия 03:48, 27 октября 2017

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

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

Используемые пространства имён и типы

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

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

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

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

# Название XML-элемента Тип Обязат. Описание Пример
1 <ws:getActivityLocationListRequest>
2 ···<bs:listOptions> bs:ListOptions [0..1] Параметры запрашиваемого списка.
3 ······<bs:count> xs:nonNegativeInteger [0..1] Максимальное запрашиваемое количество объектов в списке.
  • По умолчанию значение 100;
  • Максимально возможное значение 1000.
<bs:count>10</bs:count>
4 ······<bs:offset> xs:nonNegativeInteger [0..1] Номер элемента, по которому осуществляется смещение первого элемента списка.
  • По умолчанию значение 0.
<bs:offset>2</bs:offset>
5 ···</bs:listOptions>
6 ···<dt:businessEntity> dt:BusinessEntity [1..1] Данные о хозяйствующем субъекте.
8 ······<bs:guid> bs:UUID [1..1] Глобальный идентификатор хозяйствующего субъекта. <bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid>
39 ···</dt:businessEntity>
3 </ws:getActivityLocationListRequest>

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

# Название XML-элемента Тип Обязат. Описание Пример
1 <ws:getActivityLocationListResponse>
2 ···<dt:activityLocationList count="23" total="23" offset="0"> dt:ActivityLocationList [1..1] Список сведений о предприятиях хозяйствующего субъекта.
3 ······<dt:location> dt:BusinessMember [0..*] Сведения о предприятии хозяйствующего субъекта.
4 ·········<dt:businessEntity> dt:BusinessEntity [1..1] Данные о хозяйствующем субъекте.
5 ············<bs:uuid> bs:UUID [1..1] Идентификатор версии хозяйствующего субъекта. <bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
6 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор хозяйствующего субъекта. <bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid>
7 ············<bs:active> xs:boolean [1..1] Является ли запись активной:
  • true - запись активна;
  • false - запись не активна.
<bs:active>true</bs:active>
8 ············<bs:last> xs:boolean [1..1] Является ли версия записи последней:
  • true - да;
  • false - нет.
<bs:last>true</bs:last>
9 ············<bs:status> bs:VersionStatus [1..1] Статус версии хозяйствующего субъекта. <bs:status>230</bs:status>
10 ············<bs:createDate> xs:DateTime [1..1] Дата создания хозяйствующего субъекта. <bs:createDate>2017-07-07T12:00:00</bs:createDate>
11 ············<bs:updateDate> xs:DateTime [1..1] Дата изменения хозяйствующего субъекта. <bs:updateDate>2017-07-07T12:00:00</bs:updateDate>
12 ············<bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии записи реестра хозяйствующих субъектов. <bs:previous>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous>
13 ············<bs:next> bs:UUID [0..1] Идентификатор следующей версии записи реестра хозяйствующих субъектов. <bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next>
14 ············<dt:type> dt:BusinessEntityType [1..1] Тип создаваемого или редактируемого хозяйствующего субъекта:
  • 1 - юридическое лицо;
  • 2 - физическое лицо;
  • 3 - индивидуальный предприниматель.
<dt:type>1</dt:type>
15 ············<dt:name> bs:String255 [0..1] Наименование хозяйствующего субъекта без указания организационно-правовой формы.
  • Возвращается только для юридических лиц.
  • Для физических лиц и для индивидуальных предпринимателей поле не возвращается.
<dt:name>Гладиолус</dt:name>
16 ············<dt:incorporationForm> dt:IncorporationForm [1..1] Организационно-правовая форма хозяйствующего субъекта.
17 ···············<bs:uuid> bs:UUID [1..1] Идентификатор версии организационно-правовой формы <bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
18 ···············<dt:name> bs:String255 [1..1] Название организационно-правовой формы предприятия согласно справочнику ОКОПФ. <dt:name>Общество с ограниченной ответственностью</dt:name>
19 ···············<dt:code> bs:String255 [1..1] Код организационно-правовой формы предприятия согласно справочнику ОКОПФ. <dt:code>12300</dt:code>
20 ···············<dt:shortName> bs:String255 [0..1] Краткое название организационно-правовой формы предприятия. <dt:shortName>ООО</dt:shortName>
21 ············</dt:incorporationForm>
22 ············<dt:fullName> bs:String255 [0..1] Полное наименование хозяйствующего субъекта с указанием ОПФ так, как оно значится в ЕГРЮЛ/ЕГРИП. <dt:fullName>Общество с ограниченной ответственностью "Гладиолус"</dt:fullName>
23 ············<dt:fio> bs:String255 [0..1] ФИО физического лица или индивидуального предпринимателя.
  • Для юридических лиц поле не возвращается.
<dt:fio>Иванов Сергей Петрович</dt:fio>
24 ············<dt:inn> bs:String255 [0..1] ИНН хозяйствующего субъекта. <dt:inn>3312200096</dt:inn>
25 ············<dt:kpp> bs:String255 [0..1] Код причины постановки на учет (КПП). <dt:kpp>163501001</dt:kpp>
26 ············<dt:ogrn> bs:String255 [0..1] ОГРН или ОГРНИП.
  • Для ИП ОГРНИП может быть не указано.
<dt:ogrn>4085022240002</dt:ogrn>
27 ············<dt:juridicalAddress> dt:Address [1..1] Юридический адрес - адрес, по которому зарегистрирован хозяйствующий субъект.
28 ···············<dt:country> dt:Country [1..1] Страна
29 ··················<bs:uuid> bs:UUID [1..1] Уникальный идентификатор страны в соответствии со справочником РСХН. <bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
30 ··················<bs:guid> bs:UUID [1..1] Глобальный идентификатор страны в соответствии со справочником РСХН. <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
31 ··················<dt:name> bs:String255 [1..1] Наименование страны в соответствии со справочником РСХН. <dt:name>Российская Федерация</dt:name>
32 ···············</dt:country>
33 ···············<dt:region> dt:Region [1..1] Регион (республика, область, край, автономная область)
34 ··················<bs:uuid> bs:UUID [1..1] Уникальный идентификатор региона страны в соответствии со справочником РСХН. <bs:uuid>e440dcdb-31d6-39a4-db63-a1c0731d61d6</bs:uuid>
35 ··················<bs:guid> bs:UUID [1..1] Глобальный идентификатор региона страны в соответствии со справочником РСХН. <bs:guid>cbdf8cb6-fb9a-4f36-36d3-04488f6d1b82</bs:guid>
36 ··················<dt:name> bs:String255 [1..1] Наименование региона страны в соответствии со справочником РСХН. <dt:name>Владимирская область</dt:name>
37 ···············</dt:region>
38 ···············<dt:district> dt:Locality [0..1] Район региона
39 ··················<bs:uuid> bs:UUID [1..1] Уникальный идентификатор района региона в соответствии со справочником РСХН. <bs:uuid>3cb373d5-32f1-ac2a-754c-58d4b33825dd</bs:uuid>
40 ··················<bs:guid> bs:UUID [1..1] Глобальный идентификатор района региона в соответствии со справочником РСХН. <bs:guid>90d82878-431a-0cf1-0974-16d4fdff3bc8</bs:guid>
41 ··················<dt:name> bs:String255 [1..1] Наименование района региона в соответствии со справочником РСХН. <dt:name>Собинский район</dt:name>
42 ···············</dt:district>
43 ···············<dt:locality> dt:Locality [0..1] Населённый пункт
44 ··················<bs:uuid> bs:UUID [1..1] Уникальный идентификатор города региона (города регионального подчинения) страны в соответствии со справочником РСХН. <bs:uuid>70db962b-d3f3-9a13-93d1-f83a9bc6ed80</bs:uuid>
45 ··················<bs:guid> bs:UUID [1..1] Глобальный идентификатор города региона (города регионального подчинения) страны в соответствии со справочником РСХН. <bs:guid>a16545f3-8f9c-2778-099f-a5d302e58712</bs:guid>
46 ··················<dt:name> bs:String255 [1..1] Наименование города региона (города регионального подчинения) страны в соответствии со справочником РСХН. <dt:name>Владимир г</dt:name>
47 ···············</dt:locality>
48 ···············<dt:subLocality> dt:Locality [0..1] Населённый пункт, подчиненный другогому населенному пункту (locality)
49 ··················<bs:uuid> bs:UUID [1..1] Уникальный идентификатор населенного пункта в соответствии со справочником РСХН. <bs:uuid>3a7b2d0c-2ebd-0dff-9e93-341097ee1db3</bs:uuid>
50 ··················<bs:guid> bs:UUID [1..1] Глобальный идентификатор населенного пункта в соответствии со справочником РСХН. <bs:guid>9f315346-b470-3a1c-56d0-ae1afe9579df</bs:guid>
51 ··················<dt:name> bs:String255 [1..1] Наименование населенного пункта в соответствии со справочником РСХН. <dt:name>Энергетик мкрн</dt:name>
52 ···············</dt:subLocality>
53 ···············<dt:street> dt:Street [0..1] Улица
54 ··················<bs:uuid> bs:UUID [1..1] Уникальный идентификатор улицы города страны в соответствии со справочником РСХН. <bs:uuid>90d82878-431a-0cf1-0974-16d4fdff3bc8</bs:uuid>
55 ··················<bs:guid> bs:UUID [1..1] Глобальный идентификатор улицы города в соответствии со справочником РСХН. <bs:guid>b014d26b-5391-c852-caa4-60fc9bb0a7d4</bs:guid>
56 ··················<dt:name> bs:String255 [1..1] Наименование улицы города в соответствии со справочником РСХН. <dt:name>Энергетиков ул</dt:name>
57 ···············</dt:street>
58 ···············<dt:house> bs:String255 [0..1] Номер дома. <dt:house>6</dt:house>
59 ···············<dt:building> bs:String255 [0..1] Номер строения. <dt:building>1</dt:building>
60 ···············<dt:room> bs:String255 [0..1] Номер квартиры / офиса. <dt:room>1</dt:room>
61 ···············<dt:postIndex> bs:String255 [0..1] Почтовый индекс. <dt:postIndex>600037</dt:postIndex>
62 ···············<dt:postBox> bs:String255 [0..1] Абонентский ящик <dt:postBox>а/я 56</dt:postBox>
63 ···············<dt:additionalInfo> bs:String255 [0..1] Дополнительная информация. <dt:additionalInfo>Доп. инфо</dt:additionalInfo>
64 ···············<dt:addressView> bs:String255 [0..1] Строковое представление адреса. <dt:addressView>Российская Федерация, Владимирская обл., г. Владимир, ул. Ленина ул., д. 44</dt:addressView>
65 ············</dt:juridicalAddress>
66 ·········</dt:businessEntity>
67 ·········<dt:enterprise> dt:Enterprise [1..1] Данные о поднадзорном объекте.
68 ············<bs:uuid> bs:UUID [1..1] Идентификатор версии поднадзорного объекта. <bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
69 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор поднадзорного объекта. <bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid>
70 ············<bs:active> xs:boolean [1..1] Является ли запись активной:
  • true - запись активна;
  • false - запись не активна.
<bs:active>true</bs:active>
71 ············<bs:last> xs:boolean [1..1] Является ли версия записи последней:
  • true - да;
  • false - нет.
<bs:last>true</bs:last>
72 ············<bs:status> bs:VersionStatus [1..1] Статус версии поднадзорного объекта. <bs:status></bs:status>
73 ············<bs:createDate> xs:DateTime [1..1] Дата создания поднадзорного объекта. <bs:createDate>2017-07-07T12:00:00</bs:createDate>
74 ············<bs:updateDate> xs:DateTime [1..1] Дата изменения поднадзорного объекта. <bs:updateDate>2017-07-07T12:00:00</bs:updateDate>
75 ············<bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии записи реестра поднадзорных объектов. <bs:previous>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous>
76 ············<bs:next> bs:UUID [0..1] Идентификатор следующей версии записи реестра поднадзорных объектов. <bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next>
77 ············<dt:name> bs:String255 [1..1] Полное наименование поднадзорного объекта. <dt:name>Гладиолус</dt:name>
78 ············<dt:type> dt:EnterpriseType [1..1] Тип поднадзорного объекта:
  • 1 - предприятие;
  • 2 - рынок;
  • 3 - СББЖ;
  • 4 - судно.
<dt:type>1</dt:type>
79 ············<dt:numberList> dt:EnterpriseNumberList [0..1] Список номеров предприятия.
80 ···············<dt:enterpriseNumber> bs:String255 [1..*] Номер предприятия <dt:enterpriseNumber>RU751</dt:enterpriseNumber>
81 ············</dt:numberList>
82 ············<dt:address> dt:Address [1..1] Фактический адрес расположения поднадзорного объекта.
83 ···············<dt:country> dt:Country [1..1] Страна
84 ··················<bs:uuid> bs:UUID [1..1] Уникальный идентификатор страны в соответствии со справочником РСХН. <bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
85 ··················<bs:guid> bs:UUID [1..1] Глобальный идентификатор страны в соответствии со справочником РСХН. <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
86 ··················<dt:name> bs:String255 [1..1] Наименование страны в соответствии со справочником РСХН. <dt:name>Российская Федерация</dt:name>
87 ···············</dt:country>
88 ···············<dt:region> dt:Region [1..1] Регион (республика, область, край, автономная область)
89 ··················<bs:uuid> bs:UUID [1..1] Уникальный идентификатор региона страны в соответствии со справочником РСХН. <bs:uuid>e440dcdb-31d6-39a4-db63-a1c0731d61d6</bs:uuid>
90 ··················<bs:guid> bs:UUID [1..1] Глобальный идентификатор региона страны в соответствии со справочником РСХН. <bs:guid>cbdf8cb6-fb9a-4f36-36d3-04488f6d1b82</bs:guid>
91 ··················<dt:name> bs:String255 [1..1] Наименование региона страны в соответствии со справочником РСХН. <dt:name>Владимирская область</dt:name>
92 ···············</dt:region>
93 ···············<dt:district> dt:Locality [0..1] Район региона
94 ··················<bs:uuid> bs:UUID [1..1] Уникальный идентификатор района региона в соответствии со справочником РСХН. <bs:uuid>3cb373d5-32f1-ac2a-754c-58d4b33825dd</bs:uuid>
95 ··················<bs:guid> bs:UUID [1..1] Глобальный идентификатор района региона в соответствии со справочником РСХН. <bs:guid>90d82878-431a-0cf1-0974-16d4fdff3bc8</bs:guid>
96 ··················<dt:name> bs:String255 [1..1] Наименование района региона в соответствии со справочником РСХН. <dt:name>Собинский район</dt:name>
97 ···············</dt:district>
98 ···············<dt:locality> dt:Locality [0..1] Населённый пункт
99 ··················<bs:uuid> bs:UUID [1..1] Уникальный идентификатор города региона (города регионального подчинения) страны в соответствии со справочником РСХН. <bs:uuid>70db962b-d3f3-9a13-93d1-f83a9bc6ed80</bs:uuid>
100 ··················<bs:guid> bs:UUID [1..1] Глобальный идентификатор города региона (города регионального подчинения) страны в соответствии со справочником РСХН. <bs:guid>a16545f3-8f9c-2778-099f-a5d302e58712</bs:guid>
101 ··················<dt:name> bs:String255 [1..1] Наименование города региона (города регионального подчинения) страны в соответствии со справочником РСХН. <dt:name>Владимир г</dt:name>
102 ···············</dt:locality>
103 ···············<dt:subLocality> dt:Locality [0..1] Населённый пункт, подчиненный другогому населенному пункту (locality)
104 ··················<bs:uuid> bs:UUID [1..1] Уникальный идентификатор населенного пункта в соответствии со справочником РСХН. <bs:uuid>3a7b2d0c-2ebd-0dff-9e93-341097ee1db3</bs:uuid>
105 ··················<bs:guid> bs:UUID [1..1] Глобальный идентификатор населенного пункта в соответствии со справочником РСХН. <bs:guid>9f315346-b470-3a1c-56d0-ae1afe9579df</bs:guid>
106 ··················<dt:name> bs:String255 [1..1] Наименование населенного пункта в соответствии со справочником РСХН. <dt:name>Энергетик мкрн</dt:name>
107 ···············</dt:subLocality>
108 ···············<dt:street> dt:Street [0..1] Улица
109 ··················<bs:uuid> bs:UUID [1..1] Уникальный идентификатор улицы города страны в соответствии со справочником РСХН. <bs:uuid>90d82878-431a-0cf1-0974-16d4fdff3bc8</bs:uuid>
110 ··················<bs:guid> bs:UUID [1..1] Глобальный идентификатор улицы города в соответствии со справочником РСХН. <bs:guid>b014d26b-5391-c852-caa4-60fc9bb0a7d4</bs:guid>
111 ··················<dt:name> bs:String255 [1..1] Наименование улицы города в соответствии со справочником РСХН. <dt:name>Энергетиков ул</dt:name>
112 ···············</dt:street>
113 ···············<dt:house> bs:String255 [0..1] Номер дома. <dt:house>6</dt:house>
114 ···············<dt:building> bs:String255 [0..1] Номер строения. <dt:building>1</dt:building>
115 ···············<dt:room> bs:String255 [0..1] Номер квартиры / офиса. <dt:room>1</dt:room>
116 ···············<dt:postIndex> bs:String255 [0..1] Почтовый индекс. <dt:postIndex>600037</dt:postIndex>
117 ···············<dt:postBox> bs:String255 [0..1] Абонентский ящик <dt:postBox>а/я 56</dt:postBox>
118 ···············<dt:additionalInfo> bs:String255 [0..1] Дополнительная информация. <dt:additionalInfo>Доп. инфо</dt:additionalInfo>
119 ···············<dt:addressView> bs:String255 [0..1] Строковое представление адреса. <dt:addressView>Российская Федерация, Владимирская обл., г. Владимир, ул. Ленина ул., д. 44</dt:addressView>
120 ············</dt:address>
121 ············<dt:activityList count="1" total="1" offset="0"> dt:EnterpriseActivityList [1..1] Виды деятельности поднадзорного объекта.
122 ···············<dt:activity> dt:EnterpriseActivity [1..*] Деятельность, осуществляемая предприятием
123 ··················<dt:name> bs:NText [1..1] Название вида деятельности. <dt:name>Реализация пищевых продуктов</dt:name>
124 ···············</dt:activity>
125 ············</dt:activityList>
126 ············<dt:owner> dt:BusinessEntity [0..1] ХС-владелец поднадзорного объекта.
127 ···············<bs:uuid> bs:UUID [1..1] Идентификатор хозяйствующего субъекта. <bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
128 ···············<bs:guid> bs:UUID [1..1] Глобальный идентификатор хозяйствующего субъекта. <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
129 ···············<dt:name> bs:String255 [0..1] Наименование хозяйствующего субъекта. <dt:name>Гладиолус</dt:name>
130 ···············<dt:juridicalAddress> dt:Address [0..1] Юридический адрес
131 ··················<dt:addressView> bs:String255 [0..1] Строковое представление адреса. <dt:addressView>Российская Федерация, Владимирская обл., г. Владимир, ул. Ленина ул., д. 44</dt:addressView>
132 ···············</dt:juridicalAddress>
133 ············</dt:owner>
134 ············<dt:officialRegistration> dt:EnterpriseOfficialRegistration [0..*] Факт постановки на учёт в налоговом органе.
135 ···············<dt:ID> dt:GRNType [0..1] Государственный номер регистрации ФНС. <dt:ID>6789198</dt:ID>
136 ···············<dt:businessEntity> dt:BusinessEntity [1..1] Хозяйствующий субъект, поставивший площадку на учёт в налоговом органе.
137 ··················<bs:uuid> bs:UUID [1..1] Идентификатор хозяйствующего субъекта. <bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
138 ··················<bs:guid> bs:UUID [1..1] Глобальный идентификатор хозяйствующего субъекта. <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
139 ···············</dt:businessEntity>
140 ···············<dt:kpp> bs:String255 [1..1] Код причины постановки на учёт (КПП). <dt:kpp>163501001</dt:kpp>
141 ············<dt:officialRegistration>
142 ·········</dt:enterprise>
143 ·········<dt:globalID> dt:GLNType [1..1] Global Location Number - уникальный номер площадки хозяйствующего субъекта, на которой он осуществляет деятельность. См. http://www.gs1.org/gln. <dt:globalID>4607009526782</dt:globalID>
144 ······</dt:location>
145 ···</dt:activityLocationList>
146 </ws:getActivityLocationListResponse>

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

Запрос первых 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>


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