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

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


==Данные ответа==
==Данные ответа==
===Объект getForeignEnterpriseListResponse===
Корневой объект ответа. Содержит информацию о списке возвращаемых предприятий.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Response/enterpriseList|'''enterpriseList''']] || Объект описывает список возвращаемых предприятий. || [[EnterpriseList|ent:EnterpriseList]] || 1
|}
===Объект [[#Объект getRussianEnterpriseListResponse|..Response]]/'''enterpriseList'''===
Объект содержит список предприятий, возвращаемых в результате выполнения операции.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Response/enterpriseList/enterprise|'''enterprise''']] || Объект, описывающий предприятие. || [[Enterprise|ent:Enterprise]] || 0..*
|}
'''Атрибуты списка enterpriseList'''
{{Ветис.API EntityList Attributes}}
===Объект [[#Объект getForeignEnterpriseListResponse|..Response]]/[[#Объект ..Response/enterpriseList|enterpriseList]]/'''enterprise'''===
Объект содержит сведения о предприятии.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Уникальный идентификатор версии записи предприятия. || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор предприятия в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|-
| '''active''' || Флаг, указывающий на то, активно ли предприятие. || [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
|-
| '''last''' || Флаг, указывающий на то, последняя ли запись. || [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
|-
| '''status''' || Статус версии записи. || [[VersionStatus|bs:VersionStatus]] || 1
|-
| '''createDate''' || Дата создания записи предприятия в реестре Россельхознадзора. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
|-
| '''updateDate''' || Дата последнего обновления записи предприятия в реестре Россельхознадзора. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
|-
| '''previous''' || Предыдущая версия записи предприятия в реестре Россельхощнадзора. || [[UUID|bs:UUID]] || 0..1
|-
| '''name''' || Название предприятия. || [[String255|bs:String255]] || 1
|-
| '''englishName''' || Название предприятия на английском языке. || [[String255|bs:String255]] || 1
|-
| '''type''' || Тип предприятия согласно классификации в Меркурии:
* 1 - предприятие;
* 2 - рынок;
* 3 - СББЖ;
* 4 - судно.
|| [[EnterpriseType|ent:EnterpriseType]] || 1
|-
| '''numberList''' || Список номеров предприятия. || [[ent:EnterpriseNumberList]] || 1
|-
| '''address''' || Фактический адрес предприятия. || [[Address|ikar:Address]] || 1
|-
| '''activityList''' || Список видов деятельности предприятия. || [[EnterpriseActivityList|ent:EnterpriseActivtyList]] || 1
|}
===Объект [[#Объект getForeignEnterpriseListResponse|..Response]]/[[#Объект ..Response/enterpriseList|enterpriseList]]/[[#Объект ..Response/enterpriseList/enterprise|enterprise]]/'''address'''===
Объект, описывающий содержимое адреса предприятия.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Response/enterpriseList/enterprise/address/country|'''country''']] || Страна, где находится предприятие. || [[Country|ikar:Country]] || 1
|-
| [[#Объект ..Response/enterpriseList/enterprise/address/region|'''region''']] || Регион страны.  || [[Region|ikar:Region]] || 1
|-
| '''district''' || Район региона.
* На данный момент этот объект и объекты уровня ниже не заполняются, но в ответе возвращаются.
|| [[District|ikar:District]] || 1
|-
| '''locality''' || Населённый пункт. || [[Locality|ikar:Locality]] || 1
|-
| '''sublocality''' || Населённый пункт, подчинённый населённому пункту. || [[Locality|ikar:Locality]] || 1
|-
| '''street''' || Улица в населённом пункте. || [[Street|ikar:Street]] || 1
|-
| '''addressView''' || Текстовое представление адреса. || [[String255|bs:String255]] || 1
|}
===Объект [[#Объект getForeignEnterpriseListResponse|..Response]]/[[#Объект ..Response/enterpriseList|enterpriseList]]/[[#Объект ..Response/enterpriseList/enterprise|enterprise]]/[[#Объект ..Response/enterpriseList/enterprise/address|address]]/'''country'''===
Объект, содержащий данные страны.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Уникальный идентификатор версии записи в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор страны в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|-
| '''name''' || Название страны. || [[String255|bs:String255]] || 1
|}
===Объект [[#Объект getForeignEnterpriseListResponse|..Response]]/[[#Объект ..Response/enterpriseList|enterpriseList]]/[[#Объект ..Response/enterpriseList/enterprise|enterprise]]/[[#Объект ..Response/enterpriseList/enterprise/address|address]]/'''region'''===
Объект, содержащий данные о регионе страны.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Уникальный идентификатор версии записи в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор региона в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|-
| '''name''' || Название региона или города федерального значения. || [[String255|bs:String255]] || 1
|}
===Объект [[#Объект getForeignEnterpriseListResponse|..Response]]/[[#Объект ..Response/enterpriseList|enterpriseList]]/[[#Объект ..Response/enterpriseList/enterprise|enterprise]]/'''numberList'''===
Список номеров предприятия.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''enterpriseNumber''' || Номер предприятия. || [[EnterpriseNumber|ent:EnterpriseNumber]] || 0..*
|}
===Объект [[#Объект getForeignEnterpriseListResponse|..Response]]/[[#Объект ..Response/enterpriseList|enterpriseList]]/[[#Объект ..Response/enterpriseList/enterprise|enterprise]]/'''activityList'''===
Список видов деятельности предприятия.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Response/enterpriseList/enterprise/activityList/activity|'''activity''']] || Описание вида деятельности предприятия. || [[EnterpriseActivity|ent:EnterpriseActivity]] || 0..*
|}
'''Атрибуты списка enterpriseActivity'''
{{Ветис.API EntityList Attributes}}
===Объект [[#Объект getForeignEnterpriseListResponse|..Response]]/[[#Объект ..Response/enterpriseList|enterpriseList]]/[[#Объект ..Response/enterpriseList/enterprise|enterprise]]/[[#Объект ..Response/enterpriseList/enterprise/activityList|activityList]]/'''activity'''===
Название вида деятельности предприятия.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''name''' || Название вида деятельности предприятия. || [[String255|bs:String255]] || 0..1
|}


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


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

Версия 23:43, 27 ноября 2016

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

Операция 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/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/enterprise/address

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

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

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

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

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

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

Объект getForeignEnterpriseListResponse

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

Поле Описание Тип данных Обязательность
enterpriseList Объект описывает список возвращаемых предприятий. ent:EnterpriseList 1

Объект ..Response/enterpriseList

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

Поле Описание Тип данных Обязательность
enterprise Объект, описывающий предприятие. ent:Enterprise 0..*

Атрибуты списка enterpriseList

Атрибут Описание Тип данных Обязательность
count Количество элементов списка, запрашиваемое или переданное. xs:int 1
total Общий размер списка. xs:long 1
offset Смещение первого элемента списка относительно его начала. xs:int 1

Объект ..Response/enterpriseList/enterprise

Объект содержит сведения о предприятии.

Поле Описание Тип данных Обязательность
UUID Уникальный идентификатор версии записи предприятия. bs:UUID 1
GUID Глобальный идентификатор предприятия в реестре Россельхознадзора. bs:UUID 1
active Флаг, указывающий на то, активно ли предприятие. xs:boolean 1
last Флаг, указывающий на то, последняя ли запись. xs:boolean 1
status Статус версии записи. bs:VersionStatus 1
createDate Дата создания записи предприятия в реестре Россельхознадзора. xs:dateTime 1
updateDate Дата последнего обновления записи предприятия в реестре Россельхознадзора. xs:dateTime 1
previous Предыдущая версия записи предприятия в реестре Россельхощнадзора. bs:UUID 0..1
name Название предприятия. bs:String255 1
englishName Название предприятия на английском языке. bs:String255 1
type Тип предприятия согласно классификации в Меркурии:
  • 1 - предприятие;
  • 2 - рынок;
  • 3 - СББЖ;
  • 4 - судно.
 ent:EnterpriseType 1
numberList Список номеров предприятия. ent:EnterpriseNumberList 1
address Фактический адрес предприятия. ikar:Address 1
activityList Список видов деятельности предприятия. ent:EnterpriseActivtyList 1

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

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

Поле Описание Тип данных Обязательность
country Страна, где находится предприятие. ikar:Country 1
region Регион страны. ikar:Region 1
district Район региона.
  • На данный момент этот объект и объекты уровня ниже не заполняются, но в ответе возвращаются.
 ikar:District 1
locality Населённый пункт. ikar:Locality 1
sublocality Населённый пункт, подчинённый населённому пункту. ikar:Locality 1
street Улица в населённом пункте. ikar:Street 1
addressView Текстовое представление адреса. bs:String255 1

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

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

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

Объект ..Response/enterpriseList/enterprise/address/region

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

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

Объект ..Response/enterpriseList/enterprise/numberList

Список номеров предприятия.

Поле Описание Тип данных Обязательность
enterpriseNumber Номер предприятия. ent:EnterpriseNumber 0..*

Объект ..Response/enterpriseList/enterprise/activityList

Список видов деятельности предприятия.

Поле Описание Тип данных Обязательность
activity Описание вида деятельности предприятия. ent:EnterpriseActivity 0..*

Атрибуты списка enterpriseActivity

Атрибут Описание Тип данных Обязательность
count Количество элементов списка, запрашиваемое или переданное. xs:int 1
total Общий размер списка. xs:long 1
offset Смещение первого элемента списка относительно его начала. xs:int 1

Объект ..Response/enterpriseList/enterprise/activityList/activity

Название вида деятельности предприятия.

Поле Описание Тип данных Обязательность
name Название вида деятельности предприятия. bs:String255 0..1

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

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

Источник — http://help.vetrf.ru/index.php?title=GetForeignEnterpriseList&oldid=18651