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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
(Новая страница: «==Общие сведения== Операция '''GetMedicineRegistryEntryList''' предназначена для получения списка дейст...»)
 
(Полностью удалено содержимое страницы)
Метка: очистка
 
Строка 1: Строка 1:
==Общие сведения==


Операция '''GetMedicineRegistryEntryList''' предназначена для получения списка действующих записей государственного реестра лекарственных препаратов ветеринарного применения, фармацевтических субстанций, кормов и кормовых добавок. Поддерживается постраничный вывод. Выполнение операции заканчивается либо возвратом списка записей Реестра, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса.
===Входные данные===
* параметры выводимого списка.
===Выходные данные===
* список записей Реестра.
==Спецификация запроса==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<{{color|#660e7a|soapenv:}}Envelope>'''}}
|soapenv:Envelope
|
| style="width:52em;"| 
|-
|002
|style="font-weight: ; font-family: Courier;" |····{{color|#190dbf|'''<{{color|#660e7a|soapenv:}}Header>'''}}
|soapenv:Header
|[1..1]
| style="width:52em;"| 1. Служебная информация
|-
|003
|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>'''}}
|bs:UUID
|[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;">1.1. Идентификатор процесса в ГИС МТ
</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
Идентификатор цепочки сообщений</div>
</div>
|-
|004
|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>'''}}
|xs:dateTime
|[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;">1.2. Дата направления запроса
</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
с указанием часового пояса, МСК</div>
</div>
|-
|005
|style="font-weight: ; font-family: Courier;" |····{{color|#190dbf|'''</{{color|#660e7a|soapenv:}}Header>'''}}
|
|
| style="width:52em;"| 
|-
|006
|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;"| 
|-
|}
==Спецификация ответа==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<{{color|#660e7a|soapenv:}}Envelope>'''}}
|soapenv:Envelope
|
| style="width:52em;"| 
|-
|002
|style="font-weight: ; font-family: Courier;" |····{{color|#190dbf|'''<{{color|#660e7a|soapenv:}}Header>'''}}
|soapenv:Header
|
| style="width:52em;"| 
|-
|003
|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>'''}}
|bs:UUID
|
| style="width:52em;"| 
|-
|004
|style="font-weight: ; font-family: Courier;" |····{{color|#190dbf|'''</{{color|#660e7a|soapenv:}}Header>'''}}
|
|
| style="width:52em;"| 
|-
|005
|style="font-weight: ; font-family: Courier;" |····{{color|#190dbf|'''<{{color|#660e7a|soapenv:}}Body>'''}}
|soapenv:Body
|
| style="width:52em;"| 
|-
|006
|style="font-weight: ; font-family: Courier;" |········{{color|#190dbf|'''<{{color|#660e7a|ws:}}getMedicineRegistryEntryListResponse>'''}}
|ws:getMedicineRegistryEntryListResponse
|[0..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;">2. Результат обработки (успех)
</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
Обязательно в случае успешной обработки заявления</div>
</div>
|-
|007
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|vd:}}fmpRegistryEntryList {{color|Red|count&#61;}}{{color|#007f15|"1"}} {{color|Red|total&#61;}}{{color|#007f15|"10"}} {{color|Red|offset&#61;}}{{color|#007f15|"0"}}>'''}}
|vd:FMPRegistryEntryList
|[1..1]
| style="width:52em;"| 2.2. Параметры постраничного вывода
|-
|008
|style="font-weight: ; font-family: Courier;" |················{{color|#190dbf|'''<{{color|#660e7a|vd:}}fmpRegistryEntry>'''}}
|vd:FMPRegistryEntry
|[1..*]
| style="width:52em;"| 2.1. Сведения о регистрационном удостоверении
|-
|009
|style="font-weight: ; font-family: Courier;" |····················{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|d90f3bc5-087d-4bb9-bea8-40c5352e1daa}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|bs:UUID
|[1..1]
| style="width:52em;"| 2.1.1. Идентификатор записи реестра
|-
|010
|style="font-weight: ; font-family: Courier;" |····················{{color|#190dbf|'''<{{color|#660e7a|vd:}}registryStatus>'''}}{{color|#131313|13}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}registryStatus>'''}}
|vd:FMPRegistryStatus
|[1..1]
| style="width:52em;"| 2.1.4.1. Статус
|-
|011
|style="font-weight: ; font-family: Courier;" |····················{{color|#190dbf|'''<{{color|#660e7a|vd:}}fmpProduct {{color|Red|xsi:type&#61;}}{{color|#007f15|"vd:Pharmaceutical"}}>'''}}
|vd:FMPRegistryProduct
|[1..1]
| style="width:52em;"| 2.1.3. Описание препарата
|-
|012
|style="font-weight: ; font-family: Courier;" |························{{color|#190dbf|'''<{{color|#660e7a|vd:}}tradeName>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}tradeName>'''}}
|bs:Text
|[1..1]
| style="width:52em;"| 2.1.2. Торговое наименование лекарственного препарата
|-
|013
|style="font-weight: ; font-family: Courier;" |························{{color|#190dbf|'''<{{color|#660e7a|vd:}}chemicalName>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}chemicalName>'''}}
|bs:Text
|[0..1]
| style="width:52em;"| 2.1.3.3. Международное непатентованное наименование
|-
|014
|style="font-weight: ; font-family: Courier;" |························{{color|#190dbf|'''<{{color|#660e7a|vd:}}producer>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}producer>'''}}
|bs:Text
|[1..1]
| style="width:52em;"| 2.1.3.1. Производитель
|-
|015
|style="font-weight: ; font-family: Courier;" |························{{color|#190dbf|'''<{{color|#660e7a|vd:}}developer>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}developer>'''}}
|bs:Text
|[1..1]
| style="width:52em;"| 2.1.3.5. Разработчик
|-
|016
|style="font-weight: ; font-family: Courier;" |························{{color|#190dbf|'''<{{color|#660e7a|vd:}}formOfIssue>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}formOfIssue>'''}}
|bs:Text
|[0..1]
| style="width:52em;"| 2.1.3.2. Лекарственная форма
|-
|017
|style="font-weight: ; font-family: Courier;" |························{{color|#190dbf|'''<{{color|#660e7a|vd:}}productPurpose>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}productPurpose>'''}}
|bs:Text
|[0..1]
| style="width:52em;"| Назначение продукции
|-
|018
|style="font-weight: ; font-family: Courier;" |························{{color|#190dbf|'''<{{color|#660e7a|vd:}}componentComposition>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}componentComposition>'''}}
|bs:Text
|[0..1]
| style="width:52em;"| Компонентный состав
|-
|019
|style="font-weight: ; font-family: Courier;" |························{{color|#190dbf|'''<{{color|#660e7a|vd:}}pharmaceuticalType>'''}}{{color|#131313|VACCINE}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}pharmaceuticalType>'''}}
|vd:PharmaceuticalType
|[1..1]
| style="width:52em;"| 2.1.3.4. Тип лекарственного средства
|-
|020
|style="font-weight: ; font-family: Courier;" |····················{{color|#190dbf|'''</{{color|#660e7a|vd:}}fmpProduct>'''}}
|
|
| style="width:52em;"| 
|-
|021
|style="font-weight: ; font-family: Courier;" |····················{{color|#190dbf|'''<{{color|#660e7a|vd:}}registrationCertificate>'''}}
|vd:RegistrationCertificate
|[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;">2.1.4. Данные регистрационного удостоверения
</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
Количество блоков registrationCertificate соответствует количеству выданных регистрационных удостоверений для данного лек.средства: действующих и недействующих.
Действующее регистрационное удостоверение обязательно. При наличии ранее выданных регистрационного удостоверения с истекшим сроком действия на текущий момент сведения о них указываются дополнительно.
</div>
</div>
|-
|022
|style="font-weight: ; font-family: Courier;" |························{{color|#190dbf|'''<{{color|#660e7a|vd:}}issueSeries>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}issueSeries>'''}}
|bs:String255
|[0..1]
| style="width:52em;"| 2.1.4.5. Учетная серия регистрационного удостоверения
|-
|023
|style="font-weight: ; font-family: Courier;" |························{{color|#190dbf|'''<{{color|#660e7a|vd:}}issueNumber>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}issueNumber>'''}}
|bs:String255
|[1..1]
| style="width:52em;"| 2.1.4.6. Номер регистрационного удостоверения
|-
|024
|style="font-weight: ; font-family: Courier;" |························{{color|#190dbf|'''<{{color|#660e7a|vd:}}type>'''}}{{color|#131313|38}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}type>'''}}
|dt:DocumentType
|
| style="width:52em;"| 
|-
|025
|style="font-weight: ; font-family: Courier;" |························{{color|#190dbf|'''<{{color|#660e7a|vd:}}beginDate>'''}}{{color|#131313|2021-12-05}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}beginDate>'''}}
|xs:date
|[1..1]
| style="width:52em;"| 2.1.4.2. Дата государственной регистрации
|-
|026
|style="font-weight: ; font-family: Courier;" |························{{color|#190dbf|'''<{{color|#660e7a|vd:}}endDate>'''}}{{color|#131313|2022-12-05}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}endDate>'''}}
|xs:date
|[0..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;">2.1.4.3. Дата окончания срока действия
</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
Указывается при наличии установленного срока окончания действия. В случае регистрационных удостоверений, выданных бессрочно, атрибут отсутствует.</div>
</div>
|-
|027
|style="font-weight: ; font-family: Courier;" |························{{color|#190dbf|'''<{{color|#660e7a|vd:}}unlimited>'''}}{{color|#131313|false}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}unlimited>'''}}
|xs:boolean
|[0..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;">2.1.4.4. Признак отсутствия установленной даты окончания срока действия
</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
Атрибут обязателен для регистрационных удостоверений, выданных бессрочно.</div>
</div>
|-
|028
|style="font-weight: ; font-family: Courier;" |························{{color|#190dbf|'''<{{color|#660e7a|vd:}}certificateOwner>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}certificateOwner>'''}}
|bs:String255
|[0..1]
| style="width:52em;"| 2.1.4.7. Держатель регистрационного удостоверения
|-
|029
|style="font-weight: ; font-family: Courier;" |····················{{color|#190dbf|'''</{{color|#660e7a|vd:}}registrationCertificate>'''}}
|
|
| style="width:52em;"| 
|-
|030
|style="font-weight: ; font-family: Courier;" |················{{color|#190dbf|'''</{{color|#660e7a|vd:}}fmpRegistryEntry>'''}}
|
|
| style="width:52em;"| 
|-
|031
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''</{{color|#660e7a|vd:}}fmpRegistryEntryList>'''}}
|
|
| style="width:52em;"| 
|-
|032
|style="font-weight: ; font-family: Courier;" |········{{color|#190dbf|'''</{{color|#660e7a|ws:}}getMedicineRegistryEntryListResponse>'''}}
|
|
| style="width:52em;"| 
|-
|033
|style="font-weight: ; font-family: Courier;" |····{{color|#190dbf|'''</{{color|#660e7a|soapenv:}}Body>'''}}
|
|
| style="width:52em;"| 
|-
|034
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</{{color|#660e7a|soapenv:}}Envelope>'''}}
|
|
| style="width:52em;"| 
|-
|}
==Описание ошибок==
{| class="wikitable"
|-
! Ошибка !! Описание
|-
| '''InternalServiceFault''' || Внутренняя ошибка сервиса.
|-
| '''IncorrectRequestFault''' || Некорректный  запрос.  Происходит  в  случае,  если  запрос  не  соответствует  требованиям указанным в xsd.
|-
| '''OffsetOutOfRangeFault''' || Заданный в запросе отступ больше числа записей в результате запроса.
|}
==Пример запроса==
<!--
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Запрос первых трёх записей Реестра без смещения.
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<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>
</syntaxhighlight>
</div>
</div>
<br/>
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Ответ на запрос.
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
</syntaxhighlight>
</div>
</div>
-->

Текущая версия на 02:21, 23 июля 2024