Herriot:VerifyAnimalID:v1.0: различия между версиями

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
 
(не показаны 2 промежуточные версии этого же участника)
Строка 98: Строка 98:


== Спецификация ответа ==
== Спецификация ответа ==
{| class="wikitable"
|-
! Легенда !! Описание
|-
| style="text-align:center;"|{{color|#ff0000|'''[NEW]'''}} || Новый объект / параметр, который не поддерживается в релизной версии сервиса и '''будет доступен в следующих версиях'''.
|-
|}


{| class="wikitable"
{| class="wikitable"
Строка 142: Строка 150:
|[0..1]
|[0..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Тип средства маркирования</span>
<span style="white-space:nowrap; font-weight: normal;">{{color|#ff0000|'''[NEW]'''}} Тип средства маркирования</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
<div class="mw-collapsible-content" style="font-weight: normal;">
* Возможные значения:
* Возможные значения:
Строка 163: Строка 171:
|-
|-
|006
|006
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}status>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}status>'''}}
|dt:AnimalIDStatus
|[1..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" 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;">
* Возможные значения:
** UNKNOWN - неизвестный номер (не найдено данных об указанном в запросе номере средства маркирования или номер указан неверно)
** EMITTED - номер выпущен
** PRODUCED - изготовлено средство маркирования с данным номером
** ACTIVE - номер нанесён (используется)
** TERMINATED - номер выбыл (не используется)</div>
</div>
|-
|007
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}region>'''}}
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}region>'''}}
|dt:Region
|dt:Region
|[0..1]
|[0..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Регион, в котором зарегистрировано животное с данным номером средства маркирования</span>
<span style="white-space:nowrap; font-weight: normal;">{{color|#ff0000|'''[NEW]'''}} Регион, в котором зарегистрировано животное с данным номером средства маркирования</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
<div class="mw-collapsible-content" style="font-weight: normal;">
* Регион возвращается для следующих статусов средства маркирования (status):
* Регион возвращается для следующих статусов средства маркирования (status):
Строка 174: Строка 197:
</div>
</div>
|-
|-
|007
|008
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|bs:UUID
|bs:UUID
|[1..1]
|[1..1]
| style="width:52em;"| Глобальный идентификатор записи
| style="width:52em;"|{{color|#ff0000|'''[NEW]'''}} Глобальный идентификатор записи
|-
|-
|008
|009
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}region>'''}}
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}region>'''}}
|
|
|
|
| style="width:52em;"|  
| style="width:52em;"|  
|-
|009
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}status>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}status>'''}}
|dt:AnimalIDStatus
|[1..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" 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;">
* Возможные значения:
** UNKNOWN - неизвестный номер (не найдено данных об указанном в запросе номере средства маркирования или номер указан неверно)
** EMITTED - номер выпущен
** PRODUCED - изготовлено средство маркирования с данным номером
** ACTIVE - номер нанесён (используется)
** TERMINATED - номер выбыл (не используется)</div>
</div>
|-
|-
|010
|010
Строка 258: Строка 266:
|[0..1]
|[0..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Список связанных учётных карточек животных</span>
<span style="white-space:nowrap; font-weight: normal;">{{color|#ff0000|'''[NEW]'''}} Список связанных учётных карточек животных</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
<div class="mw-collapsible-content" style="font-weight: normal;">
* Список учетных карточек животных / групп животных возвращается в случае:
* Список учетных карточек животных / групп животных возвращается в случае:
Строка 269: Строка 277:
|vd:AnimalRegistration
|vd:AnimalRegistration
|[1..*]
|[1..*]
| style="width:52em;"| Учётная карточка животного / группы животных
| style="width:52em;"| {{color|#ff0000|'''[NEW]'''}} Учётная карточка животного / группы животных
|-
|-
|018
|018
Строка 275: Строка 283:
|bs:UUID
|bs:UUID
|[1..1]
|[1..1]
| style="width:52em;"| Глобальный идентификатор записи
| style="width:52em;"| {{color|#ff0000|'''[NEW]'''}} Глобальный идентификатор записи
|-
|-
|019
|019
Строка 281: Строка 289:
|dt:AnimalID
|dt:AnimalID
|[1..1]
|[1..1]
| style="width:52em;"| Регистрационный номер учётной карточки животного (группы животных)
| style="width:52em;"| {{color|#ff0000|'''[NEW]'''}} Регистрационный номер учётной карточки животного (группы животных)
|-
|-
|020
|020
Строка 287: Строка 295:
|vd:AnimalIdentity
|vd:AnimalIdentity
|[1..1]
|[1..1]
| style="width:52em;"| Сведения об идентификации животного
| style="width:52em;"| {{color|#ff0000|'''[NEW]'''}} Сведения об идентификации животного
|-
|-
|021
|021
Строка 293: Строка 301:
|dt:AnimalLabel
|dt:AnimalLabel
|[1..1]
|[1..1]
| style="width:52em;"| Сведения о маркировке животного
| style="width:52em;"| {{color|#ff0000|'''[NEW]'''}} Сведения о маркировке животного
|-
|-
|022
|022
Строка 300: Строка 308:
|[1..1]
|[1..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Номер, нанесенный на животное с помощью средства маркирования</span>
<span style="white-space:nowrap; font-weight: normal;">{{color|#ff0000|'''[NEW]'''}} Номер, нанесенный на животное с помощью средства маркирования</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
<div class="mw-collapsible-content" style="font-weight: normal;">
* Номер UNMM</div>
* Номер UNMM</div>
Строка 321: Строка 329:
|vd:AnimalKeepingDetails
|vd:AnimalKeepingDetails
|[1..1]
|[1..1]
| style="width:52em;"| Сведения о содержании животного (группы животных)
| style="width:52em;"| {{color|#ff0000|'''[NEW]'''}} Сведения о содержании животного (группы животных)
|-
|-
|026
|026
Строка 327: Строка 335:
|dt:SupervisedObject
|dt:SupervisedObject
|[1..1]
|[1..1]
| style="width:52em;"| Место содержания (поднадзорный объект)
| style="width:52em;"| {{color|#ff0000|'''[NEW]'''}} Место содержания (поднадзорный объект)
|-
|-
|027
|027
Строка 333: Строка 341:
|bs:UUID
|bs:UUID
|[1..1]
|[1..1]
| style="width:52em;"| Глобальный идентификатор ПО
| style="width:52em;"| {{color|#ff0000|'''[NEW]'''}} Глобальный идентификатор ПО
|-
|-
|028
|028
Строка 339: Строка 347:
|bs:Identifier
|bs:Identifier
|[1..1]
|[1..1]
| style="width:52em;"| Регистрационный номер предприятия в реестре ПО
| style="width:52em;"| {{color|#ff0000|'''[NEW]'''}} Регистрационный номер предприятия в реестре ПО
|-
|-
|029
|029
Строка 348: Строка 356:
|-
|-
|030
|030
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|vd:}}keepingDetails>'''}}
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|vd:}}keepingDetails>'''}}
|
|
|
|

Текущая версия на 08:09, 9 декабря 2024

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

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

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <hrt:verifyAnimalIDRequest>
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:animalIDList> dt:UnifiedAnimalIDList [1..1] Список номеров средств маркирования для проверки
007 ······<dt:animalIDContent> dt:UnifiedAnimalID [1..*] Сведения о номере средства маркирования
008 ·········<dt:animalID format="?">?</dt:animalID> dt:AnimalID [1..1]

Номер средства маркирования определенного формата (ISO или UNMM)

  • Возможные значения атрибута format:
    • @format = "UNMM" - полный номер средства маркирования, по которому будет выполнен поиск номера ISO.
    • @format = "ISO" - цифровой номер средства маркирования формата ISO, по которому будет выполнен поиск номера UNMM.
009 ······</dt:animalIDContent>
010 ···</hrt:animalIDList>
011 </hrt:verifyAnimalIDRequest>

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

Легенда Описание
[NEW] Новый объект / параметр, который не поддерживается в релизной версии сервиса и будет доступен в следующих версиях.
# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <hrt:verifyAnimalIDResponse>
002 ···<hrt:animalIDList> dt:UnifiedAnimalIDList [1..1] Список номеров средств маркирования
003 ······<dt:animalIDContent> dt:UnifiedAnimalID [1..*] Сведения о номере средства маркирования
004 ·········<dt:animalID format="?">?</dt:animalID> dt:AnimalID [1..2]

Номер средства маркирования

  • Если указанный в запросе номер найден, то возвращается 2 записи animalID с разным значением атрибута format:
    • @format = "UNMM" - полный номер средства маркирования
    • @format = "ISO" - цифровой номер средства маркирования формата ISO
  • Если указанный в запросе номер не найден, то возвращается 1 запись animalID из запроса с соответствующим статусом (status)
005 ·········<dt:type>?</dt:type> dt:AnimalMarkingMeansType [0..1]

[NEW] Тип средства маркирования

  • Возможные значения:
    • LABEL - Бирка
    • MICROCHIP - Вживляемый микрочип
    • BOLUS - Болюс
    • RING - Кольцо
    • ELECTRONIC_RING - Электронное кольцо
    • COLLAR - Ошейник
    • ELECTRONIC_COLAR - Электронный ошейник
    • WING_TAG - Крыло-метка
    • ELECTRONIC_WING_TAG - Электронное крыло-метка
    • ELECTRONIC_TAG - Электронная метка
    • NAMEPLATE - Табло
  • Тип средства маркирования возвращается для следующих статусов средства маркирования (status):
    • PRODUCED - изготовлено средство маркирования с данным номером
    • ACTIVE - номер нанесён (используется)
    • TERMINATED - номер выбыл (не используется)
006 ·········<dt:status>?</dt:status> dt:AnimalIDStatus [1..1]

Статус номера средства маркирования

  • Возможные значения:
    • UNKNOWN - неизвестный номер (не найдено данных об указанном в запросе номере средства маркирования или номер указан неверно)
    • EMITTED - номер выпущен
    • PRODUCED - изготовлено средство маркирования с данным номером
    • ACTIVE - номер нанесён (используется)
    • TERMINATED - номер выбыл (не используется)
007 ·········<dt:region> dt:Region [0..1]

[NEW] Регион, в котором зарегистрировано животное с данным номером средства маркирования

  • Регион возвращается для следующих статусов средства маркирования (status):
    • ACTIVE - номер нанесён (используется)
    • TERMINATED - номер выбыл (не используется)
008 ············<bs:guid>?</bs:guid> bs:UUID [1..1] [NEW] Глобальный идентификатор записи
009 ·········</dt:region>
010 ·········<dt:emissionDate>?</dt:emissionDate> xs:date [0..1]

Дата выпуска номера средства маркирования

  • Не возвращается, если данные о номере из запроса не найдены (status == UNKNOWN)
011 ·········<dt:producingDate>?</dt:producingDate> xs:date [0..1]

Дата производства средства маркирования с указанным номером

  • Может возвращаться для статусов PRODUCED, ACTIVE и TERMINATED
012 ·········<dt:attachmentDate>?</dt:attachmentDate> xs:date [0..1]

Дата нанесения / прикрепления номера средства маркирования

  • Возвращается для статусов ACTIVE и TERMINATED
013 ·········<dt:expiredDate>?</dt:expiredDate> xs:date [0..1]

Дата вывода номера средства маркирования из оборота

  • Возвращается для статуса TERMINATED
014 ······</dt:animalIDContent>
015 ···</hrt:animalIDList>
016 ···<hrt:referencedAnimalRegistrationList> vd:AnimalRegistrationList [0..1]

[NEW] Список связанных учётных карточек животных

  • Список учетных карточек животных / групп животных возвращается в случае:
    • в системе Хорриот существуют учетные карточки с номерами средств маркирования формата UNMM из списка animalIDList
    • указанный в запросе пользователь имеет доступ к обслуживанию ПО, на котором содержатся животное / группа животных из найденных учетных карточек
017 ······<vd:animalRegistration> vd:AnimalRegistration [1..*] [NEW] Учётная карточка животного / группы животных
018 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] [NEW] Глобальный идентификатор записи
019 ·········<vd:registrationNumber>?</vd:registrationNumber> dt:AnimalID [1..1] [NEW] Регистрационный номер учётной карточки животного (группы животных)
020 ·········<vd:specifiedAnimalIdentity> vd:AnimalIdentity [1..1] [NEW] Сведения об идентификации животного
021 ············<vd:attachedLabel> dt:AnimalLabel [1..1] [NEW] Сведения о маркировке животного
022 ···············<dt:animalID format="UNMM">?</dt:animalID> dt:AnimalID [1..1]

[NEW] Номер, нанесенный на животное с помощью средства маркирования

  • Номер UNMM
023 ············</vd:attachedLabel>
024 ·········</vd:specifiedAnimalIdentity>
025 ·········<vd:keepingDetails> vd:AnimalKeepingDetails [1..1] [NEW] Сведения о содержании животного (группы животных)
026 ············<vd:operatorSupervisedObject> dt:SupervisedObject [1..1] [NEW] Место содержания (поднадзорный объект)
027 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] [NEW] Глобальный идентификатор ПО
028 ···············<dt:approvalNumber>?</dt:approvalNumber> bs:Identifier [1..1] [NEW] Регистрационный номер предприятия в реестре ПО
029 ············</vd:operatorSupervisedObject>
030 ·········</vd:keepingDetails>
031 ······</vd:animalRegistration>
032 ···</hrt:referencedAnimalRegistrationList>
033 </hrt:verifyAnimalIDResponse>

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

TODO

См. также

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

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