Herriot:IncludeToAnimalGroup:v1.0

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

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

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

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <hrt:includeToAnimalGroupRequest>
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:specifiedAnimalGroup> dt:AnimalGroup [1..1] Сведения о пополнении группы
007 ······<dt:size>?</dt:size> xs:nonNegativeInteger [1..1]

Общее количество животных, участвующих в пополнении группы

  • Указывается общее количество зарегистрированных (если указывается список includedAnimalRegistrationList) и незарегистрированных животных
  • Если указывается список includedAnimalRegistrationList, то общее количество животных должно быть больше или равно количеству элементов в includedAnimalRegistrationList
008 ···</hrt:specifiedAnimalGroup>
009 ···<hrt:includedAnimalRegistrationList> vd:AnimalRegistrationList [0..1] Сведения об индивидуальных животных, включаемых в группу
010 ······<vd:animalRegistration> vd:AnimalRegistration [1..*] Сведения регистрации (учётная карточка) животного
011 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
012 ······</vd:animalRegistration>
013 ···</hrt:includedAnimalRegistrationList>
014 ···<hrt:animalRegistrationRef> vd:AnimalRegistration [1..1] Сведения регистрации (учётная карточка) пополняемой группы животных
015 ······<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии учётной карточки группы животных
016 ···</hrt:animalRegistrationRef>
017 </hrt:includeToAnimalGroupRequest>

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

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

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

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

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

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

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

  • Возможные значения:
    • BIRTH - рождение
    • IMPORT - импорт
    • OTHER - иная причина первичной идентификации
015 ···</vd:animalRegistration>
016 </hrt:includeToAnimalGroupResponse>

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

TODO

См. также

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