GetForeignEnterpriseList

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

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

xs (http://www.w3.org/2001/XMLSchema) xs:boolean xs:dateTime xs:nonNegativeInteger

ikar(http://api.vetrf.ru/schema/cdm/ikar) ikar:Address ikar:Region ikar:Disctrict ikar:Locality ikar:Street

ent (http://api.vetrf.ru/schema/cdm/cerberus/enterprise) ent:Enterprise ent:EnterpriseList ent:EnterpriseType ent:EnterpriseActivity ent:EnterpriseActivityList

bs (http://api.vetrf.ru/schema/cdm/base) bs:UUID bs:ListOptions bs:String255 bs:VersionStatus

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

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

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

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

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

Объект getForeignEnterpriseListRequest

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

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

Объект ..Request/listOptions

Объект содержит параметры выводимого списка.

Поле	Описание	Тип данных	Обязательность
count	Количество значений в списке По умолчанию значение равно 100; Максимально допустимое значение равно 1000.	xs:nonNegativeInteger	0..1
offset	Смещение в списке относительно начала.	xs:nonNegativeInteger	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

Объект ..Request/enterpriseList/enterprise/address

Объект, описывающий содержимое адреса предприятия.

Поле	Описание	Тип данных	Обязательность
country	Страна, где находится предприятие.	ikar:Country	0..1
addressView	Текстовое представление адреса. Фильтрация по текстовому полю осуществляется только при указании страны.	bs:String255	0..1

Объект ..Request/enterpriseList/enterprise/address/country

Объект, содержащий данные страны.

Поле	Описание	Тип данных	Обязательность
UUID	Уникальный идентификатор версии записи в реестре Россельхознадзора.	bs:UUID	1
GUID	Глобальный идентификатор страны в реестре Россельхознадзора.	bs:UUID	1
name	Название страны.	bs:String255	1