Herriot:VerifyAnimalID:v1.0

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

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

Код Описание операции
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