Herriot:RegisterAnimal:v1.0: различия между версиями
(не показано 35 промежуточных версий 1 участника) | |||
Строка 1: | Строка 1: | ||
== Общие сведения == | == Общие сведения == | ||
{| class="wikitable" | |||
! style="text-align:left;"|Код !! style="text-align:left;"|Описание операции | |||
|- | |||
| '''AMS.HRT.1.1''' | |||
| Операция предназначена для подачи заявки на регистрацию учётной карточки животного или группы животных, включая сведения об идентификации животного, ввозе на территорию РФ, текущем содержании, потомстве. | |||
|- | |||
|} | |||
== Сценарии операции == | == Сценарии операции == | ||
Строка 15: | Строка 22: | ||
# Объект '''specifiedAnimal''' должен отсутствовать. Если необходимо включить в состав группы зарегистрированных индивидуальных животных, то для этого используется объект '''unitInfo'''. | # Объект '''specifiedAnimal''' должен отсутствовать. Если необходимо включить в состав группы зарегистрированных индивидуальных животных, то для этого используется объект '''unitInfo'''. | ||
== Ограничения == | |||
# Учёт животных в компоненте Хорриот возможен только на '''поднадзорном объекте (ПО)''', идентификатор которого передаётся в параметре ../animalRegistration/keepingDetails/operatorSupervisedObject/'''guid''' из справочника [[Herriot:Services:v1.0#EnterpriseService_.28.D1.80.D0.B5.D0.B5.D1.81.D1.82.D1.80_.D1.85.D0.BE.D0.B7.D1.8F.D0.B9.D1.81.D1.82.D0.B2.D1.83.D1.8E.D1.89.D0.B8.D1.85_.D1.81.D1.83.D0.B1.D1.8A.D0.B5.D0.BA.D1.82.D0.BE.D0.B2_.D0.B8_.D0.BF.D1.80.D0.B5.D0.B4.D0.BF.D1.80.D0.B8.D1.8F.D1.82.D0.B8.D0.B9.29|ES.HRT.2. Реестр поднадзорных объектов]]. | |||
# '''Поднадзорный объект (ПО)''', на котором возможен учёт животных в компоненте Хорриот, '''должен удовлетворять следующим условиям''': | |||
## Статус ПО в реестре Цербер "'''Подтверждён'''" (объект ../supervisedObject/'''registryStatus''' == '''VERIFIED'''). | |||
## '''Вид ПО''' входит в список разрешённых видов ([[Herriot:GetSupervisedObjectTypeList:v1.0|справочник ES.HRT.2.5 + список разрешённых видов]]). | |||
## '''Вид деятельности ПО''' входит в список разрешённых видов деятельности ([[Herriot:GetSupervisedObjectActivityList:v1.0|справочник ES.HRT.2.4 + список разрешённых видов деятельности]]). | |||
== Массовая регистрация животных == | == Массовая регистрация животных == | ||
<p> | |||
В случае массовой регистрации животных возможно образование большого количества перекрестных связей различных учётных карточек животных или групп животных между собой (сведения о членстве животных в группах, сведения о составе групп животных, сведения о родословной). Таким образом возникает необходимость соблюдения строгого порядка отправки запросов на регистрацию и ожидания ответов, чтобы построить все необходимые связи (например, родителей животного необходимо зарегистрировать раньше самого этого животного), что может создать определённые трудности при регистрации большого количества животных и групп животных. | |||
</p></br> | |||
<p> | |||
Чтобы упростить процесс создания связей при массовой регистрации животных, '''предусмотрено два варианта''' передачи сведений: | |||
# Использование '''внешних идентификаторов''' учётной системы - в этом случае порядок отправки запросов не важен, регистрация карточки завершится только после того, как будут переданы все прочие карточки животных, которые связаны с текущей. | |||
# Использование '''идентификаторов компонента Хорриот''' - в этом случае важно соблюдать порядок отправки запросов, чтобы используемые в текущей карточке связи были уже зарегистрированы в компоненте Хорриот ранее. | |||
</p> | |||
<p> | |||
Интеграционные решения могут использовать как один из этих вариантов, так и их комбинирование в зависимости от внутренних процессов и объёмов данных. | |||
</p> | |||
===Использование идентификаторов внешней системы для построения связей=== | |||
'''Предусловия''': | |||
# На стороне внешней системы должен быть аналог учётной карточки животного (группы животных) со своим уникальным идентификатором вида UUID. | |||
# На стороне внешней системы должны быть организованы все связи между различными учётными карточками. | |||
'''Общая схема процесса''': | |||
# Каждый запрос на регистрацию учётной карточки '''обязательно''' содержит '''внешний идентификатор''' из предусловия, который передаётся с помощью связанного документа с типом '''55''' (объект '''../animalRegistration/referencedDocument'''). | |||
# При формировании новых запросов на регистрацию в зависимости от требуемой связи данный идентификатор передаётся в соответствующем связанном документе с тем же типом '''55''': | |||
## для '''родословной''': ../animalRegistration/'''pedigreeInfo/parent'''/referencedDocument/uuid; | |||
## для '''состава группы''': ../animalRegistration/'''unitInfo/individualMember'''/referencedDocument/uuid; | |||
## для '''членства в группах''': ../animalRegistration/'''membershipInfo/parentGroup'''/referencedDocument/uuid. | |||
# Все запросы с подобной организацией связей могут быть отправлены параллельно '''в любом порядке'''. | |||
# Если в переданном запросе содержатся сведения о '''ещё незарегистрированных животных (группах животных)''', то в компоненте Хорриот будет создана учётная карточка в статусе '''PREPARING (в обработке)'''. | |||
# Как только будут обработаны параллельные запросы, в которых содержатся '''все необходимые для текущей карточки сведения''', то компонент Хорриот зарегистрирует все связи, а учётная карточка перейдёт в статус '''ACTIVE (действующая учётная карточка)'''. | |||
<br /> | <br /> | ||
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%"> | <div class="toccolours mw-collapsible mw-collapsed" style="width:100%"> | ||
Примеры передачи внешних идентификаторов | |||
<div class = "mw-collapsible-content"> | <div class = "mw-collapsible-content"> | ||
<syntaxhighlight lang="xml"> | <syntaxhighlight lang="xml"> | ||
... | ... | ||
<!-- Родословная --> | |||
<vd:pedigreeInfo> | |||
<vd:parent> | |||
<vd:referencedDocument> | |||
<bs:uuid>65902137-ff15-494e-845d-d7eed68e363b</bs:uuid> | |||
<vd:type>55</vd:type> | |||
<vd:relationshipType>6</vd:relationshipType> | |||
</vd:referencedDocument> | |||
</vd:parent> | |||
<vd:parent> | |||
<vd:referencedDocument> | |||
<bs:uuid>81f07799-aa4b-4f11-a8dc-ff42873ade59</bs:uuid> | |||
<vd:type>55</vd:type> | |||
<vd:relationshipType>6</vd:relationshipType> | |||
</vd:referencedDocument> | |||
</vd:parent> | |||
</vd:pedigreeInfo> | |||
<!-- Сведения о составе группы --> | |||
<vd:unitInfo> | |||
<vd:individualMember> | |||
<vd:referencedDocument> | |||
<bs:uuid>22e39540-6889-45ee-9505-3c7f6f5746db</bs:uuid> | |||
<vd:type>55</vd:type> | |||
<vd:relationshipType>6</vd:relationshipType> | |||
</vd:referencedDocument> | |||
</vd:individualMember> | |||
<vd:individualMember> | |||
<vd:referencedDocument> | |||
<bs:uuid>357c48c4-522e-47a4-b754-881d18d8ec67</bs:uuid> | |||
<vd:type>55</vd:type> | |||
<vd:relationshipType>6</vd:relationshipType> | |||
</vd:referencedDocument> | |||
</vd:individualMember> | |||
</vd:unitInfo> | |||
<!-- Сведения о членстве в группах --> | |||
<vd:membershipInfo> | |||
<vd:parentGroup> | |||
<vd:referencedDocument> | |||
<bs:uuid>2cbd008e-6439-4e9a-a2d2-60045216c5f6</bs:uuid> | |||
<vd:type>55</vd:type> | |||
<vd:relationshipType>6</vd:relationshipType> | |||
</vd:referencedDocument> | |||
</vd:parentGroup> | |||
<vd:parentGroup> | |||
<vd:referencedDocument> | |||
<bs:uuid>4d3277d0-7ba5-4731-a73d-5df7d756e7ce</bs:uuid> | |||
<vd:type>55</vd:type> | |||
<vd:relationshipType>6</vd:relationshipType> | |||
</vd:referencedDocument> | |||
</vd:parentGroup> | |||
</vd:membershipInfo> | |||
... | ... | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Строка 45: | Строка 123: | ||
<br /> | <br /> | ||
=== Использование идентификаторов учетных карточек компонента | === Использование идентификаторов учетных карточек компонента Хорриот для построения связей === | ||
'''Общая схема процесса''': | |||
# Каждый запрос на регистрацию учётной карточки формируется и отправляется '''в строгом порядке''' таким образом, чтобы все сведения, требуемые для последующих запросов, '''были уже зарегистрированы''' в компоненте Хорриот. | |||
# После отправки каждого запроса необходимо ожидать окончания регистрации и ответа с идентификатором карточки компонента Хорриот ('''../animalRegistration/guid'''). | |||
# При формировании новых запросов на регистрацию в зависимости от требуемой связи данный идентификатор передаётся в соответствующем объекте: | |||
## для '''родословной''': ../animalRegistration/'''pedigreeInfo/parent'''/guid; | |||
## для '''состава группы''': ../animalRegistration/'''unitInfo/individualMember'''/guid; | |||
## для '''членства в группах''': ../animalRegistration/'''membershipInfo/parentGroup'''/guid. | |||
--> | <br /> | ||
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%"> | |||
Примеры передачи идентификаторов компонента Хорриот | |||
<div class = "mw-collapsible-content"> | |||
<syntaxhighlight lang="xml"> | |||
... | |||
<!-- Родословная --> | |||
<vd:pedigreeInfo> | |||
<vd:parent> | |||
<bs:guid>a80af715-3f45-4ea6-828a-77859a78bf0e</bs:guid> | |||
</vd:parent> | |||
<vd:parent> | |||
<bs:guid>2982b8b2-3f97-4b37-a7e6-2fe19fcf51c3</bs:guid> | |||
</vd:parent> | |||
</vd:pedigreeInfo> | |||
<!-- Сведения о составе группы --> | |||
<vd:unitInfo> | |||
<vd:individualMember> | |||
<bs:guid>07b613f8-c0a0-4845-8f08-354585c4779f</bs:guid> | |||
</vd:individualMember> | |||
<vd:individualMember> | |||
<bs:guid>eccffd43-069e-4810-9cc2-cde4ed44d7f3</bs:guid> | |||
</vd:individualMember> | |||
</vd:unitInfo> | |||
<!-- Сведения о членстве в группах --> | |||
<vd:membershipInfo> | |||
<vd:parentGroup> | |||
<bs:guid>e23a5f70-1fc2-4e3e-a48f-862977f66c9d</bs:guid> | |||
</vd:parentGroup> | |||
<vd:parentGroup> | |||
<bs:guid>40dc684f-a768-414d-9131-a2d72c5b096a</bs:guid> | |||
</vd:parentGroup> | |||
</vd:membershipInfo> | |||
... | |||
</syntaxhighlight> | |||
</div> | |||
</div> | |||
<br /> | |||
== Спецификация запроса == | == Спецификация запроса == | ||
Строка 557: | Строка 680: | ||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}specifiedAnimalIdentity>'''}} | |style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}specifiedAnimalIdentity>'''}} | ||
|vd:AnimalIdentity | |vd:AnimalIdentity | ||
|[ | |[0..*] | ||
| style="width:52em;" | |<div class="mw-collapsible mw-collapsed" data-expandtext=" ... " data-collapsetext="свернуть" style="font-weight: bold; width:52em;"> | ||
<span style="white-space:nowrap; font-weight: normal;">Сведения об идентификации животного / группы животных</span> | |||
<div class="mw-collapsible-content" style="font-weight: normal;"> | |||
* Могут быть '''не указаны только для следующих случаев''': | |||
** на животное или группу животных нанесено хотя бы одно средство идентификации с датой маркирования до 01.03.2024 | |||
** животное индивидуальной идентификации (передан объект specifiedAnimal) и причина первичной идентификации - импорт (initialIdentificationType == IMPORT) | |||
* В остальных случаях передача сведений об идентификации животных '''является обязательной'''.</div> | |||
</div> | |||
|- | |- | ||
|071 | |071 | ||
Строка 573: | Строка 703: | ||
<span style="white-space:nowrap; font-weight: normal;">Номер, нанесенный на животное с помощью средства маркирования</span> | <span style="white-space:nowrap; font-weight: normal;">Номер, нанесенный на животное с помощью средства маркирования</span> | ||
<div class="mw-collapsible-content" style="font-weight: normal;"> | <div class="mw-collapsible-content" style="font-weight: normal;"> | ||
* Возможные значения атрибута '''format''': | |||
** UNMM - Формат Уникального номера средства маркирования (УНСМ) в соответствии с утвержденными Правилами маркирования животных РСХН | |||
** OTHER - Другой тип номера ('''значение по умолчанию, если не передано в запросе''') | |||
* Номер '''animalID''' обязателен для следующих типов средства маркирования: | * Номер '''animalID''' обязателен для следующих типов средства маркирования: | ||
** LABEL - Бирка | ** LABEL - Бирка | ||
Строка 668: | Строка 797: | ||
<span style="white-space:nowrap; font-weight: normal;">Описание средства маркирования</span> | <span style="white-space:nowrap; font-weight: normal;">Описание средства маркирования</span> | ||
<div class="mw-collapsible-content" style="font-weight: normal;"> | <div class="mw-collapsible-content" style="font-weight: normal;"> | ||
* | * Может быть опционально указано для следующих типов средства маркирования: | ||
** BRAND (Тавро/Клеймо) | ** BRAND (Тавро/Клеймо) | ||
** TATTOO (Татуировка) | ** TATTOO (Татуировка) | ||
Строка 709: | Строка 838: | ||
|vd:AnimalMarkingEvent | |vd:AnimalMarkingEvent | ||
|[0..*] | |[0..*] | ||
| style="width:52em;" | |<div class="mw-collapsible mw-collapsed" data-expandtext=" ... " data-collapsetext="свернуть" style="font-weight: bold; width:52em;"> | ||
<span style="white-space:nowrap; font-weight: normal;">Сведения о нанесении / выбытии средства маркирования</span> | |||
<div class="mw-collapsible-content" style="font-weight: normal;"> | |||
* Сведения о нанесении средств маркирования могут не указываться '''только''' в случае импорта животного (initialIdentificationType == IMPORT).</div> | |||
</div> | |||
|- | |- | ||
|086 | |086 | ||
Строка 1164: | Строка 1297: | ||
<span style="white-space:nowrap; font-weight: normal;">Дополнительные атрибуты учётной карточки</span> | <span style="white-space:nowrap; font-weight: normal;">Дополнительные атрибуты учётной карточки</span> | ||
<div class="mw-collapsible-content" style="font-weight: normal;"> | <div class="mw-collapsible-content" style="font-weight: normal;"> | ||
* | * классификатор [[Herriot:AdditionalAttribute:v1.0|CL.HRT.1. Дополнительные атрибуты учётной карточки животных]]</div> | ||
</div> | </div> | ||
|- | |- | ||
Строка 1189: | Строка 1322: | ||
|vd:AnimalPedigreeInfo | |vd:AnimalPedigreeInfo | ||
|[0..1] | |[0..1] | ||
| | | style="width:52em;"| Сведения о родословной животного | ||
|- | |- | ||
|156 | |156 | ||
Строка 1439: | Строка 1568: | ||
|- | |- | ||
|191 | |191 | ||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a| | |style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|vd:}}issueNumber>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}issueNumber>'''}} | ||
|bs:String255 | |bs:String255 | ||
|[1..1] | |[1..1] | ||
Строка 1538: | Строка 1667: | ||
|- | |- | ||
|205 | |205 | ||
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''< | |style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|vd:}}occurrenceReason>'''}} | ||
|vd:AnimalLifecycleEventReason | |vd:AnimalLifecycleEventReason | ||
|[0..1] | |[0..1] | ||
Строка 1544: | Строка 1673: | ||
<span style="white-space:nowrap; font-weight: normal;">Основание (причина) выбытия</span> | <span style="white-space:nowrap; font-weight: normal;">Основание (причина) выбытия</span> | ||
<div class="mw-collapsible-content" style="font-weight: normal;"> | <div class="mw-collapsible-content" style="font-weight: normal;"> | ||
* '''Обязательно''' указывать причину для следующих типов выбытия: | |||
** вынужденного убоя (type == AFS) | |||
** | ** падежа (type == DTH)</div> | ||
** | |||
</div> | </div> | ||
|- | |- | ||
|206 | |206 | ||
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}} | |||
|bs:UUID | |||
|[1..1] | |||
|<div class="mw-collapsible mw-collapsed" data-expandtext=" ... " data-collapsetext="свернуть" style="font-weight: bold; width:52em;"> | |||
<span style="white-space:nowrap; font-weight: normal;">Идентификатор причины выбытия</span> | |||
<div class="mw-collapsible-content" style="font-weight: normal;"> | |||
* Классификатор причин ветеринарных событий [[Herriot:VeterinaryEventReason:v1.0|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 - падёж животного, у которого выявлена незаразная болезнь</div> | |||
</div> | |||
|- | |||
|207 | |||
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''</{{color|#660e7a|vd:}}occurrenceReason>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|208 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|vd:}}animalLifecycleEvent>'''}} | |style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|vd:}}animalLifecycleEvent>'''}} | ||
| | | | ||
Строка 1565: | Строка 1710: | ||
| style="width:52em;"| | | style="width:52em;"| | ||
|- | |- | ||
| | |209 | ||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|vd:}}lifecycleEventList>'''}} | |style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|vd:}}lifecycleEventList>'''}} | ||
| | | | ||
Строка 1571: | Строка 1716: | ||
| style="width:52em;"| | | style="width:52em;"| | ||
|- | |- | ||
| | |210 | ||
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:animalRegistration>'''}} | |style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:animalRegistration>'''}} | ||
| | | | ||
Строка 1577: | Строка 1722: | ||
| style="width:52em;"| | | style="width:52em;"| | ||
|- | |- | ||
| | |211 | ||
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</hrt:registerAnimalRequest>'''}} | |style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</hrt:registerAnimalRequest>'''}} | ||
| | | | ||
Строка 1731: | Строка 1876: | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
! # !! Шаблон XML !! Описание шаблона | ! # !! style="text-align:left;"|Шаблон XML !! style="text-align:left;"|Описание шаблона | ||
|- | |- | ||
| style="text-align:center;" |1 | | style="text-align:center;" |1 | ||
Строка 1754: | Строка 1899: | ||
|- | |- | ||
|} | |} | ||
== См. также == | |||
[[#top|Вернуться к началу ↑]]</br> | |||
[[Herriot:Services:v1.0|Вернуться на страницу профиля API Herriot:Services:v1.0]] |
Текущая версия на 10:19, 18 июня 2024
Общие сведения
Код | Описание операции |
---|---|
AMS.HRT.1.1 | Операция предназначена для подачи заявки на регистрацию учётной карточки животного или группы животных, включая сведения об идентификации животного, ввозе на территорию РФ, текущем содержании, потомстве. |
Сценарии операции
Регистрация индивидуального животного
- В случае регистрации индивидуального животного в запросе должен быть передан объект specifiedAnimal.
- Объект specifiedAnimalGroup должен отсутствовать. Если необходимо привязать индивидуальное животное к зарегистрированной группе или группам, то для этого используется объект membershipInfo.
Регистрация группы животных
- В случае регистрации группы животных в запросе должен быть передан объект specifiedAnimalGroup.
- Объект specifiedAnimal должен отсутствовать. Если необходимо включить в состав группы зарегистрированных индивидуальных животных, то для этого используется объект unitInfo.
Ограничения
- Учёт животных в компоненте Хорриот возможен только на поднадзорном объекте (ПО), идентификатор которого передаётся в параметре ../animalRegistration/keepingDetails/operatorSupervisedObject/guid из справочника ES.HRT.2. Реестр поднадзорных объектов.
- Поднадзорный объект (ПО), на котором возможен учёт животных в компоненте Хорриот, должен удовлетворять следующим условиям:
- Статус ПО в реестре Цербер "Подтверждён" (объект ../supervisedObject/registryStatus == VERIFIED).
- Вид ПО входит в список разрешённых видов (справочник ES.HRT.2.5 + список разрешённых видов).
- Вид деятельности ПО входит в список разрешённых видов деятельности (справочник ES.HRT.2.4 + список разрешённых видов деятельности).
Массовая регистрация животных
В случае массовой регистрации животных возможно образование большого количества перекрестных связей различных учётных карточек животных или групп животных между собой (сведения о членстве животных в группах, сведения о составе групп животных, сведения о родословной). Таким образом возникает необходимость соблюдения строгого порядка отправки запросов на регистрацию и ожидания ответов, чтобы построить все необходимые связи (например, родителей животного необходимо зарегистрировать раньше самого этого животного), что может создать определённые трудности при регистрации большого количества животных и групп животных.
Чтобы упростить процесс создания связей при массовой регистрации животных, предусмотрено два варианта передачи сведений:
- Использование внешних идентификаторов учётной системы - в этом случае порядок отправки запросов не важен, регистрация карточки завершится только после того, как будут переданы все прочие карточки животных, которые связаны с текущей.
- Использование идентификаторов компонента Хорриот - в этом случае важно соблюдать порядок отправки запросов, чтобы используемые в текущей карточке связи были уже зарегистрированы в компоненте Хорриот ранее.
Интеграционные решения могут использовать как один из этих вариантов, так и их комбинирование в зависимости от внутренних процессов и объёмов данных.
Использование идентификаторов внешней системы для построения связей
Предусловия:
- На стороне внешней системы должен быть аналог учётной карточки животного (группы животных) со своим уникальным идентификатором вида UUID.
- На стороне внешней системы должны быть организованы все связи между различными учётными карточками.
Общая схема процесса:
- Каждый запрос на регистрацию учётной карточки обязательно содержит внешний идентификатор из предусловия, который передаётся с помощью связанного документа с типом 55 (объект ../animalRegistration/referencedDocument).
- При формировании новых запросов на регистрацию в зависимости от требуемой связи данный идентификатор передаётся в соответствующем связанном документе с тем же типом 55:
- для родословной: ../animalRegistration/pedigreeInfo/parent/referencedDocument/uuid;
- для состава группы: ../animalRegistration/unitInfo/individualMember/referencedDocument/uuid;
- для членства в группах: ../animalRegistration/membershipInfo/parentGroup/referencedDocument/uuid.
- Все запросы с подобной организацией связей могут быть отправлены параллельно в любом порядке.
- Если в переданном запросе содержатся сведения о ещё незарегистрированных животных (группах животных), то в компоненте Хорриот будет создана учётная карточка в статусе PREPARING (в обработке).
- Как только будут обработаны параллельные запросы, в которых содержатся все необходимые для текущей карточки сведения, то компонент Хорриот зарегистрирует все связи, а учётная карточка перейдёт в статус ACTIVE (действующая учётная карточка).
Примеры передачи внешних идентификаторов
...
<!-- Родословная -->
<vd:pedigreeInfo>
<vd:parent>
<vd:referencedDocument>
<bs:uuid>65902137-ff15-494e-845d-d7eed68e363b</bs:uuid>
<vd:type>55</vd:type>
<vd:relationshipType>6</vd:relationshipType>
</vd:referencedDocument>
</vd:parent>
<vd:parent>
<vd:referencedDocument>
<bs:uuid>81f07799-aa4b-4f11-a8dc-ff42873ade59</bs:uuid>
<vd:type>55</vd:type>
<vd:relationshipType>6</vd:relationshipType>
</vd:referencedDocument>
</vd:parent>
</vd:pedigreeInfo>
<!-- Сведения о составе группы -->
<vd:unitInfo>
<vd:individualMember>
<vd:referencedDocument>
<bs:uuid>22e39540-6889-45ee-9505-3c7f6f5746db</bs:uuid>
<vd:type>55</vd:type>
<vd:relationshipType>6</vd:relationshipType>
</vd:referencedDocument>
</vd:individualMember>
<vd:individualMember>
<vd:referencedDocument>
<bs:uuid>357c48c4-522e-47a4-b754-881d18d8ec67</bs:uuid>
<vd:type>55</vd:type>
<vd:relationshipType>6</vd:relationshipType>
</vd:referencedDocument>
</vd:individualMember>
</vd:unitInfo>
<!-- Сведения о членстве в группах -->
<vd:membershipInfo>
<vd:parentGroup>
<vd:referencedDocument>
<bs:uuid>2cbd008e-6439-4e9a-a2d2-60045216c5f6</bs:uuid>
<vd:type>55</vd:type>
<vd:relationshipType>6</vd:relationshipType>
</vd:referencedDocument>
</vd:parentGroup>
<vd:parentGroup>
<vd:referencedDocument>
<bs:uuid>4d3277d0-7ba5-4731-a73d-5df7d756e7ce</bs:uuid>
<vd:type>55</vd:type>
<vd:relationshipType>6</vd:relationshipType>
</vd:referencedDocument>
</vd:parentGroup>
</vd:membershipInfo>
...
Использование идентификаторов учетных карточек компонента Хорриот для построения связей
Общая схема процесса:
- Каждый запрос на регистрацию учётной карточки формируется и отправляется в строгом порядке таким образом, чтобы все сведения, требуемые для последующих запросов, были уже зарегистрированы в компоненте Хорриот.
- После отправки каждого запроса необходимо ожидать окончания регистрации и ответа с идентификатором карточки компонента Хорриот (../animalRegistration/guid).
- При формировании новых запросов на регистрацию в зависимости от требуемой связи данный идентификатор передаётся в соответствующем объекте:
- для родословной: ../animalRegistration/pedigreeInfo/parent/guid;
- для состава группы: ../animalRegistration/unitInfo/individualMember/guid;
- для членства в группах: ../animalRegistration/membershipInfo/parentGroup/guid.
Примеры передачи идентификаторов компонента Хорриот
...
<!-- Родословная -->
<vd:pedigreeInfo>
<vd:parent>
<bs:guid>a80af715-3f45-4ea6-828a-77859a78bf0e</bs:guid>
</vd:parent>
<vd:parent>
<bs:guid>2982b8b2-3f97-4b37-a7e6-2fe19fcf51c3</bs:guid>
</vd:parent>
</vd:pedigreeInfo>
<!-- Сведения о составе группы -->
<vd:unitInfo>
<vd:individualMember>
<bs:guid>07b613f8-c0a0-4845-8f08-354585c4779f</bs:guid>
</vd:individualMember>
<vd:individualMember>
<bs:guid>eccffd43-069e-4810-9cc2-cde4ed44d7f3</bs:guid>
</vd:individualMember>
</vd:unitInfo>
<!-- Сведения о членстве в группах -->
<vd:membershipInfo>
<vd:parentGroup>
<bs:guid>e23a5f70-1fc2-4e3e-a48f-862977f66c9d</bs:guid>
</vd:parentGroup>
<vd:parentGroup>
<bs:guid>40dc684f-a768-414d-9131-a2d72c5b096a</bs:guid>
</vd:parentGroup>
</vd:membershipInfo>
...
Спецификация запроса
# | Название 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> | vd:AnimalRegistration | [1..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> | 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:supervisedObject> | dt:SupervisedObject | [1..1] | Поднадзорный объект
|
035 | ···············<bs:guid>?</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор записи |
036 | ············</dt:supervisedObject> | |||
037 | ·········</dt:birthLocation> | |||
038 | ·········<dt:photo> | bs:File | [0..1] | Фото животного |
039 | ············<bs:id>?</bs:id> | bs:Identifier | [1..1] | Идентификатор загруженного файла |
040 | ·········</dt:photo> | |||
041 | ······</vd:specifiedAnimal> | |||
042 | ······<vd:specifiedAnimalGroup> | dt:AnimalGroup | [0..1] | Сведения о животном (в случае групповой идентификации)
|
043 | ·········<dt:species> | dt:AnimalSpecies | [1..1] | Биологический вид животного
|
044 | ············<bs:guid>?</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор записи |
045 | ·········</dt:species> | |||
046 | ·········<dt:breed> | dt:AnimalBreed | [0..1] | Порода животного
|
047 | ············<bs:guid>?</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор записи |
048 | ·········</dt:breed> | |||
049 | ·········<dt:gender>?</dt:gender> | dt:AnimalGender | [1..1] | Пол животного Возможные значения:
|
050 | ·········<dt:size>?</dt:size> | xs:nonNegativeInteger | [1..1] | Численность группы животных |
051 | ·········<dt:weight> | dt:Measure | [0..1] | Суммарный вес животных
|
052 | ············<dt:value>?</dt:value> | bs:Decimal | [1..1] | Значение веса животного |
053 | ············<dt:unit> | dt:Unit | [1..1] | Единица измерения |
054 | ···············<bs:guid>?</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор записи |
055 | ············</dt:unit> | |||
056 | ·········</dt:weight> | |||
057 | ·········<dt:birthDatePeriod> | bs:ComplexDatePeriod | [0..1] | Интервал дат рождения животных |
058 | ············<bs:startDate> | bs:ComplexDate | [1..1] | Дата начала интервала |
059 | ···············<bs:year>?</bs:year> | bs:Year | [1..1] | Год |
060 | ···············<bs:month>?</bs:month> | bs:Month | [1..1] | Месяц |
061 | ···············<bs:day>?</bs:day> | bs:Day | [0..1] | День |
062 | ············</bs:startDate> | |||
063 | ············<bs:endDate> | bs:ComplexDate | [1..1] | Дата окончания интервала |
064 | ···············<bs:year>?</bs:year> | bs:Year | [1..1] | Год |
065 | ···············<bs:month>?</bs:month> | bs:Month | [1..1] | Месяц |
066 | ···············<bs:day>?</bs:day> | bs:Day | [0..1] | День |
067 | ············</bs:endDate> | |||
068 | ·········</dt:birthDatePeriod> | |||
069 | ······</vd:specifiedAnimalGroup> | |||
070 | ······<vd:specifiedAnimalIdentity> | vd:AnimalIdentity | [0..*] | Сведения об идентификации животного / группы животных
|
071 | ·········<vd:attachedLabel> | dt:AnimalLabel | [1..1] | Сведения о маркировке животного |
072 | ············<dt:animalID format="?">?</dt:animalID> | dt:AnimalID | [0..1] | Номер, нанесенный на животное с помощью средства маркирования
|
073 | ············<dt:type>?</dt:type> | dt:AnimalLabelType | [1..1] | Вид маркировки: основная/дополнительная Возможные значения:
|
074 | ············<dt:markingMeans> | dt:AnimalMarkingMeans | [1..1] | Cредство маркирования |
075 | ···············<dt:type>?</dt:type> | dt:AnimalMarkingMeansType | [1..1] | Тип средства маркирования Возможные значения:
|
076 | ············</dt:markingMeans> | |||
077 | ············<dt:attachmentLocation> | dt:AnimalMarkingLocation | [1..1] | Место нанесения/прикрепления |
078 | ···············<bs:guid>?</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор записи |
079 | ············</dt:attachmentLocation> | |||
080 | ············<dt:description>?</dt:description> | bs:String255 | [0..1] | Описание средства маркирования
|
081 | ············<dt:photo> | bs:File | [0..1] | Фото средства маркирования
|
082 | ···············<bs:id>?</bs:id> | bs:Identifier | [1..1] | Идентификатор загруженного файла |
083 | ············</dt:photo> | |||
084 | ·········</vd:attachedLabel> | |||
085 | ·········<vd:associatedMarkingEvent> | vd:AnimalMarkingEvent | [0..*] | Сведения о нанесении / выбытии средства маркирования
|
086 | ············<vd:type>?</vd:type> | vd:VeterinaryEventType | [1..1] | Тип мероприятия Возможные значения:
|
087 | ············<vd:actualDate> | bs:ComplexDatePeriod | [1..1] | Дата мероприятия |
088 | ···············<bs:date> | bs:ComplexDate | [1..1] | Точное значение даты |
089 | ··················<bs:year>?</bs:year> | bs:Year | [1..1] | Год |
090 | ··················<bs:month>?</bs:month> | bs:Month | [1..1] | Месяц |
091 | ··················<bs:day>?</bs:day> | bs:Day | [0..1] | День |
092 | ···············</bs:date> | |||
093 | ············</dt:actualDate> | |||
094 | ············<vd:operatorBusinessEntity> | dt:BusinessEntity | [0..1] | Сведения о физическом лице / организации, осуществлявшем мероприятие
|
095 | ···············<bs:guid>?</bs:guid> | bs:UUID | [0..1] | Глобальный идентификатор записи |
096 | ···············<dt:inn>?</dt:inn> | bs:String255 | [0..1] | ИНН |
097 | ············</vd:operatorBusinessEntity> | |||
098 | ············<vd:occurrenceReason>?</vd:occurrenceReason> | vd:AnimalMarkingEventReason | [0..1] | Причина выбытия средства маркирования
|
099 | ·········</vd:associatedMarkingEvent> | |||
100 | ······</vd:specifiedAnimalIdentity> | |||
101 | ······<vd:specifiedGeneticPassport> | dt:AnimalGeneticPassport | [0..1] | Сведения о генетической идентификации |
102 | ·········<dt:data>?</dt:data> | bs:String255 | [1..1] | Данные генетической идентификации |
103 | ·········<dt:conclusion>?</dt:conclusion> | bs:String255 | [1..1] | Заключение по генетической идентификации |
104 | ······</vd:specifiedGeneticPassport> | |||
105 | ······<vd:importDetails> | vd:AnimalImportDetails | [0..1] | Данные о ввозе на территорию РФ
|
106 | ·········<vd:importDate> | bs:ComplexDatePeriod | [1..1] | Дата ввоза |
107 | ············<bs:date> | bs:ComplexDate | [0..1] | Точная дата |
108 | ···············<bs:year>?</bs:year> | bs:Year | [1..1] | Год |
109 | ···············<bs:month>?</bs:month> | bs:Month | [1..1] | Месяц |
110 | ···············<bs:day>?</bs:day> | bs:Day | [0..1] | День |
111 | ············</bs:date> | |||
112 | ············<bs:startDate> | bs:ComplexDate | [0..1] | Дата начала интервала |
113 | ···············<bs:year>?</bs:year> | bs:Year | [1..1] | Год |
114 | ···············<bs:month>?</bs:month> | bs:Month | [1..1] | Месяц |
115 | ···············<bs:day>?</bs:day> | bs:Day | [0..1] | День |
116 | ············</bs:startDate> | |||
117 | ············<bs:endDate> | bs:ComplexDate | [0..1] | Дата окончания интервала |
118 | ···············<bs:year>?</bs:year> | bs:Year | [1..1] | Год |
119 | ···············<bs:month>?</bs:month> | bs:Month | [1..1] | Месяц |
120 | ···············<bs:day>?</bs:day> | bs:Day | [0..1] | День |
121 | ············</bs:endDate> | |||
122 | ·········</vd:importDate> | |||
123 | ·········<vd:importCountry> | dt:Country | [1..1] | Страна, из которой было ввезено животное (группа животных)
|
124 | ············<bs:guid>?</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор записи |
125 | ·········</vd:importCountry> | |||
126 | ······</vd:importDetails> | |||
127 | ······<vd:keepingDetails> | vd:AnimalKeepingDetails | [1..1] | Сведения о содержании животного (группы животных) |
128 | ·········<vd:operatorSupervisedObject> | dt:SupervisedObject | [1..1] | Место содержания (поднадзорный объект)
|
129 | ············<bs:guid>?</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор записи |
130 | ·········</vd:operatorSupervisedObject> | |||
131 | ·········<vd:keepingType> | dt:AnimalKeepingType | [1..1] | Тип содержания животного (группы животных)
|
132 | ············<bs:guid>?</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор записи |
133 | ·········</vd:keepingType> | |||
134 | ·········<vd:keepingPurpose> | dt:AnimalKeepingPurpose | [1..*] | Цель содержания животного (группы животных)
|
135 | ············<bs:guid>?</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор записи |
136 | ·········</vd:keepingPurpose> | |||
137 | ·········<vd:facilityDescription>?</vd:facilityDescription> | bs:String255 | [0..1] | Описание объекта (отделение, строение, корпус) содержания |
138 | ······</vd:keepingDetails> | |||
139 | ······<vd:breedingValueType>?</vd:breedingValueType> | dt:AnimalBreedingValueType | [1..1] | Племенная ценность Возможные значения:
|
140 | ······<vd:specifiedProductivity> | dt:AnimalProductivity | [0..*] | Сведения о продуктивности животного (группы животных) |
141 | ·········<dt:subProduct> | dt:SubProduct | [1..1] | Вид получаемой продукции
|
142 | ············<bs:guid>?</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор записи |
143 | ·········</dt:subProduct> | |||
144 | ·········<dt:output> | dt:ComplexMeasure | [1..1] | Значение продуктивности животного по указанному виду продукции |
145 | ············<dt:value>?</dt:value> | bs:Decimal | [1..1] | Значение |
146 | ············<dt:unit> | dt:Unit | [1..1] | Единица измерения
|
147 | ···············<bs:guid>?</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор записи |
148 | ············</dt:unit> | |||
149 | ·········</dt:output> | |||
150 | ······</vd:specifiedProductivity> | |||
151 | ······<vd:additionalAttribute> | dt:UnmeasuredAttribute | [0..*] | Дополнительные атрибуты учётной карточки |
152 | ·········<dt:attrID>?</dt:attrID> | bs:Identifier | [1..1] | Идентификатор атрибута |
153 | ·········<dt:attrValue>?</dt:attrValue> | bs:Text | [1..1] | Значение атрибута |
154 | ······</vd:additionalAttribute> | |||
155 | ······<vd:pedigreeInfo> | vd:AnimalPedigreeInfo | [0..1] | Сведения о родословной животного |
156 | ·········<vd:parent> | vd:AnimalRegistration | [1..*] | Идентификатор карточки учёта животного, являющегося родителем зарегистрированного животного
|
157 | ············<bs:guid>?</bs:guid> | bs:UUID | [0..1] | Идентификатор зарегистрированной карточки животного |
158 | ············<vd:referencedDocument> | vd:ReferencedDocument | [0..1] | Сведения о связанном документе |
159 | ···············<bs:uuid>?</bs:uuid> | bs:UUID | [1..1] | Идентификатор документа (значение внешнего идентификатора карточки) |
160 | ···············<vd:type>55</vd:type> | dt:DocumentType | [1..1] | Тип документа (55 - внешний идентификатор карточки) |
161 | ···············<vd:relationshipType>6</vd:relationshipType> | dt:ReferenceType | [1..1] | Тип связи документа |
162 | ············</vd:referencedDocument> | |||
163 | ·········</vd:parent> | |||
164 | ······</vd:pedigreeInfo> | |||
165 | ······<vd:unitInfo> | vd:AnimalUnitInfo | [0..1] | Сведения об индивидуальных животных, входящих в состав группы |
166 | ·········<vd:individualMember> | vd:AnimalRegistration | [1..*] | Идентификатор карточки индивидуального учёта животного
|
167 | ············<bs:guid>?</bs:guid> | bs:UUID | [0..1] | Идентификатор зарегистрированной карточки животного |
168 | ············<vd:referencedDocument> | vd:ReferencedDocument | [0..1] | Сведения о связанном документе |
169 | ···············<bs:uuid>?</bs:uuid> | bs:UUID | [1..1] | Идентификатор документа (значение внешнего идентификатора карточки) |
170 | ···············<vd:type>55</vd:type> | dt:DocumentType | [1..1] | Тип документа (55 - внешний идентификатор карточки) |
171 | ···············<vd:relationshipType>6</vd:relationshipType> | dt:ReferenceType | [1..1] | Тип связи документа |
172 | ············</vd:referencedDocument> | |||
173 | ·········</vd:individualMember> | |||
174 | ······</vd:unitInfo> | |||
175 | ······<vd:membershipInfo> | vd:AnimalGroupMembershipInfo | [0..1] | Сведения о членстве в зарегистрированных группах животных |
176 | ·········<vd:parentGroup> | vd:AnimalRegistration | [1..*] | Идентификатор карточки группового учёта животного
|
177 | ············<bs:guid>?</bs:guid> | bs:UUID | [0..1] | Идентификатор зарегистрированной карточки животного |
178 | ············<vd:referencedDocument> | vd:ReferencedDocument | [0..1] | Сведения о связанном документе |
179 | ···············<bs:uuid>?</bs:uuid> | bs:UUID | [1..1] | Идентификатор документа (значение внешнего идентификатора карточки) |
180 | ···············<vd:type>55</vd:type> | dt:DocumentType | [1..1] | Тип документа (55 - внешний идентификатор карточки) |
181 | ···············<vd:relationshipType>6</vd:relationshipType> | dt:ReferenceType | [1..1] | Тип связи документа |
182 | ············</vd:referencedDocument> | |||
183 | ·········</vd:parentGroup> | |||
184 | ······</vd:membershipInfo> | |||
185 | ······<vd:referencedDocument> | vd:ReferencedDocument | [1..1] | Сведения о связанном документе |
186 | ·········<bs:uuid>?</bs:uuid> | bs:UUID | [1..1] | Идентификатор документа (значение внешнего идентификатора карточки)
|
187 | ·········<vd:type>55</vd:type> | dt:DocumentType | [1..1] | Тип документа (55 - внешний идентификатор карточки) |
188 | ·········<vd:relationshipType>6</vd:relationshipType> | dt:ReferenceType | [1..1] | Тип связи документа |
189 | ······</vd:referencedDocument> | |||
190 | ······<vd:referencedDocument> | vd:ReferencedDocument | [0..1] | Сведения о связанном документе
|
191 | ·········<vd:issueNumber>?</vd:issueNumber> | bs:String255 | [1..1] | Номер документа |
192 | ·········<vd:type>56</vd:type> | dt:DocumentType | [1..1] | Тип документа (56 - иностранный идентификационный номер животного) |
193 | ·········<vd:relationshipType>6</vd:relationshipType> | dt:ReferenceType | [1..1] | Тип связи документа |
194 | ······</vd:referencedDocument> | |||
195 | ······<vd:lifecycleEventList> | vd:AnimalLifecycleEventList | [0..1] | Сведения о выбытии животных
|
196 | ·········<vd:animalLifecycleEvent> | vd:AnimalLifecycleEvent | [1..1] | Событие выбытия |
197 | ············<vd:type>?</vd:type> | vd:VeterinaryEventType | [1..1] | Тип выбытия Возможные значения:
|
198 | ············<vd:actualDate> | bs:ComplexDatePeriod | [1..1] | Дата события |
199 | ···············<bs:date> | bs:ComplexDate | [1..1] | Точная дата |
200 | ··················<bs:year>?</bs:year> | bs:Year | [1..1] | Год |
201 | ··················<bs:month>?</bs:month> | bs:Month | [1..1] | Месяц |
202 | ··················<bs:day>?</bs:day> | bs:Day | [1..1] | День |
203 | ···············</bs:date> | |||
204 | ············</vd:actualDate> | |||
205 | ············<vd:occurrenceReason> | vd:AnimalLifecycleEventReason | [0..1] | Основание (причина) выбытия
|
206 | ···············<bs:guid>?</bs:guid> | bs:UUID | [1..1] | Идентификатор причины выбытия
|
207 | ············</vd:occurrenceReason> | |||
208 | ·········</vd:animalLifecycleEvent> | |||
209 | ······</vd:lifecycleEventList> | |||
210 | ···</hrt:animalRegistration> | |||
211 | </hrt:registerAnimalRequest> |
Спецификация ответа
# | Название XML-элемента | Тип | Обязат. | Описание (нажмите [...] для отображения дополнительного описания) |
---|---|---|---|---|
001 | <hrt:registerAnimalResponse> | |||
002 | ···<hrt:animalRegistration> | vd:AnimalRegistration | [1..1] | Сведения регистрации (учётная карточка) животного или группы животных |
003 | ······<bs:uuid>?</bs:uuid> | bs:UUID | [1..1] | Идентификатор версии записи |
004 | ······<bs:guid>?</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор записи |
005 | ······<bs:active>?</bs:active> | xs:boolean | [1..1] | Флаг: является ли запись активной |
006 | ······<bs:last>?</bs:last> | xs:boolean | [1..1] | Флаг: является ли версия последней |
007 | ······<bs:status>?</bs:status> | bs:VersionStatus | [1..1] | Статус версии записи |
008 | ······<bs:createDate>?</bs:createDate> | xs:dateTime | [1..1] | Дата создания записи |
009 | ······<bs:updateDate>?</bs:updateDate> | xs:dateTime | [1..1] | Дата последнего изменения записи |
010 | ······<bs:previous>?</bs:previous> | bs:UUID | [0..1] | Идентификатор предыдущей версии записи |
011 | ······<bs:next>?</bs:next> | bs:UUID | [0..1] | Идентификатор следующей версии записи |
012 | ······<vd:identityType>?</vd:identityType> | vd:AnimalIdentityType | [1..1] | Тип идентификации/учёта: индивидуальная/групповая Возможные значения:
|
013 | ······<vd:registrationNumber>?</vd:registrationNumber> | dt:AnimalID | [0..1] | Регистрационный номер учётной карточки животного (группы животных)
|
014 | ······<vd:registrationStatus>?</vd:registrationStatus> | vd:AnimalRegistrationStatus | [1..1] | Статус учётной карточки животного (группы животных) Возможные значения:
|
015 | ······<vd:initialIdentificationType>?</vd:initialIdentificationType> | vd:AnimalIdentificationEventType | [1..1] | Причина первичной идентификации: рождение, импорт, другое Возможные значения:
|
016 | ···</hrt:animalRegistration> | |||
017 | </hrt:registerAnimalResponse> |
Примеры запросов
Данные примеры являются шаблонами для демонстрации возможной структуры запросов / ответов. В них могут содержаться случайно сгенерированные данные.
# | Шаблон XML | Описание шаблона |
---|---|---|
1 | AMS.HRT.1.1-EX.1.RQ.xml | Регистрация индивидуального животного (без связей с другими учётными карточками) |
2 | AMS.HRT.1.1-EX.2.RQ.xml | Регистрация группы животных (без связей с другими учётными карточками) |
3 | AMS.HRT.1.1-EX.3.RQ.xml | Регистрация индивидуального животного с членством в зарегистрированной группе животных |
4 | AMS.HRT.1.1-EX.4.RQ.xml | Регистрация индивидуального животного с членством в ещё не зарегистрированной группе животных с помощью внешних идентификаторов |
5 | AMS.HRT.1.1-EX.5.RQ.xml | Регистрация группы животных с передачей сведений о членстве в данной группе зарегистрированных индивидуальных животных |
См. также
Вернуться к началу ↑
Вернуться на страницу профиля API Herriot:Services:v1.0