GetVetDocumentChangesListOperation v2

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

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

Операция GetVetDocumentChangesListOperation предназначена для получения ветеринарных сопроводительных документов (ВСД) предприятия, созданных или измененных за указанный интервал дат (получение истории изменений).

На вход системы передаются следующие сведения:

  • информация о пользователе - инициаторе запроса;
  • информация о хозяйствующем субъекте и предприятии, для которых осуществляется поиск ВСД;
  • временной интервал, за который будет осуществляться поиск ВСД.

Результатом выполнения данной операции является:

  • сведения о запрашиваемых ВСД.

Возможные сценарии

При обработке запроса возможны следующие сценарии:

1.1. Запрос успешно обработан. Пользователю вернулась история изменений ВСД за запрашиваемый период.
1.2. Произошла ошибка при обработке запроса.
• Некорректный запрос.
• Внутренняя ошибка системы.

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

# Название XML-элемента Тип Кардинальность Описание Пример
1 <merc:getVetDocumentChangesListRequest>
2 ···<merc:localTransactionId> xs:NCName [1..1] Идентификатор заявки в клиентской системе. <bs:guid>A00001</bs:guid>
3 ···<merc:initiator> dt:User [1..1] Пользователь, зарегистрированный в системе Меркурий и инициирующий запрос к шлюзу. Является ответственным за выполнение бизнес-операции. Здесь потребуется логин ветврача или пользователя ХС. Логин для базовой аутентификации не подойдёт.
4 ······<dt:login> xs:NCName [1..1] Логин пользователя, зарегистрированного в системе Меркурий. <dt:login>user_ab_150101</dt:login>
5 ···</merc:initiator>
6 ···<bs:listOptions> bs:ListOptions [0..1] Параметры запрашиваемого списка.
7 ······<bs:count> xs:nonNegativeInteger [0..1] Максимальное запрашиваемое количество объектов в списке.
  • По умолчанию значение 100;
  • Максимально возможное значение 1000.
<bs:count>10</bs:count>
8 ······<bs:offset> xs:nonNegativeInteger [0..1] Номер элемента, по которому осуществляется смещение первого элемента списка.
  • По умолчанию значение 0.
<bs:offset>2</bs:offset>
9 ···<bs:listOptions>
10 ···<bs:updateDateInterval> bs:DataInterval [1..1] Интервал времени обновления. В список попадают все записи, дата обновлений которых попадает в указанный интервал.
11 ······<bs:beginDate> xs:dateTime [0..1] Начало временного интервала. <bs:beginDate>2017-07-07T00:00:00</bs:beginDate>
12 ······<bs:endDate> xs:dateTime [0..1] Конец временного интервала. <bs:endDate>2017-07-25T00:00:00</bs:endDate>
13 ···<bs:updateDateInterval>
14 ···<dt:enterpriseGuid> bs:UUID [1..1] Идентификатор предприятия, по которому производится поиск документа. <dt:enterpriseGuid>851cf860-e9a3-4981-b83e-3dc6cb06cf07</dt:enterpriseGuid>
15 </merc:getVetDocumentChangesListRequest>

Данные ответа

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

Получение списка ВСД изменённых за указанный период

Коды ошибок

Вернуться к началу ↑