Herriot:GetAnimalRegistrationChangesList:v1.0

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

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

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <hrt:getAnimalRegistrationChangesListRequest>
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 ···<bs:listOptions> bs:ListOptions [0..1] Параметры запрашиваемого списка
007 ······<bs:count>?</bs:count> xs:nonNegativeInteger [0..1]

Максимальное запрашиваемое количество объектов в списке

  • По умолчанию значение 100;
  • Максимально возможное значение 1000.
008 ······<bs:offset>?</bs:offset> xs:nonNegativeInteger [0..1]

Номер элемента, по которому осуществляется смещение первого элемента списка

  • По умолчанию значение 0.
009 ···</bs:listOptions>
010 ···<bs:updateDateInterval> vd:issueDateInterval [0..1]

Интервал времени оформления документа

  • Максимальная длина интервала - 31 день.
011 ······<bs:beginDate>?</bs:beginDate> xs:dateTime [1..1] Начало временного интервала
012 ······<bs:endDate>?</bs:endDate> xs:dateTime [1..1] Конец временного интервала
013 ···</bs:updateDateInterval>
014 ···<hrt:region> dt:Region [1..1] Зона обслуживания: субъект РФ, на территории которого содержатся животные
015 ······<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
016 ···</hrt:region>
017 ···<hrt:operator> dt:SupervisedObject [0..*] Поднадзорный объект, на котором осуществляется содержание животных
018 ······<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
019 ···</hrt:operator>
020 </hrt:getAnimalRegistrationChangesListRequest>

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

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

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

TODO

См. также

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

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