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

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


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


===Объект getRussianEnterpriseListRequest===
===Объект getRussianEnterpriseListRequest===
Строка 94: Строка 94:
* При поиске обязательно также указывать регион.
* При поиске обязательно также указывать регион.
  || [[Locality|ikar:Locality]] || 0..1
  || [[Locality|ikar:Locality]] || 0..1
|}
===Объект [[#Объект getRussianEnterpriseListRequest|..Request]]/[[#Объект ..Request/enterprise|enterprise]]/[[#Объект ..Request/enterprise/address|address]]/'''region'''===
Объект содержит данные региона. Фильтрация предприятий в операции осуществляется только при использовании GUID и UUID. Остальные поля описаны в типе данных [[Region]].
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Уникальный идентификатор версии записи региона. || [[UUID|bs:UUID]] || rowspan = 2| 1 - обязательно указать один из идентификаторов. При указании обоих приоритет будет за UUID.
|-
| '''GUID''' || Глобальный идентификатор региона. || [[UUID|bs:UUID]]
|}
|}

Версия 08:49, 25 ноября 2016

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

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

Используемые пространства имён и типы

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

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

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

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

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

Объект getRussianEnterpriseListRequest

Корневой объект запроса. Содержит информацию о параметрах запрашиваемого списка и поля фильтрации предприятия.

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

Объект ..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
address Адрес предприятия. ikar:Address 0..1

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

Объект содержит описание адреса предприятия. Описаны только поля, по которым производится фильтрация. Полный набор полей можно посмотреть в описании типа Address.

Поле Описание Тип данных Обязательность
region Регион Российской Федерации. ikar:Region 0..1
district Район региона Российской Федерации.
  • При поиске по району указывать регион не обязательно.
ikar:District 0..1
locality Населённый пункт регионального подчинения.
  • По населённым пунктам районного подчинения поиск не осуществляется;
  • При поиске обязательно также указывать регион.
ikar:Locality 0..1

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

Объект содержит данные региона. Фильтрация предприятий в операции осуществляется только при использовании GUID и UUID. Остальные поля описаны в типе данных Region.

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