Herriot:GetAnimalVeterinaryEventChangesList:v1.0

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску

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

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <hrt:getAnimalVeterinaryEventChangesListRequest>
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:animalRegistrationGuid>?</hrt:animalRegistrationGuid> bs:UUID [0..*] Глобальный идентификатор учётной карточки животного (группы животных)
021 </hrt:getAnimalVeterinaryEventChangesListRequest>

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <hrt:getAnimalVeterinaryEventChangesListResponse>
002 ···<hrt:medicationEventList total="?" offset="?" count="?"> vd:AnimalMedicationEventList [1..1] Список зарегистрированных ветеринарных мероприятий
003 ······<vd:medicationEvent> vd:AnimalMedicationEvent [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>?</bs:next> bs:UUID [0..1] Идентификатор следующей версии записи
013 ·········<vd:type>?</vd:type> vd:VeterinaryEventType [1..1] Тип мероприятия
014 ·········<vd:actualDateTime>?</vd:actualDateTime> xs:dateTime [1..1] Дата мероприятия
015 ·········<vd:eventStatus>?</vd:eventStatus> vd:VeterinaryEventStatus [1..1] Статус мероприятия
016 ·········<vd:operator> dt:Organization [0..1] Сведения об операторе проводившем мероприятие
017 ············<dt:name>?</dt:name> bs:String255 [1..1] Наименование оператора
018 ·········</vd:operator>
019 ·········<vd:authorizedPerson> vd:User [1..1] Сведения о специалисте, проводившем мероприятие
020 ············<vd:login>?</vd:login> xs:NCName [0..1] Логин уполномоченного лица
021 ············<vd:fio>?</vd:fio> bs:String255 [0..1] ФИО уполномоченного лица
022 ·········</vd:authorizedPerson>
023 ·········<vd:occurrenceReason>?</vd:occurrenceReason> vd:AnimalLifecycleEventReason [1..1] Основание проведения мероприятия
024 ·········<vd:disease> dt:AnimalDisease [0..*] Сведения о заболевании
025 ············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии записи
026 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
027 ············<dt:name>?</dt:name> bs:String255 [1..1] Наименование заболевания
028 ·········</vd:disease>
029 ·········<vd:medicinalDrug> dt:MedicinalDrug [0..1] Сведения о препарате
030 ············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии записи
031 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
032 ············<dt:name>?</dt:name> bs:String255 [1..1] Наименование препарата
033 ············<dt:activeSubstance> dt:DrugActiveSubstance [0..*] Действующее вещество препарата
034 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии записи
035 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
036 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование действующего вещества
037 ············</dt:activeSubstance>
038 ·········</vd:medicinalDrug>
039 ·········<vd:vaccine> dt:Vaccine [1..1] Сведения о вакцине
040 ············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии записи
041 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
042 ············<dt:name>?</dt:name> bs:String255 [1..1] Наименование вакцины
043 ·········</vd:vaccine>
044 ·········<vd:measuring> dt:Measure [1..1] Дозировка препарата / вакцины
045 ············<dt:value>?</dt:value> bs:Decimal [1..1] Значение дозировки
046 ············<dt:unit> dt:Unit [1..1] Единица измерения дозировки
047 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии записи
048 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
049 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование единицы измерения
050 ············</dt:unit>
051 ·········</vd:measuring>
052 ·········<vd:associatedAnimalGroup> vd:ObservableAnimalGroup [1..1] Сведения о животном (группе животных)
053 ············<vd:animalRegistrationRef> vd:AnimalRegistration [1..1] Сведения о зарегистрированных животных (группах животных)
054 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии записи
055 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
056 ···············<bs:active>?</bs:active> xs:boolean [1..1] Флаг: является ли запись активной
057 ···············<bs:last>?</bs:last> xs:boolean [1..1] Флаг: является ли версия последней
058 ···············<bs:status>?</bs:status> bs:VersionStatus [1..1] Статус версии записи
059 ···············<bs:createDate>?</bs:createDate> xs:DateTime [1..1] Дата создания записи
060 ···············<bs:updateDate>?</bs:updateDate> xs:DateTime [1..1] Дата последнего изменения записи
061 ···············<bs:previous>?</bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии записи
062 ············</vd:animalRegistrationRef>
063 ·········</vd:associatedAnimalGroup>
064 ······</vd:medicationEvent>
065 ···</hrt:medicationEventList>
066 </hrt:getAnimalVeterinaryEventChangesListResponse>

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

TODO

См. также

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