Exportcenter:GetVetDocumentByUuid:v2.0: различия между версиями

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 774: Строка 774:
|-
|-
|093
|093
|style="font-weight: ; font-family: Courier;" |··················{{color|#190dbf|'''<{{color|#660e7a|dt:}}productMarks {{color|Red|class&#61;}}{{color|#007f15|"BN"}}>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}productMarks>'''}}
|style="font-weight: ; font-family: Courier;" |··················{{color|#190dbf|'''<{{color|#660e7a|dt:}}productMarks {{color|Red|class&#61;}}{{color|#007f15|"?"}}>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}productMarks>'''}}
|[[ProductMarks_v2.0|dt:ProductMarks]]
|[[ProductMarks_v2.0|dt:ProductMarks]]
|[0..*]
|[0..*]

Версия 14:23, 30 марта 2022

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

Операция 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:vetDForm>?</vd:vetDForm> vd:VetDocumentForm [1..1]

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

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

Тип ВСД.

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

Статус ВСД.

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

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

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

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

  • Объект certifiedConsignment возвращается для транспортных ВСД (входящих, исходящих, возвратных).
013 ·········<vd:consignor> dt:BusinessMember [1..1] Сведения об отправителе (владельце).
014 ············<dt:businessEntity> dt:BusinessEntity [1..1] Информация о хозяйствующем субъекте-отправителе транспортной партии.
015 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии хозяйствующего субъекта.
016 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор хозяйствующего субъекта.
017 ············</dt:businessEntity>
018 ············<dt:enterprise> dt:Enterprise [1..1] Информация о предприятии-отправителе транспортной партии.
019 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии предприятия.
020 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор предприятия.
021 ············</dt:enterprise>
022 ·········</vd:consignor>
023 ·········<vd:consignee> dt:BusinessMember [1..1] Сведения о получателе продукции.
024 ············<dt:businessEntity> dt:BusinessEntity [1..1] Информация о хозяйствующем субъекте-получателе транспортной партии.
025 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии хозяйствующего субъекта.
026 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор хозяйствующего субъекта.
027 ············</dt:businessEntity>
028 ············<dt:enterprise> dt:Enterprise [1..1] Информация о предприятии-получателе транспортной партии.
029 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии предприятия.
030 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор предприятия.
031 ············</dt:enterprise>
032 ·········</vd:consignee>
033 ·········<vd:transportInfo> dt:TransportInfo [0..1]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • FROZEN - замороженный;
  • CHILLED - охлажденный;
  • COOLED - охлаждаемый;
  • VENTILATED - вентилируемый.
045 ·········<vd:batch> vd:Batch [1..1] Сведения о партии продукции.
046 ············<vd:productType>?</vd:productType> dt:ProductType [1..1] Тип продукции. Первый уровень иерархического справочника продукции ИС Меркурий.
047 ············<vd:product> dt:Product [1..1] Продукция. Второй уровень иерархического справочника продукции ИС Меркурий.
048 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии продукции.
049 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор продукции.
050 ············</vd:product>
051 ············<vd:subProduct> dt:SubProduct [1..1] Вид продукции. Третий уровень иерархического справочника продукции ИС Меркурий.
052 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии вида продукции.
053 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор вида продукции.
054 ············</vd:subProduct>
055 ············<vd:productItem> dt:ProductItem [1..1]

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

  • Наименование номенклатуры, указанное отправителем ВСД.
  • Если отправитель не указывал номенклатуру в запросе на оформление транспортной транзакции, то в ВСД сохранится номенклатура из записи журнала отправителя.
  • Если отправитель указывал номенклатуру в запросе на оформление транспортной транзакции, то в ВСД будет сохранена она.
056 ···············<bs:uuid>?</bs:uuid> bs:UUID [0..1] Идентификатор версии номенклатуры.
057 ···············<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор номенклатуры.
058 ···············<dt:globalID>?</dt:globalID> dt:GTINType [0..1] Trade Identification Number (GTIN) - идентификационный номер продукции производителя.
059 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование продукции.
060 ···············<dt:code>?</dt:code> bs:String255 [0..1] Артикул (код) продукции в соответствии с внутренним кодификатором производителя.
061 ············</vd:productItem>
062 ············<vd:volume>?</vd:volume> bs:Decimal [1..1] Объем продукции.
063 ············<vd:unit> dt:Unit [1..1] Единица измерения объема партии продукции.
064 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии единицы измерения.
065 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор единицы измерения.
066 ············</vd:unit>
067 ············<vd:batchID>?</vd:batchID> bs:String255 [0..*] Уникальный идентификатор производственной партии продукции.
068 ············<vd:origin> vd:BatchOrigin [0..1] Сведения о происхождении продукции.
069 ···············<vd:country> dt:Country [1..1] Страна происхождения партии продукции.
070 ··················<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии страны.
071 ··················<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор страны.
072 ··················<dt:name>?</dt:name> bs:String255 [1..1] Наименование страны происхождения партии продукции.
073 ···············</vd:country>
074 ···············<vd:producer> dt:Producer [1..*] Производитель продукции.
075 ··················<dt:enterprise> dt:Enterprise [1..1]

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

  • Если производитель в записи журнала отправителя существовал не из справочника (например, для импортного сертификата), то может быть возвращено поле name с отсутствием uuid/guid
076 ·····················<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии предприятия.
077 ·····················<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор предприятия.
078 ·····················<dt:name>?</dt:name> bs:String255 [0..1] Наименование производителя.
079 ··················</dt:enterprise>
080 ··················<dt:role>?</dt:role> dt:EnterpriseRole [1..1] Роль предприятия-производителя продукции.
081 ···············</vd:producer>
082 ············</vd:origin>
083 ············<vd:packageList> dt:PackageList [0..1] Список физической упаковки.
084 ···············<dt:package> dt:Package [1..*]

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

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

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

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

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

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

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

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

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

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

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

  • CATTLE_SLAUGHTER - Боенское.
  • LOSS_OF_CATTLE - Палое.
  • MANUFACTURED - Промышленное.
  • MIXED - Сборное.
  • FROM_HEALTHY_ANIMALS - Получено от здоровых животных.
  • FROM_SICK_ANIMALS - Получено от больных животных.
098 ············</vd:applicableClassifications>
099 ·········</vd:batch>
100 ······</vd:certifiedConsignment>
101 ······<vd:authentication> vd:VeterinaryAuthentication [1..1] Результаты осмотра/исследований партии. Заключение ветеринарного врача/специалиста.
102 ·········<vd:laboratoryResearch> vd:LaboratoryResearchEvent [0..*] Сведения о проведенных лабораторных исследованиях.
103 ············<vd:ID>?</vd:ID> bs:Identifier [1..1] Идентификатор события в разрезе записи складского журнала или вет.сертификата.
104 ············<vd:type>?</vd:type> vd:VeterinaryEventType [1..1] Тип мероприятия.
105 ············<vd:actualDateTime>?</vd:actualDateTime> xs:DateTime [1..1] Дата события.
106 ············<vd:operator> dt:Organization [1..1] Организация-оператор, осуществляющий мероприятие.
107 ···············<dt:name>?</dt:name> bs:String255 [1..1] Название организации оператора.
108 ············</vd:operator>
109 ············<vd:referencedDocument> vd:ReferencedDocument [0..*] Сведения об акте отбора проб
110 ···············<vd:issueNumber>?</vd:issueNumber> bs:String255 [0..1] Номер документа.
111 ···············<vd:issueDate>?</vd:issueDate> xs:date [0..1] Дата оформления документа.
112 ···············<vd:type>?</vd:type> dt:DocumentType [1..1] Тип документа = 9 (акт отбора проб).
113 ············</vd:referencedDocument>
114 ············<vd:notes>?</vd:notes> bs:Text [0..1] Дополнительные сведения.
115 ············<vd:expertiseID>?</vd:expertiseID> bs:String255 [1..1] Номер экспертизы.
116 ············<vd:disease> bs:String255 [1..1] Показатель исследования.
117 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование показателя.
118 ············</vd:disease>
119 ············<vd:method> dt:ResearchMethod [0..1] Метод исследования.
120 ···············<dt:name>?</dt:name> bs:String255 [1..1] Название метода исследования.
121 ············</vd:method>
122 ············<vd:result>?</vd:result> dt:ResearchResult [0..1] Результат исследования.
123 ············<vd:conclusion>?</vd:conclusion> bs:Text [0..1] Заключение.
124 ·········</vd:laboratoryResearch>
125 ·········<vd:specialMarks>?</vd:specialMarks> bs:Text [0..1] Особые отметки для ветеринарно-сопроводительного документа.
126 ······</vd:authentication>
127 ···</vd:vetDocument>
128 </exc:getVetDocumentByUuidResponse>
Источник — http://help.vetrf.ru/index.php?title=Exportcenter:GetVetDocumentByUuid:v2.0&oldid=33735