Exportcenter:GetPreExportVetDocumentList:v2.0

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

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

Операция GetPreExportVetDocumentList предназначена для получения списка предэкспортных ВСД на конкретную партию продукции.

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

Пространство имён (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:getPreExportVetDocumentListRequest>
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 [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:listOptions> bs:ListOptions [0..1] Параметры запрашиваемого списка
015 ······<bs:count>?</bs:count> xs:nonNegativeInteger [0..1]

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

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

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

  • По умолчанию значение 0.
017 ···</bs:listOptions>
018 ···<dt:consignorEnterprise> dt:Enterprise [1..1] Сведения о площадке-отправителе
019 ······<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
020 ···</dt:consignorEnterprise>
021 ···<dt:consigneeEnterprise> dt:Enterprise [1..1] Сведения о площадке-получателе
022 ······<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
023 ···<dt:consigneeEnterprise>
024 ···<dt:subProduct> dt:SubProduct [1..1] Сведения о виде продукции
025 ······<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
026 ···</dt:subProduct>
027 ···<dt:producerEnterprise> dt:Enterprise [1..1] Сведения о производителе
028 ······<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
029 ···</dt:producerEnterprise>
030 ···<dt:dateOfProduction> bs:DateInterval [1..1] Интервал дат производства продукции
031 ······<bs:beginDate>?</bs:beginDate> xs:dateTime [1..1] Дата начала интервала
032 ······<bs:endDate>?</bs:endDate> xs:dateTime [0..1] Дата окончания интервала
033 ···</dt:dateOfProduction>
034 </exc:getPreExportVetDocumentListRequest>

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <exc:getPreExportVetDocumentListResponse>
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:vetDocumentList total="?" offset="?" count="?"> vd:VetDocumentList [1..1]

Список ВСД.

  • total - всего ВСД;
  • offset - смещение относительно первого элемента;
  • count - количество выводимых ВСД.
007 ······<vd:vetDocument> vd:VetDocument [0..*] Сведения о ветеринарном сопроводительном документе (ВСД).
008 ·········<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор документа.
009 ·········<vd:issueDate>?</vd:issueDate> xs:date [1..1] Дата оформления ВСД.
010 ·········<vd:vetDForm>?</vd:vetDForm> vd:VetDocumentForm [1..1]

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

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

Тип ВСД.

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

Статус ВСД.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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