Herriot:VerifyAnimalID:v1.0

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

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

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

#	Название 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]	Тип средства маркирования Возможные значения: LABEL - Бирка MICROCHIP - Вживляемый микрочип BOLUS - Болюс RING - Кольцо ELECTRONIC_RING - Электронное кольцо COLLAR - Ошейник ELECTRONIC_COLAR - Электронный ошейник WING_TAG - Крыло-метка ELECTRONIC_WING_TAG - Электронное крыло-метка ELECTRONIC_TAG - Электронная метка NAMEPLATE - Табло Тип средства маркирования возвращается для следующих статусов средства маркирования (status): PRODUCED - изготовлено средство маркирования с данным номером ACTIVE - номер нанесён (используется) TERMINATED - номер выбыл (не используется)
006	·········<dt:region>	dt:Region	[0..1]	Регион, в котором зарегистрировано животное с данным номером средства маркирования Регион возвращается для следующих статусов средства маркирования (status): ACTIVE - номер нанесён (используется) TERMINATED - номер выбыл (не используется)
007	············<bs:guid>?</bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор записи
008	·········</dt:region>
009	·········<dt:status>?</dt:status>	dt:AnimalIDStatus	[1..1]	Статус номера средства маркирования Возможные значения: UNKNOWN - неизвестный номер (не найдено данных об указанном в запросе номере средства маркирования или номер указан неверно) EMITTED - номер выпущен PRODUCED - изготовлено средство маркирования с данным номером ACTIVE - номер нанесён (используется) TERMINATED - номер выбыл (не используется)
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]	Список связанных учётных карточек животных Список учетных карточек животных / групп животных возвращается в случае: в системе Хорриот существуют учетные карточки с номерами средств маркирования формата UNMM из списка animalIDList указанный в запросе пользователь имеет доступ к обслуживанию ПО, на котором содержатся животное / группа животных из найденных учетных карточек
017	······<vd:animalRegistration>	vd:AnimalRegistration	[1..*]	Учётная карточка животного / группы животных
018	·········<bs:guid>?</bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор записи
019	·········<vd:registrationNumber>?</vd:registrationNumber>	dt:AnimalID	[1..1]	Регистрационный номер учётной карточки животного (группы животных)
020	·········<vd:specifiedAnimalIdentity>	vd:AnimalIdentity	[1..1]	Сведения об идентификации животного
021	············<vd:attachedLabel>	dt:AnimalLabel	[1..1]	Сведения о маркировке животного
022	···············<dt:animalID format="UNMM">?</dt:animalID>	dt:AnimalID	[0..1]	Номер, нанесенный на животное с помощью средства маркирования Номер UNMM
023	············</vd:attachedLabel>
024	·········</vd:specifiedAnimalIdentity>
025	·········<vd:keepingDetails>	vd:AnimalKeepingDetails	[1..1]	Сведения о содержании животного (группы животных)
026	············<vd:operatorSupervisedObject>	dt:SupervisedObject	[1..1]	Место содержания (поднадзорный объект)
027	···············<bs:guid>?</bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор ПО
028	···············<dt:approvalNumber>?</dt:approvalNumber>	bs:Identifier	[1..1]	Регистрационный номер предприятия в реестре ПО
029	············</vd:operatorSupervisedObject>
030	·········<vd:keepingDetails>
031	······</vd:animalRegistration>
032	···</hrt:referencedAnimalRegistrationList>
033	</hrt:verifyAnimalIDResponse>

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

TODO

См. также

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