Herriot:RegisterAnimalMovementEvent:v1.0

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

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

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

Ограничения

Текущая версия операции предназначена для перемещения индивидуальных животных или полного перемещения группы животных.

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <hrt:registerAnimalMovementEventRequest>
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:referencedMovementEvent> vd:AnimalMovementEvent [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 ······</dt:actualDate>
014 ······<vd:consignor> dt:SupervisedObject [1..1]

Отправитель (поднадзорный объект)

  • Отправитель должен совпадать с местом содержания животных в зарегистрированных учетных карточках в списке movementAnimalRegistrationList
015 ·········<bs:guid>?</bs:guid> bs:UUID [1..1]

Глобальный идентификатор записи

016 ······</vd:consignor>
017 ······<vd:consignee> dt:SupervisedObject [1..1] Получатель (поднадзорный объект)
018 ·········<bs:guid>?</bs:guid> bs:UUID [1..1]

Глобальный идентификатор записи

019 ······</vd:consignee>
020 ······<vd:purpose> dt:AnimalKeepingPurpose [1..1] Цель (причина) перемещения животных
021 ·········<bs:guid>?</bs:guid> bs:UUID [1..1]

Глобальный идентификатор записи

022 ······</vd:purpose>
023 ···</hrt:referencedMovementEvent>
024 ···<hrt:movementAnimalRegistrationList> vd:AnimalRegistrationList [1..1] Cведения о перемещаемых зарегистрированных животных или групп животных
025 ······<vd:animalRegistration> vd:AnimalRegistration [1..*] Зарегистрированная учетная карточка животного или группы животных
026 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
027 ······</vd:animalRegistration>
028 ···</hrt:movementAnimalRegistrationList>
029 </hrt:registerAnimalMovementEventRequest>

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <hrt:registerAnimalMovementEventResponse>
002 ···<hrt:movementAnimalRegistrationList> vd:AnimalRegistrationList [1..1]

Список учётных карточек перемещаемых животных

  • Список учётных карточек, участвовавших в запросе
003 ······<vd:animalRegistration> vd:AnimalRegistration [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 [1..1] Идентификатор предыдущей версии записи
012 ·········<vd:identityType>?</vd:identityType> vd:AnimalIdentityType [1..1]

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

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

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

  • Возможные значения:
    • ACTIVE - Действующий.
015 ·········<vd:initialIdentificationType>?</vd:initialIdentificationType> vd:AnimalIdentificationEventType [1..1]

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

  • Возможные значения:
    • BIRTH - рождение
    • IMPORT - импорт
    • OTHER - иная причина первичной идентификации
016 ······</vd:animalRegistration>
017 ···</hrt:movementAnimalRegistrationList>
018 ···<hrt:referencedAnimalRegistrationList> vd:AnimalRegistrationList [0..1]

Список связанных учётных карточек животных

  • Список связанных карточек животных, которые в явном виде не участвовали в запросе, но были изменены в результате выполнения операции (например, перемещение индивидуального животного, входящего в группу, влечёт изменение данной группы)
019 ······<vd:animalRegistration> vd:AnimalRegistration [1..*] Сведения регистрации (учётная карточка) животного или группы животных
020 ·········<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии записи
021 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
022 ······</vd:animalRegistration>
023 ···</hrt:referencedAnimalRegistrationList>
024 </hrt:registerAnimalMovementEventResponse>

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

TODO

См. также

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