Exportcenter:GetExportVeterinaryPermitList:v2.0

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

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

Операция GetExportVeterinaryPermitList предназначена для получения списка действующих ветеринарных разрешений, выданных хозяйствующему субъекту.

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

Версия 2.0

Пространство имён (xmlns) XSD-схема, содержащая описание типов
xmlns:bs="http://api.vetrf.ru/schema/cdm/base" https://api.vetrf.ru/schema/platform/exportcenter/v2.0b-20211126/base_v2.0.xsd
xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2" https://api.vetrf.ru/schema/platform/exportcenter/v2.0b-20211126/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-20211126/document_v2.2.xsd
xmlns:exc="http://api.vetrf.ru/schema/cdm/exportcenter/applications/v2" https://api.vetrf.ru/schema/platform/exportcenter/v2.0b-20211126/exportcenter_applications_v2.0.xsd

Версия 2.1

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

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <exc:getExportVeterinaryPermitListRequest>
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 ···<exc:consignorEnterprise> dt:Enterprise [0..1]

Сведения о складе отгрузки (площадка)

  • Склад отгрузки может быть определен как площадка или как зарегистрированный поднадзорный объект.
  • В целях обратной совместимости поддерживаются оба варианта.
  • Минимальным необходимым параметром для подбора ветеринарных разрешений является регион склада.
  • Конкретный идентификатор поднадзорного объекта или площадки, соответствующей данному объекту, может быть указан в дополнение для конкретизации и сокращения результатов поиска.
019 ······<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор записи
020 ······<dt:address> dt:Address [1..1] Сведения об адресе
021 ·········<dt:region> dt:Region [1..1] Регион отгрузки
022 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
023 ·········</dt:region>
024 ······</dt:address>
025 ···</exc:consignorEnterprise>
026 ···<exc:storagePoint> dt:StoragePoint [0..1]

Сведения о складе отгрузки (поднадзорный объект)

  • Склад отгрузки может быть определен как площадка или как зарегистрированный поднадзорный объект.
  • В целях обратной совместимости поддерживаются оба варианта.
  • Минимальным необходимым параметром для подбора ветеринарных разрешений является регион склада.
  • Конкретный идентификатор поднадзорного объекта или площадки, соответствующей данному объекту, может быть указан в дополнение для конкретизации и сокращения результатов поиска.
027 ······<dt:supervisedObject> dt:SupervisedObject [1..1] Поднадзорный объект
028 ·········<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор записи
029 ·········<dt:enterprise> dt:Enterprise [1..1] Сведения о складе отгрузки
030 ············<dt:address> dt:Address [1..1] Сведения об адресе
031 ···············<dt:region> dt:Region [1..1] Регион отгрузки
032 ··················<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
033 ···············</dt:region>
034 ············</dt:address>
035 ·········</dt:consignorEnterprise>
036 ······</dt:supervisedObject>
037 ···</exc:storagePoint>
038 ···<dt:subProduct> dt:SubProduct [1..1] Вид продукции
039 ······<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор вида продукции
040 ···</dt:subProduct>
041 ···<exc:permitYear>?</exc:permitYear> dt:Year [1..1] Год выдачи разрешения
042 ···<exc:importCountry> dt:Country [1..1] Сведения о стране-импортере
043 ······<dt:code>?</dt:code> dt:Code [1..1]

Код страны

  • двухбуквенный код страны, соответствующий стандарту ISO 3166-1. В качестве кода используются буквы латинского алфавита.
044 ···</exc:importCountry>
045 ···<exc:vetPermit> vd:VeterinaryPermit [0..1]

Сведения о ветеринарном разрешении

  • Реквизиты конкретного ветеринарного разрешения, например, из результатов операции 3.4. Данный сценарий может быть использован для получения полных сведений о выданном разрешении по заявлению, направленному в рамках операции 3.3.
  • Должен быть указан или идентификатор заявления (п.3.5.1) или сведения о номере и дате (п.3.5.2 и 3.5.3)
  • Обращаем внимание, что при поиске по реквизитам документа атрибуты "3.1.2. Регион места отгрузки", "3.4. Страна-импортер" и "3.3. Год разрешения на вывоз" в запросе также обязательны для заполнения.
  • При поиске по конкретным реквизитам документа в ответе будут возвращаться как действующие разрешения, так и выданные запреты с указанным номером/идентификатором. Если блок 3.5. в запросе отсутствует или не заполнен, результатом операции будут только действующие разрешения.
046 ······<bs:uuid>?</bs:uuid> bs:UUID [0..1] Уникальный идентификатор разрешения
047 ······<vd:issueNumber>?</vd:issueNumber> bs:String255 [0..1] Номер разрешения
048 ······<vd:issueDate>?</vd:issueDate> xs:date [0..1] Дата разрешения
049 ···</exc:vetPermit>
050 </exc:getExportVeterinaryPermitListRequest>

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

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

Список ветеринарных разрешений

  • total - всего записей;
  • offset - смещение относительно первого элемента;
  • count - количество выводимых записей.
007 ······<vd:vetPermit> vd:VetDocument [0..*] Сведения о ветеринарном разрешении
008 ·········<vd:issueNumber>?</vd:issueNumber> bs:String255 [1..1] Номер разрешения
009 ·········<vd:issueDate>?</vd:issueDate> xs:date [1..1] Дата разрешения
010 ·········<vd:type>27</vd:type> dt:DocumentType [1..1] Тип документа (27 - разрешение на экспорт продукции в третьи страны)
011 ·········<vd:permitYear>?</vd:permitYear> dt:Year [1..1] Год, на который выдано разрешение
012 ·········<vd:permitDecision>AUTHORIZED</vd:permitDecision> vd:PermitDecision [1..1] Решение (только AUTHORIZED - разрешается)
013 ·········<vd:transferType>2</vd:transferType> dt:TransferType [1..1] Тип операции (2 - вывоз)
014 ·········<vd:productType>?</vd:productType> dt:ProductType [1..1] Тип продукции
015 ·········<vd:transferPurpose> dt:Purpose [0..1] Цель вывоза
016 ············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор цели вывоза
017 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор цели вывоза
018 ············<dt:name>?</dt:name> bs:String255 [1..1] Наименование цели вывоза
019 ·········</vd:transferPurpose>
020 ·········<vd:businessEntity> dt:BusinessEntity [1..1] Сведения о хозяйствующем субъекте
021 ············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор записи
022 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
023 ············<dt:name>?</dt:name> bs:String255 [1..1] Наименование хозяйствующего субъекта
024 ············<dt:fullName>?</dt:fullName> bs:String255 [1..1] Полное наименование хозяйствующего субъекта
025 ············<dt:inn>?</dt:inn> bs:String255 [1..1] ИНН хозяйствующего субъекта
026 ·········</vd:businessEntity>
027 ·········<vd:importCountry> dt:Country [1..1] Сведения о стране-импортере
028 ············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор страны
029 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор страны
030 ············<dt:name>?</dt:name> bs:String255 [1..1] Наименование страны-импортера
031 ············<dt:code>?</dt:code> dt:Code [1..1] Код страны
032 ·········</vd:importCountry>
033 ·········<vd:consignee> dt:BusinessEntity [1..1] Сведения о получателе продукции.
034 ············<dt:name>?</dt:name> bs:String255 [1..1] Наименование хозяйствующего субъекта
035 ············<dt:juridicalAddress> dt:Address [1..1] Сведения об адресе получателя
036 ···············<dt:addressView>?</dt:addressView> bs:String255 [1..1] Строковое представление адреса
037 ············</dt:juridicalAddress>
038 ·········</vd:consignee>
039 ·········<vd:storagePoint> dt:StoragePoint [1..*] Сведения о месте хранения продукции
040 ············<dt:name>?</dt:name> bs:String255 [1..1] Наименование места хранения
041 ············<dt:address> dt:Address [1..1] Сведения об адресе места хранения продукции
042 ···············<dt:country> dt:Country [1..1] Сведения о стране места хранения продукции
043 ··················<dt:name>?</dt:name> bs:String255 [1..1] Наименование страны
044 ··················<dt:code>?</dt:code> dt:Code [1..1] Код страны
045 ···············</dt:country>
046 ···············<dt:region> dt:Region [1..1] Сведения о регионе места хранения продукции
047 ··················<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
048 ··················<dt:name>?</dt:name> bs:String255 [1..1] Наименование региона
049 ···············</dt:region>
050 ···············<dt:addressView>?</dt:addressView> bs:String255 [0..1] Строковое представление адреса
051 ············</dt:address>
052 ·········</vd:storagePoint>
053 ·········<vd:cargoList> vd:VetPermitCargoItemList [1..1] Список грузов в разрешении
054 ············<vd:cargo> vd:VetPermitCargoItem [1..*] Позиция груза в ветеринарном разрешении
055 ···············<vd:codeWithinPermit>?</vd:codeWithinPermit> vd:PermitCargoCode [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 ··················<dt:name>?</dt:name> bs:String255 [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 ··················<dt:name>?</dt:name> bs:String255 [1..1] Наименование вида продукции
065 ···············</vd:subProduct>
066 ···············<vd:cargoAvailableAmount>?</vd:cargoAvailableAmount> bs:Decimal [1..1] Остаток по разрешенному объему
067 ···············<vd:cargoUnit> dt:Unit [1..1] Сведения о единице измерения объема груза
068 ··················<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор единицы измерения
069 ··················<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор единицы измерения.
070 ··················<dt:name>?</dt:name> bs:String255 [1..1] Наименование единицы измерения.
071 ···············</vd:cargoUnit>
072 ···············<vd:producerList> dt:CertifiedProducerList [1..1] Сведения о поднадзорных объектах производителях продукции
073 ···················<dt:producer> dt:CertifiedProducer [1..*] Производитель продукции
074 ·······················<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор поднадзорного объекта производителя
075 ·······················<dt:enterprise> dt:Enterprise [0..1] Сведения о предприятии-производителе
076 ···························<dt:address> dt:Address [1..1] Сведения об адресе предприятия-производителя
077 ·······························<dt:addressView>?</dt:addressView> bs:NText [1..1] Текстовое представление адреса
078 ···························</dt:address>
079 ·······················</dt:enterprise>
080 ·······················<dt:approvalNumber>?</dt:approvalNumber> bs:Identifier [1..1] Регистрационный номер предприятия
081 ·······················<dt:approvedName>?</dt:approvedName> bs:String255 [1..1] Наименование поднадзорного объекта, установленное при включении в реестр
082 ···················</dt:producer>
083 ···············</vd:producerList>
084 ···············<vd:cargoDetails> vd:VetPermitCargoItemDetails [0..1] Дополнительная информация о грузе
085 ···················<vd:productName>?</vd:productName> bs:NText [1..1] Наименование продукции
086 ···············</vd:cargoDetails>
087 ············</vd:cargo>
088 ·········</vd:cargoList>
089 ······</vd:vetPermit>
090 ···</vd:veterinaryPermitList>
091 </exc:getExportVeterinaryPermitListResponse>
Источник — http://help.vetrf.ru/index.php?title=Exportcenter:GetExportVeterinaryPermitList:v2.0&oldid=34052