Herriot:GetAnimalRegistrationByUuid:v1.0

Материал из Справочная система Россельхознадзора
Версия от 09:08, 13 ноября 2023; Romanov-av-170814 (обсуждение | вклад) (Новая страница: « == Общие сведения == == Спецификация запроса == {| class="wikitable" ! # ! Название XML-элемента ! Тип ! О...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)
Перейти к навигации Перейти к поиску

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

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

# Название 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] Тип идентификации/учёта: индивидуальная/групповая
013 ······<vd:registrationStatus>?</vd:registrationStatus> vd:AnimalRegistrationStatus [1..1] Статус учётной карточки животного (группы животных)
014 ······<vd:initialIdentificationType>?</vd:initialIdentificationType> vd:AnimalIdentificationEventType [1..1] Причина первичной идентификации: рождение, импорт, другое
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:species>
019 ·········<dt:breed> dt:AnimalBreed [0..1] Порода животного
020 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
021 ·········</dt:breed>
022 ·········<dt:colour> dt:AnimalColour [0..1] Масть/окрас животного
023 ············<dt:name>?</dt:name> bs:String255 [1..1] Наименование масти/кокраса животного
024 ·········</dt:colour>
025 ·········<dt:gender>?</dt:gender> dt:AnimalGender [1..1] Пол животного
026 ·········<dt:name>?</dt:name> bs:String255 [0..1] Кличка животного
027 ·········<dt:weight> dt:Measure [0..1] Вес животного
028 ············<dt:value>?</dt:value> bs:Decimal [1..1] Значение веса животного
029 ············<dt:unit> dt:Unit [1..1] Единица измерения
030 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
031 ············</dt:unit>
032 ·········</dt:weight>
033 ·········<dt:birthDate> bs:ComplexDate [0..1] Дата рождения животного
034 ············<bs:year>?</bs:year> bs:Year [1..1] Год
035 ············<bs:month>?</bs:month> bs:Month [1..1] Месяц
036 ············<bs:day>?</bs:day> bs:Day [0..1] День
037 ·········</dt:birthDate>
038 ·········<dt:birthLocation> dt:AnimalKeepingLocation [0..1] Место рождения
039 ············<dt:location> dt:Location [0..1] Локация
040 ···············<dt:address> dt:Address [0..1] Адрес
041 ··················<dt:country> dt:Country [0..1] Страна
042 ·····················<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
043 ··················</dt:country>
044 ··················<dt:region> dt:Region [0..1] Регион
045 ·····················<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
046 ··················</dt:region>
047 ··················<dt:addressView>?</dt:addressView> bs:Ntext [0..1] Текстовое представление адреса
048 ···············</dt:address>
049 ···············<dt:nameEn>?</dt:nameEn> bs:String255 [0..1] Наименование места (англ.)
050 ············</dt:location>
051 ············<dt:supervisedObject> dt:SupervisedObject [0..1] Поднадзорный объект
052 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
053 ············</dt:supervisedObject>
054 ·········</dt:birthLocation>
055 ······</vd:specifiedAnimal>
056 ······<vd:specifiedAnimalGroup> dt:AnimalGroup [0..1] Сведения о животном (в случае групповой идентификации)
057 ·········<dt:species> dt:AnimalSpecies [1..1] Биологический вид животного
058 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
059 ·········</dt:species>
060 ·········<dt:breed> dt:AnimalBreed [0..1] Порода животного
061 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
062 ·········</dt:breed>
063 ·········<dt:gender>?</dt:gender> dt:AnimalGender [1..1] Пол животного
064 ·········<dt:size>?</dt:size> xs:nonNegativeInteger [1..1] Численность группы животных
065 ·········<dt:weight> dt:Measure [0..1] Суммарный вес животных
066 ············<dt:value>?</dt:value> bs:Decimal [1..1] Значение веса животного
067 ············<dt:unit> dt:Unit [1..1] Единица измерения
068 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
069 ············</dt:unit>
070 ·········</dt:weight>
071 ·········<dt:birthDatePeriod> bs:ComplexDatePeriod [0..1] Интервал дат рождения животных
072 ············<bs:startDate> bs:ComplexDate [1..1] Дата начала интервала
073 ···············<bs:year>?</bs:year> bs:Year [1..1] Год
074 ···············<bs:month>?</bs:month> bs:Month [1..1] Месяц
075 ···············<bs:day>?</bs:day> bs:Day [0..1] День
076 ············</bs:startDate>
077 ············<bs:endDate> bs:ComplexDate [0..1] Дата окончания интервала
078 ···············<bs:year>?</bs:year> bs:Year [1..1] Год
079 ···············<bs:month>?</bs:month> bs:Month [1..1] Месяц
080 ···············<bs:day>?</bs:day> bs:Day [0..1] День
081 ············</bs:endDate>
082 ·········</dt:birthDatePeriod>
083 ······</vd:specifiedAnimalGroup>
084 ······<vd:specifiedAnimalIdentity> vd:AnimalIdentity [0..*] Сведения об идентификации животного
085 ·········<vd:attachedLabel> dt:AnimalLabel [1..1] Сведения о маркировке животного
086 ············<dt:animalID format="?">?</dt:animalID> dt:AnimalID [0..1] Номер, нанесенный на животное с помощью средства маркирования
087 ············<dt:markingMeans> dt:AnimalMarkingMeans [1..1] Cредство маркирования
088 ···············<dt:type>?</dt:type> dt:AnimalMarkingMeansType [1..1] Тип средства маркирования
089 ············</dt:markingMeans>
090 ············<dt:attachmentDate> bs:ComplexDate [1..1] Дата маркирования
091 ···············<bs:year>?</bs:year> bs:Year [1..1] Год
092 ···············<bs:month>?</bs:month> bs:Month [1..1] Месяц
093 ···············<bs:day>?</bs:day> bs:Day [0..1] День
094 ············</dt:attachmentDate>
095 ············<dt:attachmentLocation> dt:AnimalMarkingLocation [1..1] Место нанесения/прикрепления
096 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
097 ············</dt:attachmentLocation>
098 ············<dt:description>?</dt:description> bs:String255 [0..1] Описание средства маркирования
099 ············<dt:photo> bs:File [0..1] Фото средства маркирования
100 ···············<bs:id>?</bs:id> bs:Identifier [0..1] Идентификатор загруженного файла
101 ···············<bs:binaryData mimeCode="?">?</bs:binaryData> bs:BinaryData [0..1] Содержимое файла в формате base64
102 ············</dt:photo>
103 ·········</vd:attachedLabel>
104 ······</vd:specifiedAnimalIdentity>
105 ······<vd:specifiedGeneticPassport> dt:AnimalGeneticPassport [0..1] Сведения о генетической идентификации
106 ·········<dt:data>?</dt:data> bs:Text [1..1] Данные генетической идентификации
107 ·········<dt:sampleStorageLocation> dt:Location [0..1] Место хранения пробы генетического материала
108 ············<dt:name>?</dt:name> bs:String255 [1..1] Наименование места
109 ·········</dt:sampleStorageLocation>
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 ·········</vd:operatorSupervisedObject>
137 ·········<vd:keepingType> dt:AnimalKeepingType [1..1] Тип содержания животного (группы животных)
138 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
139 ·········</vd:keepingType>
140 ·········<vd:keepingPurpose> dt:AnimalKeepingPurpose [1..1] Цель содержания животного (группы животных)
141 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
142 ·········</vd:keepingPurpose>
143 ·········<vd:facilityDescription>?</vd:facilityDescription> bs:String255 [0..1] Описание объекта (отделение, строение, корпус) содержания
144 ······</vd:keepingDetails>
145 ······<vd:breedingValueType>?</vd:breedingValueType> dt:AnimalBreedingValueType [1..1] Племенная ценность
146 ······<vd:specifiedProductivity> dt:AnimalProductivity [0..1] Сведения о продуктивности животного (группы животных)
147 ·········<dt:subProduct> dt:SubProduct [1..1] Вид получаемой продукции
148 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
149 ·········</dt:subProduct>
150 ·········<dt:output> dt:ComplexMeasure [1..1] Значение продуктивности животного по указанному виду продукции
151 ············<dt:value>?</dt:value> bs:Decimal [1..1] Значение
152 ············<dt:unit> dt:Unit [1..1] Единица измерения
153 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
154 ············</dt:unit>
155 ·········</dt:output>
156 ······</vd:specifiedProductivity>
157 ······<vd:applicableClassification> dt:ClassificationAttribute [0..*] Дополнительные характеристики учётной карточки
158 ·········<dt:attrID>?</dt:attrID> bs:Identifier [1..1] Идентификатор характеристики
159 ·········<dt:className>?</dt:className> bs:Text [1..1] Значение (описание) характеристики
160 ······</vd:applicableClassification>
161 ······<vd:pedigreeInfo> vd:AnimalPedigreeInfo [0..1] Сведения о родословной животного
162 ·········<vd:parent> vd:AnimalRegistration [0..*] Идентификатор карточки учёта животного, являющегося родителем зарегистрированного животного
163 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Идентификатор карточки животного
164 ············<vd:specifiedAnimal> dt:Animal [0..1] Сведения о животном
165 ···············<dt:gender>?</dt:gender> dt:AnimalGender [1..1] Пол животного
166 ············</vd:specifiedAnimal>
167 ············<vd:referencedDocument> vd:ReferencedDocument [0..*] Связанные документы
168 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор документа
169 ···············<vd:type>?</vd:type> dt:DocumentType [1..1] Тип документа
170 ···············<vd:relationshipType>?</vd:relationshipType> dt:ReferenceType [1..1] Тип связи документа
171 ············</vd:referencedDocument>
172 ·········</vd:parent>
173 ······</vd:pedigreeInfo>
174 ······<vd:unitInfo> vd:AnimalUnitInfo [0..1] Сведения о животных, входящих в состав группы
175 ·········<vd:individualMember> vd:AnimalRegistration [1..*] Идентификатор карточки индивидуального учёта животного, входящего в зарегистрированную группу
176 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Идентификатор карточки животного
177 ············<vd:specifiedAnimal> dt:Animal [0..1] Сведения о животном
178 ···············<dt:gender>?</dt:gender> dt:AnimalGender [1..1] Пол животного
179 ············</vd:specifiedAnimal>
180 ············<vd:referencedDocument> vd:ReferencedDocument [0..*] Связанные документы
181 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор документа
182 ···············<vd:type>?</vd:type> dt:DocumentType [1..1] Тип документа
183 ···············<vd:relationshipType>?</vd:relationshipType> dt:ReferenceType [1..1] Тип связи документа
184 ············</vd:referencedDocument>
185 ·········</vd:individualMember>
186 ······</vd:unitInfo>
187 ······<vd:referencedDocument> vd:ReferencedDocument [0..*] Связанные документы
188 ·········<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор документа
189 ·········<vd:type>?</vd:type> dt:DocumentType [1..1] Тип документа
190 ·········<vd:relationshipType>?</vd:relationshipType> dt:ReferenceType [1..1] Тип связи документа
191 ······</vd:referencedDocument>
192 ···</hrt:animalRegistration>
193 </hrt:getAnimalRegistrationByUuidResponse>

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

TODO

См. также

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

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