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

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


{{столбцы}}
{{столбцы}}
Строка 35: Строка 35:
* поля предприятия, по которым список фильтруется.
* поля предприятия, по которым список фильтруется.


===Выходные данные===
===[[#Объект getForeignEnterpriseListResponse|Выходные данные]]===
* список предприятий с заданными параметрами.
* список предприятий с заданными параметрами.


Строка 53: Строка 53:
* 2 - неаттестованные зарубежные предприятия;
* 2 - неаттестованные зарубежные предприятия;
* если значение не указано, то будет получен полный список.
* если значение не указано, то будет получен полный список.
|| ent:EnterpriseGroup || 0..1
|| [[EnterpriseGroup|ent:EnterpriseGroup]] || 0..1
|-
|-
| [[#Объект ..Request/enterprise|'''enterprise''']] || Объект, описывающий предприятие. Содержит поля, по которым доступна фильтрация. || [[Enterprise|ent:Enterprise]] || 0..1
| [[#Объект ..Request/enterprise|'''enterprise''']] || Объект, описывающий предприятие. Содержит поля, по которым доступна фильтрация. || [[Enterprise|ent:Enterprise]] || 0..1
Строка 66: Строка 66:
! Поле !! Описание !! Тип данных !! Обязательность
! Поле !! Описание !! Тип данных !! Обязательность
|-
|-
| '''count''' || Количество значений в списке
| '''count''' || Количество значений в списке.
* По умолчанию значение равно 100;
* По умолчанию значение равно 100;
* Максимально допустимое значение равно 1000.
* Максимально допустимое значение равно 1000.
Строка 90: Строка 90:
|-
|-
| [[#Объект ..Request/enterprise/address|'''address''']] || Адрес предприятия. || [[Address|ikar:Address]] || 0..1
| [[#Объект ..Request/enterprise/address|'''address''']] || Адрес предприятия. || [[Address|ikar:Address]] || 0..1
|-
| [[#Объект ..Request/enterprise/numberList|'''numberList''']] || Список номеров предприятия. || [[EnterpriseNumberList|ikar:EnterpriseNumberList]] || 0..1
|}
|}


Строка 104: Строка 106:
* Фильтрация по текстовому представлению адреса осуществляется только при указании страны.
* Фильтрация по текстовому представлению адреса осуществляется только при указании страны.
|| [[String255|bs:String255]] || 0..1
|| [[String255|bs:String255]] || 0..1
|}
===Объект [[#Объект getForeignEnterpriseListRequest|..Request]]/[[#Объект ..Request/enterprise|enterprise]]/'''numberList'''===
Объект, описывающий содержимое адреса предприятия.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''enterpriseNumber''' || Номер предприятия. || [[EnterpriseNumber|ent:EnterpriseNumber]] || 0..1
|}
|}


Строка 134: Строка 146:
|}
|}


===Объект [[#Объект getRussianEnterpriseListResponse|..Response]]/'''enterpriseList'''===
===Объект [[#Объект getForeignEnterpriseListResponse|..Response]]/'''enterpriseList'''===


Объект содержит список предприятий, возвращаемых в результате выполнения операции.
Объект содержит список предприятий, возвращаемых в результате выполнения операции.
Строка 183: Строка 195:
|| [[EnterpriseType|ent:EnterpriseType]] || 1
|| [[EnterpriseType|ent:EnterpriseType]] || 1
|-
|-
| '''numberList''' || Список номеров предприятия. || [[ent:EnterpriseNumberList]] || 1
| [[#Объект ..Response/enterpriseList/enterprise/numberList|'''numberList''']] || Список номеров предприятия. || [[ent:EnterpriseNumberList]] || 1
|-
|-
| '''address''' || Фактический адрес предприятия. || [[Address|ikar:Address]] || 1
| [[#Объект ..Response/enterpriseList/enterprise/address|'''address''']] || Фактический адрес предприятия. || [[Address|ikar:Address]] || 1
|-
|-
| '''activityList''' || Список видов деятельности предприятия. || [[EnterpriseActivityList|ent:EnterpriseActivtyList]] || 1
| [[#Объект ..Response/enterpriseList/enterprise/activityList |'''activityList''']] || Список видов деятельности предприятия. || [[EnterpriseActivityList|ent:EnterpriseActivtyList]] || 1
|}
 
===Объект [[#Объект getForeignEnterpriseListResponse|..Response]]/[[#Объект ..Response/enterpriseList|enterpriseList]]/[[#Объект ..Response/enterpriseList/enterprise|enterprise]]/'''numberList'''===
 
Список номеров предприятия.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''enterpriseNumber''' || Номер предприятия. || [[String255|bs:String255]] || 0..*
|}
|}


Строка 213: Строка 236:
|-
|-
| '''addressView''' || Текстовое представление адреса. || [[String255|bs:String255]] || 1
| '''addressView''' || Текстовое представление адреса. || [[String255|bs:String255]] || 1
|-
| '''enAddressView''' || Текстовое представление адреса на английском языке. || [[String255|bs:String255]] || 1
|}
|}


Строка 243: Строка 268:
|-
|-
| '''name''' || Название региона или города федерального значения. || [[String255|bs:String255]] || 1
| '''name''' || Название региона или города федерального значения. || [[String255|bs:String255]] || 1
|}
===Объект [[#Объект getForeignEnterpriseListResponse|..Response]]/[[#Объект ..Response/enterpriseList|enterpriseList]]/[[#Объект ..Response/enterpriseList/enterprise|enterprise]]/'''numberList'''===
Список номеров предприятия.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''enterpriseNumber''' || Номер предприятия. || [[EnterpriseNumber|ent:EnterpriseNumber]] || 0..*
|}
|}


Строка 283: Строка 297:


==Описание ошибок==
==Описание ошибок==
{| class="wikitable"
|-
! Ошибка <!--!! Пространство имён--> !! Описание
|-
| '''InternalServiceFault''' <!--|| namespace=”http://api.vetrf.ru/schema/cdm/ikar/ws-definitions”--> || Внутренняя ошибка сервиса.
|-
| '''IncorrectRequestFault''' <!--|| namespace=”http://api.vetrf.ru/schema/cdm/ikar/ws-definitions”--> || Некорректный запрос. Возникает, если запрос не соответствует требованиям указанным в xsd.
|-
| '''OffsetOutOfRangeFault''' <!--|| namespace=”http://api.vetrf.ru/schema/cdm/ikar/ws-definitions”--> || Заданный в запросе отступ больше числа записей в результате запроса.
|}


==Пример запроса==
==Пример запроса==
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Запрос первого предприятия, в текстовом представлении адреса которого встречается "Айзербайджанская Республика, г. Баку".
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:ws="http://api.vetrf.ru/schema/cdm/cerberus/enterprise/ws-definitions"
                  xmlns:base="http://api.vetrf.ru/schema/cdm/base"
                  xmlns:ent="http://api.vetrf.ru/schema/cdm/cerberus/enterprise"
                  xmlns:ikar="http://api.vetrf.ru/schema/cdm/ikar">
  <soapenv:Header/>
  <soapenv:Body>
    <ws:getForeignEnterpriseListRequest>
      <base:listOptions>
        <base:count>1</base:count>
        <base:offset>0</base:offset>
      </base:listOptions>
      <ent:enterpriseGroup>0</ent:enterpriseGroup>
      <ent:enterprise>
        <ent:address>
          <ikar:country>
            <base:guid>3d8255f1-48eb-7932-b951-c91a1d65aead</base:guid>
          </ikar:country>
          <ikar:addressView>Айзербайджанская Республика, г. Баку</ikar:addressView>
        </ent:address>
      </ent:enterprise>
    </ws:getForeignEnterpriseListRequest>
  </soapenv:Body>
</soapenv:Envelope>
</syntaxhighlight>
</div>
</div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Ответ на запрос.
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Body xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <ws:getForeignEnterpriseListResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base"
                                        xmlns:ikar="http://api.vetrf.ru/schema/cdm/ikar"
                                        xmlns:ent="http://api.vetrf.ru/schema/cdm/cerberus/enterprise"
                                        xmlns:ws="http://api.vetrf.ru/schema/cdm/cerberus/enterprise/ws-definitions">
      <ent:enterpriseList count="1" total="1" offset="0">
        <ent:enterprise>
          <bs:uuid>070818cc-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
          <bs:guid>7b7ce78a-60fc-80ee-419f-bd7d5d9ab8db</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2009-12-14T14:48:30+03:00</bs:createDate>
          <bs:updateDate>2009-12-14T14:48:30+03:00</bs:updateDate>
          <ent:name>ОАО "Бакинский Морской Рыбный Порт"</ent:name>
          <ent:englishName>ОАО "Бакинский Морской Рыбный Порт"</ent:englishName>
          <ent:type>1</ent:type>
          <ent:address>
            <ikar:country>
              <bs:uuid>9860ea6c-d599-a234-ee96-e1b4b563b716</bs:uuid>
              <bs:guid>3d8255f1-48eb-7932-b951-c91a1d65aead</bs:guid>
              <ikar:name>Азербайджан</ikar:name>
            </ikar:country>
            <ikar:region>
              <ikar:name/>
            </ikar:region>
            <ikar:district/>
            <ikar:locality/>
            <ikar:subLocality/>
            <ikar:street/>
            <ikar:addressView>Айзербайджанская Республика, г. Баку, Сураханский район, пос. Говсаны 89, ул.Ш.Зиядова</ikar:addressView>
            <ikar:enAddressView/>
          </ent:address>
          <ent:activityList count="1" total="1" offset="0">
            <ent:activity>
              <ent:name>Мороженая рыба-килька Каспийская</ent:name>
            </ent:activity>
          </ent:activityList>
        </ent:enterprise>
      </ent:enterpriseList>
    </ws:getForeignEnterpriseListResponse>
  </S:Body>
</soapenv:Envelope>
</syntaxhighlight>
</div>
</div>
[[Category:Ветис.API]]
[[Category:EnterpriseService]]
[[Category:Реестры]]

Текущая версия на 08:38, 16 декабря 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
numberList Список номеров предприятия. ikar:EnterpriseNumberList 0..1

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

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

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

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

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

Поле Описание Тип данных Обязательность
enterpriseNumber Номер предприятия. ent:EnterpriseNumber 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/numberList

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

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

Объект ..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
enAddressView Текстовое представление адреса на английском языке. 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/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

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

Ошибка Описание
InternalServiceFault Внутренняя ошибка сервиса.
IncorrectRequestFault Некорректный запрос. Возникает, если запрос не соответствует требованиям указанным в xsd.
OffsetOutOfRangeFault Заданный в запросе отступ больше числа записей в результате запроса.

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

Запрос первого предприятия, в текстовом представлении адреса которого встречается "Айзербайджанская Республика, г. Баку".

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
                  xmlns:ws="http://api.vetrf.ru/schema/cdm/cerberus/enterprise/ws-definitions" 
                  xmlns:base="http://api.vetrf.ru/schema/cdm/base" 
                  xmlns:ent="http://api.vetrf.ru/schema/cdm/cerberus/enterprise" 
                  xmlns:ikar="http://api.vetrf.ru/schema/cdm/ikar">
  <soapenv:Header/>
  <soapenv:Body>
    <ws:getForeignEnterpriseListRequest>
      <base:listOptions>
        <base:count>1</base:count>
        <base:offset>0</base:offset>
      </base:listOptions>
      <ent:enterpriseGroup>0</ent:enterpriseGroup>
      <ent:enterprise>
        <ent:address>
          <ikar:country>
            <base:guid>3d8255f1-48eb-7932-b951-c91a1d65aead</base:guid>
          </ikar:country>
          <ikar:addressView>Айзербайджанская Республика, г. Баку</ikar:addressView>
        </ent:address>
      </ent:enterprise>
    </ws:getForeignEnterpriseListRequest>
  </soapenv:Body>
</soapenv:Envelope>


Ответ на запрос.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Body xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <ws:getForeignEnterpriseListResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base" 
                                         xmlns:ikar="http://api.vetrf.ru/schema/cdm/ikar" 
                                         xmlns:ent="http://api.vetrf.ru/schema/cdm/cerberus/enterprise" 
                                         xmlns:ws="http://api.vetrf.ru/schema/cdm/cerberus/enterprise/ws-definitions">
      <ent:enterpriseList count="1" total="1" offset="0">
        <ent:enterprise>
          <bs:uuid>070818cc-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
          <bs:guid>7b7ce78a-60fc-80ee-419f-bd7d5d9ab8db</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2009-12-14T14:48:30+03:00</bs:createDate>
          <bs:updateDate>2009-12-14T14:48:30+03:00</bs:updateDate>
          <ent:name>ОАО "Бакинский Морской Рыбный Порт"</ent:name>
          <ent:englishName>ОАО "Бакинский Морской Рыбный Порт"</ent:englishName>
          <ent:type>1</ent:type>
          <ent:address>
            <ikar:country>
              <bs:uuid>9860ea6c-d599-a234-ee96-e1b4b563b716</bs:uuid>
              <bs:guid>3d8255f1-48eb-7932-b951-c91a1d65aead</bs:guid>
              <ikar:name>Азербайджан</ikar:name>
            </ikar:country>
            <ikar:region>
              <ikar:name/>
            </ikar:region>
            <ikar:district/>
            <ikar:locality/>
            <ikar:subLocality/>
            <ikar:street/>
            <ikar:addressView>Айзербайджанская Республика, г. Баку, Сураханский район, пос. Говсаны 89, ул.Ш.Зиядова</ikar:addressView>
            <ikar:enAddressView/>
          </ent:address>
          <ent:activityList count="1" total="1" offset="0">
            <ent:activity>
              <ent:name>Мороженая рыба-килька Каспийская</ent:name>
            </ent:activity>
          </ent:activityList>
        </ent:enterprise>
      </ent:enterpriseList>
    </ws:getForeignEnterpriseListResponse>
  </S:Body>
</soapenv:Envelope>