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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 39: Строка 39:
* список российских предприятий.
* список российских предприятий.


==Данные запроса==
==Спецификация запроса==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание
! Пример
|-
|1
|style="font-weight: bold; font-family: Courier;" |<ws:getRussianEnterpriseListRequest>
|
|
|
|style="font-family: Courier;" |
|-
|2
|style="font-weight: bold; font-family: Courier;" |···<bs:listOptions>
|[[ListOptions|bs:ListOptions]]
|[0..1]
|Параметры запрашиваемого списка.
|style="font-family: Courier;" |
|-
|3
|style="font-weight: bold; font-family: Courier;" |······<bs:count>
|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
|[0..1]
|Максимальное запрашиваемое количество объектов в списке.
* По умолчанию значение 100;
* Максимально возможное значение 1000.
|style="font-family: Courier;" |<bs:count>10</bs:count>
|-
|4
|style="font-weight: bold; font-family: Courier;" |······<bs:offset>
|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
|[0..1]
|Номер элемента, по которому осуществляется смещение первого элемента списка.
* По умолчанию значение 0.
|style="font-family: Courier;" |<bs:offset>2</bs:offset>
|-
|5
|style="font-weight: bold; font-family: Courier;" |···</bs:listOptions>
|
|
|
|style="font-family: Courier;" |
|-
|6
|style="font-weight: bold; font-family: Courier;" |···&lt;dt:enterprise>
|[[Enterprise_v2.0|dt:Enterprise]]
|[0..1]
|Данные о поднадзорном объекте.
|style="font-family: Courier;" |
|-
|7
|style="font-weight: bold; font-family: Courier;" |······<bs:uuid>
|[[UUID|bs:UUID]]
|[0..1]
|Идентификатор версии поднадзорного объекта.
|style="font-family: Courier;" |<bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
|-
|8
|style="font-weight: bold; font-family: Courier;" |······<bs:guid>
|[[UUID|bs:UUID]]
|[0..1]
|Глобальный идентификатор поднадзорного объекта.
|style="font-family: Courier;" |<bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid>
|-
|9
|style="font-weight: bold; font-family: Courier;" |······&lt;dt:name>
|[[String255|bs:String255]]
|[0..1]
|Полное наименование поднадзорного объекта.
|style="font-family: Courier;" |&lt;dt:name>Гладиолус</dt:name>
|-
|11
|style="font-weight: bold; font-family: Courier;" |······&lt;dt:numberList>
|[[EnterpriseNumberList_v2.0|dt:EnterpriseNumberList]]
|[0..1]
|Список номеров предприятия.
|style="font-family: Courier;" |
|-
|12
|style="font-weight: bold; font-family: Courier;" |·········&lt;dt:enterpriseNumber>
|[[String255|bs:String255]]
|[1..*]
|Номер предприятия
|style="font-family: Courier;" |&lt;dt:enterpriseNumber>RU751</dt:enterpriseNumber>
|-
|13
|style="font-weight: bold; font-family: Courier;" |······</dt:numberList>
|
|
|
|style="font-family: Courier;" |
|-
|10
|style="font-weight: bold; font-family: Courier;" |······&lt;dt:address>
|[[Address_v2.0|dt:Address]]
|[0..1]
|Фактический адрес расположения поднадзорного объекта.
|style="font-family: Courier;" |
|-
|11
|style="font-weight: bold; font-family: Courier;" |·········&lt;dt:country>
|[[Country_v2.0|dt:Country]]
|[0..1]
|Страна
|style="font-family: Courier;" |
|-
|12
|style="font-weight: bold; font-family: Courier;" |············<bs:guid>
|[[UUID|bs:UUID]]
|[1..1]
|Глобальный идентификатор страны в соответствии со справочником РСХН.
|style="font-family: Courier;" |<bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
|-
|13
|style="font-weight: bold; font-family: Courier;" |·········</dt:country>
|
|
|
|style="font-family: Courier;" |
|-
|14
|style="font-weight: bold; font-family: Courier;" |·········&lt;dt:region>
|[[Region_v2.0|dt:Region]]
|[0..1]
|Регион (республика, область, край, автономная область)
|style="font-family: Courier;" |
|-
|15
|style="font-weight: bold; font-family: Courier;" |············<bs:guid>
|[[UUID|bs:UUID]]
|[1..1]
|Глобальный идентификатор региона страны в соответствии со справочником РСХН.
|style="font-family: Courier;" |<bs:guid>cbdf8cb6-fb9a-4f36-36d3-04488f6d1b82</bs:guid>
|-
|16
|style="font-weight: bold; font-family: Courier;" |·········</dt:region>
|
|
|
|style="font-family: Courier;" |
|-
|17
|style="font-weight: bold; font-family: Courier;" |·········&lt;dt:district>
|[[Localilty_v2.0|dt:Localilty]]
|[0..1]
|Район региона
|style="font-family: Courier;" |
|-
|18
|style="font-weight: bold; font-family: Courier;" |············<bs:guid>
|[[UUID|bs:UUID]]
|[1..1]
|Глобальный идентификатор района региона в соответствии со справочником РСХН.
|style="font-family: Courier;" |<bs:guid>90d82878-431a-0cf1-0974-16d4fdff3bc8</bs:guid>
|-
|19
|style="font-weight: bold; font-family: Courier;" |·········</dt:district>
|
|
|
|style="font-family: Courier;" |
|-
|20
|style="font-weight: bold; font-family: Courier;" |·········&lt;dt:locality>
|[[Localilty_v2.0|dt:Localilty]]
|[0..1]
|Населённый пункт
|style="font-family: Courier;" |
|-
|21
|style="font-weight: bold; font-family: Courier;" |············<bs:guid>
|[[UUID|bs:UUID]]
|[1..1]
|Глобальный идентификатор города региона (города регионального подчинения) страны в соответствии со справочником РСХН.
|style="font-family: Courier;" |<bs:guid>a16545f3-8f9c-2778-099f-a5d302e58712</bs:guid>
|-
|22
|style="font-weight: bold; font-family: Courier;" |·········</dt:locality>
|
|
|
|style="font-family: Courier;" |
|-
|23
|style="font-weight: bold; font-family: Courier;" |·········&lt;dt:subLocality>
|[[Localilty_v2.0|dt:Localilty]]
|[0..1]
|Населённый пункт, подчиненный другогому населенному пункту (locality)
|style="font-family: Courier;" |
|-
|24
|style="font-weight: bold; font-family: Courier;" |············<bs:guid>
|[[UUID|bs:UUID]]
|[1..1]
|Глобальный идентификатор населенного пункта в соответствии со справочником РСХН.
|style="font-family: Courier;" |<bs:guid>9f315346-b470-3a1c-56d0-ae1afe9579df</bs:guid>
|-
|25
|style="font-weight: bold; font-family: Courier;" |·········</dt:subLocality>
|
|
|
|style="font-family: Courier;" |
|-
|26
|style="font-weight: bold; font-family: Courier;" |·········&lt;dt:street>
|[[Street_v2.0|dt:Street]]
|[0..1]
|Улица
|style="font-family: Courier;" |
|-
|27
|style="font-weight: bold; font-family: Courier;" |············<bs:guid>
|[[UUID|bs:UUID]]
|[1..1]
|Глобальный идентификатор улицы города в соответствии со справочником РСХН.
|style="font-family: Courier;" |<bs:guid>b014d26b-5391-c852-caa4-60fc9bb0a7d4</bs:guid>
|-
|28
|style="font-weight: bold; font-family: Courier;" |·········</dt:street>
|
|
|
|style="font-family: Courier;" |
|-
|29
|style="font-weight: bold; font-family: Courier;" |·········&lt;dt:house>
|[[String255|bs:String255]]
|[0..1]
|Номер дома.
|style="font-family: Courier;" |&lt;dt:house>6</dt:house>
|-
|30
|style="font-weight: bold; font-family: Courier;" |·········&lt;dt:building>
|[[String255|bs:String255]]
|[0..1]
|Номер строения.
|style="font-family: Courier;" |&lt;dt:building>1</dt:building>
|-
|31
|style="font-weight: bold; font-family: Courier;" |·········&lt;dt:room>
|[[String255|bs:String255]]
|[0..1]
|Номер квартиры / офиса.
|style="font-family: Courier;" |&lt;dt:room>1</dt:room>
|-
|32
|style="font-weight: bold; font-family: Courier;" |·········&lt;dt:postIndex>
|[[String255|bs:String255]]
|[0..1]
|Почтовый индекс.
|style="font-family: Courier;" |&lt;dt:postIndex>600037</dt:postIndex>
|-
|33
|style="font-weight: bold; font-family: Courier;" |······</dt:address>
|
|
|
|style="font-family: Courier;" |
|-
|34
|style="font-weight: bold; font-family: Courier;" |···</dt:enterprise>
|
|
|
|style="font-family: Courier;" |
|-
|35
|style="font-weight: bold; font-family: Courier;" |</ws:getRussianEnterpriseListRequest>
|
|
|
|style="font-family: Courier;" |
|-
|}


==Данные ответа==
==Данные ответа==

Версия 15:04, 27 октября 2017

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

Операция GetRussianEnterpriseList предназначена для получения списка предприятий, зарегистрированных на территории Российской Федерации. Выводятся актуальные записи (active=true, last=true). Операция поддерживает фильтрацию по полям предприятия и постраничный вывод. Выполнение операции заканчивается либо возвратом списка предприятий, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса.

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

  • параметры выводимого списка;
  • поля, по которым осуществляется фильтрация предприятий.

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

  • список российских предприятий.

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

# Название XML-элемента Тип Обязат. Описание Пример
1 <ws:getRussianEnterpriseListRequest>
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:enterprise> dt:Enterprise [0..1] Данные о поднадзорном объекте.
7 ······<bs:uuid> bs:UUID [0..1] Идентификатор версии поднадзорного объекта. <bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
8 ······<bs:guid> bs:UUID [0..1] Глобальный идентификатор поднадзорного объекта. <bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid>
9 ······<dt:name> bs:String255 [0..1] Полное наименование поднадзорного объекта. <dt:name>Гладиолус</dt:name>
11 ······<dt:numberList> dt:EnterpriseNumberList [0..1] Список номеров предприятия.
12 ·········<dt:enterpriseNumber> bs:String255 [1..*] Номер предприятия <dt:enterpriseNumber>RU751</dt:enterpriseNumber>
13 ······</dt:numberList>
10 ······<dt:address> dt:Address [0..1] Фактический адрес расположения поднадзорного объекта.
11 ·········<dt:country> dt:Country [0..1] Страна
12 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор страны в соответствии со справочником РСХН. <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
13 ·········</dt:country>
14 ·········<dt:region> dt:Region [0..1] Регион (республика, область, край, автономная область)
15 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор региона страны в соответствии со справочником РСХН. <bs:guid>cbdf8cb6-fb9a-4f36-36d3-04488f6d1b82</bs:guid>
16 ·········</dt:region>
17 ·········<dt:district> dt:Localilty [0..1] Район региона
18 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор района региона в соответствии со справочником РСХН. <bs:guid>90d82878-431a-0cf1-0974-16d4fdff3bc8</bs:guid>
19 ·········</dt:district>
20 ·········<dt:locality> dt:Localilty [0..1] Населённый пункт
21 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор города региона (города регионального подчинения) страны в соответствии со справочником РСХН. <bs:guid>a16545f3-8f9c-2778-099f-a5d302e58712</bs:guid>
22 ·········</dt:locality>
23 ·········<dt:subLocality> dt:Localilty [0..1] Населённый пункт, подчиненный другогому населенному пункту (locality)
24 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор населенного пункта в соответствии со справочником РСХН. <bs:guid>9f315346-b470-3a1c-56d0-ae1afe9579df</bs:guid>
25 ·········</dt:subLocality>
26 ·········<dt:street> dt:Street [0..1] Улица
27 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор улицы города в соответствии со справочником РСХН. <bs:guid>b014d26b-5391-c852-caa4-60fc9bb0a7d4</bs:guid>
28 ·········</dt:street>
29 ·········<dt:house> bs:String255 [0..1] Номер дома. <dt:house>6</dt:house>
30 ·········<dt:building> bs:String255 [0..1] Номер строения. <dt:building>1</dt:building>
31 ·········<dt:room> bs:String255 [0..1] Номер квартиры / офиса. <dt:room>1</dt:room>
32 ·········<dt:postIndex> bs:String255 [0..1] Почтовый индекс. <dt:postIndex>600037</dt:postIndex>
33 ······</dt:address>
34 ···</dt:enterprise>
35 </ws:getRussianEnterpriseListRequest>

Данные ответа

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

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

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

Запрос списка первых двух предприятий, в названии которых встречается "Совунья".


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

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