Herriot:TerminateAnimalRegistration:v1.0

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

Код	Описание операции
AMS.HRT.1.4	Операция предназначена для прекращения регистрации животного / группы животных по причине выбытия.

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

#	Название XML-элемента	Тип	Обязат.	Описание (нажмите [...] для отображения дополнительного описания)
001	<hrt:terminateAnimalRegistrationRequest>
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:referencedLifecycleEvent>	vd:AnimalLifecycleEvent	[1..1]	Cведения о выбытии животного / группы животных
007	······<vd:type>?</vd:type>	vd:VeterinaryEventType	[1..1]	Тип выбытия животного / группы животных Возможные значения: APS - Плановый убой ADS - Диагностический убой AFS - Вынужденный убой DTH - Падёж LSS - Пропажа (сбежало, украдено и т.п.) RLS - Выпуск в среду обитания EXP - Экспорт OTH - Прочие события
008	······<vd:actualDate>	bs:ComplexDatePeriod	[1..1]	Дата выбытия
009	·········<bs:date>	bs:ComplexDate	[1..1]	Точное значение даты
010	············<bs:year>?</bs:year>	bs:Year	[1..1]	Год
011	············<bs:month>?</bs:month>	bs:Month	[1..1]	Месяц
012	············<bs:day>?</bs:day>	bs:Day	[1..1]	День
013	·········</bs:date>
014	······</vd:actualDate>
015	······<vd:occurrenceReason>	vd:AnimalLifecycleEventReason	[0..1]	Причина выбытия Обязательно указывать причину для следующих типов выбытия: вынужденный убой (type == AFS) падеж (type == DTH) прочие события (type == OTH) Опционально причина может быть указана для следующих типов выбытия: плановый убой (type == APS) Не указывается для прочих типов выбытия
016	·········<bs:guid>?</bs:guid>	bs:UUID	[1..1]	Идентификатор причины выбытия Классификатор причин ветеринарных событий CL.HRT.3. VeterinaryEventReason Возможные значения для type == AFS: d1b1c0df-560b-4096-950d-afecafc518a7 - убой животного, у которого выявлена заразная болезнь 9a7f5f4c-9e86-4878-ae2b-fd3f2de8e6ba - убой животного, у которого выявлена незаразная болезнь 5ac2b5be-3c19-49d6-9f14-1b4cf72e7a0a - убой здорового животного в рамках ликвидации болезни 0a5a1c1c-8c8e-43d3-a3d0-7fbf7d4c5f1b - убой животного в научно-исследовательских целях 6e5de2d1-a0f2-4b70-b2fd-41a38dfb75dc - убой животного за ненадобностью в будущем (лабораторные животные, непродуктивные и т.п.) Возможные значения для type == DTH: 4e8f5d90-0b16-4b6f-bf3c-2c0f6b8a2d9e - падёж животного, у которого не выявлено заразных или незаразных болезней 5c84d5f1-7c07-4d6b-bf9f-0e4e9e8f2b67 - падёж животного, у которого выявлена заразная болезнь 9e7d5a38-6b3c-4a6d-b55e-efb3d6d4d09c - падёж животного, у которого выявлена незаразная болезнь Возможные значения для type == APS: 9f9ba61f-487a-4cb3-8783-6eff248ce6d2 - убой для личных нужд Возможные значения для type == OTH: 2e813dc0-4f71-42f1-a9cb-88c11db55dda - расформирование группы животных
017	······</vd:occurrenceReason>
018	······<vd:associatedAnimalGroup>	vd:ObservableAnimalGroup	[0..1]	Сведения о частичном выбытии группы животных Не указывается в случае полного выбытия группы животных Не указывается в случае выбытия индивидуального животного Не указывается в случае расформирования группы животных
019	·········<vd:specifiedAnimalGroup>	dt:AnimalGroup	[1..1]	Сведения о численности выбывших животных группы
020	············<dt:size>?</dt:size>	xs:nonNegativeInteger	[1..1]	Количество выбывших животных Если указаны сведения о выбывших животных индивидуальной регистрации (../associatedAnimalGroup/animalRegistrationRef), то количество выбывших животных должно быть больше или равно количеству указанных учётных карточек индивидуальных животных
021	·········</vd:specifiedAnimalGroup>
022	·········<vd:animalRegistrationRef>	vd:AnimalRegistration	[0..*]	Сведения о выбывших из группы животных индивидуальной регистрации
023	············<bs:guid>?</bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор учётной карточки животного
024	·········</vd:animalRegistrationRef>
025	······</vd:associatedAnimalGroup>
026	···</hrt:referencedLifecycleEvent>
027	···<hrt:animalRegistrationRef>	vd:AnimalRegistration	[1..1]	Сведения регистрации (учётная карточка) животного или группы животных
028	······<bs:uuid>?</bs:uuid>	bs:UUID	[1..1]	Идентификатор версии учётной карточки животного
029	···</hrt:animalRegistrationRef>
030	</hrt:terminateAnimalRegistrationRequest>

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

#	Название XML-элемента	Тип	Обязат.	Описание (нажмите [...] для отображения дополнительного описания)
001	<hrt:terminateAnimalRegistrationResponse>
002	···<hrt:terminatedAnimalRegistrationList>	vd:AnimalRegistrationList	[1..1]	Список учётных карточек выбывших животных Список учётных карточек, участвоваших в запросе
003	······<vd:animalRegistration>	vd:AnimalRegistration	[1..*]	Сведения регистрации (учётная карточка) животного или группы животных
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	[1..1]	Идентификатор предыдущей версии записи
012	·········<vd:identityType>?</vd:identityType>	vd:AnimalIdentityType	[1..1]	Тип идентификации/учёта: индивидуальная/групповая Возможные значения: INDIVIDUAL - индивидуальная идентификация GROUP - групповая идентификация
013	·········<vd:registrationNumber>?</vd:registrationNumber>	dt:AnimalID	[1..1]	Регистрационный номер учётной карточки животного (группы животных)
014	·········<vd:registrationStatus>?</vd:registrationStatus>	vd:AnimalRegistrationStatus	[1..1]	Статус учётной карточки животного (группы животных) Возможные значения: TERMINATED - Недействующий, регистрация завершена.
015	·········<vd:initialIdentificationType>?</vd:initialIdentificationType>	vd:AnimalIdentificationEventType	[1..1]	Причина первичной идентификации: рождение, импорт, другое Возможные значения: BIRTH - рождение IMPORT - импорт OTHER - иная причина первичной идентификации
016	······</vd:animalRegistration>
017	···</hrt:terminatedAnimalRegistrationList>
018	···<hrt:referencedAnimalRegistrationList>	vd:AnimalRegistrationList	[0..1]	Список связанных учётных карточек животных Список учётных карточек, которые были изменены в результате выполнения запроса (например, обновленные учётные карточки групп животных, в которых содержались выбывшие индивидуальные животные из запроса)
019	······<vd:animalRegistration>	vd:AnimalRegistration	[1..*]	Сведения регистрации (учётная карточка) животного или группы животных
020	·········<bs:uuid>?</bs:uuid>	bs:UUID	[1..1]	Идентификатор версии записи
021	·········<bs:guid>?</bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор записи
022	······</vd:animalRegistration>
023	···</hrt:referencedAnimalRegistrationList>
024	</hrt:terminateAnimalRegistrationResponse>

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

TODO

См. также

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