GetVetDocumentListOperation v2: различия между версиями
Перейти к навигации
Перейти к поиску
Строка 28: | Строка 28: | ||
== Данные запроса == | == Данные запроса == | ||
{| class="wikitable" | |||
! # | |||
! style="font-weight: bold; font-family: Courier;" | Название XML-элемента | |||
! Тип | |||
! Кардинальность | |||
! Описание | |||
! Пример | |||
|- | |||
| 1 | |||
| style="font-weight: bold; font-family: Courier;" | <merc:getVetDocumentListRequest> | |||
| | |||
| | |||
| | |||
| | |||
|- | |||
| 2 | |||
| style="font-weight: bold; font-family: Courier;" | ···<merc:localTransactionId> | |||
| [http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName] | |||
| [1..1] | |||
| Идентификатор заявки в клиентской системе. | |||
| <bs:guid>A00001</bs:guid> | |||
|- | |||
| 3 | |||
| style="font-weight: bold; font-family: Courier;" | ···<merc:initiator> | |||
| [[User_v2.0|dt:User]] | |||
| [1..1] | |||
| Пользователь, зарегистрированный в системе Меркурий и инициирующий запрос к шлюзу. Является ответственным за выполнение бизнес-операции. Здесь потребуется логин ветврача или пользователя ХС. Логин для базовой аутентификации не подойдёт. | |||
| | |||
|- | |||
| 4 | |||
| style="font-weight: bold; font-family: Courier;" | ······<dt:login> | |||
| [http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName] | |||
| [1..1] | |||
| Логин пользователя, зарегистрированного в системе Меркурий. | |||
| <dt:login>user_ab_150101</dt:login> | |||
|- | |||
| 5 | |||
| style="font-weight: bold; font-family: Courier;" | ···</merc:initiator> | |||
| | |||
| | |||
| | |||
| | |||
|- | |||
| 6 | |||
| style="font-weight: bold; font-family: Courier;" | ···<bs:listOptions> | |||
| [[ListOptions|bs:ListOptions]] | |||
| [0..1] | |||
| Параметры запрашиваемого списка. | |||
| | |||
|- | |||
| 7 | |||
| style="font-weight: bold; font-family: Courier;" | ······<bs:count> | |||
| [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] | |||
| [0..1] | |||
| Максимальное запрашиваемое количество объектов в списке. | |||
* По умолчанию значение 100; | |||
* Максимально возможное значение 1000. | |||
| <bs:count>10</bs:count> | |||
|- | |||
| 8 | |||
| style="font-weight: bold; font-family: Courier;" | ······<bs:offset> | |||
| [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] | |||
| [0..1] | |||
| Номер элемента, по которому осуществляется смещение первого элемента списка. | |||
* По умолчанию значение 0. | |||
| <bs:offset>2</bs:offset> | |||
|- | |||
| 9 | |||
| style="font-weight: bold; font-family: Courier;" | ···<bs:listOptions> | |||
| | |||
| | |||
| | |||
| | |||
|- | |||
| 10 | |||
| style="font-weight: bold; font-family: Courier;" | ···<vd:vetDocumentType> | |||
| [[VetDocumentType_v2.0|vd:VetDocumentType]] | |||
| [0..1] | |||
| Тип ВСД. | |||
* входящий (INCOMING). | |||
* исходящий (OUTGOING). | |||
* производственный (PRODUCTIVE). | |||
| <vd:vetDocumentType>INCOMING</vd:vetDocumentType> | |||
|- | |||
| 11 | |||
| style="font-weight: bold; font-family: Courier;" | ···<vd:vetDocumentStatus> | |||
| [[VetDocumentStatus_v2.0|vd:VetDocumentStatus]] | |||
| [0..1] | |||
| | |||
* подтверждён (CONFIRMED). | |||
* аннулирован (WITHDRAWN). | |||
* погашен (UTILIZED). | |||
| <vd:vetDocumentStatus>CONFIRMED</vd:vetDocumentStatus> | |||
|- | |||
| 12 | |||
| style="font-weight: bold; font-family: Courier;" | ···<dt:enterpriseGuid> | |||
| [[UUID|bs:UUID]] | |||
| [1..1] | |||
| Идентификатор предприятия, по которому производится поиск документа. | |||
| <dt:enterpriseGuid>851cf860-e9a3-4981-b83e-3dc6cb06cf07</dt:enterpriseGuid> | |||
|- | |||
| 13 | |||
| style="font-weight: bold; font-family: Courier;" | </merc:getVetDocumentListRequest> | |||
| | |||
| | |||
| | |||
| | |||
|} | |||
==Данные ответа== | ==Данные ответа== |
Версия 19:55, 16 июля 2017
Общие сведения
Операция GetVetDocumentListOperation предназначена для получения всех ветеринарных сопроводительных документов (ВСД) предприятия. При этом список ВСД может быть отфильтрован по следующим критериям:
- Тип ВСД:
- входящий ВСД;
- исходящий ВСД;
- производственный ВСД;
- транспортный ВСД;
- возвратный ВСД.
- Статус ВСД:
- оформлен;
- погашен;
- аннулирован.
На вход системы передаются следующие сведения:
- информация о пользователе - инициаторе запроса;
- информация о предприятии и хозяйствующем субъекте, где осуществляется поиск ВСД;
- параметры, по которым будет отфильтрован список ВСД.
Результатом выполнения данной операции является:
- сведения о запрашиваемых ВСД.
Возможные сценарии
При обработке запроса возможны следующие сценарии:
- 1.1. Запрос успешно обработан. Пользователю вернулись все ВСД для запрашиваемой площадки.
- 1.2. Произошла ошибка при обработке запроса.
- • Некорректный запрос.
- • Внутренняя ошибка системы.
Данные запроса
# | Название XML-элемента | Тип | Кардинальность | Описание | Пример |
---|---|---|---|---|---|
1 | <merc:getVetDocumentListRequest> | ||||
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] | Максимальное запрашиваемое количество объектов в списке.
|
<bs:count>10</bs:count> |
8 | ······<bs:offset> | xs:nonNegativeInteger | [0..1] | Номер элемента, по которому осуществляется смещение первого элемента списка.
|
<bs:offset>2</bs:offset> |
9 | ···<bs:listOptions> | ||||
10 | ···<vd:vetDocumentType> | vd:VetDocumentType | [0..1] | Тип ВСД.
|
<vd:vetDocumentType>INCOMING</vd:vetDocumentType> |
11 | ···<vd:vetDocumentStatus> | vd:VetDocumentStatus | [0..1] |
|
<vd:vetDocumentStatus>CONFIRMED</vd:vetDocumentStatus> |
12 | ···<dt:enterpriseGuid> | bs:UUID | [1..1] | Идентификатор предприятия, по которому производится поиск документа. | <dt:enterpriseGuid>851cf860-e9a3-4981-b83e-3dc6cb06cf07</dt:enterpriseGuid> |
13 | </merc:getVetDocumentListRequest> |
Данные ответа
Примеры запросов
Получение списка всех входящих погашенных ВСД данного предприятия