Exportcenter:GetExportClearancePointList:v2.0

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

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

Операция GetExportClearancePointList предназначена для получения списка актуальных записей о местах оформления электронных ветеринарных сертификатов (active=true, last=true). Поддерживается постраничный вывод.

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

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

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

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

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

  • По умолчанию значение 0.
005 ···</bs:listOptions>
006 ···<dt:enterprise> dt:Enterprise [0..1] Сведения о месте осуществления деятельности (площадке)
007 ······<dt:address> dt:Address [1..1] Сведения об адресе
008 ·········<dt:region> dt:Region [1..1] Сведения о регионе
009 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор региона
010 ·········</dt:region>
011 ······</dt:address>
012 ···</dt:enterprise>
013 </ws:getExportClearancePointListRequest>

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getExportClearancePointListResponset>
002 ···<dt:enterpriseList count="?" total="?" offset="?"> dt:ActivityLocationList [1..1]

Список поднадзорных объектов (площадок).

  • total - всего записей;
  • offset - смещение относительно первого элемента;
  • count - количество выводимых записей.
003 ······<dt:enterprise> dt:Enterprise [0..*] Сведения о месте осуществления деятельности (площадке)
004 ·········<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор версии записи
005 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
006 ·········<bs:active>?</bs:active> xs:boolean [1..1]

Флаг, указывающий на то, активна ли запись

  • true - запись активна;
  • false - запись не активна.
007 ·········<bs:last>?</bs:last> xs:boolean [1..1]

Флаг, указывающий на то, является ли запись последней

  • true - да;
  • false - нет.
008 ·········<bs:status>?</bs:status> bs:VersionStatus [1..1] Статус версии записи
009 ·········<bs:createDate>?</bs:createDate> xs:DateTime [1..1] Дата создания версии записи
010 ·········<bs:updateDate>?</bs:createDate> xs:DateTime [1..1] Дата последнего обновления версии записи
011 ·········<bs:previous>?</bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии записи
012 ·········<bs:name>?</bs:name> bs:String255 [1..1] Наименование места осуществления деятельности (площадки)
013 ·········<dt:type>?</dt:type> dt:EnterpriseType [1..1]

Тип поднадзорного объекта

  • 1 - предприятие;
  • 2 - рынок;
  • 3 - СББЖ;
  • 4 - судно.
014 ·········<dt:numberList> dt:EnterpriseNumberList [0..1] Список номеров предприятия
015 ············<dt:enterpriseNumber>?</dt:enterpriseNumber> bs:String255 [1..*] Номер предприятия
016 ·········</dt:numberList>
017 ·········<dt:address> dt:Address [1..1] Сведения об адресе места осуществления деятельности (площадки)
018 ············<dt:country> dt:Country [1..1] Сведения о стране
019 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор версии записи
020 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
021 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование страны
022 ···············<dt:code>?</dt:code> dt:Code [1..1]

Код страны

  • ОКСМ, alpha-2
023 ············</dt:country>
024 ············<dt:region> dt:Region [1..1] Сведения о регионе
025 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор версии записи
026 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
027 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование региона
028 ············</dt:region>
029 ············<dt:district> dt:District [0..1] Сведения о районе региона
030 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор версии записи
031 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
032 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование района региона
033 ············</dt:district>
034 ············<dt:locality> dt:Locality [0..1] Сведения о населенном пункте
035 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор версии записи
036 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
037 ···············<dt:name>?</dt:name> bs:String255 [1..1]
038 ············</dt:locality>
039 ············<dt:sublocality> dt:Locality [0..1] Населённый пункт, подчиненный другогому населенному пункту (locality)
040 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор версии записи
041 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
042 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование населенного пункта
043 ············</dt:sublocality>
044 ············<dt:street> dt:Street [0..1] Сведения об улице
045 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор версии записи
046 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
047 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование улицы
048 ············</dt:street>
049 ············<dt:house>?</dt:house> bs:String255 [0..1] Номер дома
050 ············<dt:bulding>?</dt:bulding> bs:String255 [0..1] Номер строения
051 ············<dt:room>?</dt:room> bs:String255 [0..1] Номер квартиры / офиса
052 ············<dt:postIndex>?</dt:postIndex> bs:String255 [0..1] Почтовый индекс
053 ············<dt:postBox>?</dt:postBox> bs:String255 [0..1] Абонентский ящик
054 ············<dt:additionalInfo>?</dt:additionalInfo> bs:String255 [0..1] Дополнительная информация
055 ············<dt:addressView>?</dt:addressView> bs:String255 [0..1] Строковое представление адреса
056 ·········</dt:address>
057 ·········<dt:registryStatus>?</dt:registryStatus> dt:EnterpriseStatus [0..1]

Статус места осуществления деятельности (площадки) в реестре ИС Цербер

  • UNVERIFIED - Не подтверджен (не в реестре).
  • VERIFIED - Подтвержден (включен в реестр).
  • CANCELED - Исключен из реестра.
  • DELETED - Удален.
058 ······</dt:enterprise>
059 ···</dt:enterpriseList>
060 </ws:getExportClearancePointListResponset>