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

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


== Спецификация запроса ==
== Спецификация запроса ==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<hrt:excludeFromAnimalGroupRequest>'''}}
|
|
| 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|'''<hrt:specifiedAnimalGroup>'''}}
|dt:AnimalGroup
|[1..1]
| style="width:52em;"| Сведения об исключении животных из группы
|-
|007
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}size>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}size>'''}}
|xs:nonNegativeInteger
|[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;">
* Указывается общее количество зарегистрированных (если указывается список excludedAnimalRegistrationList) и незарегистрированных животных
* Если указывается список excludedAnimalRegistrationList, то общее количество животных должно быть больше или равно количеству элементов в excludedAnimalRegistrationList</div>
</div>
|-
|008
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:specifiedAnimalGroup>'''}}
|
|
| style="width:52em;"|
|-
|009
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:excludedAnimalRegistrationList>'''}}
|vd:AnimalRegistrationList
|[0..1]
| style="width:52em;"| Сведения об индивидуальных животных, исключаемых из группы
|-
|010
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}animalRegistration>'''}}
|vd:AnimalRegistration
|[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]
| style="width:52em;"| Глобальный идентификатор записи
|-
|012
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|vd:}}animalRegistration>'''}}
|
|
| style="width:52em;"|
|-
|013
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:excludedAnimalRegistrationList>'''}}
|
|
| style="width:52em;"|
|-
|014
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:animalRegistrationRef>'''}}
|vd:AnimalRegistration
|[1..1]
| style="width:52em;"| Сведения регистрации (учётная карточка) группы, из которой выполняется исключение животных
|-
|015
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}uuid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}uuid>'''}}
|bs:UUID
|[1..1]
| style="width:52em;"| Идентификатор версии учётной карточки группы животных
|-
|016
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:animalRegistrationRef>'''}}
|
|
| style="width:52em;"|
|-
|017
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</hrt:excludeFromAnimalGroupRequest>'''}}
|
|
| style="width:52em;"|
|-
|}


== Спецификация ответа ==
== Спецификация ответа ==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<hrt:excludeFromAnimalGroupResponse>'''}}
|
|
| style="width:52em;"|
|-
|002
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|vd:}}animalRegistration>'''}}
|vd:AnimalRegistration
|[1..1]
| style="width:52em;"| Сведения регистрации (учётная карточка) животного или группы животных
|-
|003
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}uuid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}uuid>'''}}
|bs:UUID
|[1..1]
| style="width:52em;"| Идентификатор версии записи
|-
|004
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|bs:UUID
|[1..1]
| style="width:52em;"| Глобальный идентификатор записи
|-
|005
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}active>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}active>'''}}
|xs:boolean
|[1..1]
| style="width:52em;"| Флаг: является ли запись активной
|-
|006
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}last>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}last>'''}}
|xs:boolean
|[1..1]
| style="width:52em;"| Флаг: является ли версия последней
|-
|007
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}status>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}status>'''}}
|bs:VersionStatus
|[1..1]
| style="width:52em;"| Статус версии записи
|-
|008
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}createDate>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}createDate>'''}}
|xs:dateTime
|[1..1]
| style="width:52em;"| Дата создания записи
|-
|009
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}updateDate>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}updateDate>'''}}
|xs:dateTime
|[1..1]
| style="width:52em;"| Дата последнего изменения записи
|-
|010
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}previous>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}previous>'''}}
|bs:UUID
|[1..1]
| style="width:52em;"| Идентификатор предыдущей версии записи
|-
|011
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}identityType>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}identityType>'''}}
|vd:AnimalIdentityType
|[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;">
* Возможные значения:
** GROUP - групповая идентификация</div>
</div>
|-
|012
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}registrationNumber>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}registrationNumber>'''}}
|dt:AnimalID
|[1..1]
| style="width:52em;"| Регистрационный номер учётной карточки животного (группы животных)
|-
|013
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}registrationStatus>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}registrationStatus>'''}}
|vd:AnimalRegistrationStatus
|[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;">
* Возможные значения:
** ACTIVE - действующий</div>
</div>
|-
|014
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}initialIdentificationType>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}initialIdentificationType>'''}}
|vd:AnimalIdentificationEventType
|[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;">
* Возможные значения:
** BIRTH - рождение
** IMPORT - импорт
** OTHER - иная причина первичной идентификации</div>
</div>
|-
|015
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|vd:}}animalRegistration>'''}}
|
|
| style="width:52em;"|
|-
|016
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</hrt:excludeFromAnimalGroupResponse>'''}}
|
|
| style="width:52em;"|
|-
|}


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

Текущая версия на 03:13, 22 мая 2024

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

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

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <hrt:excludeFromAnimalGroupRequest>
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 ···<hrt:specifiedAnimalGroup> dt:AnimalGroup [1..1] Сведения об исключении животных из группы
007 ······<dt:size>?</dt:size> xs:nonNegativeInteger [1..1]

Общее количество животных, исключаемых из группы

  • Указывается общее количество зарегистрированных (если указывается список excludedAnimalRegistrationList) и незарегистрированных животных
  • Если указывается список excludedAnimalRegistrationList, то общее количество животных должно быть больше или равно количеству элементов в excludedAnimalRegistrationList
008 ···</hrt:specifiedAnimalGroup>
009 ···<hrt:excludedAnimalRegistrationList> vd:AnimalRegistrationList [0..1] Сведения об индивидуальных животных, исключаемых из группы
010 ······<vd:animalRegistration> vd:AnimalRegistration [1..*] Сведения регистрации (учётная карточка) животного
011 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
012 ······</vd:animalRegistration>
013 ···</hrt:excludedAnimalRegistrationList>
014 ···<hrt:animalRegistrationRef> vd:AnimalRegistration [1..1] Сведения регистрации (учётная карточка) группы, из которой выполняется исключение животных
015 ······<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии учётной карточки группы животных
016 ···</hrt:animalRegistrationRef>
017 </hrt:excludeFromAnimalGroupRequest>

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <hrt:excludeFromAnimalGroupResponse>
002 ···<vd:animalRegistration> vd:AnimalRegistration [1..1] Сведения регистрации (учётная карточка) животного или группы животных
003 ······<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии записи
004 ······<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
005 ······<bs:active>?</bs:active> xs:boolean [1..1] Флаг: является ли запись активной
006 ······<bs:last>?</bs:last> xs:boolean [1..1] Флаг: является ли версия последней
007 ······<bs:status>?</bs:status> bs:VersionStatus [1..1] Статус версии записи
008 ······<bs:createDate>?</bs:createDate> xs:dateTime [1..1] Дата создания записи
009 ······<bs:updateDate>?</bs:updateDate> xs:dateTime [1..1] Дата последнего изменения записи
010 ······<bs:previous>?</bs:previous> bs:UUID [1..1] Идентификатор предыдущей версии записи
011 ······<vd:identityType>?</vd:identityType> vd:AnimalIdentityType [1..1]

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

  • Возможные значения:
    • GROUP - групповая идентификация
012 ······<vd:registrationNumber>?</vd:registrationNumber> dt:AnimalID [1..1] Регистрационный номер учётной карточки животного (группы животных)
013 ······<vd:registrationStatus>?</vd:registrationStatus> vd:AnimalRegistrationStatus [1..1]

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

  • Возможные значения:
    • ACTIVE - действующий
014 ······<vd:initialIdentificationType>?</vd:initialIdentificationType> vd:AnimalIdentificationEventType [1..1]

Причина первичной идентификации: рождение, импорт, другое

  • Возможные значения:
    • BIRTH - рождение
    • IMPORT - импорт
    • OTHER - иная причина первичной идентификации
015 ···</vd:animalRegistration>
016 </hrt:excludeFromAnimalGroupResponse>

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

TODO

См. также

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

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