Herriot:GetAnimalRegistrationHistory:v1.0

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

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

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <hrt:getAnimalRegistrationHistoryRequest>
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:animalRegistrationGuid>?</hrt:animalRegistrationGuid> bs:UUID [1..1] Глобальный идентификатор учётной карточки животного (группы животных)
007 </hrt:getAnimalRegistrationHistoryRequest>

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

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

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

  • count - размер текущей страницы списка
  • offset - смещение относительного первого элемента списка
  • hasMore - признак, что текущая страница общего списка не является последней
003 ······<vd:animalRegistration> vd:AnimalRegistration [0..*] Сведения регистрации (учётная карточка) животного или группы животных
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 [0..1] Идентификатор предыдущей версии записи
012 ·········<bs:next>?</bs:next> bs:UUID [0..1] Идентификатор следующей версии записи
013 ·········<vd:identityType>?</vd:identityType> vd:AnimalIdentityType [1..1]

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

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

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

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

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

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

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

  • Возможные значения:
    • BIRTH - рождение
    • IMPORT - импорт
    • OTHER - иная причина первичной идентификации
017 ·········<vd:specifiedAnimal> dt:Animal [0..1] Сведения о животном (в случае индивидуальной идентификации)
018 ············<dt:species> dt:AnimalSpecies [1..1] Биологический вид животного
019 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
020 ············</dt:species>
021 ············<dt:breed> dt:AnimalBreed [0..1] Порода животного
022 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
023 ············</dt:breed>
024 ············<dt:colour> dt:AnimalColour [0..1] Масть/окрас животного
025 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование масти/кокраса животного
026 ············</dt:colour>
027 ············<dt:gender>?</dt:gender> dt:AnimalGender [1..1]

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

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

  • MALE - самец
  • FEMALE - самка
028 ············<dt:name>?</dt:name> bs:String255 [0..1] Кличка животного
029 ············<dt:weight> dt:Measure [0..1] Вес животного
030 ···············<dt:value>?</dt:value> bs:Decimal [1..1] Значение веса животного
031 ···············<dt:unit> dt:Unit [1..1] Единица измерения
032 ··················<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
033 ···············</dt:unit>
034 ············</dt:weight>
035 ············<dt:birthDate> bs:ComplexDate [0..1] Дата рождения животного
036 ···············<bs:year>?</bs:year> bs:Year [1..1] Год
037 ···············<bs:month>?</bs:month> bs:Month [1..1] Месяц
038 ···············<bs:day>?</bs:day> bs:Day [0..1] День
039 ············</dt:birthDate>
040 ············<dt:birthLocation> dt:AnimalKeepingLocation [0..1] Место рождения
041 ···············<dt:supervisedObject> dt:SupervisedObject [0..1] Поднадзорный объект (ПО)
042 ··················<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор ПО
043 ··················<dt:approvalNumber>?</dt:approvalNumber> bs:Identifier [1..1] Регистрационный номер предприятия в реестре ПО
044 ···············</dt:supervisedObject>
045 ············</dt:birthLocation>
046 ·········</vd:specifiedAnimal>
047 ·········<vd:specifiedAnimalGroup> dt:AnimalGroup [0..1] Сведения о животном (в случае групповой идентификации)
048 ············<dt:species> dt:AnimalSpecies [1..1] Биологический вид животного
049 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
050 ············</dt:species>
051 ············<dt:breed> dt:AnimalBreed [0..1] Порода животного
052 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
053 ············</dt:breed>
054 ············<dt:gender>?</dt:gender> dt:AnimalGender [1..1]

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

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

  • MALE - самец
  • FEMALE - самка
055 ············<dt:size>?</dt:size> xs:nonNegativeInteger [1..1] Численность группы животных
056 ············<dt:weight> dt:Measure [0..1] Суммарный вес животных
057 ···············<dt:value>?</dt:value> bs:Decimal [1..1] Значение веса животного
058 ···············<dt:unit> dt:Unit [1..1] Единица измерения
059 ··················<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
060 ···············</dt:unit>
061 ············</dt:weight>
062 ············<dt:birthDatePeriod> bs:ComplexDatePeriod [0..1] Интервал дат рождения животных
063 ···············<bs:startDate> bs:ComplexDate [1..1] Дата начала интервала
064 ··················<bs:year>?</bs:year> bs:Year [1..1] Год
065 ··················<bs:month>?</bs:month> bs:Month [1..1] Месяц
066 ··················<bs:day>?</bs:day> bs:Day [0..1] День
067 ···············</bs:startDate>
068 ···············<bs:endDate> bs:ComplexDate [0..1] Дата окончания интервала
069 ··················<bs:year>?</bs:year> bs:Year [1..1] Год
070 ··················<bs:month>?</bs:month> bs:Month [1..1] Месяц
071 ··················<bs:day>?</bs:day> bs:Day [0..1] День
072 ···············</bs:endDate>
073 ············</dt:birthDatePeriod>
074 ·········</vd:specifiedAnimalGroup>
075 ·········<vd:specifiedAnimalIdentity> vd:AnimalIdentity [0..*] Сведения об идентификации животного
076 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор средства маркирования
077 ············<vd:identityStatus>?</vd:identityStatus> vd:AnimalIdentityStatus [1..1]

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

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

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

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

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

  • MAIN - основное средство маркирования
  • ADDITIONAL - дополнительное средство маркирования
081 ···············<dt:markingMeans> dt:AnimalMarkingMeans [1..1] Cредство маркирования
082 ··················<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 - Табло
083 ···············</dt:markingMeans>
084 ···············<dt:attachmentLocation> dt:AnimalMarkingLocation [1..1] Место нанесения/прикрепления
085 ··················<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
086 ···············</dt:attachmentLocation>
087 ···············<dt:description>?</dt:description> bs:String255 [0..1] Описание средства маркирования
088 ············</vd:attachedLabel>
089 ············<vd:associatedMarkingEvent> vd:AnimalMarkingEvent [0..*] Сведения о нанесении / выбытии средства маркирования
090 ···············<vd:type>?</vd:type> vd:VeterinaryEventType [1..1]

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

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

  • AME - нанесение средства маркирования
  • AIR - выбытие средства маркирования
091 ···············<vd:actualDate> bs:ComplexDatePeriod [1..1] Дата мероприятия
092 ··················<bs:date> bs:ComplexDate [1..1] Точное значение даты
093 ·····················<bs:year>?</bs:year> bs:Year [1..1] Год
094 ·····················<bs:month>?</bs:month> bs:Month [1..1] Месяц
095 ·····················<bs:day>?</bs:day> bs:Day [0..1] День
096 ··················</bs:date>
097 ···············</dt:actualDate>
098 ···············<vd:operatorBusinessEntity> dt:BusinessEntity [0..1] Сведения о физическом лице / организации, осуществлявшем мероприятие
099 ··················<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор записи
100 ··················<dt:fullName>?</dt:fullName> bs:String255 [0..1] Наименование лица
101 ··················<dt:fio>?</dt:fio> bs:String255 [0..1] ФИО лица
102 ··················<dt:inn>?</dt:inn> bs:String255 [0..1] ИНН
103 ···············</vd:operatorBusinessEntity>
104 ···············<vd:occurrenceReason>?</vd:occurrenceReason> vd:AnimalMarkingEventReason [0..1]

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

  • Обязательно, если тип мероприятия - выбытие (type == AIR)
  • Возможные значения:
    • TERMINATED - Прекращение экплуатации средства маркирования по причине выбытия животного
    • LOSS - Средство маркирования утеряно
    • BROKEN - Средство маркирования повреждено (сломано)
    • EXPIRATION - Истёк срок действия средства маркирования
    • REMOVED - Средство маркирования удалено владельцем животного
105 ············</vd:associatedMarkingEvent>
106 ·········</vd:specifiedAnimalIdentity>
107 ·········<vd:specifiedGeneticPassport> dt:AnimalGeneticPassport [0..1] Сведения о генетической идентификации
108 ············<dt:data>?</dt:data> bs:String255 [1..1] Данные генетической идентификации
109 ············<dt:conclusion>?</dt:conclusion> bs:String255 [1..1] Заключение по генетической идентификации
110 ·········</vd:specifiedGeneticPassport>
111 ·········<vd:importDetails> vd:AnimalImportDetails [0..1] Данные о ввозе на территорию РФ
112 ············<vd:importDate> bs:ComplexDatePeriod [1..1] Дата ввоза
113 ···············<bs:date> bs:ComplexDate [0..1] Точная дата
114 ··················<bs:year>?</bs:year> bs:Year [1..1] Год
115 ··················<bs:month>?</bs:month> bs:Month [1..1] Месяц
116 ··················<bs:day>?</bs:day> bs:Day [0..1] День
117 ···············</bs:date>
118 ···············<bs:startDate> bs:ComplexDate [0..1] Дата начала интервала
119 ··················<bs:year>?</bs:year> bs:Year [1..1] Год
120 ··················<bs:month>?</bs:month> bs:Month [1..1] Месяц
121 ··················<bs:day>?</bs:day> bs:Day [0..1] День
122 ···············</bs:startDate>
123 ···············<bs:endDate> bs:ComplexDate [0..1] Дата окончания интервала
124 ··················<bs:year>?</bs:year> bs:Year [1..1] Год
125 ··················<bs:month>?</bs:month> bs:Month [1..1] Месяц
126 ··················<bs:day>?</bs:day> bs:Day [0..1] День
127 ···············</bs:endDate>
128 ············</vd:importDate>
129 ············<vd:importCountry> dt:Country [1..1] Страна, из которой было ввезено животное (группа животных)
130 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
131 ············</vd:importCountry>
132 ·········</vd:importDetails>
133 ·········<vd:keepingDetails> vd:AnimalKeepingDetails [0..1] Сведения о содержании животного (группы животных)
134 ············<vd:operatorSupervisedObject> dt:SupervisedObject [1..1] Место содержания (поднадзорный объект)
135 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор ПО
136 ···············<dt:approvalNumber>?</dt:approvalNumber> bs:Identifier [1..1] Регистрационный номер предприятия в реестре ПО
137 ············</vd:operatorSupervisedObject>
138 ············<vd:keepingType> dt:AnimalKeepingType [1..1] Тип содержания животного (группы животных)
139 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
140 ············</vd:keepingType>
141 ············<vd:keepingPurpose> dt:AnimalKeepingPurpose [1..*] Цель содержания животного (группы животных)
142 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
143 ············</vd:keepingPurpose>
144 ············<vd:facilityDescription>?</vd:facilityDescription> bs:String255 [0..1] Описание объекта (отделение, строение, корпус) содержания
145 ·········</vd:keepingDetails>
146 ·········<vd:breedingValueType>?</vd:breedingValueType> dt:AnimalBreedingValueType [1..1]

Племенная ценность

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

  • BREEDING - Племенное
  • NON_BREEDING - Неплеменное
  • UNDEFINED - Тип не определен
147 ·········<vd:specifiedProductivity> dt:AnimalProductivity [0..*] Сведения о продуктивности животного (группы животных)
148 ············<dt:subProduct> dt:SubProduct [1..1] Вид получаемой продукции
149 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
150 ············</dt:subProduct>
151 ············<dt:output> dt:ComplexMeasure [1..1] Значение продуктивности животного по указанному виду продукции
152 ···············<dt:value>?</dt:value> bs:Decimal [1..1] Значение
153 ···············<dt:unit> dt:Unit [1..1] Единица измерения
154 ··················<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
155 ···············</dt:unit>
156 ············</dt:output>
157 ·········</vd:specifiedProductivity>
158 ·········<vd:additionalAttribute> dt:UnmeasuredAttribute [0..*]

Дополнительные атрибуты учётной карточки

159 ············<dt:attrID>?</dt:attrID> bs:Identifier [1..1] Идентификатор атрибута
160 ············<dt:attrName>?</dt:attrName> bs:NText [1..1] Наименование атрибута
161 ············<dt:attrValue>?</dt:attrValue> bs:Text [1..1] Значение атрибута
162 ·········</vd:additionalAttribute>
163 ·········<vd:pedigreeInfo> vd:AnimalPedigreeInfo [0..1]

Сведения о родословной животного

  • сведения возвращаются, если связанная учетная карточка животного (группы животных) была зарегистрирована в компоненте Хорриот.
164 ············<vd:parent> vd:AnimalRegistration [1..*] Идентификатор карточки учёта животного, являющегося родителем зарегистрированного животного
165 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Идентификатор карточки животного
166 ···············<vd:registrationNumber>?</vd:registrationNumber> dt:AnimalID [0..1]

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

  • при статусе PREPARING связанной учетной карточки регистрационный номер отсутствует (не присваивается системой до окончания регистрации)
167 ············</vd:parent>
168 ·········</vd:pedigreeInfo>
169 ·········<vd:unitInfo> vd:AnimalUnitInfo [0..1]

Сведения о животных, входящих в состав группы

  • сведения возвращаются, если связанная учетная карточка животного (группы животных) была зарегистрирована в компоненте Хорриот.
170 ············<vd:individualMember> vd:AnimalRegistration [1..*] Идентификатор карточки индивидуального учёта животного, входящего в зарегистрированную группу
171 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Идентификатор карточки животного
172 ···············<vd:registrationNumber>?</vd:registrationNumber> dt:AnimalID [0..1]

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

  • при статусе PREPARING связанной учетной карточки регистрационный номер отсутствует (не присваивается системой до окончания регистрации)
173 ············</vd:individualMember>
174 ·········</vd:unitInfo>
175 ·········<vd:membershipInfo> vd:AnimalGroupMembershipInfo [0..1]

Сведения о членстве в зарегистрированных группах животных

  • сведения возвращаются, если связанная учетная карточка животного (группы животных) была зарегистрирована в компоненте Хорриот.
176 ············<vd:parentGroup> vd:AnimalRegistration [1..*] Идентификатор карточки группового учёта животного
177 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Идентификатор зарегистрированной карточки животного
178 ···············<vd:registrationNumber>?</vd:registrationNumber> dt:AnimalID [0..1]

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

  • при статусе PREPARING связанной учетной карточки регистрационный номер отсутствует (не присваивается системой до окончания регистрации)
179 ············</vd:parentGroup>
180 ·········</vd:membershipInfo>
181 ·········<vd:referencedDocument> vd:ReferencedDocument [0..1]

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

  • обязательно, если причина первичной регистрации - импорт (initialIdentificationType == IMPORT)
182 ············<bs:issueNumber>?</bs:issueNumber> bs:String255 [1..1] Номер документа
183 ············<vd:type>56</vd:type> dt:DocumentType [1..1] Тип документа (56 - иностранный идентификационный номер животного)
184 ············<vd:relationshipType>6</vd:relationshipType> dt:ReferenceType [1..1] Тип связи документа
185 ·········</vd:referencedDocument>
186 ·········<vd:lifecycleEventList> vd:AnimalLifecycleEventList [0..1] Сведения о выбытии животных
187 ············<vd:animalLifecycleEvent> vd:AnimalLifecycleEvent [1..1] Событие выбытия
188 ···············<vd:type>?</vd:type> vd:VeterinaryEventType [1..1]

Тип выбытия

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

  • APS - Плановый убой животного
  • ADS - Диагностический убой животного
  • AFS - Вынужденный убой животного
  • DTH - Падёж животного
  • LSS - Пропажа животного (сбежало, украдено и т.п.)
  • RLS - Выпуск животного в среду обитания
  • EXP - Экспорт животного
189 ···············<vd:actualDate> bs:ComplexDatePeriod [1..1] Дата события
190 ··················<bs:date> bs:ComplexDate [1..1] Точная дата
191 ·····················<bs:year>?</bs:year> bs:Year [1..1] Год
192 ·····················<bs:month>?</bs:month> bs:Month [1..1] Месяц
193 ·····················<bs:day>?</bs:day> bs:Day [1..1] День
194 ··················</bs:date>
195 ···············</vd:actualDate>
196 ···············<vd:occurrenceReason>?</vd:occurrenceReason> vd:AnimalLifecycleEventReason [0..1]

Основание (причина) выбытия

  • Обязательно, если тип выбытия (type):
    • AFS (Вынужденный убой животного)
    • DTH (Падёж животного)
  • Возможные значения для типа AFS:
    • IDENTIFIED_CONTAGIOUS_DISEASE - Падёж/убой животного, у которого выявлена заразная болезнь
    • IDENTIFIED_NON_CONTAGIOUS_DISEASE - Падёж/убой животного, у которого выявлена незаразная болезнь
    • DISEASE_ERADICATION - Убой здорового животного в рамках ликвидации болезни
    • RESEARCH_OBJECTIVES - Убой животного в научно-исследовательских целях
    • USELESSNESS - Убой животного за ненадобностью в будущем (лабораторные животные, непродуктивные и т.п.)
  • Возможные значения для типа DTH:
    • WITHOUT_DISEASES - Падёж/убой животного, у которого не выявлено заразных или незаразных болезней
    • IDENTIFIED_CONTAGIOUS_DISEASE - Падёж/убой животного, у которого выявлена заразная болезнь
    • IDENTIFIED_NON_CONTAGIOUS_DISEASE - Падёж/убой животного, у которого выявлена незаразная болезнь
197 ············</vd:animalLifecycleEvent>
198 ·········</vd:lifecycleEventList>
199 ······</vd:animalRegistration>
200 ···</hrt:animalRegistrationList>
201 </hrt:getAnimalRegistrationHistoryResponse>

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

TODO

См. также

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

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