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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 110: Строка 110:
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:animalRegistration>'''}}
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:animalRegistration>'''}}
|vd:AnimalRegistration
|vd:AnimalRegistration
|[1..1]
|[1..*]
| style="width:52em;"| Сведения регистрации (учётная карточка) животного или группы животных
| style="width:52em;"| Сведения регистрации (учётная карточка) животного или группы животных
|-
|-

Версия 10:27, 21 марта 2024

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

Код Описание операции
AMS.HRT.1.5 Операция предназначена для аннулирования регистрации учётной карточки животного или группы животных.

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <hrt:withdrawAnimalRegistrationRequest>
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:withdrawReason>?</hrt:withdrawReason> vd:WithdrawAnimalRegistrationEventReason [1..1]

Причина аннулировании регистрационной карточки животного

  • Возможные значения:
    • DUPLICATE - Дубликат существующей учётной карточки животного / группы животных
    • INCORRECT_KEEPING_DETAILS - Некорректные сведения о месте содержания животного / группы животных
    • INCORRECT_IDENTITY_TYPE - Некорректные сведения о типе учёта
007 ···<hrt:animalRegistrationRef> vd:AnimalRegistration [1..*] Сведения регистрации (учётная карточка) животного или группы животных
008 ······<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии учётной карточки
009 ···</hrt:animalRegistrationRef>
010 </hrt:withdrawAnimalRegistrationRequest>

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

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

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

TODO

См. также

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