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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
(Новая страница: «==Общие сведения== Операция '''GetMedicineRegistryEntryList''' предназначена для получения списка дейст...»)
 
Строка 18: Строка 18:
|-
|-
|001
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getMedicineRegistryEntryListRequest>'''}}
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<{{color|#660e7a|soapenv:}}Envelope'''}}
|soapenv:Envelope
|
|
|
| style="width:52em;"|
| style="width:52em;"|  
|-
|-
|002
|002
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|bs:}}listOptions>'''}}
|style="font-weight: ; font-family: Courier;" |····{{color|#190dbf|'''<{{color|#660e7a|soapenv:}}Header>'''}}
|[[ListOptions|bs:ListOptions]]
|soapenv:Header
|[0..1]
|[1..1]
| style="width:52em;"| Параметры запрашиваемого списка.
| style="width:52em;"| 1. Служебная информация
|-
|-
|003
|003
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}count>'''}}{{color|#131313|10}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}count>'''}}
|style="font-weight: ; font-family: Courier;" |········{{color|#190dbf|'''<{{color|#660e7a|ws:}}SSPID>'''}}{{color|#131313|c05285b7-6f69-49d6-81d8-ef23fa44546c}}{{color|#190dbf|'''</{{color|#660e7a|ws:}}SSPID>'''}}
|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
|bs:UUID
|[0..1]
|[1..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
|<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 style="white-space:nowrap; font-weight: normal;">1.1. Идентификатор процесса в ИС Одно окно РЭЦ
</span>
</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
<div class="mw-collapsible-content" style="font-weight: normal;">
* По умолчанию значение 100;
Идентификатор цепочки сообщений</div>
* Максимально возможное значение 1000.</div>
</div>
</div>
|-
|-
|004
|004
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}offset>'''}}{{color|#131313|2}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}offset>'''}}
|style="font-weight: ; font-family: Courier;" |········{{color|#190dbf|'''<{{color|#660e7a|ws:}}RequestDate>'''}}{{color|#131313|2021-12-05T12:34:17}}{{color|#190dbf|'''</{{color|#660e7a|ws:}}RequestDate>'''}}
|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
|xs:dateTime
|[0..1]
|[1..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
|<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 style="white-space:nowrap; font-weight: normal;">1.2. Дата направления запроса
</span>
</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
<div class="mw-collapsible-content" style="font-weight: normal;">
* По умолчанию значение 0.</div>
с указанием часового пояса, МСК</div>
</div>
</div>
|-
|-
|005
|005
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|bs:}}listOptions>'''}}
|style="font-weight: ; font-family: Courier;" |····{{color|#190dbf|'''</{{color|#660e7a|soapenv:}}Header>'''}}
|
|
|
|
| style="width:52em;"|  
| style="width:52em;"|
|-
|-
|006
|006
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getMedicineRegistryEntryListRequest>'''}}
|style="font-weight: ; font-family: Courier;" |····{{color|#190dbf|'''<{{color|#660e7a|soapenv:}}Body>'''}}
|soapenv:Body
|
| style="width:52em;"| 
|-
|007
|style="font-weight: ; font-family: Courier;" |········{{color|#190dbf|'''<{{color|#660e7a|ws:}}getMedicineRegistryEntryListRequest>'''}}
|ws:getMedicineRegistryEntryListRequest
|
| style="width:52em;"| 
|-
|008
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}listOptions>'''}}
|bs:ListOptions
|[1..1]
| style="width:52em;"| 2. Параметры постраничного вывода
|-
|009
|style="font-weight: ; font-family: Courier;" |················{{color|#190dbf|'''<{{color|#660e7a|bs:}}count>'''}}{{color|#131313|10}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}count>'''}}
|xs:nonNegativeInteger
|
| style="width:52em;"| 
|-
|010
|style="font-weight: ; font-family: Courier;" |················{{color|#190dbf|'''<{{color|#660e7a|bs:}}offset>'''}}{{color|#131313|0}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}offset>'''}}
|xs:nonNegativeInteger
|
| style="width:52em;"| 
|-
|011
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''</{{color|#660e7a|bs:}}listOptions>'''}}
|
|
| style="width:52em;"| 
|-
|012
|style="font-weight: ; font-family: Courier;" |········{{color|#190dbf|'''</{{color|#660e7a|ws:}}getMedicineRegistryEntryListRequest>'''}}
|
|
| style="width:52em;"| 
|-
|013
|style="font-weight: ; font-family: Courier;" |····{{color|#190dbf|'''</{{color|#660e7a|soapenv:}}Body>'''}}
|
|
| style="width:52em;"| 
|-
|014
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</{{color|#660e7a|soapenv:}}Envelope>'''}}
|
|
|
|
| style="width:52em;"|  
| style="width:52em;"|
|-
|-
|}
|}

Версия 00:56, 6 декабря 2021

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

Операция GetMedicineRegistryEntryList предназначена для получения списка действующих записей государственного реестра лекарственных препаратов ветеринарного применения, фармацевтических субстанций, кормов и кормовых добавок. Поддерживается постраничный вывод. Выполнение операции заканчивается либо возвратом списка записей Реестра, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса.

Входные данные

  • параметры выводимого списка.

Выходные данные

  • список действующих записей Реестра.

Спецификация запроса

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <soapenv:Envelope soapenv:Envelope
002 ····<soapenv:Header> soapenv:Header [1..1] 1. Служебная информация
003 ········<ws:SSPID>c05285b7-6f69-49d6-81d8-ef23fa44546c</ws:SSPID> bs:UUID [1..1]

1.1. Идентификатор процесса в ИС Одно окно РЭЦ

Идентификатор цепочки сообщений
004 ········<ws:RequestDate>2021-12-05T12:34:17</ws:RequestDate> xs:dateTime [1..1]

1.2. Дата направления запроса

с указанием часового пояса, МСК
005 ····</soapenv:Header>
006 ····<soapenv:Body> soapenv:Body
007 ········<ws:getMedicineRegistryEntryListRequest> ws:getMedicineRegistryEntryListRequest
008 ············<bs:listOptions> bs:ListOptions [1..1] 2. Параметры постраничного вывода
009 ················<bs:count>10</bs:count> xs:nonNegativeInteger
010 ················<bs:offset>0</bs:offset> xs:nonNegativeInteger
011 ············</bs:listOptions>
012 ········</ws:getMedicineRegistryEntryListRequest>
013 ····</soapenv:Body>
014 </soapenv:Envelope>

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

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

Список единиц измерения.

  • total - всего записей;
  • offset - смещение относительно первого элемента;
  • count - количество выводимых записей.
003 ······<dt:unit> dt:Unit [0..*] Единица измерения.
004 ·········<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Идентификатор версии единицы измерения.
005 ·········<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор единицы измерения.
006 ·········<bs:active>true</bs:active> xs:boolean [1..1]

Описывает, является ли запись активной.

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

Описывает, является ли версия записи последней.

  • true - да;
  • false - нет.
008 ·········<bs:status>100</bs:status> bs:VersionStatus [1..1] Статус версии единицы измерения.
009 ·········<bs:createDate>2017-07-07T12:00:00</bs:createDate> xs:DateTime [1..1] Дата создания единицы измерения.
010 ·········<bs:updateDate>2017-07-07T12:00:00</bs:updateDate> xs:DateTime [1..1] Дата изменения единицы измерения.
011 ·········<bs:previous>UUID</bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии записи реестра единиц измерения.
012 ·········<dt:name>кг</dt:name> bs:String255 [1..1] Наименование единицы измерения.
013 ·········<dt:fullName>килограмм</dt:fullName> bs:String255 [1..1] Полное наименование единицы измерения.
014 ·········<dt:commonUnitGuid>GUID</dt:commonUnitGuid> bs:UUID [1..1]

Глобальный идентификатор базовой единицы измерения.

  • Например, для тонны базовая единица - кг
015 ·········<dt:factor>1</dt:factor> xs:integer [1..1]

Коэффициент относительно базовой единицы измерения.

  • Например, для тонны = 1000
016 ······</dt:unit>
017 ···</dt:unitList>
018 </ws:getMedicineRegistryEntryListResponse>

Описание ошибок

Ошибка Описание
InternalServiceFault Внутренняя ошибка сервиса.
IncorrectRequestFault Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd.
OffsetOutOfRangeFault Заданный в запросе отступ больше числа записей в результате запроса.

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

Запрос первых трёх записей Реестра без смещения. 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2" xmlns:bs="http://api.vetrf.ru/schema/cdm/base">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:getMedicineRegistryEntryListRequest>
         <bs:listOptions>
            <bs:count>3</bs:count>
            <bs:offset>0</bs:offset>
         </bs:listOptions>
      </ws:getMedicineRegistryEntryListRequest>
   </soapenv:Body>
</soapenv:Envelope>


Ответ на запрос.

Источник — http://help.vetrf.ru/index.php?title=Exportcenter:getMedicineRegistryEntryList:v2.0&oldid=33187