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

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


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

Версия 04:37, 26 марта 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: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> vd:AnimalRegistration [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]

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

Возможные значения:

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

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

Возможные значения:

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

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

Возможные значения:

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

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

TODO

См. также

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