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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 241: Строка 241:
|
|
| style="width:52em;"|  
| style="width:52em;"|  
|-
|}
==Спецификация ответа==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<exc:getPreExportVetDocumentListResponse>'''}}
|
|
| style="width:52em;"|
|-
|002
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<exc:metadata>'''}}
|[[ServiceMetadata_v2.0|exc:ServiceMetadata]]
|[1..1]
| style="width:52em;"| Служебная информация
|-
|003
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<exc:processID>'''}}{{color|#131313|?}}{{color|#190dbf|'''</exc:processID>'''}}
|[[Identifier_v2.0|bs:Identifier]]
|[1..1]
| style="width:52em;"| Идентификатор процесса в ИС Одно окно РЭЦ
|-
|004
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<exc:seqNumber>'''}}{{color|#131313|?}}{{color|#190dbf|'''</exc:seqNumber>'''}}
|[[SequenceNumber_v2.0|bs:SequenceNumber]]
|[1..1]
| style="width:52em;"| Номер входящего запроса
|-
|005
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</exc:metadata>'''}}
|
|
| style="width:52em;"|
|-
|006
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|vd:}}vetDocumentList {{color|Red|total&#61;}}{{color|#007f15|"?"}} {{color|Red|offset&#61;}}{{color|#007f15|"?"}} {{color|Red|count&#61;}}{{color|#007f15|"?"}}>'''}}
|[[VetDocumentList_v2.0|vd:VetDocumentList]]
|[1..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Список ВСД.</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* total - всего ВСД;
* offset - смещение относительно первого элемента;
* count - количество выводимых ВСД.</div>
</div>
|-
|007
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}vetDocument>'''}}
|[[VetDocument_v2.0|vd:VetDocument]]
|[1..1]
| style="width:52em;"| Сведения о ветеринарном сопроводительном документе (ВСД).
|-
|008
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}uuid>'''}}{{color|#131313|UUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}uuid>'''}}
|[[UUID|bs:UUID]]
|[1..1]
| style="width:52em;"| Идентификатор документа.
|-
|009
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|vd:}}vetDForm>'''}}{{color|#131313|LIC2}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}vetDForm>'''}}
|[[VetDocumentForm_v2.0|vd:VetDocumentForm]]
|[1..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Форма ветеринарного сопроводительного документа.</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* Описание форм ВСД - [[VetDocumentForm_v2.0|vd:VetDocumentForm]]</div>
</div>
|-
|010
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|vd:}}vetDType>'''}}{{color|#131313|TRANSPORT}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}vetDType>'''}}
|[[VetDocumentType_v2.0|vd:VetDocumentType]]
|[1..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Тип ВСД.</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* Описание типов ВСД - [[VetDocumentType_v2.0|vd:VetDocumentType]]</div>
</div>
|-
|011
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|vd:}}vetDStatus>'''}}{{color|#131313|CONFIRMED}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}vetDStatus>'''}}
|[[VetDocumentStatus_v2.0|vd:VetDocumentStatus]]
|[1..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Статус ВСД.</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* Описание статусов ВСД - [[VetDocumentStatus_v2.0|vd:VetDocumentStatus]]</div>
</div>
|-
|012
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|vd:}}lastUpdateDate>'''}}{{color|#131313|2018-02-02T13:18:54}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}lastUpdateDate>'''}}
|[http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime]
|[0..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Дата и время последнего изменения статуса ВСД.</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* В том числе при обновлении объема для незавершенного производства.</div>
</div>
|-
|-
|}
|}

Версия 06:08, 8 сентября 2021

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

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

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

# Название 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 [1..1] Сведения о ветеринарном сопроводительном документе (ВСД).
008 ·········<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Идентификатор документа.
009 ·········<vd:vetDForm>LIC2</vd:vetDForm> vd:VetDocumentForm [1..1]

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

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

Тип ВСД.

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

Статус ВСД.

012 ·········<vd:lastUpdateDate>2018-02-02T13:18:54</vd:lastUpdateDate> xs:DateTime [0..1]

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

  • В том числе при обновлении объема для незавершенного производства.
Источник — http://help.vetrf.ru/index.php?title=Exportcenter:GetPreExportVetDocumentList:v2.0&oldid=32699