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

Версия 09:14, 2 июля 2018

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

Операция 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-элемента	Тип	Обязат.	Описание	Пример
1	<ws:getForeignEnterpriseListResponse>
2	···<dt:enterpriseList count="100" total="292706" offset="0">	dt:ActivityLocationList	[1..1]
3	······<dt:enterprise>	dt:Enterprise	[0..*]	Данные о поднадзорном объекте.
4	·········<bs:uuid>	bs:UUID	[1..1]	Идентификатор версии поднадзорного объекта.	<bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
5	·········<bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор поднадзорного объекта.	<bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid>
6	·········<bs:active>	xs:boolean	[1..1]	Является ли запись активной: true - запись активна; false - запись не активна.	<bs:active>true</bs:active>
7	·········<bs:last>	xs:boolean	[1..1]	Является ли версия записи последней: true - да; false - нет.	<bs:last>true</bs:last>
8	·········<bs:status>	bs:VersionStatus	[1..1]	Статус версии поднадзорного объекта.	<bs:status>100</bs:status>
9	·········<bs:createDate>	xs:DateTime	[1..1]	Дата создания поднадзорного объекта.	<bs:createDate>2017-07-07T12:00:00</bs:createDate>
10	·········<bs:updateDate>	xs:DateTime	[1..1]	Дата изменения поднадзорного объекта.	<bs:updateDate>2017-07-07T12:00:00</bs:updateDate>
11	·········<bs:previous>	bs:UUID	[0..1]	Идентификатор предыдущей версии записи реестра поднадзорных объектов.	<bs:previous>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous>
12	·········<bs:next>	bs:UUID	[0..1]	Идентификатор следующей версии записи реестра поднадзорных объектов.	<bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next>
13	·········<dt:name>	bs:String255	[1..1]	Полное наименование поднадзорного объекта.	<dt:name>Фрэш Митс</dt:name>
14	·········<dt:englishName>	bs:String255	[1..1]	Английское наименование иностранного предприятия	<dt:englishName>Tyson Fresh Meats</dt:englishName>
15	·········<dt:type>	dt:EnterpriseType	[1..1]	Тип поднадзорного объекта: 1 - предприятие; 2 - рынок; 3 - СББЖ; 4 - судно.	<dt:type>1</dt:type>
16	·········<dt:numberList>	dt:EnterpriseNumberList	[0..1]	Список номеров предприятия.
17	············<dt:enterpriseNumber>	bs:String255	[1..*]	Номер предприятия	<dt:enterpriseNumber>51E</dt:enterpriseNumber>
18	·········</dt:numberList>
19	·········<dt:address>	dt:Address	[1..1]	Фактический адрес расположения поднадзорного объекта.
20	············<dt:country>	dt:Country	[1..1]	Страна
21	···············<bs:uuid>	bs:UUID	[1..1]	Уникальный идентификатор страны в соответствии со справочником РСХН.	<bs:uuid>8fc2b7bd-6d1c-4172-ae87-d27c69e5d9b9</bs:uuid>
22	···············<bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор страны в соответствии со справочником РСХН.	<bs:guid>cac8a802-3c65-397d-895d-c0495bf6ea61</bs:guid>
23	···············<dt:name>	bs:String255	[1..1]	Наименование страны в соответствии со справочником РСХН.	<dt:name>США</dt:name>
24	············</dt:country>
25	············<dt:region>	dt:Region	[1..1]	Регион (республика, область, край, автономная область)
26	···············<bs:uuid>	bs:UUID	[1..1]	Уникальный идентификатор региона страны в соответствии со справочником РСХН.	<bs:uuid>c7bad316-6564-787c-c502-6a9e8afdc093</bs:uuid>
27	···············<bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор региона страны в соответствии со справочником РСХН.	<bs:guid>bbee471c-0548-7190-cca9-5897eedbeac3</bs:guid>
28	···············<dt:name>	bs:String255	[1..1]	Наименование региона страны в соответствии со справочником РСХН.	<dt:name>Техас</dt:name>
29	············</dt:region>
30	············<dt:district>	dt:Locality	[0..1]	Район региона	<dt:district/>
31	···············<bs:uuid>	bs:UUID	[1..1]	Уникальный идентификатор района региона в соответствии со справочником РСХН.
32	···············<bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор района региона в соответствии со справочником РСХН.
33	···············<dt:name>	bs:String255	[1..1]	Наименование района региона в соответствии со справочником РСХН.
34	············</dt:district>
35	············<dt:locality>	dt:Locality	[0..1]	Населённый пункт	<dt:locality/>
36	···············<bs:uuid>	bs:UUID	[1..1]	Уникальный идентификатор города региона (города регионального подчинения) страны в соответствии со справочником РСХН.
37	···············<bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор города региона (города регионального подчинения) страны в соответствии со справочником РСХН.
38	···············<dt:name>	bs:String255	[1..1]	Наименование города региона (города регионального подчинения) страны в соответствии со справочником РСХН.
39	············</dt:locality>
40	············<dt:subLocality>	dt:Locality	[0..1]	Населённый пункт, подчиненный другогому населенному пункту (locality)	<dt:subLocality/>
41	···············<bs:uuid>	bs:UUID	[1..1]	Уникальный идентификатор населенного пункта в соответствии со справочником РСХН.
42	···············<bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор населенного пункта в соответствии со справочником РСХН.
43	···············<dt:name>	bs:String255	[1..1]	Наименование населенного пункта в соответствии со справочником РСХН.
44	············</dt:subLocality>
45	············<dt:street>	dt:Street	[0..1]	Улица	<dt:street/>
46	···············<bs:uuid>	bs:UUID	[1..1]	Уникальный идентификатор улицы города страны в соответствии со справочником РСХН.
47	···············<bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор улицы города в соответствии со справочником РСХН.
48	···············<dt:name>	bs:String255	[1..1]	Наименование улицы города в соответствии со справочником РСХН.
49	············</dt:street>
50	············<dt:house>	bs:String255	[0..1]	Номер дома.	<dt:house>6</dt:house>
51	············<dt:building>	bs:String255	[0..1]	Номер строения.	<dt:building>1</dt:building>
52	············<dt:room>	bs:String255	[0..1]	Номер квартиры / офиса.	<dt:room>1</dt:room>
53	············<dt:postIndex>	bs:String255	[0..1]	Почтовый индекс.	<dt:postIndex>600037</dt:postIndex>
54	············<dt:postBox>	bs:String255	[0..1]	Абонентский ящик	<dt:postBox>11</dt:postBox>
55	············<dt:additionalInfo>	bs:String255	[0..1]	Дополнительная информация.	<dt:additionalInfo>Доп. инфо</dt:additionalInfo>
56	············<dt:addressView>	bs:String255	[0..1]	Строковое представление адреса.	<dt:addressView>Lyndhurst</dt:addressView>
57	············<dt:enAddressView>	bs:String255	[0..1]	Английское строковое представление адреса.	<dt:enAddressView>Lyndhurst</dt:enAddressView>
58	·········</dt:address>
59	·········<dt:activityList count="1" total="1" offset="0">	dt:EnterpriseActivityList	[1..1]	Виды деятельности поднадзорного объекта.
60	············<dt:activity>	dt:EnterpriseActivity	[1..*]	Деятельность, осуществляемая предприятием, указывается согласно справочнику видов деятельности.
61	···············<dt:name>	bs:NText	[0..1]	Название вида деятельности.	<dt:name>Реализация пищевых продуктов</dt:name>
62	············</dt:activity>
63	·········</dt:activityList>
64	·········<dt:owner>	dt:BusinessEntity	[0..1]	Собственник поднадзорного объекта.
65	············<bs:uuid>	bs:UUID	[0..1]	Идентификатор хозяйствующего субъекта.	<bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
66	············<bs:guid>	bs:UUID	[0..1]	Глобальный идентификатор хозяйствующего субъекта.	<bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
67	············<dt:name>	bs:String255	[0..1]	Наименование хозяйствующего субъекта.	<dt:name>Гладиолус</dt:name>
68	············<dt:juridicalAddress>	dt:Address	[0..1]	Юридический адрес
69	···············<dt:addressView>	bs:String255	[0..1]	Строковое представление адреса.	<dt:addressView>Российская Федерация, Владимирская обл., г. Владимир, ул. Ленина ул., д. 44</dt:addressView>
70	············</dt:juridicalAddress>
71	·········</dt:owner>
72	······</dt:enterprise>
73	···</dt:enterpriseList>
74	</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>