Exportcenter:GetVetDocumentByUuid:v2.0

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

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

Операция GetVetDocumentByUuid предназначена для получения ветеринарного сопроводительного документа (далее - ВСД) по его уникальному идентификатору.

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

Пространство имён (xmlns) XSD-схема, содержащая описание типов
xmlns:bs="http://api.vetrf.ru/schema/cdm/base" https://api.vetrf.ru/schema/platform/exportcenter/v2.0b-20210906/base_v2.0.xsd
xmlns:ws="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2" https://api.vetrf.ru/schema/platform/exportcenter/v2.0b-20210906/registry_ws_definitions_v2.2.xsd
xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2" https://api.vetrf.ru/schema/platform/exportcenter/v2.0b-20210906/dictionary_v2.2.xsd
xmlns:vd="http://api.vetrf.ru/schema/cdm/mercury/vet-document/v2" https://api.vetrf.ru/schema/platform/exportcenter/v2.0b-20210906/document_v2.2.xsd
xmlns:exc="http://api.vetrf.ru/schema/cdm/exportcenter/applications/v2" https://api.vetrf.ru/schema/platform/exportcenter/v2.0b-20210906/exportcenter_applications_v2.0.xsd

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <exc:getVetDocumentByUuidRequest>
002 ···<exc:metadata> exc:ServiceMetadata [1..1] Служебная информация
003 ······<exc:processID>?</exc:processID> bs:Identifier [1..1] Идентификатор процесса в ИС Одно окно РЭЦ
004 ······<exc:seqNumber>?</exc:seqNumber> bs:SequenceNumber [1..1] Порядковый номер запроса
005 ······<dt:businessEntity> dt:BusinessEntity [1..1] Сведения о хозяйствующем субъекте
006 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор хозяйствующего субъекта
007 ·········<dt:inn>?</dt:inn> bs:String255 [1..1] ИНН хозяйствующего субъекта
008 ······</dt:businessEntity>
009 ······<vd:user> vd:User [0..1] Уполномоченное лицо, инициатор операции
010 ·········<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор уполномоченного лица
011 ·········<vd:snils>?</vd:snils> vd:SNILSType [1..1] СНИЛС уполномоченного лица
012 ······</vd:user>
013 ···</exc:metadata>
014 ···<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор ВСД
015 </exc:getVetDocumentByUuidRequest>

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <exc:getVetDocumentByUuidResponse>
002 ···<exc:metadata> exc:ServiceMetadata [1..1] Служебная информация
003 ······<exc:processID>?</exc:processID> bs:Identifier [1..1] Идентификатор процесса в ИС Одно окно РЭЦ
004 ······<exc:seqNumber>?</exc:seqNumber> bs:SequenceNumber [1..1] Номер входящего запроса
005 ···</exc:metadata>
006 ···<vd:vetDocument> vd:VetDocument [1..1] Сведения о ветеринарном сопроводительном документе (ВСД).
007 ······<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор документа.
008 ······<vd:issueDate>?</vd:issueDate> xs:date [1..1] Дата оформления ВСД.
009 ······<vd:vetDForm>?</vd:vetDForm> vd:VetDocumentForm [1..1]

Форма ветеринарного сопроводительного документа.

010 ······<vd:vetDType>?</vd:vetDType> vd:VetDocumentType [1..1]

Тип ВСД.

011 ······<vd:vetDStatus>?</vd:vetDStatus> vd:VetDocumentStatus [1..1]

Статус ВСД.

012 ······<vd:lastUpdateDate>?</vd:lastUpdateDate> xs:DateTime [0..1]

Дата и время последнего изменения статуса ВСД.

  • В том числе при обновлении объема для незавершенного производства.
013 ······<vd:certifiedConsignment> vd:CertifiedConsignment [0..1]

Сертифицируемая партия.

  • Объект certifiedConsignment возвращается для транспортных ВСД (входящих, исходящих, возвратных).
014 ·········<vd:consignor> dt:BusinessMember [1..1] Сведения об отправителе (владельце).
015 ············<dt:businessEntity> dt:BusinessEntity [1..1] Информация о хозяйствующем субъекте-отправителе транспортной партии.
016 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии хозяйствующего субъекта.
017 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор хозяйствующего субъекта.
018 ···············<dt:fullName>?</dt:fullName> bs:String255 [0..1] Полное наименование хозяйствующего субъекта
019 ···············<dt:fio>?</dt:fio> bs:String255 [0..1]

ФИО хозяйствующего субъекта

  • Выводится, если тип хозяйствующего субъекта - индивидуальный предприниматель.
020 ···············<dt:inn>?</dt:inn> bs:String255 [0..1] Идентификационный номер хозяйствующего субъекта
021 ············</dt:businessEntity>
022 ············<dt:enterprise> dt:Enterprise [1..1] Информация о предприятии-отправителе транспортной партии.
023 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии предприятия.
024 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор предприятия.
025 ···············<dt:name>?</dt:name> bs:String255 [0..1] Наименование предприятия
026 ············</dt:enterprise>
027 ·········</vd:consignor>
028 ·········<vd:consignee> dt:BusinessMember [1..1] Сведения о получателе продукции.
029 ············<dt:businessEntity> dt:BusinessEntity [1..1] Информация о хозяйствующем субъекте-получателе транспортной партии.
030 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии хозяйствующего субъекта.
031 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор хозяйствующего субъекта.
032 ···············<dt:fullName>?</dt:fullName> bs:String255 [0..1] Полное наименование хозяйствующего субъекта
033 ···············<dt:fio>?</dt:fio> bs:String255 [0..1]

ФИО хозяйствующего субъекта

  • Выводится, если тип хозяйствующего субъекта - индивидуальный предприниматель.
034 ···············<dt:inn>?</dt:inn> bs:String255 [0..1] Идентификационный номер хозяйствующего субъекта
035 ············</dt:businessEntity>
036 ············<dt:enterprise> dt:Enterprise [1..1] Информация о предприятии-получателе транспортной партии.
037 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии предприятия.
038 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор предприятия.
039 ···············<dt:name>?</dt:name> bs:String255 [0..1] Наименование предприятия
040 ············</dt:enterprise>
041 ·········</vd:consignee>
042 ·········<vd:transportInfo> dt:TransportInfo [0..1]

Информация о транспорте.

  • Если происходит смена владельца без перевозки, то информация о транспорте, способах хранения при перегрузке, точках перегрузки будет отсутствовать.
043 ············<vd:transportType>?</vd:transportType> dt:TransportType [1..1] Тип транспортного средства.
044 ············<vd:transportNumber> dt:TransportNumber [1..1] Номер транспортного средства.
045 ···············<vd:containerNumber>?</vd:containerNumber> bs:String255 [0..1]

Номер контейнера (при автомобильной перевозке).

  • Может быть указан при transportType = 1
046 ···············<vd:wagonNumber>?</vd:wagonNumber> bs:String255 [0..1]

Номер вагона.

  • Обязателен к указанию при transportType = 2
047 ···············<vd:vehicleNumber>?</vd:vehicleNumber> bs:String255 [0..1]

Номер автомобиля.

  • Обязателен к указанию при transportType = 1
048 ···············<vd:trailerNumber>?</vd:trailerNumber> bs:String255 [0..1]

Номер прицепа (полуприцепа).

  • Может быть указан при transportType = 1
049 ···············<vd:shipName>?</vd:shipName> bs:String255 [0..1]

Название судна (или номер контейнера).

  • Обязателен к указанию при transportType = 4 или 5
050 ···············<vd:flightNumber>?</vd:flightNumber> bs:String255 [0..1]

Номер авиарейса.

  • Обязателен к указанию при transportType = 3
051 ············</vd:transportNumber>
052 ·········</vd:transportInfo>
053 ·········<vd:transportStorageType>?</vd:transportStorageType> dt:TransportationStorageType [0..1]

Способ хранения продукции при перевозке.

Возможные значения:

  • FROZEN - замороженный;
  • CHILLED - охлажденный;
  • COOLED - охлаждаемый;
  • VENTILATED - вентилируемый.
054 ·········<vd:batch> vd:Batch [1..1] Сведения о партии продукции.
055 ············<vd:productType>?</vd:productType> dt:ProductType [1..1] Тип продукции. Первый уровень иерархического справочника продукции ИС Меркурий.
056 ············<vd:product> dt:Product [1..1] Продукция. Второй уровень иерархического справочника продукции ИС Меркурий.
057 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии продукции.
058 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор продукции.
059 ············</vd:product>
060 ············<vd:subProduct> dt:SubProduct [1..1] Вид продукции. Третий уровень иерархического справочника продукции ИС Меркурий.
061 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии вида продукции.
062 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор вида продукции.
063 ············</vd:subProduct>
064 ············<vd:productItem> dt:ProductItem [1..1]

Наименование продукции в номенклатуре производителя.

  • Наименование номенклатуры, указанное отправителем ВСД.
  • Если отправитель не указывал номенклатуру в запросе на оформление транспортной транзакции, то в ВСД сохранится номенклатура из записи журнала отправителя.
  • Если отправитель указывал номенклатуру в запросе на оформление транспортной транзакции, то в ВСД будет сохранена она.
065 ···············<bs:uuid>?</bs:uuid> bs:UUID [0..1] Идентификатор версии номенклатуры.
066 ···············<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор номенклатуры.
067 ···············<dt:globalID>?</dt:globalID> dt:GTINType [0..1] Trade Identification Number (GTIN) - идентификационный номер продукции производителя.
068 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование продукции.
069 ···············<dt:code>?</dt:code> bs:String255 [0..1] Артикул (код) продукции в соответствии с внутренним кодификатором производителя.
070 ············</vd:productItem>
071 ············<vd:volume>?</vd:volume> bs:Decimal [1..1] Объем продукции.
072 ············<vd:unit> dt:Unit [1..1] Единица измерения объема партии продукции.
073 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии единицы измерения.
074 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор единицы измерения.
075 ···············<dt:name>?</dt:name> bs:String255 [0..1] Наименование единицы измерения
076 ···············<dt:fullName>?</dt:fullName> bs:String255 [0..1] Полное наименование единицы измерения
077 ············</vd:unit>
078 ············<vd:dateOfProduction> vd:GoodsDate [1..1] Дата выработки продукции
079 ···············<vd:firstDate> dt:ComplexDate [0..1] Начальная дата в интервале, либо единичная дата
080 ··················<dt:year>?</dt:year> dt:Year [1..1] Год
081 ··················<dt:month>?</dt:month> dt:Month [0..1] Месяц
082 ··················<dt:day>?</dt:day> dt:Day [0..1] День
083 ··················<dt:hour>?</dt:hour> dt:Hour [0..1] Час
084 ···············</vd:firstDate>
085 ···············<vd:secondDate> dt:ComplexDate [0..1] Конечная дата в интервале
086 ··················<dt:year>?</dt:year> dt:Year [1..1] Год
087 ··················<dt:month>?</dt:month> dt:Month [0..1] Месяц
088 ··················<dt:day>?</dt:day> dt:Day [0..1] День
089 ··················<dt:hour>?</dt:hour> dt:Hour [0..1] Час
090 ···············</vd:secondDate>
091 ············</vd:dateOfProduction>
092 ············<vd:expiryDate> vd:GoodsDate [0..1] Дата окончания срока годности продукции
093 ···············<vd:firstDate> dt:ComplexDate [0..1] Начальная дата в интервале, либо единичная дата
094 ··················<dt:year>?</dt:year> dt:Year [1..1] Год
095 ··················<dt:month>?</dt:month> dt:Month [0..1] Месяц
096 ··················<dt:day>?</dt:day> dt:Day [0..1] День
097 ··················<dt:hour>?</dt:hour> dt:Hour [0..1] Час
098 ···············</vd:firstDate>
099 ···············<vd:secondDate> dt:ComplexDate [0..1] Конечная дата в интервале
100 ··················<dt:year>?</dt:year> dt:Year [1..1] Год
101 ··················<dt:month>?</dt:month> dt:Month [0..1] Месяц
102 ··················<dt:day>?</dt:day> dt:Day [0..1] День
103 ··················<dt:hour>?</dt:hour> dt:Hour [0..1] Час
104 ···············</vd:secondDate>
105 ············</vd:expiryDate>
106 ············<vd:batchID>?</vd:batchID> bs:String255 [0..*] Уникальный идентификатор производственной партии продукции.
107 ············<vd:origin> vd:BatchOrigin [0..1] Сведения о происхождении продукции.
108 ···············<vd:country> dt:Country [1..1] Страна происхождения партии продукции.
109 ··················<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии страны.
110 ··················<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор страны.
111 ··················<dt:name>?</dt:name> bs:String255 [1..1] Наименование страны происхождения партии продукции.
112 ··················<dt:code>?</dt:code> dt:Code [1..1] Код страны
113 ···············</vd:country>
114 ···············<vd:producer> dt:Producer [1..*] Производитель продукции.
115 ··················<dt:enterprise> dt:Enterprise [1..1]

Информация о предприятии-производителе продукции.

  • Если производитель в записи журнала отправителя существовал не из справочника (например, для импортного сертификата), то может быть возвращено поле name с отсутствием uuid/guid
116 ·····················<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии предприятия.
117 ·····················<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор предприятия.
118 ·····················<dt:name>?</dt:name> bs:String255 [0..1] Наименование производителя.
119 ·····················<dt:address> dt:Address [0..1] Адрес производителя
120 ························<dt:addressView>?</dt:addressView> bs:String255 [1..1] Строковое представление адреса на русском
121 ·····················</dt:address>
122 ··················</dt:enterprise>
123 ··················<dt:role>?</dt:role> dt:EnterpriseRole [1..1] Роль предприятия-производителя продукции.
124 ···············</vd:producer>
125 ············</vd:origin>
126 ············<vd:packageList> dt:PackageList [0..1] Список физической упаковки.
127 ···············<dt:package> dt:Package [1..*]

Описание упаковки.

  • Поддерживается указание многоуровневой упаковки и маркировки партии продукции.
  • Всего предусмотрено шесть уровней упаковки (см. тип dt:PackageLevelType).
  • Количество единиц упаковки и маркировка партии указывается для каждой упаковки конкретного уровня отдельно.
  • На каждом уровне может быть произвольное количество типов упаковки, в том числе и ни одного, т.е. какого-то уровня упаковки в описании партии продукции может не быть.
128 ··················<dt:level>?</dt:level> dt:PackageLevelType [1..1]

Уровень упаковки.

  • Список возможных значений находится тут - dt:PackageLevelType
129 ··················<dt:packingType> dt:PackingType [1..1]

Тип упаковки.

  • Список сопоставлений uuid/guid/globalId находится тут - dt:PackingType
130 ·····················<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии упаковки.
131 ·····················<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор упаковки.
132 ·····················<dt:globalID>?</dt:globalID> dt:PackingCodeType [1..1]

Идентификатор упаковки по классификатору ЕК 013-2010 (ред.1)

ЕК 013-2010 (ред.1) - Классификатор видов груза, упаковки и упаковочных материалов. См. https://eomi.eaeunion.org/ru/#/repository/nsi/173
133 ·····················<dt:name>?</dt:name> bs:String255 [1..1] Наименование упаковки.
134 ··················</dt:packingType>
135 ··················<dt:quantity>2</dt:quantity> xs:int [0..1] Количество единиц упаковки.
136 ··················<dt:productMarks class="BN">?</dt:productMarks> dt:ProductMarks [0..*]

Маркировка партии продукции.

137 ···············</dt:package>
138 ············</vd:packageList>
139 ············<vd:applicableClassifications> vd:BatchExtraInfo [0..1] Дополнительные характеристики партии.
140 ···············<vd:nonFoodSource>?</vd:nonFoodSource> vd:NonFoodProductSourceType [0..1]

Вид проиcхождения для непищевой продукции и кормов.

  • CATTLE_SLAUGHTER - Боенское.
  • LOSS_OF_CATTLE - Палое.
  • MANUFACTURED - Промышленное.
  • MIXED - Сборное.
  • FROM_HEALTHY_ANIMALS - Получено от здоровых животных.
  • FROM_SICK_ANIMALS - Получено от больных животных.
141 ············</vd:applicableClassifications>
142 ·········</vd:batch>
143 ······</vd:certifiedConsignment>
144 ······<vd:authentication> vd:VeterinaryAuthentication [1..1] Результаты осмотра/исследований партии. Заключение ветеринарного врача/специалиста.
145 ·········<vd:laboratoryResearch> vd:LaboratoryResearchEvent [0..*] Сведения о проведенных лабораторных исследованиях.
146 ············<vd:ID>?</vd:ID> bs:Identifier [1..1] Идентификатор события в разрезе записи складского журнала или вет.сертификата.
147 ············<vd:type>?</vd:type> vd:VeterinaryEventType [1..1] Тип мероприятия.
148 ············<vd:actualDateTime>?</vd:actualDateTime> xs:DateTime [1..1] Дата события.
149 ············<vd:operator> dt:Organization [1..1] Организация-оператор, осуществляющий мероприятие.
150 ···············<dt:name>?</dt:name> bs:String255 [1..1] Название организации оператора.
151 ············</vd:operator>
152 ············<vd:referencedDocument> vd:ReferencedDocument [0..*] Сведения об акте отбора проб
153 ···············<vd:issueNumber>?</vd:issueNumber> bs:String255 [0..1] Номер документа.
154 ···············<vd:issueDate>?</vd:issueDate> xs:date [0..1] Дата оформления документа.
155 ···············<vd:type>?</vd:type> dt:DocumentType [1..1] Тип документа = 9 (акт отбора проб).
156 ············</vd:referencedDocument>
157 ············<vd:notes>?</vd:notes> bs:Text [0..1] Дополнительные сведения.
158 ············<vd:expertiseID>?</vd:expertiseID> bs:String255 [1..1] Номер экспертизы.
159 ············<vd:disease> bs:String255 [1..1] Показатель исследования.
160 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование показателя.
161 ············</vd:disease>
162 ············<vd:method> dt:ResearchMethod [0..1] Метод исследования.
163 ···············<dt:name>?</dt:name> bs:String255 [1..1] Название метода исследования.
164 ············</vd:method>
165 ············<vd:result>?</vd:result> dt:ResearchResult [0..1] Результат исследования.
166 ············<vd:conclusion>?</vd:conclusion> bs:Text [0..1] Заключение.
167 ·········</vd:laboratoryResearch>
168 ·········<vd:specialMarks>?</vd:specialMarks> bs:Text [0..1] Особые отметки для ветеринарно-сопроводительного документа.
169 ······</vd:authentication>
170 ···</vd:vetDocument>
171 </exc:getVetDocumentByUuidResponse>
Источник — http://help.vetrf.ru/index.php?title=Exportcenter:GetVetDocumentByUuid:v2.0&oldid=33757