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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 261: Строка 261:
|-
|-
|002
|002
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:animalRegistration>'''}}
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:terminatedAnimalRegistrationList>'''}}
|vd:AnimalRegistrationList
|[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>
|-
|003
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<hrt:animalRegistration>'''}}
|vd:AnimalRegistration
|vd:AnimalRegistration
|[1..*]
|[1..*]
| style="width:52em;"| Сведения регистрации (учётная карточка) животного или группы животных
| style="width:52em;"| Сведения регистрации (учётная карточка) животного или группы животных
|-
|-
|003
|004
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}uuid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}uuid>'''}}
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}uuid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}uuid>'''}}
|bs:UUID
|bs:UUID
|[1..1]
|[1..1]
| style="width:52em;"| Идентификатор версии записи
| style="width:52em;"| Идентификатор версии записи
|-
|-
|004
|005
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|bs:UUID
|bs:UUID
|[1..1]
|[1..1]
| style="width:52em;"| Глобальный идентификатор записи
| style="width:52em;"| Глобальный идентификатор записи
|-
|-
|005
|006
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}active>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}active>'''}}
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}active>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}active>'''}}
|xs:boolean
|xs:boolean
|[1..1]
|[1..1]
| style="width:52em;"| Флаг: является ли запись активной
| style="width:52em;"| Флаг: является ли запись активной
|-
|-
|006
|007
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}last>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}last>'''}}
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}last>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}last>'''}}
|xs:boolean
|xs:boolean
|[1..1]
|[1..1]
| style="width:52em;"| Флаг: является ли версия последней
| style="width:52em;"| Флаг: является ли версия последней
|-
|-
|007
|008
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}status>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}status>'''}}
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}status>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}status>'''}}
|bs:VersionStatus
|bs:VersionStatus
|[1..1]
|[1..1]
| style="width:52em;"| Статус версии записи  
| style="width:52em;"| Статус версии записи  
|-
|-
|008
|009
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}createDate>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}createDate>'''}}
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}createDate>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}createDate>'''}}
|xs:dateTime
|xs:dateTime
|[1..1]
|[1..1]
| style="width:52em;"| Дата создания записи
| style="width:52em;"| Дата создания записи
|-
|-
|009
|010
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}updateDate>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}updateDate>'''}}
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}updateDate>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}updateDate>'''}}
|xs:dateTime
|xs:dateTime
|[1..1]
|[1..1]
| style="width:52em;"| Дата последнего изменения записи
| style="width:52em;"| Дата последнего изменения записи
|-
|-
|010
|011
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}previous>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}previous>'''}}
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}previous>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}previous>'''}}
|bs:UUID
|bs:UUID
|[1..1]
|[1..1]
| style="width:52em;"| Идентификатор предыдущей версии записи
| style="width:52em;"| Идентификатор предыдущей версии записи
|-
|-
|011
|012
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}identityType>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}identityType>'''}}
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|vd:}}identityType>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}identityType>'''}}
|vd:AnimalIdentityType
|vd:AnimalIdentityType
|[1..1]
|[1..1]
Строка 321: Строка 331:
<span style="white-space:nowrap; font-weight: normal;">Тип идентификации/учёта: индивидуальная/групповая</span>
<span style="white-space:nowrap; font-weight: normal;">Тип идентификации/учёта: индивидуальная/групповая</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
<div class="mw-collapsible-content" style="font-weight: normal;">
Возможные значения:
* возможные значения:
* INDIVIDUAL - индивидуальная идентификация
** INDIVIDUAL - индивидуальная идентификация
* GROUP - групповая идентификация</div>
** GROUP - групповая идентификация</div>
</div>
</div>
|-
|-
|012
|013
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}registrationNumber>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}registrationNumber>'''}}
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|vd:}}registrationNumber>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}registrationNumber>'''}}
|dt:AnimalID
|dt:AnimalID
|[1..1]
|[1..1]
| style="width:52em;"| Регистрационный номер учётной карточки животного (группы животных)
| style="width:52em;"| Регистрационный номер учётной карточки животного (группы животных)
|-
|-
|013
|014
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}registrationStatus>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}registrationStatus>'''}}
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|vd:}}registrationStatus>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}registrationStatus>'''}}
|vd:AnimalRegistrationStatus
|vd:AnimalRegistrationStatus
|[1..1]
|[1..1]
Строка 339: Строка 349:
<span style="white-space:nowrap; font-weight: normal;">Статус учётной карточки животного (группы животных)</span>
<span style="white-space:nowrap; font-weight: normal;">Статус учётной карточки животного (группы животных)</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
<div class="mw-collapsible-content" style="font-weight: normal;">
Возможные значения:
* возможные значения:
* TERMINATED - Недействующий, регистрация завершена.</div>
** TERMINATED - Недействующий, регистрация завершена.</div>
</div>
</div>
|-
|-
|014
|015
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}initialIdentificationType>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}initialIdentificationType>'''}}
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|vd:}}initialIdentificationType>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}initialIdentificationType>'''}}
|vd:AnimalIdentificationEventType
|vd:AnimalIdentificationEventType
|[1..1]
|[1..1]
Строка 350: Строка 360:
<span style="white-space:nowrap; font-weight: normal;">Причина первичной идентификации: рождение, импорт, другое</span>
<span style="white-space:nowrap; font-weight: normal;">Причина первичной идентификации: рождение, импорт, другое</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
<div class="mw-collapsible-content" style="font-weight: normal;">
Возможные значения:
* возможные значения:
* BIRTH - рождение
** BIRTH - рождение
* IMPORT - импорт  
** IMPORT - импорт  
* OTHER - иная причина первичной идентификации</div>
** OTHER - иная причина первичной идентификации</div>
</div>
</div>
|-
|-
|015
|016
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:animalRegistration>'''}}
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</hrt:animalRegistration>'''}}
|
|
| style="width:52em;"|
|-
|017
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:terminatedAnimalRegistrationList>'''}}
|
|
| style="width:52em;"|
|-
|018
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:referencedAnimalRegistrationList>'''}}
|vd:AnimalRegistrationList
|[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>
|-
|019
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<hrt:animalRegistration>'''}}
|vd:AnimalRegistration
|[1..*]
| style="width:52em;"| Сведения регистрации (учётная карточка) животного или группы животных
|-
|020
|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;"| Идентификатор версии записи
|-
|021
|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;"| Глобальный идентификатор записи
|-
|022
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</hrt:animalRegistration>'''}}
|
|
| style="width:52em;"|
|-
|023
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:referencedAnimalRegistrationList>'''}}
|
|
|
|
| style="width:52em;"|  
| style="width:52em;"|  
|-
|-
|016
|024
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</hrt:terminateAnimalRegistrationResponse>'''}}
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</hrt:terminateAnimalRegistrationResponse>'''}}
|
|

Версия 02:53, 3 апреля 2024

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

Код Описание операции
AMS.HRT.1.4 Операция предназначена для прекращения регистрации животного / группы животных по причине выбытия.

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <hrt:terminateAnimalRegistrationRequest>
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:referencedLifecycleEvent> vd:AnimalLifecycleEvent [1..1] Cведения о выбытии животного / группы животных
007 ······<vd:type>?</vd:type> vd:VeterinaryEventType [1..1]

Тип выбытия животного / группы животных

  • Возможные значения:
    • APS - Плановый убой
    • ADS - Диагностический убой
    • AFS - Вынужденный убой
    • DTH - Падёж
    • LSS - Пропажа (сбежало, украдено и т.п.)
    • RLS - Выпуск в среду обитания
    • EXP - Экспорт
008 ······<vd:actualDate> bs:ComplexDatePeriod [1..1] Дата выбытия
009 ·········<bs:date> bs:ComplexDate [1..1] Точное значение даты
010 ············<bs:year>?</bs:year> bs:Year [1..1] Год
011 ············<bs:month>?</bs:month> bs:Month [1..1] Месяц
012 ············<bs:day>?</bs:day> bs:Day [1..1] День
013 ·········</bs:date>
014 ······</dt:actualDate>
015 ······<vd:occurrenceReason> vd:AnimalLifecycleEventReason [0..1]

Причина выбытия

  • Обязательно указывать причину для следующих типов выбытия:
    • вынужденного убоя (type == AFS)
    • падежа (type == DTH)
016 ·········<bs:guid>?</bs:guid> bs:UUID [1..1]

Идентификатор причины выбытия

  • Классификатор причин ветеринарных событий CL.HRT.3. VeterinaryEventReason
  • Возможные значения для type == AFS:
    • d1b1c0df-560b-4096-950d-afecafc518a7 - убой животного, у которого выявлена заразная болезнь
    • 9a7f5f4c-9e86-4878-ae2b-fd3f2de8e6ba - убой животного, у которого выявлена незаразная болезнь
    • 5ac2b5be-3c19-49d6-9f14-1b4cf72e7a0a - убой здорового животного в рамках ликвидации болезни
    • 0a5a1c1c-8c8e-43d3-a3d0-7fbf7d4c5f1b - убой животного в научно-исследовательских целях
    • 6e5de2d1-a0f2-4b70-b2fd-41a38dfb75dc - убой животного за ненадобностью в будущем (лабораторные животные, непродуктивные и т.п.)
  • Возможные значения для type == DTH:
    • 4e8f5d90-0b16-4b6f-bf3c-2c0f6b8a2d9e - падёж животного, у которого не выявлено заразных или незаразных болезней
    • 5c84d5f1-7c07-4d6b-bf9f-0e4e9e8f2b67 - падёж животного, у которого выявлена заразная болезнь
    • 9e7d5a38-6b3c-4a6d-b55e-efb3d6d4d09c - падёж животного, у которого выявлена незаразная болезнь
017 ······</vd:occurrenceReason>
018 ······<vd:associatedAnimalGroup> vd:ObservableAnimalGroup [0..1]

Сведения о частичном выбытии группы животных

  • Не указывается в случае полного выбытия группы животных
  • Не указывается в случае выбытия индивидуального животного
019 ·········<vd:specifiedAnimalGroup> dt:AnimalGroup [1..1] Сведения о численности выбывших животных группы
020 ············<dt:size>?</dt:size> xs:nonNegativeInteger [1..1]

Количество выбывших животных

  • Если указаны сведения о выбывших животных индивидуальной регистрации (../associatedAnimalGroup/animalRegistrationRef), то количество выбывших животных должно быть больше или равно количеству указанных учётных карточек индивидуальных животных
021 ·········</vd:specifiedAnimalGroup>
022 ·········<vd:animalRegistrationRef> vd:AnimalRegistration [0..*] Сведения о выбывших животных индивидуальной регистрации
023 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор учётной карточки животного
024 ·········</vd:animalRegistrationRef>
025 ······</vd:associatedAnimalGroup>
026 ···</hrt:referencedLifecycleEvent>
027 ···<hrt:animalRegistrationRef> vd:AnimalRegistration [1..1] Сведения регистрации (учётная карточка) животного или группы животных
028 ······<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии учётной карточки животного
029 ···</hrt:animalRegistrationRef>
030 </hrt:terminateAnimalRegistrationRequest>

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <hrt:terminateAnimalRegistrationResponse>
002 ···<hrt:terminatedAnimalRegistrationList> vd:AnimalRegistrationList [1..1]

Список учётных карточек выбывших животных

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

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

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

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

  • возможные значения:
    • TERMINATED - Недействующий, регистрация завершена.
015 ·········<vd:initialIdentificationType>?</vd:initialIdentificationType> vd:AnimalIdentificationEventType [1..1]

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

  • возможные значения:
    • BIRTH - рождение
    • IMPORT - импорт
    • OTHER - иная причина первичной идентификации
016 ······</hrt:animalRegistration>
017 ···</hrt:terminatedAnimalRegistrationList>
018 ···<hrt:referencedAnimalRegistrationList> vd:AnimalRegistrationList [0..1]

Список связанных учётных карточек животных

  • список учётных карточек, которые были изменены в результате выполнения запроса (например, обновленные учётные карточки групп животных, в которых содержались выбывшие индивидуальные животные из запроса)
019 ······<hrt:animalRegistration> vd:AnimalRegistration [1..*] Сведения регистрации (учётная карточка) животного или группы животных
020 ·········<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии записи
021 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
022 ······</hrt:animalRegistration>
023 ···</hrt:referencedAnimalRegistrationList>
024 </hrt:terminateAnimalRegistrationResponse>

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

TODO

См. также

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

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