Herriot:GetAnimalRegistrationList:v1.0

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

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

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

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <hrt:getAnimalRegistrationListRequest>
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 ···<bs:listOptions> bs:ListOptions [0..1] Параметры запрашиваемого списка
007 ······<bs:count>?</bs:count> xs:nonNegativeInteger [0..1]

Максимальное запрашиваемое количество объектов в списке

  • По умолчанию значение 100;
  • Максимально возможное значение 1000.
008 ······<bs:offset>?</bs:offset> xs:nonNegativeInteger [0..1]

Номер элемента, по которому осуществляется смещение первого элемента списка

  • По умолчанию значение 0.
009 ···</bs:listOptions>
010 ···<hrt:region> dt:Region [1..1] Зона обслуживания: субъект РФ, на территории которого содержатся животные
011 ······<bs:guid>?</bs:guid> bs:UUID [1..1]

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

  • Справочник IS.HRT.2. Регионы
012 ···</hrt:region>
013 ···<hrt:supervisedObjectList> dt:SupervisedObjectList [0..1] Сведения о поднадзорных объектах, на которых осуществляется содержание животных
014 ······<dt:supervisedObject> dt:SupervisedObject [1..*] Поднадзорный объект
015 ·········<bs:guid>?</bs:guid> bs:UUID [1..1]

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

  • Справочник ES.HRT.2. Реестр поднадзорных объектов
016 ······</dt:supervisedObject>
017 ···</hrt:supervisedObjectList>
018 ···<hrt:animalIdentityType>?</hrt:animalIdentityType> vd:AnimalIdentityType [0..1]

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

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

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

  • Поддерживается поиск по частичному совпадению
020 ···<hrt:animalIDList> dt:UnifiedAnimalIDList [0..1] Сведения о номерах средств маркирования
021 ······<dt:animalIDContent> dt:UnifiedAnimalID [1..1] Номер средства маркирования
022 ·········<dt:animalID>?</dt:animalID> dt:AnimalID [1..1]

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

  • Поддерживается поиск по частичному совпадению
023 ······</dt:animalIDContent>
024 ···</hrt:animalIDList>
025 ···<hrt:registrationStatusList> vd:AnimalRegistrationStatusList [0..1] Сведения о статусах учётных карточек животных (группы животных)
026 ······<vd:registrationStatus>?</vd:registrationStatus> vd:AnimalRegistrationStatus [1..*]

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

  • Возможные значения:
    • PREPARING - В обработке (сведения приняты на регистрацию)
    • ACTIVE - Активна (зарегистированная учетная карточка)
    • TERMINATED - Регистрация завершена
027 ···</hrt:registrationStatusList>
028 ···<hrt:animalSpeciesList> dt:AnimalSpeciesList [0..1] Сведения о биологическом виде животного
029 ······<dt:animalSpecies> dt:AnimalSpecies [1..1] Биологический вид животного
030 ·········<bs:guid>?</bs:guid> bs:UUID [1..1]

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

  • Справочник DS.HRT.2. Биологические виды животных
031 ······</dt:animalSpecies>
032 ···</hrt:animalSpeciesList>
033 ···<hrt:specifiedAnimal> dt:Animal [0..1] Сведения о животных
034 ······<dt:gender>?</dt:gender> dt:AnimalGender [1..1]

Пол животного

  • Возможные значения:
    • MALE - самец
    • FEMALE - самка
    • UNDEFINED - не определен
035 ···</hrt:specifiedAnimal>
036 </hrt:getAnimalRegistrationListRequest>

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

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

TODO

См. также

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