Herriot:GetAnimalRegistrationList:v1.0: различия между версиями

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


== Спецификация запроса ==
== Спецификация запроса ==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<hrt:getAnimalRegistrationListRequest>'''}}
|
|
| style="width:52em;"|
|-
|002
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:localTransactionId>'''}}{{color|#131313|?}}{{color|#190dbf|'''</hrt:localTransactionId>'''}}
|bs:Identifier
|[1..1]
| style="width:52em;"| Идентификатор заявки в клиентской системе
|-
|003
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:initiator>'''}}
|vd:User
|[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;">
* является ответственным за выполнение бизнес-операции
* требуется логин ветврача или пользователя ХС, логин для базовой аутентификации не подойдёт</div>
</div>
|-
|004
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}login>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}login>'''}}
|xs:NCName
|[1..1]
| style="width:52em;"| Логин пользователя
|-
|005
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:initiator>'''}}
|
|
| style="width:52em;"|
|-
|006
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|bs:}}listOptions>'''}}
|bs:ListOptions
|[0..1]
| style="width:52em;"| Параметры запрашиваемого списка
|-
|007
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}count>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}count>'''}}
|xs:nonNegativeInteger
|[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;">Максимальное запрашиваемое количество объектов в списке</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* По умолчанию значение 100;
* Максимально возможное значение 1000.</div>
</div>
|-
|008
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}offset>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}offset>'''}}
|xs:nonNegativeInteger
|[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;">Номер элемента, по которому осуществляется смещение первого элемента списка</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* По умолчанию значение 0.</div>
</div>
|-
|009
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|bs:}}listOptions>'''}}
|
|
| style="width:52em;"|
|-
|010
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:region>'''}}
|dt:Region
|[1..1]
| style="width:52em;"| Зона обслуживания: субъект РФ, на территории которого содержатся животные
|-
|011
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|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;">Глобальный идентификатор записи</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* Справочник IS.HRT.2. Регионы</div>
</div>
|-
|012
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:region>'''}}
|
|
| style="width:52em;"|
|-
|013
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:supervisedObjectList>'''}}
|dt:SupervisedObjectList
|[0..1]
| style="width:52em;"| Сведения о поднадзорных объектах, на которых осуществляется содержание животных
|-
|014
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}supervisedObject>'''}}
|dt:SupervisedObject
|[1..*]
| style="width:52em;"| Поднадзорный объект
|-
|015
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|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;">Глобальный идентификатор записи</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* Справочник ES.HRT.2. Реестр поднадзорных объектов</div>
</div>
|-
|016
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|dt:}}supervisedObject>'''}}
|
|
| style="width:52em;"|
|-
|017
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:supervisedObjectList>'''}}
|
|
| style="width:52em;"|
|-
|018
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:animalIdentityType>'''}}{{color|#131313|?}}{{color|#190dbf|'''</hrt:animalIdentityType>'''}}
|vd:AnimalIdentityType
|[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;">Тип идентификации/учёта: индивидуальная / групповая</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* Возможные значения:
** INDIVIDUAL - индивидуальная идентификация
** GROUP - групповая идентификация</div>
</div>
|-
|019
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:registrationNumber>'''}}{{color|#131313|?}}{{color|#190dbf|'''</hrt:registrationNumber>'''}}
|dt:AnimalID
|[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;">Регистрационный номер учётной карточки животного (группы животных)</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* Поддерживается поиск по частичному совпадению</div>
</div>
|-
|020
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:animalIDList>'''}}
|dt:UnifiedAnimalIDList
|[0..1]
| style="width:52em;"| Сведения о номерах средств маркирования
|-
|021
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}animalIDContent>'''}}
|dt:UnifiedAnimalID
|[1..1]
| style="width:52em;"| Номер средства маркирования
|-
|022
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}animalID>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}animalID>'''}}
|dt:AnimalID
|[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;">
* Поддерживается поиск по частичному совпадению</div>
</div>
|-
|023
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|dt:}}animalIDContent>'''}}
|
|
| style="width:52em;"|
|-
|024
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:animalIDList>'''}}
|
|
| style="width:52em;"|
|-
|025
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:registrationStatusList>'''}}
|vd:AnimalRegistrationStatusList
|[0..1]
| style="width:52em;"| Сведения о статусах учётных карточек животных (группы животных)
|-
|026
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}registrationStatus>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}registrationStatus>'''}}
|vd:AnimalRegistrationStatus
|[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;">
* Возможные значения:
** PREPARING - В обработке (сведения приняты на регистрацию)
** ACTIVE - Активна (зарегистированная учетная карточка)
** TERMINATED - Регистрация завершена</div>
</div>
|-
|027
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:registrationStatusList>'''}}
|
|
| style="width:52em;"|
|-
|028
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:animalSpeciesList>'''}}
|dt:AnimalSpeciesList
|[0..1]
| style="width:52em;"| Сведения о биологическом виде животного
|-
|029
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}animalSpecies>'''}}
|dt:AnimalSpecies
|[1..1]
| style="width:52em;"| Биологический вид животного
|-
|030
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|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;">Глобальный идентификатор записи</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* Справочник DS.HRT.2. Биологические виды животных </div>
</div>
|-
|031
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|dt:}}animalSpecies>'''}}
|
|
| style="width:52em;"|
|-
|032
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:animalSpeciesList>'''}}
|
|
| style="width:52em;"|
|-
|033
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:specifiedAnimal>'''}}
|dt:Animal
|[0..1]
| style="width:52em;"| Сведения о животных
|-
|034
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}gender>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}gender>'''}}
|dt:AnimalGender
|[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;">
* Возможные значения:
** MALE - самец
** FEMALE - самка
** UNDEFINED - не определен</div>
</div>
|-
|035
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:specifiedAnimal>'''}}
|
|
| style="width:52em;"|
|-
|036
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</hrt:getAnimalRegistrationListRequest>'''}}
|
|
| style="width:52em;"|
|-
|}


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

Версия 04:32, 14 октября 2024

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

Код Описание операции
AMS.HRT.1.11 Операция предназначена для получения списка актуальных сведений о регистрации животных или групп животных с возможностью фильтрации.

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <hrt:getAnimalRegistrationListRequest>
002 ···<hrt:localTransactionId>?</hrt:localTransactionId> bs:Identifier [1..1] Идентификатор заявки в клиентской системе
003 ···<hrt:initiator> vd:User [1..1]

Пользователь, зарегистрированный в ВетИС, инициирующий запрос

  • является ответственным за выполнение бизнес-операции
  • требуется логин ветврача или пользователя ХС, логин для базовой аутентификации не подойдёт
004 ······<vd:login>?</vd:login> xs:NCName [1..1] Логин пользователя
005 ···</hrt:initiator>
006 ···<bs:listOptions> bs:ListOptions [0..1] Параметры запрашиваемого списка
007 ······<bs:count>?</bs:count> xs:nonNegativeInteger [0..1]

Максимальное запрашиваемое количество объектов в списке

  • По умолчанию значение 100;
  • Максимально возможное значение 1000.
008 ······<bs:offset>?</bs:offset> xs:nonNegativeInteger [0..1]

Номер элемента, по которому осуществляется смещение первого элемента списка

  • По умолчанию значение 0.
009 ···</bs:listOptions>
010 ···<hrt:region> dt:Region [1..1] Зона обслуживания: субъект РФ, на территории которого содержатся животные
011 ······<bs:guid>?</bs:guid> bs:UUID [1..1]

Глобальный идентификатор записи

  • Справочник IS.HRT.2. Регионы
012 ···</hrt:region>
013 ···<hrt:supervisedObjectList> dt:SupervisedObjectList [0..1] Сведения о поднадзорных объектах, на которых осуществляется содержание животных
014 ······<dt:supervisedObject> dt:SupervisedObject [1..*] Поднадзорный объект
015 ·········<bs:guid>?</bs:guid> bs:UUID [1..1]

Глобальный идентификатор записи

  • Справочник ES.HRT.2. Реестр поднадзорных объектов
016 ······</dt:supervisedObject>
017 ···</hrt:supervisedObjectList>
018 ···<hrt:animalIdentityType>?</hrt:animalIdentityType> vd:AnimalIdentityType [0..1]

Тип идентификации/учёта: индивидуальная / групповая

  • Возможные значения:
    • INDIVIDUAL - индивидуальная идентификация
    • GROUP - групповая идентификация
019 ···<hrt:registrationNumber>?</hrt:registrationNumber> dt:AnimalID [0..1]

Регистрационный номер учётной карточки животного (группы животных)

  • Поддерживается поиск по частичному совпадению
020 ···<hrt:animalIDList> dt:UnifiedAnimalIDList [0..1] Сведения о номерах средств маркирования
021 ······<dt:animalIDContent> dt:UnifiedAnimalID [1..1] Номер средства маркирования
022 ·········<dt:animalID>?</dt:animalID> dt:AnimalID [1..1]

Значение номера средства маркирования

  • Поддерживается поиск по частичному совпадению
023 ······</dt:animalIDContent>
024 ···</hrt:animalIDList>
025 ···<hrt:registrationStatusList> vd:AnimalRegistrationStatusList [0..1] Сведения о статусах учётных карточек животных (группы животных)
026 ······<vd:registrationStatus>?</vd:registrationStatus> vd:AnimalRegistrationStatus [1..*]

Статус учётной карточки животного (группы животных)

  • Возможные значения:
    • PREPARING - В обработке (сведения приняты на регистрацию)
    • ACTIVE - Активна (зарегистированная учетная карточка)
    • TERMINATED - Регистрация завершена
027 ···</hrt:registrationStatusList>
028 ···<hrt:animalSpeciesList> dt:AnimalSpeciesList [0..1] Сведения о биологическом виде животного
029 ······<dt:animalSpecies> dt:AnimalSpecies [1..1] Биологический вид животного
030 ·········<bs:guid>?</bs:guid> bs:UUID [1..1]

Глобальный идентификатор записи

  • Справочник DS.HRT.2. Биологические виды животных
031 ······</dt:animalSpecies>
032 ···</hrt:animalSpeciesList>
033 ···<hrt:specifiedAnimal> dt:Animal [0..1] Сведения о животных
034 ······<dt:gender>?</dt:gender> dt:AnimalGender [1..1]

Пол животного

  • Возможные значения:
    • MALE - самец
    • FEMALE - самка
    • UNDEFINED - не определен
035 ···</hrt:specifiedAnimal>
036 </hrt:getAnimalRegistrationListRequest>

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

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

TODO

См. также

Вернуться к началу ↑
Вернуться на страницу профиля API Herriot:Services:v1.0

Источник — http://help.vetrf.ru/index.php?title=Herriot:GetAnimalRegistrationList:v1.0&oldid=41186