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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
 
(не показаны 3 промежуточные версии этого же участника)
Строка 62: Строка 62:
|vd:AnimalMarkingEvent
|vd:AnimalMarkingEvent
|[1..1]
|[1..1]
| style="width:52em;"| Сведения о замене средства маркирования
| style="width:52em;"| Сведения о снятии средства маркирования
|-
|-
|007
|007
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}type>'''}}{{color|#131313|AIR}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}type>'''}}
|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;">
* Возможное значение: AIR</div>
</div>
|-
|008
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}actualDate>'''}}
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}actualDate>'''}}
|bs:ComplexDatePeriod
|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>'''}}
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}date>'''}}
|bs:ComplexDate
|bs:ComplexDate
Строка 76: Строка 86:
| style="width:52em;"| Точное значение даты
| style="width:52em;"| Точное значение даты
|-
|-
|009
|010
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}year>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}year>'''}}
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}year>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}year>'''}}
|bs:Year
|bs:Year
Строка 82: Строка 92:
| style="width:52em;"| Год
| style="width:52em;"| Год
|-
|-
|010
|011
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}month>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}month>'''}}
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}month>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}month>'''}}
|bs:Month
|bs:Month
Строка 88: Строка 98:
| style="width:52em;"| Месяц
| style="width:52em;"| Месяц
|-
|-
|011
|012
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}day>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}day>'''}}
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}day>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}day>'''}}
|bs:Day
|bs:Day
Строка 94: Строка 104:
| style="width:52em;"| День
| style="width:52em;"| День
|-
|-
|012
|013
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|bs:}}date>'''}}
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|bs:}}date>'''}}
|
|
Строка 100: Строка 110:
| style="width:52em;"|  
| style="width:52em;"|  
|-
|-
|013
|014
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|vd:}}actualDate>'''}}
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|vd:}}actualDate>'''}}
|
|
Строка 106: Строка 116:
| style="width:52em;"|  
| style="width:52em;"|  
|-
|-
|014
|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:AnimalMarkingEventReason
|vd:AnimalMarkingEventReason
|[0..1]
|[0..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
|<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>
<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;">
* Не указывается, если средство маркирования находится в статусе "Требует замены" (identityStatus == REPLACEMENT_REQUIRED)
* Не указывается, если средство маркирования находится в статусе "Требует замены" (identityStatus == REPLACEMENT_REQUIRED)
Строка 118: Строка 128:
** BROKEN - Средство маркирования повреждено (сломано)
** BROKEN - Средство маркирования повреждено (сломано)
** EXPIRATION - Истёк срок действия средства маркирования
** EXPIRATION - Истёк срок действия средства маркирования
** REMOVED - Средство маркирования удалено по решению владельца</div>
** REMOVED - Средство маркирования снято по решению владельца</div>
</div>
</div>
|-
|-
|015
|016
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:referencedMarkingEvent>'''}}
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:referencedMarkingEvent>'''}}
|
|
Строка 127: Строка 137:
| style="width:52em;"|  
| style="width:52em;"|  
|-
|-
|016
|017
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:animalIdentityRef>'''}}
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:animalRegistrationRef>'''}}
|vd:AnimalRegistration
|[1..1]
| style="width:52em;"| Сведения об учетной карточке животного / группы животных
|-
|018
|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;"| Идентификатор версии записи
|-
|019
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}specifiedAnimalIdentity>'''}}
|vd:AnimalIdentity
|vd:AnimalIdentity
|[1..1]
|[1..1]
| style="width:52em;"| Сведения об удаляемом средстве маркирования
| style="width:52em;"| Сведения о снятом средстве маркирования
|-
|-
|017
|020
|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]
Строка 140: Строка 162:
<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;">
* Операция может быть выполнена только для средств маркирования с типом "Дополнительное" (type == ADDITIONAL)
* Операция может быть выполнена только для средств маркирования с типом "Дополнительное" (type == ADDITIONAL)</div>
* Удаление / снятие основных средств маркирования (type == MAIN) запрещено</div>
</div>
</div>
|-
|-
|018
|021
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:animalIdentityRef>'''}}
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|vd:}}specifiedAnimalIdentity>'''}}
|
|
| style="width:52em;"|
|-
|022
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:animalRegistrationRef>'''}}
|
|
|
|
| style="width:52em;"|  
| style="width:52em;"|  
|-
|-
|019
|023
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</hrt:removeAnimalIdentityRequest>'''}}
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</hrt:removeAnimalIdentityRequest>'''}}
|
|

Текущая версия на 02:11, 29 мая 2024

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

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

Ограничения

  1. Снятие возможно только дополнительных средств маркирования: ../specifiedAnimalIdentity/attachedLabel/type == ADDITIONAL в зарегистрированной карточке животного или группы животных.
  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:type>AIR</vd:type> vd:VeterinaryEventType [1..1]

Тип события: выбытие (снятие) средства маркирования

  • Возможное значение: AIR
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 ······</vd:actualDate>
015 ······<vd:occurrenceReason>?</vd:occurrenceReason> vd:AnimalMarkingEventReason [0..1]

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

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

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

  • Операция может быть выполнена только для средств маркирования с типом "Дополнительное" (type == ADDITIONAL)
021 ······</vd:specifiedAnimalIdentity>
022 ···</hrt:animalRegistrationRef>
023 </hrt:removeAnimalIdentityRequest>

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <hrt:removeAnimalIdentityResponse>
002 ···<hrt:animalRegistrationList> vd:AnimalRegistrationList [1..1] Список учетных карточек животного или группы животных
003 ······<vd:animalRegistration> vd:AnimalRegistration [1..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 [0..1] Идентификатор предыдущей версии записи
012 ·········<bs:next>?</bs:next> bs:UUID [0..1] Идентификатор следующей версии записи
013 ·········<vd:identityType>?</vd:identityType> vd:AnimalIdentityType [1..1]

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

  • Возможные значения:
    • INDIVIDUAL - индивидуальная идентификация
    • GROUP - групповая идентификация
014 ·········<vd:registrationNumber>?</vd:registrationNumber> dt:AnimalID [0..1]

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

  • При статусе PREPARING регистрационный номер отсутствует (не присваивается системой до окончания регистрации)
015 ·········<vd:registrationStatus>?</vd:registrationStatus> vd:AnimalRegistrationStatus [1..1]

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

  • Возможные значения:
    • PREPARING - В обработке (сведения приняты на регистрацию)
    • ACTIVE - Активна (зарегистированная учетная карточка)
    • TERMINATED - Регистрация завершена
    • WITHDRAWN - Аннулирована
016 ·········<vd:initialIdentificationType>?</vd:initialIdentificationType> vd:AnimalIdentificationEventType [1..1]

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

  • Возможные значения:
    • BIRTH - рождение
    • IMPORT - импорт
    • OTHER - иная причина первичной идентификации
017 ·········<vd:specifiedAnimalIdentity> vd:AnimalIdentity [0..*] Сведения об идентификации животного
018 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор средства маркирования
019 ············<vd:identityStatus>?</vd:identityStatus> vd:AnimalIdentityStatus [1..1]

Статус средства маркирования

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

  • ACTIVE - действующее средство маркирования (нанесено)
  • TERMINATED - недействующее средство маркирования (выбыло)
  • REPLACEMENT_REQUIRED - средство маркирования требует замены
020 ············<vd:attachedLabel> dt:AnimalLabel [1..1] Сведения о маркировке животного
021 ···············<dt:animalID format="?">?</dt:animalID> dt:AnimalID [0..1] Номер, нанесенный на животное с помощью средства маркирования
022 ···············<dt:type>?</dt:type> dt:AnimalLabelType [1..1]

Вид маркировки: основная/дополнительная

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

  • MAIN - основное средство маркирования
  • ADDITIONAL - дополнительное средство маркирования
023 ···············<dt:markingMeans> dt:AnimalMarkingMeans [1..1] Cредство маркирования
024 ··················<dt:type>?</dt:type> dt:AnimalMarkingMeansType [1..1]

Тип средства маркирования

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

  • LABEL - Бирка
  • MICROCHIP - Вживляемый микрочип
  • BRAND - Тавро/Клеймо
  • TATTOO - Татуировка
  • BOLUS - Болюс
  • RING - Кольцо
  • ELECTRONIC_RING - Электронное кольцо
  • COLLAR - Ошейник
  • ELECTRONIC_COLAR - Электронный ошейник
  • WING_TAG - Крыло-метка
  • ELECTRONIC_WING_TAG - Электронное крыло-метка
  • ELECTRONIC_TAG - Электронная метка
  • TISSUE_SECTION - Вырез тканей
  • NAMEPLATE - Табло
025 ···············</dt:markingMeans>
026 ···············<dt:attachmentLocation> dt:AnimalMarkingLocation [1..1] Место нанесения/прикрепления
027 ··················<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
028 ··················<dt:name>?</dt:name> bs:String255 [1..1] Наименование места нанесения
029 ···············</dt:attachmentLocation>
030 ···············<dt:description>?</dt:description> bs:String255 [0..1] Описание средства маркирования
031 ············</vd:attachedLabel>
032 ············<vd:associatedMarkingEvent> vd:AnimalMarkingEvent [0..*] Сведения о нанесении / выбытии средства маркирования
033 ···············<vd:type>?</vd:type> vd:VeterinaryEventType [1..1]

Тип мероприятия

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

  • AME - нанесение средства маркирования
  • AIR - выбытие средства маркирования
034 ···············<vd:actualDate> bs:ComplexDatePeriod [1..1] Дата мероприятия
035 ··················<bs:date> bs:ComplexDate [1..1] Точное значение даты
036 ·····················<bs:year>?</bs:year> bs:Year [1..1] Год
037 ·····················<bs:month>?</bs:month> bs:Month [1..1] Месяц
038 ·····················<bs:day>?</bs:day> bs:Day [0..1] День
039 ··················</bs:date>
040 ···············</dt:actualDate>
041 ···············<vd:operatorBusinessEntity> dt:BusinessEntity [0..1] Сведения о физическом лице / организации, осуществлявшем мероприятие
042 ··················<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор записи
043 ··················<dt:fullName>?</dt:fullName> bs:String255 [0..1] Наименование лица
044 ··················<dt:fio>?</dt:fio> bs:String255 [0..1] ФИО лица
045 ··················<dt:inn>?</dt:inn> bs:String255 [0..1] ИНН
046 ···············</vd:operatorBusinessEntity>
047 ···············<vd:occurrenceReason>?</vd:occurrenceReason> vd:AnimalMarkingEventReason [0..1]

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

  • Обязательно, если тип мероприятия - выбытие (type == AIR)
  • Возможные значения:
    • TERMINATED - Прекращение экплуатации средства маркирования по причине выбытия животного
    • LOSS - Средство маркирования утеряно
    • BROKEN - Средство маркирования повреждено (сломано)
    • EXPIRATION - Истёк срок действия средства маркирования
    • REMOVED - Средство маркирования удалено владельцем животного
048 ············</vd:associatedMarkingEvent>
049 ·········</vd:specifiedAnimalIdentity>
050 ······</vd:animalRegistration>
051 ···</hrt:animalRegistrationList>
052 </hrt:removeAnimalIdentityResponse>

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

TODO

См. также

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