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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
 
(не показано 6 промежуточных версий этого же участника)
Строка 5: Строка 5:
|-
|-
| '''AMS.HRT.2.6'''  
| '''AMS.HRT.2.6'''  
| Операция предназначена проверки статусов выпущенных в оборот номеров средств маркирования животных
| Операция предназначена для проверки статусов выпущенных в оборот номеров средств маркирования животных
|-
|-
|}
|}


== Спецификация запроса ==
== Спецификация запроса ==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<hrt:verifyAnimalIDRequest>'''}}
|
|
| style="width:52em;"|
|-
|002
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:localTransactionId>'''}}{{color|#131313|?}}{{color|#190dbf|'''</hrt:localTransactionId>'''}}
|bs:Identifier
|[1..1]
| style="width:52em;"| Идентификатор заявки в клиентской системе
|-
|003
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:initiator>'''}}
|vd:User
|[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;">
* является ответственным за выполнение бизнес-операции
* требуется логин ветврача или пользователя ХС, логин для базовой аутентификации не подойдёт</div>
</div>
|-
|004
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}login>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}login>'''}}
|xs:NCName
|[1..1]
| style="width:52em;"| Логин пользователя
|-
|005
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:initiator>'''}}
|
|
| style="width:52em;"|
|-
|006
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:animalIDList>'''}}
|dt:UnifiedAnimalIDList
|[1..1]
| style="width:52em;"| Список номеров средств маркирования для проверки
|-
|007
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}animalIDContent>'''}}
|dt:UnifiedAnimalID
|[1..*]
| style="width:52em;"| Сведения о номере средства маркирования
|-
|008
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}animalID>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}animalID>'''}}
|dt:AnimalID
|[1..1]
| style="width:52em;"| Полный номер средства маркирования
|-
|009
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|dt:}}animalIDContent>'''}}
|
|
| style="width:52em;"|
|-
|010
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:animalIDList>'''}}
|
|
| style="width:52em;"|
|-
|011
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</hrt:verifyAnimalIDRequest>'''}}
|
|
| style="width:52em;"|
|-
|}


== Спецификация ответа ==
== Спецификация ответа ==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<hrt:verifyAnimalIDResponse>'''}}
|
|
| style="width:52em;"|
|-
|002
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:animalIDList>'''}}
|dt:UnifiedAnimalIDList
|[1..1]
| style="width:52em;"| Список номеров средств маркирования
|-
|003
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}animalIDContent>'''}}
|dt:UnifiedAnimalID
|[1..*]
| style="width:52em;"| Сведения о номере средства маркирования
|-
|004
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}animalID format&#61;{{color|#007f15|"?"}}>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}animalID>'''}}
|dt:AnimalID
|[1..2]
|<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;">
* Если указанный в запросе номер найден, то возвращается 2 записи animalID с разным значением атрибута format:
** @format = "UNMM" - полный номер средства маркирования из запроса
** @format = "ISO" - соответствующий номеру из запроса цифровой номер средства маркирования формата ISO
* Если указанный в запросе номер не найден, то возвращается 1 запись animalID из запроса с соответствующим статусом (status)</div>
</div>
|-
|005
|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>
|-
|006
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}emissionDate>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}emissionDate>'''}}
|xs:date
|[0..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;">
* Не возвращается, если данные о номере из запроса не найдены (status == UNKNOWN)</div>
</div>
|-
|007
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}producingDate>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}producingDate>'''}}
|xs:date
|[0..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;">
* Может возвращаться для статусов для статусов PRODUCED, ACTIVE и TERMINATED</div>
</div>
|-
|008
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}attachmentDate>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}attachmentDate>'''}}
|xs:date
|[0..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;">
* Возвращается для статусов ACTIVE и TERMINATED</div>
</div>
|-
|009
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}expiredDate>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}expiredDate>'''}}
|xs:date
|[0..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;">
* Возвращается для статуса TERMINATED</div>
</div>
|-
|010
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|dt:}}animalIDContent>'''}}
|
|
| style="width:52em;"|
|-
|011
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:animalIDList>'''}}
|
|
| style="width:52em;"|
|-
|012
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</hrt:verifyAnimalIDResponse>'''}}
|
|
| style="width:52em;"|
|-
|}


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

Текущая версия на 05:46, 4 июня 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>?</dt:animalID> dt:AnimalID [1..1] Полный номер средства маркирования
009 ······</dt:animalIDContent>
010 ···</hrt:animalIDList>
011 </hrt:verifyAnimalIDRequest>

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

# Название 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:status>?</dt:status> dt:AnimalIDStatus [1..1]

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

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

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

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

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

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

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

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

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

  • Возвращается для статуса TERMINATED
010 ······</dt:animalIDContent>
011 ···</hrt:animalIDList>
012 </hrt:verifyAnimalIDResponse>

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

TODO

См. также

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

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