GetForeignEnterpriseChangesList

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

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

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

Используемые пространства имён и типы


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

  • параметры запрашиваемого списка;
  • интервал дат, за которые запрашиваются изменения.

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

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

Данные запроса

Объект getForeignEnterpriseChangesListRequest

Корневой объект запроса. Содержит параметры запрашиваемого списка.

Поле Описание Тип данных Обязательность
listOptions Параметры запрашиваемого списка. bs:ListOptions 0..1
updateDateInterval Интервал дат, за который выбираются изменения. bs:DateInterval 1

Объект ..Request/listOptions

Объект содержит параметры запрашиваемого списка продукции.

Поле Описание Тип данных Обязательность
count Количество значений в списке
  • По умолчанию значение равно 100;
  • Максимально допустимое значение равно 1000
 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
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 Номер предприятия. ent:EnterpriseNumber 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

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

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

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