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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
(Новая страница: «== Общие сведения == == Спецификация запроса == {| class="wikitable" ! # ! Название XML-элемента ! Тип ! Об...»)
 
Строка 49: Строка 49:
|vd:AnimalLifecycleEvent
|vd:AnimalLifecycleEvent
|[1..1]
|[1..1]
| style="width:52em;"| Cведения о выбытии животного
| style="width:52em;"| Cведения о выбытии животного / группы животных
|-
|-
|007
|007
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}actualDateTime>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}actualDateTime>'''}}
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}type>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}type>'''}}
|xs:dateTime
|vd:VeterinaryEventType
|[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;">
* APS - Плановый убой
* ADS - Диагностический убой
* AFS - Вынужденный убой
* DTH - Падёж
* LSS - Пропажа (сбежало, украдено и т.п.)
* RLS - Выпуск в среду обитания
* EXP - Экспорт</div>
</div>
|-
|008
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}actualDate>'''}}
|bs:ComplexDatePeriod
|[1..1]
|[1..1]
| style="width:52em;"| Дата выбытия
| style="width:52em;"| Дата выбытия
|-
|-
|008
|009
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}date>'''}}
|bs:ComplexDate
|[1..1]
| style="width:52em;"| Точное значение даты
|-
|010
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}year>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}year>'''}}
|bs:Year
|[1..1]
| style="width:52em;"| Год
|-
|011
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}month>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}month>'''}}
|bs:Month
|[1..1]
| style="width:52em;"| Месяц
|-
|012
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}day>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}day>'''}}
|bs:Day
|[1..1]
| style="width:52em;"| День
|-
|013
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|bs:}}date>'''}}
|
|
| style="width:52em;"|
|-
|014
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|dt:}}actualDate>'''}}
|
|
| style="width:52em;"|
|-
|015
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}occurrenceReason>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}occurrenceReason>'''}}
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}occurrenceReason>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}occurrenceReason>'''}}
|vd:AnimalLifecycleEventReason
|vd:AnimalLifecycleEventReason
|[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;">
* '''Обязательно''' указывать причину для следующих типов выбытия:
** вынужденного убоя (type == AFS)
** падежа (type == DTH)
* Описание причин для разных типов выбытия в разделе '''Сценарии операции'''</div>
</div>
|-
|016
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}associatedAnimalGroup>'''}}
|vd:ObservableAnimalGroup
|[0..1]
| style="width:52em;"| Сведения о частичном выбытии группы животных
|-
|017
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|vd:}}specifiedAnimalGroup>'''}}
|dt:AnimalGroup
|[0..1]
| style="width:52em;"| Сведения о численности выбывших животных группы
|-
|018
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}size>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}size>'''}}
|xs:nonNegativeInteger
|[1..1]
|[1..1]
| style="width:52em;"| Причина выбытия
| style="width:52em;"| Количество выбывших животных
|-
|-
|009
|019
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|vd:}}specifiedAnimalGroup>'''}}
|
|
| style="width:52em;"|
|-
|020
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|vd:}}animalRegistrationRef>'''}}
|vd:AnimalRegistration
|[0..*]
| style="width:52em;"| Сведения о выбывших животных индивидуальной регистрации
|-
|021
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|vd:AnimalIdentityType
|[1..1]
| style="width:52em;"| Глобальный идентификатор учётной карточки животного
|-
|022
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|vd:}}animalRegistrationRef>'''}}
|
|
| style="width:52em;"|
|-
|023
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|vd:}}associatedAnimalGroup>'''}}
|
|
| style="width:52em;"|
|-
|024
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:referencedLifecycleEvent>'''}}
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:referencedLifecycleEvent>'''}}
|
|
Строка 69: Строка 176:
| style="width:52em;"|  
| style="width:52em;"|  
|-
|-
|010
|025
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:animalRegistrationRef>'''}}
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:animalRegistrationRef>'''}}
|vd:AnimalRegistration
|vd:AnimalRegistration
|[1..*]
|[1..1]
| style="width:52em;"| Сведения регистрации (учётная карточка) животного или группы животных
| style="width:52em;"| Сведения регистрации (учётная карточка) животного или группы животных
|-
|-
|011
|026
|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>'''}}
|vd:AnimalIdentityType
|vd:AnimalIdentityType
Строка 81: Строка 188:
| style="width:52em;"| Идентификатор записи
| style="width:52em;"| Идентификатор записи
|-
|-
|012
|027
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}specifiedAnimalIdentity>'''}}
|vd:AnimalIdentity
|[1..1]
| style="width:52em;"| Сведения об обновляемом средстве маркирования
|-
|028
|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;"| Глобальный идентификатор средства маркирования
|-
|029
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|vd:}}specifiedAnimalIdentity>'''}}
|
|
| style="width:52em;"|
|-
|030
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:animalRegistrationRef>'''}}
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:animalRegistrationRef>'''}}
|
|
Строка 87: Строка 212:
| style="width:52em;"|  
| style="width:52em;"|  
|-
|-
|013
|031
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</hrt:terminateAnimalRegistrationRequest>'''}}
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</hrt:terminateAnimalRegistrationRequest>'''}}
|
|

Версия 04:35, 26 марта 2024

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

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

# Название 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:occurrenceReason> vd:AnimalLifecycleEventReason [0..1]

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

  • Обязательно указывать причину для следующих типов выбытия:
    • вынужденного убоя (type == AFS)
    • падежа (type == DTH)
  • Описание причин для разных типов выбытия в разделе Сценарии операции
016 ······<vd:associatedAnimalGroup> vd:ObservableAnimalGroup [0..1] Сведения о частичном выбытии группы животных
017 ·········<vd:specifiedAnimalGroup> dt:AnimalGroup [0..1] Сведения о численности выбывших животных группы
018 ············<dt:size>?</dt:size> xs:nonNegativeInteger [1..1] Количество выбывших животных
019 ·········</vd:specifiedAnimalGroup>
020 ·········<vd:animalRegistrationRef> vd:AnimalRegistration [0..*] Сведения о выбывших животных индивидуальной регистрации
021 ············<bs:guid>?</bs:guid> vd:AnimalIdentityType [1..1] Глобальный идентификатор учётной карточки животного
022 ·········</vd:animalRegistrationRef>
023 ······</vd:associatedAnimalGroup>
024 ···</hrt:referencedLifecycleEvent>
025 ···<hrt:animalRegistrationRef> vd:AnimalRegistration [1..1] Сведения регистрации (учётная карточка) животного или группы животных
026 ······<bs:guid>?</bs:guid> vd:AnimalIdentityType [1..1] Идентификатор записи
027 ······<vd:specifiedAnimalIdentity> vd:AnimalIdentity [1..1] Сведения об обновляемом средстве маркирования
028 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор средства маркирования
029 ······</vd:specifiedAnimalIdentity>
030 ···</hrt:animalRegistrationRef>
031 </hrt:terminateAnimalRegistrationRequest>

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <hrt:terminateAnimalRegistrationResponse>
002 ···<hrt:animalRegistration qualifier="?"> vd:AnimalRegistration [1..*] Сведения регистрации (учётная карточка) животного или группы животных
003 ······<bs:guid>?</bs:guid> vd:AnimalIdentityType [1..1] Идентификатор учётной карточки животного (группы животных)
004 ······<vd:registrationStatus>?</vd:registrationStatus> vd:AnimalRegistrationStatus [1..1] Статус учётной карточки животного (группы животных)
005 ···</hrt:animalRegistration>
006 </hrt:terminateAnimalRegistrationResponse>

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

TODO

См. также

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