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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 39: Строка 39:
|[[ServiceMetadata_v2.0|exc:ServiceMetadata]]
|[[ServiceMetadata_v2.0|exc:ServiceMetadata]]
|[1..1]
|[1..1]
| style="width:52em;"|  
| style="width:52em;"| Служебная информация
|-
|-
|003
|003

Версия 05:37, 8 сентября 2021

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

Операция 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

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

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

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

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

Тип ВСД.

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

Статус ВСД.

011 ······<vd:lastUpdateDate>2018-02-02T13:18:54</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>UUID</bs:uuid> bs:UUID [1..1] Идентификатор версии хозяйствующего субъекта.
016 ···············<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор хозяйствующего субъекта.
017 ············</dt:businessEntity>
018 ············<dt:enterprise> dt:Enterprise [1..1] Информация о предприятии-отправителе транспортной партии.
019 ···············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Идентификатор версии предприятия.
020 ···············<bs:guid>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>UUID</bs:uuid> bs:UUID [1..1] Идентификатор версии хозяйствующего субъекта.
026 ···············<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор хозяйствующего субъекта.
027 ············</dt:businessEntity>
028 ············<dt:enterprise> dt:Enterprise [1..1] Информация о предприятии-получателе транспортной партии.
029 ···············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Идентификатор версии предприятия.
030 ···············<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор предприятия.
031 ············</dt:enterprise>
032 ·········</vd:consignee>
033 ·········<vd:transportInfo> dt:TransportInfo [0..1]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • Наименование номенклатуры, указанное отправителем ВСД.
  • Если отправитель не указывал номенклатуру в запросе на оформление транспортной транзакции, то в ВСД сохранится номенклатура из записи журнала отправителя.
  • Если отправитель указывал номенклатуру в запросе на оформление транспортной транзакции, то в ВСД будет сохранена она.
056 ···············<bs:uuid>UUID</bs:uuid> bs:UUID [0..1] Идентификатор версии номенклатуры.
057 ···············<bs:guid>GUID</bs:guid> bs:UUID [0..1] Глобальный идентификатор номенклатуры.
058 ···············<dt:globalID>4607147136201</dt:globalID> dt:GTINType [0..1] Trade Identification Number (GTIN) - идентификационный номер продукции производителя.
059 ···············<dt:name>Наименование продукции</dt:name> bs:String255 [1..1] Наименование продукции.
060 ···············<dt:code>А12345</dt:code> bs:String255 [0..1] Артикул (код) продукции в соответствии с внутренним кодификатором производителя.
061 ···············<dt:packaging> dt:Packaging [0..1] Фасовка.
062 ··················<dt:packagingType> dt:PackingType [1..1] Тип упаковки.
063 ·····················<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Идентификатор версии типа упаковки.
064 ·····················<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор упаковки.
065 ·····················<dt:globalID>BE</dt:globalID> dt:PackingCodeType [1..1] Уникальный идентификатор упаковки.
066 ·····················<dt:name>Пакет (пачка/связка)</dt:name> bs:String255 [1..1] Наименование упаковки.
067 ··················</dt:packagingType>
068 ··················<dt:quantity>10</dt:quantity> xs:int [0..1] Количество единиц упаковки.
069 ··················<dt:volume>50</dt:volume> bs:Decimal [0..1] Объём единицы упаковки товара.
070 ··················<dt:unit> dt:Unit [0..1] Единица измерения объёма единицы упаковки товара.
071 ·····················<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Идентификатор версии единицы измерения.
072 ·····················<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор единицы измерения.
073 ·····················<dt:name>кг</dt:name> bs:String255 [1..1] Наименование единицы измерения.
074 ··················</dt:unit>
075 ···············</dt:packaging>
076 ············</vd:productItem>
077 ············<vd:volume>370.0</vd:volume> bs:Decimal [1..1] Объем продукции.
078 ············<vd:unit> dt:Unit [1..1] Единица измерения объема партии продукции.
079 ···············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Идентификатор версии единицы измерения.
080 ···············<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор единицы измерения.
081 ············</vd:unit>
082 ············<vd:batchID>ПП64219</vd:batchID> bs:String255 [0..*] Уникальный идентификатор производственной партии продукции.
083 ············<vd:origin> vd:BatchOrigin [0..1] Сведения о происхождении продукции.
084 ···············<vd:country> dt:Country [1..1] Страна происхождения партии продукции.
085 ··················<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Идентификатор версии страны.
086 ··················<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор страны.
087 ··················<dt:name>Российская федерация</dt:name> bs:String255 [1..1] Наименование страны происхождения партии продукции.
088 ···············</vd:country>
089 ···············<vd:producer> dt:Producer [1..*] Производитель продукции.
090 ··················<dt:enterprise> dt:Enterprise [1..1]

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

  • Если производитель в записи журнала отправителя существовал не из справочника (например, для импортного сертификата), то может быть возвращено поле name с отсутствием uuid/guid
091 ·····················<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Идентификатор версии предприятия.
092 ·····················<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор предприятия.
093 ·····················<dt:name>Производитель</dt:name> bs:String255 [0..1] Наименование производителя.
094 ··················</dt:enterprise>
095 ··················<dt:role>PRODUCER</dt:role> dt:EnterpriseRole [1..1] Роль предприятия-производителя продукции.
096 ···············</vd:producer>
097 ············</vd:origin>
098 ············<vd:packageList> dt:PackageList [0..1] Список физической упаковки.
099 ···············<dt:package> dt:Package [1..*]

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

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

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

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

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

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

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

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

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

109 ···············</dt:package>
110 ············</vd:packageList>
111 ············<vd:owner> dt:BusinessEntity [1..1] Фирма-владелец продукции.
112 ···············<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Идентификатор версии хозяйствующего субъекта-владельца.
113 ···············<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор хозяйствующего субъекта-владельца.
114 ············</vd:owner>
115 ············<vd:applicableClassifications> vd:BatchExtraInfo [0..1] Дополнительные характеристики партии.
116 ···············<vd:nonFoodSource>MANUFACTURED</vd:nonFoodSource> vd:NonFoodProductSourceType [0..1]

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

  • CATTLE_SLAUGHTER - Боенское.
  • LOSS_OF_CATTLE - Палое.
  • MANUFACTURED - Промышленное.
  • MIXED - Сборное.
  • FROM_HEALTHY_ANIMALS - Получено от здоровых животных.
  • FROM_SICK_ANIMALS - Получено от больных животных.
117 ············</vd:applicableClassifications>
118 ·········</vd:batch>
119 ······</vd:certifiedConsignment>
120 ······<vd:authentication> vd:VeterinaryAuthentication [1..1] Результаты осмотра/исследований партии. Заключение ветеринарного врача/специалиста.
121 ·········<vd:laboratoryResearch> vd:LaboratoryResearchEvent [0..*] Сведения о проведенных лабораторных исследованиях.
122 ············<vd:ID>ID</vd:ID> bs:Identifier [1..1] Идентификатор события в разрезе записи складского журнала или вет.сертификата.
123 ············<vd:type>LBR</vd:type> vd:VeterinaryEventType [1..1] Тип мероприятия.
124 ············<vd:actualDateTime>2017-07-07T12:00:00</vd:actualDateTime> xs:DateTime [1..1] Дата события.
125 ············<vd:operator> dt:Organization [1..1] Организация-оператор, осуществляющий мероприятие.
126 ···············<dt:name>Лаборатория №81</dt:name> bs:String255 [1..1] Название организации оператора.
127 ············</vd:operator>
128 ············<vd:referencedDocument> vd:ReferencedDocument [0..*] Сведения об акте отбора проб
129 ···············<vd:issueNumber>79498-97</vd:issueNumber> bs:String255 [0..1] Номер документа.
130 ···············<vd:issueDate>2017-07-07</vd:issueDate> xs:date [0..1] Дата оформления документа.
131 ···············<vd:type>9</vd:type> dt:DocumentType [1..1] Тип документа = 9 (акт отбора проб).
132 ············</vd:referencedDocument>
133 ············<vd:notes>Доп.сведения</vd:notes> bs:Text [0..1] Дополнительные сведения.
134 ············<vd:expertiseID>913-7613</vd:expertiseID> bs:String255 [1..1] Номер экспертизы.
135 ············<vd:disease> bs:String255 [1..1] Показатель исследования.
136 ···············<dt:name>Показатель 1</dt:name> bs:String255 [1..1] Наименование показателя.
137 ············</vd:disease>
138 ············<vd:method> dt:ResearchMethod [0..1] Метод исследования.
139 ···············<dt:name>Метод 1</dt:name> bs:String255 [1..1] Название метода исследования.
140 ············</vd:method>
141 ············<vd:result>NEGATIVE</vd:result> dt:ResearchResult [0..1] Результат исследования.
142 ············<vd:conclusion>Заключение</vd:conclusion> bs:Text [0..1] Заключение.
143 ·········</vd:laboratoryResearch>
144 ·········<vd:specialMarks>Особые отметки</vd:specialMarks> bs:Text [0..1] Особые отметки для ветеринарно-сопроводительного документа.
145 ······</vd:authentication>
146 ···</vd:vetDocument>
147 </exc:getVetDocumentByUuidResponse>
Источник — http://help.vetrf.ru/index.php?title=Exportcenter:GetVetDocumentByUuid:v2.0&oldid=32693