GetForeignEnterpriseList v2

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

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

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

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

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

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

Спецификация запроса

#	Название XML-элемента	Тип	Обязат.	Описание (нажмите [...] для отображения дополнительного описания)
001	<ws:getForeignEnterpriseListRequest>
002	···<bs:listOptions>	bs:ListOptions	[0..1]	Параметры запрашиваемого списка.
003	······<bs:count>10</bs:count>	xs:nonNegativeInteger	[0..1]	Максимальное запрашиваемое количество объектов в списке. По умолчанию значение 100; Максимально возможное значение 1000.
004	······<bs:offset>2</bs:offset>	xs:nonNegativeInteger	[0..1]	Номер элемента, по которому осуществляется смещение первого элемента списка. По умолчанию значение 0.
005	···</bs:listOptions>
006	···<dt:enterprise>	dt:Enterprise	[0..1]	Данные о поднадзорном объекте.
007	······<bs:uuid>UUID</bs:uuid>	bs:UUID	[0..1]	Идентификатор версии поднадзорного объекта.
008	······<bs:guid>GUID</bs:guid>	bs:UUID	[0..1]	Глобальный идентификатор поднадзорного объекта.
009	······<dt:name>Фрэш Митс</dt:name>	bs:String255	[0..1]	Полное наименование поднадзорного объекта.
010	······<dt:englishName>Tyson Fresh Meats</dt:englishName>	bs:String255	[0..1]	Полное наименование поднадзорного объекта.
011	······<dt:numberList>	dt:EnterpriseNumberList	[0..1]	Список номеров предприятия.
012	·········<dt:enterpriseNumber>RU751</dt:enterpriseNumber>	bs:String255	[1..*]	Номер предприятия.
013	······</dt:numberList>
014	······<dt:address>	dt:Address	[0..1]	Фактический адрес расположения поднадзорного объекта.
015	·········<dt:country>	dt:Country	[0..1]	Страна.
016	············<bs:guid>GUID</bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор страны в соответствии со справочником РСХН.
017	·········</dt:country>
018	·········<dt:region>	dt:Region	[0..1]	Регион (республика, область, край, автономная область).
019	············<bs:guid>GUID</bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор региона в соответствии со справочником РСХН.
020	·········</dt:region>
021	······</dt:address>
022	···</dt:enterprise>
023	</ws:getForeignEnterpriseListRequest>

Спецификация ответа

#	Название XML-элемента	Тип	Обязат.	Описание (нажмите [...] для отображения дополнительного описания)
001	<ws:getForeignEnterpriseListResponse>
002	···<dt:enterpriseList count="100" total="292706" offset="0">	dt:ActivityLocationList	[1..1]
003	······<dt:enterprise>	dt:Enterprise	[1..1]	Данные о поднадзорном объекте.
004	·········<bs:uuid>UUID</bs:uuid>	bs:UUID	[1..1]	Идентификатор версии предприятия.
005	·········<bs:guid>GUID</bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор предприятия.
006	·········<bs:active>true</bs:active>	xs:boolean	[1..1]	Является ли запись активной. true - запись активна; false - запись не активна.
007	·········<bs:last>true</bs:last>	xs:boolean	[1..1]	Является ли версия записи последней. true - да; false - нет.
008	·········<bs:status>100</bs:status>	bs:VersionStatus	[1..1]	Статус версии предприятия.
009	·········<bs:createDate>2017-07-07T12:00:00</bs:createDate>	xs:DateTime	[1..1]	Дата создания записи.
010	·········<bs:updateDate>2017-07-07T12:00:00</bs:updateDate>	xs:DateTime	[1..1]	Дата изменения записи.
011	·········<bs:previous>UUID</bs:previous>	bs:UUID	[0..1]	Идентификатор предыдущей версии записи.
012	·········<bs:next>UUID</bs:next>	bs:UUID	[0..1]	Идентификатор следующей версии записи.
013	·········<dt:name>Наименование</dt:name>	bs:String255	[1..1]	Полное наименование поднадзорного объекта.
014	·········<dt:englishName>Tyson Fresh Meats</dt:englishName>	bs:String255	[0..1]	Полное наименование поднадзорного объекта.
015	·········<dt:type>1</dt:type>	dt:EnterpriseType	[1..1]	Тип поднадзорного объекта. 1 - предприятие; 2 - рынок; 3 - СББЖ; 4 - судно.
016	·········<dt:numberList>	dt:EnterpriseNumberList	[0..1]	Список номеров предприятия.
017	············<dt:enterpriseNumber>RU751</dt:enterpriseNumber>	bs:String255	[1..*]	Номер предприятия.
018	·········</dt:numberList>
019	·········<dt:address>	dt:Address	[1..1]	Фактический адрес расположения поднадзорного объекта.
020	············<dt:country>	dt:Country	[1..1]	Страна.
021	···············<bs:uuid>UUID</bs:uuid>	bs:UUID	[1..1]	Уникальный идентификатор страны в соответствии со справочником РСХН.
022	···············<bs:guid>GUID</bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор страны в соответствии со справочником РСХН.
023	···············<dt:name>Страна</dt:name>	bs:String255	[1..1]	Наименование страны в соответствии со справочником РСХН.
024	············</dt:country>
025	············<dt:region>	dt:Region	[0..1]	Регион (республика, область, край, автономная область).
026	···············<bs:uuid>UUID</bs:uuid>	bs:UUID	[1..1]	Уникальный идентификатор региона в соответствии со справочником РСХН.
027	···············<bs:guid>GUID</bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор региона в соответствии со справочником РСХН.
028	···············<dt:name>Регион</dt:name>	bs:String255	[1..1]	Наименование региона страны в соответствии со справочником РСХН.
029	············</dt:region>
030	············<dt:district>	dt:Locality	[0..1]	Район региона.
031	···············<bs:uuid>UUID</bs:uuid>	bs:UUID	[1..1]	Уникальный идентификатор района в соответствии со справочником РСХН.
032	···············<bs:guid>GUID</bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор района в соответствии со справочником РСХН.
033	···············<dt:name>Район</dt:name>	bs:String255	[1..1]	Наименование района региона в соответствии со справочником РСХН.
034	············</dt:district>
035	············<dt:locality>	dt:Locality	[0..1]	Населённый пункт.
036	···············<bs:uuid>UUID</bs:uuid>	bs:UUID	[1..1]	Уникальный идентификатор города в соответствии со справочником РСХН.
037	···············<bs:guid>GUID</bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор города в соответствии со справочником РСХН.
038	···············<dt:name>Город</dt:name>	bs:String255	[1..1]	Наименование города в соответствии со справочником РСХН.
039	············</dt:locality>
040	············<dt:subLocality>	dt:Locality	[0..1]	Населённый пункт, подчиненный другогому населенному пункту (locality).
041	···············<bs:uuid>UUID</bs:uuid>	bs:UUID	[1..1]	Уникальный идентификатор населенного пункта в соответствии со справочником РСХН.
042	···············<bs:guid>GUID</bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор населенного пункта в соответствии со справочником РСХН.
043	···············<dt:name>Населенный пункт</dt:name>	bs:String255	[1..1]	Наименование населенного пункта в соответствии со справочником РСХН.
044	············</dt:subLocality>
045	············<dt:street>	dt:Street	[0..1]	Улица.
046	···············<bs:uuid>UUID</bs:uuid>	bs:UUID	[1..1]	Уникальный идентификатор улицы в соответствии со справочником РСХН.
047	···············<bs:guid>GUID</bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор улицы в соответствии со справочником РСХН.
048	···············<dt:name>Улица</dt:name>	bs:String255	[1..1]	Наименование улицы в соответствии со справочником РСХН.
049	············</dt:street>
050	············<dt:house>6</dt:house>	bs:String255	[0..1]	Номер дома.
051	············<dt:building>1</dt:building>	bs:String255	[0..1]	Номер строения.
052	············<dt:room>1</dt:room>	bs:String255	[0..1]	Номер квартиры / офиса.
053	············<dt:postIndex>600037</dt:postIndex>	bs:String255	[0..1]	Почтовый индекс.
054	············<dt:postBox>а/я 56</dt:postBox>	bs:String255	[0..1]	Абонентский ящик
055	············<dt:additionalInfo>Доп. инфо</dt:additionalInfo>	bs:String255	[0..1]	Дополнительная информация.
056	············<dt:addressView>Текстовый адрес</dt:addressView>	bs:String255	[0..1]	Строковое представление адреса.
057	·········</dt:address>
058	·········<dt:activityList count="1" total="1" offset="0">	dt:EnterpriseActivityList	[0..1]	Виды деятельности поднадзорного объекта.
059	············<dt:activity>	dt:EnterpriseActivity	[1..*]	Деятельность, осуществляемая предприятием.
060	···············<dt:name>Реализация пищевых продуктов</dt:name>	bs:NText	[1..1]	Название вида деятельности.
061	············</dt:activity>
062	·········</dt:activityList>
063	·········<dt:owner>	dt:BusinessEntity	[0..1]	ХС-владелец поднадзорного объекта.
064	············<bs:uuid>UUID</bs:uuid>	bs:UUID	[1..1]	Идентификатор хозяйствующего субъекта.
065	············<bs:guid>GUID</bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор хозяйствующего субъекта.
066	············<dt:juridicalAddress>	dt:Address	[0..1]	Юридический адрес.
067	···············<dt:addressView>Текстовый адрес</dt:addressView>	bs:String255	[0..1]	Строковое представление адреса.
068	············</dt:juridicalAddress>
069	·········</dt:owner>
070	·········<dt:registryStatus>VERIFIED</dt:registryStatus>	dt:EnterpriseStatus	[0..1]	(v2.1) Статус предприятия в реестре ИС Цербер. UNVERIFIED - Не подтверджен (не в реестре). VERIFIED - Подтвержден (включен в реестр). CANCELED - Исключен из реестра. DELETED - Удален.
071	······</dt:enterprise>
072	···</dt:enterpriseList>
073	</ws:getForeignEnterpriseListResponse>

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

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

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

Поиск предприятий, в названии которых содержится слово "Meat"

Поиск предприятий, в названии которых содержится слово "Meat". Вывод первых трех записей без смещения.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2" xmlns:bs="http://api.vetrf.ru/schema/cdm/base" xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:getForeignEnterpriseListRequest>
     	<bs:listOptions>
           <bs:count>3</bs:count>
           <bs:offset>0</bs:offset>
        </bs:listOptions>
     	<dt:enterprise>
           <dt:name>Meat</dt:name>
        </dt:enterprise>
      </ws:getForeignEnterpriseListRequest>
   </soapenv:Body>
</soapenv:Envelope>

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

Поиск предприятий, расположенных в США.

Поиск предприятий, расположенных в США. Вывод первых трех записей без смещения.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2" xmlns:bs="http://api.vetrf.ru/schema/cdm/base" xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:getForeignEnterpriseListRequest>
     	 <bs:listOptions>
            <bs:count>3</bs:count>
            <bs:offset>0</bs:offset>
         </bs:listOptions>
     	 <dt:enterprise>
            <dt:address>
               <dt:country>
                  <bs:guid>cac8a802-3c65-397d-895d-c0495bf6ea61</bs:guid>
               </dt:country>
	    </dt:address>
         </dt:enterprise>
      </ws:getForeignEnterpriseListRequest>
   </soapenv:Body>
</soapenv:Envelope>

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