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

Текущая версия на 09:58, 5 июня 2023

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

Операция GetVeterinaryLaboratoryList предназначена для получения списка актуальных записей о лабораториях (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:getVeterinaryLaboratoryListRequest>
002	···<bs:listOptions>	bs:ListOptions	[0..1]	Параметры запрашиваемого списка.
003	······<bs:count>?</bs:count>	xs:nonNegativeInteger	[0..1]	1.1. Максимальное запрашиваемое количество объектов в списке. По умолчанию значение 100; Максимально возможное значение 1000.
004	······<bs:offset>?</bs:offset>	xs:nonNegativeInteger	[0..1]	1.2. Номер элемента, по которому осуществляется смещение первого элемента списка. По умолчанию значение 0.
005	···</bs:listOptions>
006	</ws:getVeterinaryLaboratoryListRequest>

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

#	Название XML-элемента	Тип	Обязат.	Описание (нажмите [...] для отображения дополнительного описания)
001	<ws:getVeterinaryLaboratoryListResponse>
002	···<dt:veterinaryLaboratoryList count="?" total="?" offset="?">	dt:VeterinaryLaboratoryList	[1..1]	2. Список лабораторий total - 1.3. всего записей; offset - 1.2. смещение относительно первого элемента; count - 1.1. количество выводимых записей.
003	······<dt:veterinaryLaboratory>	dt:VeterinaryLaboratory	[0..*]	2.1. Сведения о лаборатории
004	·········<bs:uuid>?</bs:uuid>	bs:UUID	[1..1]	2.1.1. Уникальный идентификатор версии записи
005	·········<bs:guid>?</bs:guid>	bs:UUID	[1..1]	2.1.2. Глобальный идентификатор записи
006	·········<bs:active>?</bs:active>	xs:boolean	[1..1]	2.1.3. Флаг, указывающий на то, активна ли запись true - запись активна; false - запись не активна.
007	·········<bs:last>?</bs:last>	xs:boolean	[1..1]	2.1.4. Флаг, указывающий на то, является ли запись последней true - да; false - нет.
008	·········<bs:status>?</bs:status>	bs:VersionStatus	[1..1]	2.1.5. Статус версии записи
009	·········<bs:createDate>?</bs:createDate>	xs:DateTime	[1..1]	2.1.6. Дата создания версии записи
010	·········<bs:updateDate>?</bs:updateDate>	xs:DateTime	[1..1]	2.1.7. Дата последнего обновления версии записи
011	·········<bs:previous>?</bs:previous>	bs:UUID	[0..1]	2.1.8. Идентификатор предыдущей версии записи
012	·········<dt:name>?</dt:name>	bs:String255	[1..1]	2.1.9. Наименование лаборатории
013	·········<dt:fullName>?</dt:fullName>	bs:String255	[1..1]	2.1.10. Полное наименование лаборатории
014	·········<dt:address>	dt:Address	[1..1]	2.1.11. Сведения об адресе лаборатории
015	············<dt:addressView>?</dt:addressView>	bs:String255	[1..1]	2.1.11.1. Строковое представление адреса
016	·········</dt:address>
017	·········<dt:serviceList>	dt:VeterinaryServiceList	[0..1]	2.1.12. Список услуг, оказываемых лабораторией
018	············<dt:service>	dt:VeterinaryService	[1..1]	2.1.12.1. Услуга
019	···············<dt:serviceType>WBR_COMPLIENCE_STATEMENT</dt:serviceType>	dt:VeterinaryServiceType	[1..1]	2.1.12.1.1. Признак выдачи заключений ВБР данной лабораторией
020	············</dt:service>
021	·········</dt:serviceList>
022	······</dt:veterinaryLaboratory>
023	···</dt:veterinaryLaboratoryList>
024	</ws:getVeterinaryLaboratoryListResponse>

Примеры запросов

8.10.RQ1. Пример запроса списка всех лабораторий.

8.10.Request.Example

<ws:getVeterinaryLaboratoryListRequest
	xmlns:ws="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2" 
	xmlns:bs="http://api.vetrf.ru/schema/cdm/base">         
</ws:getVeterinaryLaboratoryListRequest>

8.10.Response.Example

<ws:getVeterinaryLaboratoryListResponse
	xmlns:ws="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2" 
	xmlns:bs="http://api.vetrf.ru/schema/cdm/base"
	xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2">         
   <dt:veterinaryLaboratoryList count="2" total="2" offset="0">
      <dt:veterinaryLaboratory>
         <bs:uuid>2874c443-9060-46a7-89b8-bf4219ac373a</bs:uuid>
         <bs:guid>2874c443-9060-46a7-89b8-bf4219ac373a</bs:guid>
         <bs:active>true</bs:active>
         <bs:last>true</bs:last>
         <bs:status>100</bs:status>
         <bs:createDate>2023-01-01T00:00:00</bs:createDate>
         <bs:updateDate>2023-01-01T00:00:00</bs:createDate>
         <dt:name>string</dt:name>
         <dt:fullName>string</dt:fullName>
         <dt:address>
            <dt:addressView>string</dt:addressView>
         </dt:address>
         <dt:serviceList>
            <dt:service>
               <dt:serviceType>WBR_COMPLIENCE_STATEMENT</dt:serviceType>
            </dt:service>
         </dt:serviceList>
      </dt:veterinaryLaboratory>
      <dt:veterinaryLaboratory>
         <bs:uuid>2874c443-9060-46a7-89b8-bf4219ac373a</bs:uuid>
         <bs:guid>2874c443-9060-46a7-89b8-bf4219ac373a</bs:guid>
         <bs:active>true</bs:active>
         <bs:last>true</bs:last>
         <bs:status>100</bs:status>
         <bs:createDate>2023-01-01T00:00:00</bs:createDate>
         <bs:updateDate>2023-01-01T00:00:00</bs:createDate>
         <dt:name>string</dt:name>
         <dt:fullName>string</dt:fullName>
         <dt:address>
            <dt:addressView>string</dt:addressView>
         </dt:address>
      </dt:veterinaryLaboratory>
   </dt:veterinaryLaboratoryList>
</ws:getVeterinaryLaboratoryListResponse>