GetRussianEnterpriseList
Общие сведения
Операция GetRussianEnterpriseList предназначена для получения списка предприятий, зарегистрированных на территории Российской Федерации. Выводятся актуальные записи (active=true, last=true). Операция поддерживает фильтрацию по полям предприятия и постраничный вывод.
Используемые пространства имён и типы
|
|
Входные данные
- параметры выводимого списка;
- поля предприятия, по которым список фильтруется.
Выходные данные
- список российских предприятий.
Данные запросы
Объект getRussianEnterpriseListRequest
Корневой объект запроса. Содержит информацию о параметрах запрашиваемого списка и поля фильтрации предприятия.
| Поле | Описание | Тип данных | Обязательность |
|---|---|---|---|
| listOptions | Параметры выводимого списка. | bs:ListOptions | 0..1 |
| enterprise | Объект, описывающий предприятие. Содержит поля, по которым доступна фильтрация. | ent:Enterprise | 0..* |
Объект ..Request/listOptions
Объект содержит параметры выводимого списка.
| Поле | Описание | Тип данных | Обязательность |
|---|---|---|---|
| count | Количество значений в списке
|
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 |
| address | Адрес предприятия. | ikar:Address | 0..1 |
Объект ..Request/enterprise/address
Объект содержит описание адреса предприятия. Описаны только поля, по которым производится фильтрация. Полный набор полей можно посмотреть в описании типа Address.
