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

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


==Спецификация ответа==
==Спецификация ответа==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getLaboratoryListResponse>'''}}       
|
|
| style="width:52em;"|
|-
|002
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|dt:}}laboratoryList {{color|Red|count&#61;}}{{color|#007f15|"?"}} {{color|Red|total&#61;}}{{color|#007f15|"?"}} {{color|Red|offset&#61;}}{{color|#007f15|"?"}}>'''}}
|[[LaboratoryList_v2.3|dt:LaboratoryList]]
|[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>
|-
|003
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}laboratory>'''}}
|[[Laboratory_v2.3|dt:Laboratory]]
|[0..*]
| 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]
|<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;">
* true - запись активна;
* false - запись не активна.</div>
</div>
|-
|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]
|<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;">
* true - да;
* false - нет. </div>
</div>
|-
|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|bs:}}next>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}next>'''}}
|[[UUID|bs:UUID]]
|[0..1]
| style="width:52em;"| Идентификатор следующей версии записи
|-
|013
|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;"| Наименование лаборатории
|-
|014
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}fullName>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}fullName>'''}}
|[[String255|bs:String255]]
|[1..1]
| style="width:52em;"| Полное наименование лаборатории
|-
|015
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}address>'''}}
|[[Address_v2.0|dt:Address]]
|[1..1]
| style="width:52em;"| Сведения об адресе лаборатории
|-
|016
|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;"| Строковое представление адреса
|-
|017
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}address>'''}}
|
|
| style="width:52em;"|
|-
|018
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}issuanceConclusionsWBR>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}issuanceConclusionsWBR>'''}}
|[http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
|[0..1]
| style="width:52em;"| Признак выдачи заключений ВБР данной лабораторией
|-
|019
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|dt:}}laboratory>'''}}
|
|
| style="width:52em;"|
|-
|020
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|dt:}}laboratoryList>'''}}
|
|
| style="width:52em;"|
|-
|021
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getLaboratoryListResponse>'''}}       
|
|
| style="width:52em;"|
|-
|}

Версия 02:35, 22 декабря 2022

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

Операция GetLaboratoryList предназначена для получения списка актуальных записей о лабораториях (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:getLaboratoryListRequest>
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 </ws:getLaboratoryListRequest>

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

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

Список лабораторий

  • total - всего записей;
  • offset - смещение относительно первого элемента;
  • count - количество выводимых записей.
003 ······<dt:laboratory> dt:Laboratory [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:next>?</bs:next> bs:UUID [0..1] Идентификатор следующей версии записи
013 ·········<dt:name>?</dt:name> bs:String255 [1..1] Наименование лаборатории
014 ·········<dt:fullName>?</dt:fullName> bs:String255 [1..1] Полное наименование лаборатории
015 ·········<dt:address> dt:Address [1..1] Сведения об адресе лаборатории
016 ············<dt:addressView>?</dt:addressView> bs:String255 [0..1] Строковое представление адреса
017 ·········</dt:address>
018 ·········<dt:issuanceConclusionsWBR>?</dt:issuanceConclusionsWBR> xs:boolean [0..1] Признак выдачи заключений ВБР данной лабораторией
019 ······</dt:laboratory>
020 ···</dt:laboratoryList>
021 </ws:getLaboratoryListResponse>