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

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


== Спецификация ответа ==
== Спецификация ответа ==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<hrt:checkAnimalMarkingMeansNumberResponse>'''}}
|
|
| style="width:52em;"|
|-
|002
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:animalMarkingMeansNumberList>'''}}
|dt:AnimalMarkingMeansNumberList
|[1..1]
| style="width:52em;"| Список номеров средств маркирования
|-
|003
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}animalMarkingMeansNumber>'''}}
|dt:AnimalMarkingMeansNumber
|[1..*]
| style="width:52em;"| Сведения о номере средства маркирования
|-
|004
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}fullNumber>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}fullNumber>'''}}
|bs:String255
|[1..1]
| style="width:52em;"| Полный номер средства маркирования
|-
|005
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}digitalNumber>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}digitalNumber>'''}}
|xs:positiveInteger
|[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>
|-
|006
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}status>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}status>'''}}
|dt:AnimalMarkingMeansNumberStatus
|[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 - номер выпущен
** ACTIVE - номер нанесён (используется)
** TERMINATED - номер выбыл (не используется)</div>
</div>
|-
|007
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}emissionDate>'''}}
|bs:ComplexDate
|[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>
|-
|008
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}year>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}year>'''}}
|bs:Year
|[1..1]
| style="width:52em;"| Год
|-
|009
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}month>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}month>'''}}
|bs:Month
|[1..1]
| style="width:52em;"| Месяц
|-
|010
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}day>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}day>'''}}
|bs:Day
|[1..1]
| style="width:52em;"| День
|-
|011
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}emissionDate>'''}}
|
|
| style="width:52em;"|
|-
|012
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}attachmentDate>'''}}
|bs:ComplexDate
|[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>
|-
|013
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}year>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}year>'''}}
|bs:Year
|[1..1]
| style="width:52em;"| Год
|-
|014
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}month>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}month>'''}}
|bs:Month
|[1..1]
| style="width:52em;"| Месяц
|-
|015
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}day>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}day>'''}}
|bs:Day
|[1..1]
| style="width:52em;"| День
|-
|016
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}attachmentDate>'''}}
|
|
| style="width:52em;"|
|-
|017
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}expiredDate>'''}}
|bs:ComplexDate
|[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>
|-
|018
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}year>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}year>'''}}
|bs:Year
|[1..1]
| style="width:52em;"| Год
|-
|019
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}month>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}month>'''}}
|bs:Month
|[1..1]
| style="width:52em;"| Месяц
|-
|020
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}day>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}day>'''}}
|bs:Day
|[1..1]
| style="width:52em;"| День
|-
|021
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}expiredDate>'''}}
|
|
| style="width:52em;"|
|-
|022
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|dt:}}animalMarkingMeansNumber>'''}}
|
|
| style="width:52em;"|
|-
|023
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:animalMarkingMeansNumberList>'''}}
|
|
| style="width:52em;"|
|-
|024
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</hrt:checkAnimalMarkingMeansNumberResponse>'''}}
|
|
| style="width:52em;"|
|-
|}


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

Версия 03:41, 22 мая 2024

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

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

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <hrt:checkAnimalMarkingMeansNumberRequest>
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:animalMarkingMeansNumberList> dt:AnimalMarkingMeansNumberList [1..1] Список номеров средств маркирования для проверки
007 ······<dt:animalMarkingMeansNumber> dt:AnimalMarkingMeansNumber [1..*] Сведения о номере средства маркирования
008 ·········<dt:fullNumber>?</dt:fullNumber> bs:String255 [1..1] Полный номер средства маркирования
009 ······</dt:animalMarkingMeansNumber>
010 ···</hrt:animalMarkingMeansNumberList>
011 </hrt:checkAnimalMarkingMeansNumberRequest>

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <hrt:checkAnimalMarkingMeansNumberResponse>
002 ···<hrt:animalMarkingMeansNumberList> dt:AnimalMarkingMeansNumberList [1..1] Список номеров средств маркирования
003 ······<dt:animalMarkingMeansNumber> dt:AnimalMarkingMeansNumber [1..*] Сведения о номере средства маркирования
004 ·········<dt:fullNumber>?</dt:fullNumber> bs:String255 [1..1] Полный номер средства маркирования
005 ·········<dt:digitalNumber>?</dt:digitalNumber> xs:positiveInteger [0..1]

Цифровой номер средства маркирования

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

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

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

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

  • Не возвращается, если данные о номере из запроса не найдены (status == UNKNOWN)
008 ············<bs:year>?</bs:year> bs:Year [1..1] Год
009 ············<bs:month>?</bs:month> bs:Month [1..1] Месяц
010 ············<bs:day>?</bs:day> bs:Day [1..1] День
011 ·········</dt:emissionDate>
012 ·········<dt:attachmentDate> bs:ComplexDate [0..1]

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

  • Возвращается для статусов ACTIVE и TERMINATED
013 ············<bs:year>?</bs:year> bs:Year [1..1] Год
014 ············<bs:month>?</bs:month> bs:Month [1..1] Месяц
015 ············<bs:day>?</bs:day> bs:Day [1..1] День
016 ·········</dt:attachmentDate>
017 ·········<dt:expiredDate> bs:ComplexDate [0..1]

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

  • Возвращается для статуса TERMINATED
018 ············<bs:year>?</bs:year> bs:Year [1..1] Год
019 ············<bs:month>?</bs:month> bs:Month [1..1] Месяц
020 ············<bs:day>?</bs:day> bs:Day [1..1] День
021 ·········</dt:expiredDate>
022 ······</dt:animalMarkingMeansNumber>
023 ···</hrt:animalMarkingMeansNumberList>
024 </hrt:checkAnimalMarkingMeansNumberResponse>

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

TODO

См. также

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