Exportcenter:GetVeterinaryBCPList:v2.0

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

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

Операция GetVeterinaryBCPList предназначена для получения списка актуальных записей о ПВКП (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:getVeterinaryBCPListRequest>
002 ···<bs:listOptions> bs:ListOptions [0..1] Параметры запрашиваемого списка.
003 ······<bs:count>10</bs:count> xs:nonNegativeInteger [0..1]

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

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

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

  • По умолчанию значение 0.
005 ···</bs:listOptions>
006 </ws:getVeterinaryBCPListRequest>

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

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

Список пограничных ветеринарных контрольных пунктов.

  • total - всего записей;
  • offset - смещение относительно первого элемента;
  • count - количество выводимых записей.
003 ······<dt:borderVetControlPost> dt:borderVetControlPost [1..*] Данные о пограничном ветеринарном контрольном пункте
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] Флаг, указывающий на то, активна ли запись
007 ·········<bs:last>?</bs:last> xs:boolean [1..1] Флаг, указывающий на то, является ли запись последней
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 ·········<dt:name>?</dt:name> bs:String255 [1..1] Наименование учреждения
013 ·········<dt:fullName>?</dt:name> bs:String255 [1..1] Полное наименование учреждения
014 ·········<dt:transportType>?</dt:transportType> dt:TransportType [1..1]

Тип транспортного средства, пересекающего пункт пропуска

Возможные типы транспорта:

  • Автомобильный
  • Железнодорожный
  • Авиатранспортный
  • Морской
015 ·········<dt:address> [0..1] Адрес местонахождения
016 ············<dt:country> dt:Country [0..1] Страна
017 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор версии записи
018 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
019 ···············<dt:name>?</dt:name> bs:String255 [0..1] Наименование страны
020 ···············<dt:code>?</dt:code> dt:Code [1..1] Код страны в соответствии со справочником ОКСМ
021 ············</dt:country>
022 ············<dt:region> dt:Region [0..1] Сведения о регионе
023 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор версии записи
024 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
025 ···············<dt:name>?</dt:name> bs:String255 [0..1] Наименование региона
026 ············</dt:region>
027 ············<dt:addressView>?</dt:addressView> bs:String255 [0..1] Строковое представление адреса
028 ·········</dt:address>
029 ······</dt:borderVetControlPost>
030 ···</dt:borderVetControlPostList>
031 </ws:getVeterinaryBCPListResponse>