Herriot:ModifyAnimalRegistration:v1.0

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

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

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

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

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

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

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

TODO

См. также

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