GetForeignEnterpriseChangesList: различия между версиями
Перейти к навигации
Перейти к поиску
(Новая страница: «==Общие сведения== Операция '''GetForeignEnterpriseChangesList''' предназначена для получения изменений в…») |
|||
Строка 71: | Строка 71: | ||
==Данные ответа== | ==Данные ответа== | ||
===Объект getForeignEnterpriseChangesListResponse=== | |||
Корневой объект ответа. Содержит список предприятий. | |||
{| class="wikitable" | |||
|- | |||
! Поля !! Описание !! Тип данных !! Обязательность | |||
|- | |||
| '''enterpriseList''' || Список предприятий, изменённых за заданный период времени. || [[EnterpriseList|ent:EnterpriseList]] || 1 | |||
|} | |||
'''Атрибуты списка enterpriseList''' | |||
{{Ветис.API EntityList Attributes}} | |||
===Объект [[#Объект getForeignEnterpriseChangesListResponse|..Response]]/[[#Объект ..Response/enterpriseList|enterpriseList]]/'''enterprise'''=== | |||
Объект содержит сведения о предприятии. | |||
{| class="wikitable" | |||
|- | |||
! Поле !! Описание !! Тип данных !! Обязательность | |||
|- | |||
| '''UUID''' || Уникальный идентификатор версии записи предприятия. || [[UUID|bs:UUID]] || 1 | |||
|- | |||
| '''GUID''' || Глобальный идентификатор предприятия в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1 | |||
|- | |||
| '''active''' || Флаг, указывающий на то, активно ли предприятие. || [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1 | |||
|- | |||
| '''last''' || Флаг, указывающий на то, последняя ли запись. || [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1 | |||
|- | |||
| '''status''' || Статус версии записи. || [[VersionStatus|bs:VersionStatus]] || 1 | |||
|- | |||
| '''createDate''' || Дата создания записи предприятия в реестре Россельхознадзора. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1 | |||
|- | |||
| '''updateDate''' || Дата последнего обновления записи предприятия в реестре Россельхознадзора. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1 | |||
|- | |||
| '''previous''' || Предыдущая версия записи предприятия в реестре Россельхощнадзора. || [[UUID|bs:UUID]] || 0..1 | |||
|- | |||
| '''name''' || Название предприятия. || [[String255|bs:String255]] || 1 | |||
|- | |||
| '''englishName''' || Название предприятия на английском языке. || [[String255|bs:String255]] || 1 | |||
|- | |||
| '''type''' || Тип предприятия согласно классификации в Меркурии: | |||
* 1 - предприятие; | |||
* 2 - рынок; | |||
* 3 - СББЖ; | |||
* 4 - судно. | |||
|| [[EnterpriseType|ent:EnterpriseType]] || 1 | |||
|- | |||
| [[#Объект ..Response/enterpriseList/enterprise/numberList|'''numberList''']] || Список номеров предприятия. || [[ent:EnterpriseNumberList]] || 1 | |||
|- | |||
| [[#Объект ..Response/enterpriseList/enterprise/address|'''address''']] || Фактический адрес предприятия. || [[Address|ikar:Address]] || 1 | |||
|- | |||
| [[#Объект ..Response/enterpriseList/enterprise/activityList |'''activityList''']] || Список видов деятельности предприятия. || [[EnterpriseActivityList|ent:EnterpriseActivtyList]] || 1 | |||
|} | |||
==Описание ошибок== | ==Описание ошибок== | ||
==Пример запроса== | ==Пример запроса== |
Версия 14:14, 28 ноября 2016
Общие сведения
Операция GetForeignEnterpriseChangesList предназначена для получения изменений в списке иностранных предприятий за указанный период времени. В общем случае могут быть возвращены не последние и не актуальные записи (active=false, last=false). Поддерживается постраничный вывод.
Используемые пространства имён и типы
|
|
Входные данные
- параметры запрашиваемого списка;
- интервал дат, за которые запрашиваются изменения.
Выходные данные
- список изменённых за период времени предприятий.
Данные запроса
Объект getForeignEnterpriseChangesList
Корневой объект запроса. Содержит параметры запрашиваемого списка.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
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 |
Атрибуты списка 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 | Тип предприятия согласно классификации в Меркурии:
|
ent:EnterpriseType | 1 |
numberList | Список номеров предприятия. | ent:EnterpriseNumberList | 1 |
address | Фактический адрес предприятия. | ikar:Address | 1 |
activityList | Список видов деятельности предприятия. | ent:EnterpriseActivtyList | 1 |