Herriot:GetAnimalRegistrationByGuid:v1.0

Материал из Справочная система Россельхознадзора
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)
Перейти к навигации Перейти к поиску

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

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <hrt:getAnimalRegistrationByGuidRequest>
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:getAnimalRegistrationByGuidRequest>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Тип выбытия

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

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

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

TODO

См. также

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

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