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

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


== Спецификация запроса ==
== Спецификация запроса ==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<hrt:removeAnimalIdentityRequest>'''}}
|
|
| 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:referencedMarkingEvent>'''}}
|vd:AnimalMarkingEvent
|[1..1]
| style="width:52em;"| Сведения о замене средства маркирования
|-
|007
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}actualDate>'''}}
|bs:ComplexDatePeriod
|[1..1]
| style="width:52em;"| Дата замены средства маркирования
|-
|008
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}date>'''}}
|bs:ComplexDate
|[1..1]
| style="width:52em;"| Точное значение даты
|-
|009
|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;"| Год
|-
|010
|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;"| Месяц
|-
|011
|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;"| День
|-
|012
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|bs:}}date>'''}}
|
|
| style="width:52em;"|
|-
|013
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|vd:}}actualDate>'''}}
|
|
| style="width:52em;"|
|-
|014
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}occurrenceReason>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}occurrenceReason>'''}}
|vd:AnimalMarkingEventReason
|[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;">
* Не указывается, если средство маркирования находится в статусе "Требует замены" (identityStatus == REPLACEMENT_REQUIRED)
* Возможные значения:
** LOSS - Средство маркирования утеряно
** BROKEN - Средство маркирования повреждено (сломано)
** EXPIRATION - Истёк срок действия средства маркирования
** REMOVED - Средство маркирования удалено по решению владельца</div>
</div>
|-
|015
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:referencedMarkingEvent>'''}}
|
|
| style="width:52em;"|
|-
|016
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:animalIdentityRef>'''}}
|vd:AnimalIdentity
|[1..1]
| style="width:52em;"| Сведения об удаляемом средстве маркирования
|-
|017
|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;">
* Операция может быть выполнена только для средств маркирования с типом "Дополнительное" (type == ADDITIONAL)
* Удаление / снятие основных средств маркирования (type == MAIN) запрещено</div>
</div>
|-
|018
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:animalIdentityRef>'''}}
|
|
| style="width:52em;"|
|-
|019
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</hrt:removeAnimalIdentityRequest>'''}}
|
|
| style="width:52em;"|
|-
|}


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

Версия 10:38, 20 мая 2024

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

Код Описание операции
AMS.HRT.2.2 Операция предназначена для прекращения регистрации сведений об идентификации зарегистрированного животного или группы животных (снятие средства маркирования)

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <hrt:removeAnimalIdentityRequest>
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:referencedMarkingEvent> vd:AnimalMarkingEvent [1..1] Сведения о замене средства маркирования
007 ······<vd:actualDate> bs:ComplexDatePeriod [1..1] Дата замены средства маркирования
008 ·········<bs:date> bs:ComplexDate [1..1] Точное значение даты
009 ············<bs:year>?</bs:year> bs:Year [1..1] Год
010 ············<bs:month>?</bs:month> bs:Month [1..1] Месяц
011 ············<bs:day>?</bs:day> bs:Day [1..1] День
012 ·········</bs:date>
013 ······</vd:actualDate>
014 ······<vd:occurrenceReason>?</vd:occurrenceReason> vd:AnimalMarkingEventReason [0..1]

Причина выбытия средства маркирования

  • Не указывается, если средство маркирования находится в статусе "Требует замены" (identityStatus == REPLACEMENT_REQUIRED)
  • Возможные значения:
    • LOSS - Средство маркирования утеряно
    • BROKEN - Средство маркирования повреждено (сломано)
    • EXPIRATION - Истёк срок действия средства маркирования
    • REMOVED - Средство маркирования удалено по решению владельца
015 ···</hrt:referencedMarkingEvent>
016 ···<hrt:animalIdentityRef> vd:AnimalIdentity [1..1] Сведения об удаляемом средстве маркирования
017 ······<bs:guid>?</bs:guid> bs:UUID [1..1]

Глобальный идентификатор средства маркирования

  • Операция может быть выполнена только для средств маркирования с типом "Дополнительное" (type == ADDITIONAL)
  • Удаление / снятие основных средств маркирования (type == MAIN) запрещено
018 ···</hrt:animalIdentityRef>
019 </hrt:removeAnimalIdentityRequest>

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

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

TODO

См. также

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