MercuryG2B:GetVetDocumentList:v3.0

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

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

Спецификация запроса

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <merc:getVetDocumentListRequest>
002 ···<merc:localTransactionId>?</merc:localTransactionId> xs:NCName [1..1] Идентификатор заявки в клиентской системе
003 ···<merc:initiator> vd:User [1..1]

Пользователь, зарегистрированный в системе Меркурий и инициирующий запрос

  • Является ответственным за выполнение бизнес-операции.
  • Здесь потребуется логин ветврача или пользователя ХС. Логин для базовой аутентификации не подойдёт.
004 ······<vd:login>?</vd:login> xs:NCName [1..1] Логин пользователя
005 ···</merc:initiator>
006 ···<bs:listOptions> bs:ListOptions [0..1] Параметры запрашиваемого списка
007 ······<bs:count>?</bs:count> xs:nonNegativeInteger [0..1]

Максимальное запрашиваемое количество объектов в списке

  • По умолчанию значение 100;
  • Максимально возможное значение 1000.
008 ······<bs:offset>?</bs:offset> xs:nonNegativeInteger [0..1]

Номер элемента, по которому осуществляется смещение первого элемента списка

  • По умолчанию значение 0.
009 ···</bs:listOptions>
010 ···<vd:vetDocumentType>?</vd:vetDocumentType> vd:VetDocumentType [0..1]

Тип ВСД

  • входящий (INCOMING).
  • исходящий (OUTGOING).
  • производственный (PRODUCTIVE).
  • транспортный (TRANSPORT).
  • возвратный (RETURNABLE).
011 ···<vd:vetDocumentStatus>?</vd:vetDocumentStatus> vd:VetDocumentStatus [0..1]

Статус ВСД

  • подтверждён (CONFIRMED).
  • аннулирован (WITHDRAWN).
  • погашен (UTILIZED).
012 ···<vd:issueDateInterval> vd:issueDateInterval [0..1]

Интервал времени оформления документа

  • Максимальная длина интервала - 31 день.
013 ······<bs:beginDate>?</bs:beginDate> xs:dateTime [1..1] Начало временного интервала
014 ······<bs:endDate>?</bs:endDate> xs:dateTime [1..1] Конец временного интервала
015 ···</vd:issueDateInterval>
016 ···<vd:consignor> dt:BusinessMember [0..1]

Сведения об отправителе транспортной партии

  • Фильтрация осуществляется по глобальному идентификатору ХС (consignor/businessEntity/guid) и площадки (consignor/enterprise/guid).
  • Если производится поиск по производственным документам (установлен фильтр vetDocumentType = PRODUCTIVE), поле consignor игнорируется.
017 ······<dt:businessEntity> dt:BusinessEntity [0..1] Хозяйствующий субъект-отправитель транспортной партии
018 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор хозяйствующего субъекта
019 ······</dt:businessEntity>
020 ······<dt:enterprise> dt:Enterprise [0..1] Предприятие-отправитель транспортной партии
021 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор предприятия
022 ······</dt:enterprise>
023 ···</vd:consignor>
024 ···<vd:referencedDocument> vd:ReferencedDocument [0..1]

Связанные документы

  • Поддерживается поиск по связанным документам с отношением (relationshipType) равным 1 и 6.
  • Поддерживаемые типы документов: 1-5 (транспортный документ).
  • Для документа обязательными к заполнению являются поля тип (type), номер (issueNumber) и дата (issueDate).
  • При поиске по связанному документу обязательно заполнение фильтра vetDocumentType.
025 ······<vd:issueNumber>?</vd:issueNumber> bs:String255 [1..1] Номер документа
026 ······<vd:issueDate>?</vd:issueDate> xs:date [1..1] Дата оформления документа
027 ······<vd:type>?</vd:type> dt:DocumentType [1..1] Тип документа
028 ···</vd:referencedDocument>
029 ···<dt:enterpriseGuid>?</dt:enterpriseGuid> bs:UUID [1..1]

Идентификатор предприятия, по которому производится поиск документа

В результирующий список попадут (в общем случае, если не установлено других критериев отбора):

  • Транспортные ВСД, для которых ХС-отправитель соответствует заявителю (issuer), предприятие-отправитель - указанному идентификатору (enterpriseGuid).
  • Транспортные ВСД, для которых ХС-получатель соответствует заявителю (issuer), предприятие-получатель - указанному идентификатору (enterpriseGuid).
  • Производственные ВСД, для которых ХС-производитель соответствует заявителю (issuer), предприятие-производитель - указанному идентификатору (enterpriseGuid).
030 </merc:getVetDocumentListRequest>

Спецификация ответа

Классификатор справочников и перечислений Codelist

Описание классификатора и назначения опциональных атрибутов типа dt:CodeType (@listID, @listAgencyID, @listName, @listVersionID, @name) приведено на странице: MercuryG2B:Codelist:v2.4r1

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

TODO

См. также

Вернуться к началу ↑
Вернуться на страницу профиля API MercuryG2B:Services:v3.0

Источник — http://help.vetrf.ru/index.php?title=MercuryG2B:GetVetDocumentList:v3.0&oldid=37988