Herriot:GetAnimalRegistrationByGuid:v1.0

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

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

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

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

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

TODO

См. также

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

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