GetForeignEnterpriseChangesList
Общие сведения
Операция GetForeignEnterpriseChangesList предназначена для получения изменений в списке иностранных предприятий за указанный период времени. В общем случае могут быть возвращены не последние и/или не актуальные записи (active=false, last=false). Поддерживается постраничный вывод. Выполнение операции заканчивается либо возвратом списка предприятий, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса.
Используемые пространства имён и типы
|
|
Входные данные
- параметры запрашиваемого списка;
- интервал дат, за которые запрашиваются изменения.
Выходные данные
- список изменённых за период времени предприятий.
Данные запроса
Объект getForeignEnterpriseChangesListRequest
Корневой объект запроса. Содержит параметры запрашиваемого списка.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
listOptions | Параметры запрашиваемого списка. | bs:ListOptions | 0..1 |
updateDateInterval | Интервал дат, за который выбираются изменения. | bs:DateInterval | 1 |
Объект ..Request/listOptions
Объект содержит параметры запрашиваемого списка продукции.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
count | Количество значений в списке.
|
xs:nonNegativeInteger | 0..1 |
offset | Смещение в списке относительно начала. | xs:nonNegativeInteger | 0..1 |
Объект ..Request/updateDateInterval
Объект содержит данные об интервале дат, за которые происходили изменения.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
beginDate | Начальная дата интервала. | xs:dateTime | 1 |
endDate | Конечная дата интервала.
|
xs:dateTime | 0..1 |
Данные ответа
Объект getForeignEnterpriseChangesListResponse
Корневой объект ответа. Содержит список предприятий.
Поля | Описание | Тип данных | Обязательность |
---|---|---|---|
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 |
next | Идентификатор следующей версии записи. | bs:UUID | 0..1 |
name | Название предприятия. | bs:String255 | 1 |
englishName | Название предприятия на английском языке. | bs:String255 | 1 |
type | Тип предприятия согласно классификации в Меркурии:
|
ent:EnterpriseType | 1 |
numberList | Список номеров предприятия. | ent:EnterpriseNumberList | 1 |
address | Фактический адрес предприятия. | ikar:Address | 1 |
activityList | Список видов деятельности предприятия. | ent:EnterpriseActivtyList | 1 |
Объект ..Response/enterpriseList/enterprise/numberList
Список номеров предприятия.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
enterpriseNumber | Номер предприятия. | bs:String255 | 0..* |
Атрибуты списка numberList
Атрибут | Описание | Тип данных | Обязательность |
---|---|---|---|
count | Количество элементов списка, запрашиваемое или переданное. | xs:int | 1 |
total | Общий размер списка. | xs:long | 1 |
offset | Смещение первого элемента списка относительно его начала. | xs:int | 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 |
house | Дом. | bs:String255 | 0..1 |
building | Строение. | bs:String255 | 0..1 |
room | Помещение (офис, квартира и т.п.) | bs:String255 | 0..1 |
postIndex | Почтовый индекс. | bs:String255 | 0..1 |
postBox | Абонентский ящик. | bs:String255 | 0..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/address/district
Объект, содержащий данные о районе.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
UUID | Уникальный идентификатор версии записи в реестре Россельхознадзора. | bs:UUID | 1 |
GUID | Глобальный идентификатор района в реестре Россельхознадзора. | bs:UUID | 1 |
name | Название района. | bs:String255 | 1 |
Объект ..Response/enterpriseList/enterprise/address/locality
Объект, содержащий данные о населённом пункте.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
GUID | Глобальный идентификатор населённого пункта в реестре Россельхознадзора. | bs:UUID | 1 |
name | Название населённого пункта. | bs:String255 | 1 |
Объект ..Response/enterpriseList/enterprise/address/sublocality
Объект, содержащий данные о населённом пункте, подчинённом населённому пункту.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
GUID | Глобальный идентификатор населённого пункта в реестре Россельхознадзора. | bs:UUID | 1 |
name | Название населённого пункта. | bs:String255 | 1 |
Объект ..Response/enterpriseList/enterprise/address/street
Объект, содержащий данные об улице.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
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 | Заданный в запросе отступ больше числа записей в результате запроса. |
Пример запроса
Запрос первых трех иностранных предприятий, измененных за период с 01.01.2015 по текущий день.
<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">
<soapenv:Header/>
<soapenv:Body>
<ws:getForeignEnterpriseChangesListRequest>
<base:listOptions>
<base:count>3</base:count>
<base:offset>0</base:offset>
</base:listOptions>
<base:updateDateInterval>
<base:beginDate>2015-01-01</base:beginDate>
<base:endDate></base:endDate>
</base:updateDateInterval>
</ws:getForeignEnterpriseChangesListRequest>
</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:getForeignEnterpriseChangesListResponse 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="3" total="70" offset="0">
<ent:enterprise>
<bs:uuid>cd3f7df4-add7-493e-85e7-03972fefb156</bs:uuid>
<bs:guid>16105921-1723-2506-c04a-c25613460c90</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>200</bs:status>
<bs:createDate>2015-01-02T02:20:13+03:00</bs:createDate>
<bs:updateDate>2015-01-02T02:20:13+03:00</bs:updateDate>
<bs:previous>0764af6a-053d-11e1-99b4-d8d385fbc9e8</bs:previous>
<ent:name>HB GRANDI HF</ent:name>
<ent:englishName/>
<ent:type>1</ent:type>
<ent:numberList>
<ent:enterpriseNumber>A476</ent:enterpriseNumber>
</ent:numberList>
<ent:address>
<ikar:country>
<bs:uuid>753e740a-60ec-be51-9368-15ab10bc9ed8</bs:uuid>
<bs:guid>df7b0a71-ef4c-7c30-c77f-4e49b3ffd992</bs:guid>
<ikar:name>Исландия</ikar:name>
</ikar:country>
<ikar:region>
<ikar:name/>
</ikar:region>
<ikar:district/>
<ikar:locality/>
<ikar:subLocality/>
<ikar:street/>
<ikar:addressView>NORÐURGARÐUR 1 101 REYKJAVÍK</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:enterprise>
<bs:uuid>35b7834e-a46f-40dd-832e-c934be56bdb9</bs:uuid>
<bs:guid>037fb4d0-fd29-5e19-cdc3-faa142d7431f</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>200</bs:status>
<bs:createDate>2015-01-02T02:21:08+03:00</bs:createDate>
<bs:updateDate>2015-01-02T02:21:08+03:00</bs:updateDate>
<bs:previous>0764d634-053d-11e1-99b4-d8d385fbc9e8</bs:previous>
<ent:name>SALTVER EHF</ent:name>
<ent:englishName/>
<ent:type>1</ent:type>
<ent:numberList>
<ent:enterpriseNumber>A586</ent:enterpriseNumber>
</ent:numberList>
<ent:address>
<ikar:country>
<bs:uuid>753e740a-60ec-be51-9368-15ab10bc9ed8</bs:uuid>
<bs:guid>df7b0a71-ef4c-7c30-c77f-4e49b3ffd992</bs:guid>
<ikar:name>Исландия</ikar:name>
</ikar:country>
<ikar:region>
<ikar:name/>
</ikar:region>
<ikar:district/>
<ikar:locality/>
<ikar:subLocality/>
<ikar:street/>
<ikar:addressView>HAFNARBAKKI 13 260 NJARÐVÍK</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:enterprise>
<bs:uuid>dfcb25c3-dd38-41f4-9786-5c5455af4e01</bs:uuid>
<bs:guid>5504fe64-d72a-f00d-70ce-20a91390a1df</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>200</bs:status>
<bs:createDate>2015-01-02T02:21:48+03:00</bs:createDate>
<bs:updateDate>2015-01-02T02:21:48+03:00</bs:updateDate>
<bs:previous>0764ac0e-053d-11e1-99b4-d8d385fbc9e8</bs:previous>
<ent:name>HB GRANDI HF</ent:name>
<ent:englishName/>
<ent:type>1</ent:type>
<ent:numberList>
<ent:enterpriseNumber>A472</ent:enterpriseNumber>
</ent:numberList>
<ent:address>
<ikar:country>
<bs:uuid>753e740a-60ec-be51-9368-15ab10bc9ed8</bs:uuid>
<bs:guid>df7b0a71-ef4c-7c30-c77f-4e49b3ffd992</bs:guid>
<ikar:name>Исландия</ikar:name>
</ikar:country>
<ikar:region>
<ikar:name/>
</ikar:region>
<ikar:district/>
<ikar:locality/>
<ikar:subLocality/>
<ikar:street/>
<ikar:addressView>BÁRUGATA 8-10 300 AKRANES</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:getForeignEnterpriseChangesListResponse>
</S:Body>
</soapenv:Envelope>