Exportcenter:GetVeterinaryBCPList:v2.0: различия между версиями
Перейти к навигации
Перейти к поиску
(не показаны 4 промежуточные версии 1 участника) | |||
Строка 1: | Строка 1: | ||
==Общие сведения== | ==Общие сведения== | ||
Операция '''GetVeterinaryBCPList''' предназначена для получения списка актуальных записей о ПВКП (active=true, last=true). Поддерживается постраничный вывод | Операция '''GetVeterinaryBCPList''' предназначена для получения списка актуальных записей о ПВКП (active=true, last=true). Поддерживается постраничный вывод. | ||
==Используемые пространства имён | ==Используемые пространства имён== | ||
{| class="wikitable" | {| class="wikitable" | ||
Строка 21: | Строка 21: | ||
==Спецификация запроса== | ==Спецификация запроса== | ||
{| class="wikitable" | |||
! # | |||
! Название XML-элемента | |||
! Тип | |||
! Обязат. | |||
! Описание (нажмите [...] для отображения дополнительного описания) | |||
|- | |||
|001 | |||
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getVeterinaryBCPListRequest>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|002 | |||
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|bs:}}listOptions>'''}} | |||
|[[ListOptions|bs:ListOptions]] | |||
|[0..1] | |||
| style="width:52em;"| Параметры запрашиваемого списка. | |||
|- | |||
|003 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}count>'''}}{{color|#131313|10}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}count>'''}} | |||
|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] | |||
|[0..1] | |||
|<div class="mw-collapsible mw-collapsed" data-expandtext=" ... " 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;"> | |||
* По умолчанию значение 100; | |||
* Максимально возможное значение 1000.</div> | |||
</div> | |||
|- | |||
|004 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}offset>'''}}{{color|#131313|2}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}offset>'''}} | |||
|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] | |||
|[0..1] | |||
|<div class="mw-collapsible mw-collapsed" data-expandtext=" ... " 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;"> | |||
* По умолчанию значение 0.</div> | |||
</div> | |||
|- | |||
|005 | |||
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|bs:}}listOptions>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|006 | |||
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getVeterinaryBCPListRequest>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|} | |||
==Спецификация ответа== | ==Спецификация ответа== | ||
{| class="wikitable" | |||
! # | |||
! Название XML-элемента | |||
! Тип | |||
! Обязат. | |||
! Описание (нажмите [...] для отображения дополнительного описания) | |||
|- | |||
|001 | |||
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getVeterinaryBCPListResponse>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|002 | |||
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|dt:}}getVeterinaryBCPList {{color|Red|count=}}{{color|#007f15|"?"}} {{color|Red|total=}}{{color|#007f15|"?"}} {{color|Red|offset=}}{{color|#007f15|"?"}}>'''}} | |||
|[[BorderVetControlPostList_v2.0|dt:borderVetControlPostList]] | |||
|[1..1] | |||
|<div class="mw-collapsible mw-collapsed" data-expandtext=" ... " 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> | |||
|- | |||
|003 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}borderVetControlPost>'''}} | |||
|[[BorderVetControlPost_v2.0|dt:borderVetControlPost]] | |||
|[1..*] | |||
| style="width:52em;"| Данные о пограничном ветеринарном контрольном пункте | |||
|- | |||
|004 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}uuid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}uuid>'''}} | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
| style="width:52em;"| Уникальный идентификатор версии записи | |||
|- | |||
|005 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}} | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
| style="width:52em;"| Глобальный идентификатор записи | |||
|- | |||
|006 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}active>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}active>'''}} | |||
|[http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] | |||
|[1..1] | |||
| style="width:52em;"| Флаг, указывающий на то, активна ли запись | |||
|- | |||
|007 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}last>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}last>'''}} | |||
|[http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] | |||
|[1..1] | |||
| style="width:52em;"| Флаг, указывающий на то, является ли запись последней | |||
|- | |||
|008 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}status>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}status>'''}} | |||
|[[VersionStatus|bs:VersionStatus]] | |||
|[1..1] | |||
| style="width:52em;"| Статус версии записи | |||
|- | |||
|009 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}createDate>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}createDate>'''}} | |||
|[http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime] | |||
|[1..1] | |||
| style="width:52em;"| Дата создания версии записи | |||
|- | |||
|010 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}updateDate>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}createDate>'''}} | |||
|[http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime] | |||
|[1..1] | |||
| style="width:52em;"| Дата последнего обновления версии записи | |||
|- | |||
|011 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}previous>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}previous>'''}} | |||
|[[UUID|bs:UUID]] | |||
|[0..1] | |||
| style="width:52em;"| Идентификатор предыдущей версии записи | |||
|- | |||
|012 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}name>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}name>'''}} | |||
|[[String255|bs:String255]] | |||
|[1..1] | |||
| style="width:52em;"| Наименование учреждения | |||
|- | |||
|013 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}fullName>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}name>'''}} | |||
|[[String255|bs:String255]] | |||
|[1..1] | |||
| style="width:52em;"| Полное наименование учреждения | |||
|- | |||
|014 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}transportType>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}transportType>'''}} | |||
|[[TransportType_v2.0|dt:TransportType]] | |||
|[1..1] | |||
|<div class="mw-collapsible mw-collapsed" data-expandtext=" ... " 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> | |||
|- | |||
|015 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}address>'''}} | |||
| | |||
|[0..1] | |||
| style="width:52em;"| Адрес местонахождения | |||
|- | |||
|016 | |||
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}country>'''}} | |||
|[[Country_v2.0|dt:Country]] | |||
|[0..1] | |||
| style="width:52em;"| Страна | |||
|- | |||
|017 | |||
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|bs:}}uuid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}uuid>'''}} | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
| style="width:52em;"| Уникальный идентификатор версии записи | |||
|- | |||
|018 | |||
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}} | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
| style="width:52em;"| Глобальный идентификатор записи | |||
|- | |||
|019 | |||
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|dt:}}name>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}name>'''}} | |||
|[[String255|bs:String255]] | |||
|[0..1] | |||
| style="width:52em;"| Наименование страны | |||
|- | |||
|020 | |||
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|dt:}}code>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}code>'''}} | |||
|[[Code_v2.0|dt:Code]] | |||
|[1..1] | |||
| style="width:52em;"| Код страны в соответствии со справочником ОКСМ | |||
|- | |||
|021 | |||
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''</{{color|#660e7a|dt:}}country>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|022 | |||
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}region>'''}} | |||
|[[Region_v2.0|dt:Region]] | |||
|[0..1] | |||
| style="width:52em;"| Сведения о регионе | |||
|- | |||
|023 | |||
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|bs:}}uuid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}uuid>'''}} | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
| style="width:52em;"| Уникальный идентификатор версии записи | |||
|- | |||
|024 | |||
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}} | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
| style="width:52em;"| Глобальный идентификатор записи | |||
|- | |||
|025 | |||
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|dt:}}name>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}name>'''}} | |||
|[[String255|bs:String255]] | |||
|[0..1] | |||
| style="width:52em;"| Наименование региона | |||
|- | |||
|026 | |||
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''</{{color|#660e7a|dt:}}region>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|027 | |||
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}addressView>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}addressView>'''}} | |||
|[[String255|bs:String255]] | |||
|[0..1] | |||
| style="width:52em;"| Строковое представление адреса | |||
|- | |||
|028 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}address>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|029 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|dt:}}borderVetControlPost>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|030 | |||
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|dt:}}borderVetControlPostList>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|031 | |||
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getVeterinaryBCPListResponse>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|} |
Текущая версия на 17:23, 24 февраля 2022
Общие сведения
Операция 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] | Максимальное запрашиваемое количество объектов в списке.
|
004 | ······<bs:offset>2</bs:offset> | xs:nonNegativeInteger | [0..1] | Номер элемента, по которому осуществляется смещение первого элемента списка.
|
005 | ···</bs:listOptions> | |||
006 | </ws:getVeterinaryBCPListRequest> |
Спецификация ответа
# | Название XML-элемента | Тип | Обязат. | Описание (нажмите [...] для отображения дополнительного описания) |
---|---|---|---|---|
001 | <ws:getVeterinaryBCPListResponse> | |||
002 | ···<dt:getVeterinaryBCPList count="?" total="?" offset="?"> | dt:borderVetControlPostList | [1..1] | Список пограничных ветеринарных контрольных пунктов.
|
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> |