Herriot:GetAnimalRegistrationByUuid:v1.0

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • MALE - самец
  • FEMALE - самка
062 ·········<dt:size>?</dt:size> xs:nonNegativeInteger [1..1] Численность группы животных
063 ·········<dt:weight> dt:Measure [0..1] Суммарный вес животных
064 ············<dt:value>?</dt:value> bs:Decimal [1..1] Значение веса животного
065 ············<dt:unit> dt:Unit [1..1] Единица измерения
066 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
067 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование единицы измерения
068 ············</dt:unit>
069 ·········</dt:weight>
070 ·········<dt:birthDatePeriod> bs:ComplexDatePeriod [0..1] Интервал дат рождения животных
071 ············<bs:startDate> bs:ComplexDate [1..1] Дата начала интервала
072 ···············<bs:year>?</bs:year> bs:Year [1..1] Год
073 ···············<bs:month>?</bs:month> bs:Month [1..1] Месяц
074 ···············<bs:day>?</bs:day> bs:Day [0..1] День
075 ············</bs:startDate>
076 ············<bs:endDate> bs:ComplexDate [0..1] Дата окончания интервала
077 ···············<bs:year>?</bs:year> bs:Year [1..1] Год
078 ···············<bs:month>?</bs:month> bs:Month [1..1] Месяц
079 ···············<bs:day>?</bs:day> bs:Day [0..1] День
080 ············</bs:endDate>
081 ·········</dt:birthDatePeriod>
082 ······</vd:specifiedAnimalGroup>
083 ······<vd:specifiedAnimalIdentity> vd:AnimalIdentity [0..*] Сведения об идентификации животного
084 ·········<vd:attachedLabel> dt:AnimalLabel [1..1] Сведения о маркировке животного
085 ············<dt:animalID format="?">?</dt:animalID> dt:AnimalID [0..1] Номер, нанесенный на животное с помощью средства маркирования
086 ············<dt:type>?</dt:type> dt:AnimalLabelType [1..1]

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

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

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

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

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

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

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

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

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

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

  • BREEDING - Племенное
  • NON_BREEDING - Неплеменное
  • UNDEFINED - Тип не определен
158 ······<vd:specifiedProductivity> dt:AnimalProductivity [0..*] Сведения о продуктивности животного (группы животных)
159 ·········<dt:subProduct> dt:SubProduct [1..1] Вид получаемой продукции
160 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
161 ············<dt:name>?</dt:name> bs:String255 [1..1] Наименование вида продукции
162 ·········</dt:subProduct>
163 ·········<dt:output> dt:ComplexMeasure [1..1] Значение продуктивности животного по указанному виду продукции
164 ············<dt:value>?</dt:value> bs:Decimal [1..1] Значение
165 ············<dt:unit> dt:Unit [1..1] Единица измерения
166 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
167 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование единицы измерения
168 ············</dt:unit>
169 ·········</dt:output>
170 ······</vd:specifiedProductivity>
171 ······<vd:applicableClassification> dt:ClassificationAttribute [0..*] Дополнительные характеристики учётной карточки
172 ·········<dt:classCode>?</dt:classCode> bs:Identifier [1..1] Идентификатор характеристики
173 ·········<dt:className>?</dt:className> bs:Text [1..1] Наименование характеристики
174 ·········<dt:classValue>?</dt:classValue> bs:Text [1..1] Значение характеристики
175 ······</vd:applicableClassification>
176 ······<vd:pedigreeInfo> vd:AnimalPedigreeInfo [0..1]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Тип выбытия

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

  • APS - Плановый убой животного
  • ADS - Диагностический убой животного
  • AFS - Вынужденный убой животного
  • DTH - Падёж животного
  • LSS - Пропажа животного (сбежало, украдено и т.п.)
  • RLS - Выпуск животного в среду обитания
  • EXP - Экспорт животного
202 ············<vd:actualDate> bs:ComplexDatePeriod [1..1] Дата события
203 ···············<bs:date> bs:ComplexDate [1..1] Точная дата
204 ··················<bs:year>?</bs:year> bs:Year [1..1] Год
205 ··················<bs:month>?</bs:month> bs:Month [1..1] Месяц
206 ··················<bs:day>?</bs:day> bs:Day [1..1] День
207 ···············</bs:date>
208 ············</vd:actualDate>
209 ············<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 - Падёж/убой животного, у которого выявлена незаразная болезнь
210 ·········</vd:animalLifecycleEvent>
211 ······</vd:lifecycleEventList>
212 ···</hrt:animalRegistration>
213 </hrt:getAnimalRegistrationByUuidResponse>

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

TODO

См. также

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

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