Herriot:RegisterAnimal:v1.0: различия между версиями

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
← Предыдущая правкаСледующая правка →
ВизуальныйВики-текст
Строка 1236: Строка 1236:


== Спецификация ответа ==
== Спецификация ответа ==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<hrt:registerAnimalResponse>'''}}
|
|
| style="width:52em;"|
|-
|002
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:animalRegistration {{color|Red|qualifier&#61;}}{{color|#007f15|"?"}}>'''}}
|vd:AnimalRegistration
|[1..*]
| style="width:52em;"| Сведения регистрации (учётная карточка) животного или группы животных
|-
|003
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|vd:AnimalIdentityType
|[1..1]
| style="width:52em;"| Идентификатор учётной карточки животного (группы животных)
|-
|004
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}registrationStatus>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}registrationStatus>'''}}
|vd:AnimalRegistrationStatus
|[1..1]
| style="width:52em;"| Статус учётной карточки животного (группы животных)
|-
|005
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:animalRegistration>'''}}
|
|
| style="width:52em;"|
|-
|006
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</hrt:registerAnimalResponse>'''}}
|
|
| style="width:52em;"|
|-
|}


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

Версия от 10:34, 10 ноября 2023

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

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

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

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <hrt:registerAnimalResponse>
002 ···<hrt:animalRegistration qualifier="?"> vd:AnimalRegistration [1..*] Сведения регистрации (учётная карточка) животного или группы животных
003 ······<bs:guid>?</bs:guid> vd:AnimalIdentityType [1..1] Идентификатор учётной карточки животного (группы животных)
004 ······<vd:registrationStatus>?</vd:registrationStatus> vd:AnimalRegistrationStatus [1..1] Статус учётной карточки животного (группы животных)
005 ···</hrt:animalRegistration>
006 </hrt:registerAnimalResponse>

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

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