GetForeignEnterpriseList v2

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

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

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

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

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

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

  • список предприятий с заданными параметрами.

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

# Название XML-элемента Тип Обязат. Описание Пример
1 <ws:getForeignEnterpriseListRequest>
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>
10 ······<dt:englishName> bs:String255 [0..1] Полное наименование поднадзорного объекта. <dt:englishName>Tyson Fresh Meats</dt:englishName>
11 ······<dt:numberList> dt:EnterpriseNumberList [0..1] Список номеров предприятия.
12 ·········<dt:enterpriseNumber> bs:String255 [1..*] Номер предприятия <dt:enterpriseNumber>51E</dt:enterpriseNumber>
13 ······</dt:numberList>
14 ······<dt:address> dt:Address [0..1] Фактический адрес расположения поднадзорного объекта.
15 ·········<dt:country> dt:Country [0..1] Страна, где расположен поднадзорный объект.
16 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор страны в соответствии со справочником РСХН. <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
17 ·········</dt:country>
18 ·········<dt:region> dt:Region [0..1] Регион (республика, область, край, автономная область), в котором расположен поднадзорный объект.
19 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор региона страны в соответствии со справочником РСХН. <bs:guid>cbdf8cb6-fb9a-4f36-36d3-04488f6d1b82</bs:guid>
20 ·········</dt:region>
21 ······</dt:address>
22 ···</dt:enterprise>
23 </ws:getForeignEnterpriseListRequest>

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

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

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

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

Запрос первого предприятия, в текстовом представлении адреса которого встречается "Айзербайджанская Республика, г. Баку".


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