GetForeignEnterpriseList

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

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

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

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

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

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

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

Данные запроса

Объект getForeignEnterpriseListRequest

Корневой объект запроса. Содержит параметры выводимого списка, и объект, описывающий предприятие.

Поле Описание Тип данных Обязательность
listOptions Параметры выводимого списка. bs:ListOptions 0..1
enterpriseGroup Параметр определяющий группировку предприятий (аттестованные или нет).
  • 0 - все зарубежные предприятия;
  • 1 - аттестованные зарубежные предприятия;
  • 2 - неаттестованные зарубежные предприятия;
  • если значение не указано, то будет получен полный список.
ent:EnterpriseGroup 0..1
enterprise Объект, описывающий предприятие. Содержит поля, по которым доступна фильтрация. ent:Enterprise 0..1

Объект ..Request/enterprise

Объект, описывающий предприятие. Здесь приведены только те его поля, по которым допустима фильтрация в методе. Полный список полей можно посмотреть в описании типа Enterprise.

Поле Описание Тип данных Обязательность
UUID Уникальный идентификатор версии записи предприятия в реестре Россельхознадзора. bs:UUID 0..1
GUID Уникальный глобальный идентификатор в реестре Россельхознадзора. bs:UUID 0..1
name Название предприятия. bs:String255 0..1
englishName Название предприятия на английском языке. bs:String255 0..1
address Адрес предприятия. ikar:Address 0..1

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

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

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