Herriot:ReplaceAnimalIdentity:v1.0

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

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

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

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <hrt:replaceAnimalIdentityRequest>
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:operatorBusinessEntity> dt:BusinessEntity [0..1]

Сведения о физическом лице / организации, осуществлявшем мероприятие

015 ·········<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор записи
016 ·········<dt:inn>?</dt:inn> bs:String255 [0..1] ИНН
017 ······</vd:operatorBusinessEntity>
018 ······<vd:occurrenceReason>?</vd:occurrenceReason> vd:AnimalMarkingEventReason [0..1]

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

  • Не указывается, если средство маркирования находится в статусе "Требует замены" (identityStatus == REPLACEMENT_REQUIRED)
  • Возможные значения:
    • LOSS - Средство маркирования утеряно
    • BROKEN - Средство маркирования повреждено (сломано)
    • EXPIRATION - Истёк срок действия средства маркирования
019 ······<vd:associatedAnimalIdentity> vd:AnimalIdentity [1..1] Сведения о новой маркировке животного / группы животных
020 ·········<vd:attachedLabel> dt:AnimalLabel [1..1] Сведения о маркировке
021 ············<dt:animalID format="?">?</dt:animalID> dt:AnimalID [0..1]

Номер, нанесенный на животное с помощью средства маркирования

  • Возможные значения атрибута format:
    • UNMM - Формат Уникального номера средства маркирования (УНСМ) в соответствии с утвержденными Правилами маркирования животных РСХН
    • OTHER - Другой тип номера (значение по умолчанию, если не передано в запросе)
  • Номер animalID обязателен для следующих типов средства маркирования:
    • LABEL - Бирка
    • MICROCHIP - Вживляемый микрочип
    • BOLUS - Болюс
    • RING - Кольцо
    • ELECTRONIC_RING - Электронное кольцо
    • COLLAR - Ошейник
    • ELECTRONIC_COLAR - Электронный ошейник
    • WING_TAG - Крыло-метка
    • ELECTRONIC_WING_TAG - Электронное крыло-метка
    • ELECTRONIC_TAG - Электронная метка
    • NAMEPLATE - Табло
022 ············<dt:markingMeans> dt:AnimalMarkingMeans [1..1] Cредство маркирования
023 ···············<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 - Табло
024 ············</dt:markingMeans>
025 ············<dt:attachmentLocation> dt:AnimalMarkingLocation [1..1]

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

026 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
027 ············</dt:attachmentLocation>
028 ············<dt:description>?</dt:description> bs:String255 [0..1]

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

  • Может быть опционально указано для следующих типов средства маркирования:
    • BRAND (Тавро/Клеймо)
    • TATTOO (Татуировка)
    • TISSUE_SECTION - Вырез тканей
029 ············<dt:photo> bs:File [0..1]

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

  • Обязательно для следующих типов средства маркирования:
    • BRAND (Тавро/Клеймо)
    • TATTOO (Татуировка)
    • TISSUE_SECTION - Вырез тканей
030 ···············<bs:id>?</bs:id> bs:Identifier [1..1] Идентификатор загруженного файла
031 ············</dt:photo>
032 ·········</vd:attachedLabel>
033 ······</vd:associatedAnimalIdentity>
034 ···</hrt:referencedMarkingEvent>
035 ···<hrt:animalIdentityRef> vd:AnimalIdentity [1..1] Сведения о заменяемом средстве маркирования
036 ······<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор средства маркирования
037 ···</hrt:animalIdentityRef>
038 </hrt:replaceAnimalIdentityRequest>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • MAIN - основное средство маркирования
  • ADDITIONAL - дополнительное средство маркирования
022 ············<dt:markingMeans> dt:AnimalMarkingMeans [1..1] Cредство маркирования
023 ···············<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 - Табло
024 ············</dt:markingMeans>
025 ············<dt:attachmentLocation> dt:AnimalMarkingLocation [1..1] Место нанесения/прикрепления
026 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
027 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование места нанесения
028 ············</dt:attachmentLocation>
029 ············<dt:description>?</dt:description> bs:String255 [0..1] Описание средства маркирования
030 ·········</vd:attachedLabel>
031 ·········<vd:associatedMarkingEvent> vd:AnimalMarkingEvent [0..*] Сведения о нанесении / выбытии средства маркирования
032 ············<vd:type>?</vd:type> vd:VeterinaryEventType [1..1]

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

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

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

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

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

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

TODO

См. также

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

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