Herriot:Services:v1.0

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

Сервис позволяет вносить в компонент Хорриот информацию, связанную с маркировкой и учетом животных, и получать от компонента Хорриот эту информацию.

Версии профиля API

• v1.0 – Herriot:Services:v1.0
  • v1.0b-20240603 – herriot-schemas-v1.0b-20240603.zip   последняя версия тест
  • v1.0b-20240216 – herriot-schemas-v1.0b-20240216.zip   прод
  • v1.0b-20240116 – herriot-schemas-v1.0b-20240116.zip
  • v1.0b-20231109 – herriot-schemas-v1.0b-20231109.zip

Предоставляемые сервисы

№	Сервис	Описание	WSDL
1	ApplicationManagementService	Подсистема обработки заявок	https://api.vetrf.ru/schema/platform/herriot/v1.0b-last/ams-herriot.service_v1.0.wsdl
2	EnterpriseService	Сервис реестров хозяйствующих субъектов и предприятий	https://api.vetrf.ru/schema/platform/herriot/v1.0b-last/EnterpriseService_v1.0.wsdl
3	DictionaryService	Сервис справочной информации	https://api.vetrf.ru/schema/platform/herriot/v1.0b-last/DictionaryService_v1.0.wsdl
4	ProductService	Сервис реестров категорий продукции	https://api.vetrf.ru/schema/platform/herriot/v1.0b-last/ProductService_v1.0.wsdl
5	IkarService	Сервис получения адресной информации	https://api.vetrf.ru/schema/platform/herriot/v1.0b-last/IkarService_v1.0.wsdl

Операции, доступные для тестирования

№	Название операции	Сервис	Доступно для тестирования
1	RegisterAnimal	ApplicationManagementService	Да
2	ModifyAnimalRegistration	ApplicationManagementService	Да
3	RegisterAnimalMovementEvent	ApplicationManagementService	Да
4	TerminateAnimalRegistration	ApplicationManagementService	Да
5	WithdrawAnimalRegistration	ApplicationManagementService	Да
6	GetAnimalRegistrationByGuid	ApplicationManagementService	Да
7	GetAnimalRegistrationHistory	ApplicationManagementService	Да
8	GetAnimalRegistrationChangesList	ApplicationManagementService	Да
9	GetAnimalRegistrationByUuid	ApplicationManagementService	Да
10	RegisterAnimalIdentity	ApplicationManagementService	Нет
11	RemoveAnimalIdentity	ApplicationManagementService	Да
12	ReplaceAnimalIdentity	ApplicationManagementService	Да
13	WithdrawAnimalIdentity	ApplicationManagementService	Нет
14	VerifyAnimalID	ApplicationManagementService	Да
15	RegisterAnimalVeterinaryEvent	ApplicationManagementService	Нет
16	ModifyAnimalVeterinaryEvent	ApplicationManagementService	Нет
17	ConfirmAnimalVeterinaryEvent	ApplicationManagementService	Нет
18	WithdrawAnimalVeterinaryEvent	ApplicationManagementService	Нет
19	GetAnimalVeterinaryEventByGuid	ApplicationManagementService	Нет
20	GetAnimalVeterinaryEventChangesList	ApplicationManagementService	Нет
21	GetAnimalVeterinaryEventHistory	ApplicationManagementService	Нет
22	GetAnimalVeterinaryEventByUuid	ApplicationManagementService	Нет
23	GetUnitByGuid	DictionaryService	Да
24	GetUnitByUuid	DictionaryService	Да
25	GetUnitList	DictionaryService	Да
26	GetUnitChangesList	DictionaryService	Да
27	GetAnimalSpeciesByGuid	DictionaryService	Да
28	GetAnimalSpeciesByUuid	DictionaryService	Да
29	GetAnimalSpeciesList	DictionaryService	Да
30	GetAnimalSpeciesChangesList	DictionaryService	Да
31	GetAnimalBreedByGuid	DictionaryService	Да
32	GetAnimalBreedByUuid	DictionaryService	Да
33	GetAnimalBreedList	DictionaryService	Да
34	GetAnimalBreedChangesList	DictionaryService	Да
35	GetAnimalKeepingTypeByGuid	DictionaryService	Да
36	GetAnimalKeepingTypeByUuid	DictionaryService	Да
37	GetAnimalKeepingTypeList	DictionaryService	Да
38	GetAnimalKeepingTypeChangesList	DictionaryService	Да
39	GetAnimalKeepingPurposeByGuid	DictionaryService	Да
40	GetAnimalKeepingPurposeByUuid	DictionaryService	Да
41	GetAnimalKeepingPurposeList	DictionaryService	Да
42	GetAnimalKeepingPurposeChangesList	DictionaryService	Да
43	GetAnimalMarkingLocationByGuid	DictionaryService	Да
44	GetAnimalMarkingLocationByUuid	DictionaryService	Да
45	GetAnimalMarkingLocationList	DictionaryService	Да
46	GetAnimalMarkingLocationChangesList	DictionaryService	Да
47	GetBusinessEntityByGuid	EnterpriseService	Да
48	GetBusinessEntityByUuid	EnterpriseService	Да
49	GetBusinessEntityList	EnterpriseService	Да
50	GetBusinessEntityChangesList	EnterpriseService	Да
51	GetEnterpriseByGuid	EnterpriseService	Да
52	GetEnterpriseByUuid	EnterpriseService	Да
53	GetRussianEnterpriseList	EnterpriseService	Да
54	GetRussianEnterpriseChangesList	EnterpriseService	Да
55	GetSupervisedObjectByGuid	EnterpriseService	Да
56	GetSupervisedObjectByUuid	EnterpriseService	Да
57	GetBESupervisedObjectList	EnterpriseService	Да
58	GetSupervisedObjectTypeList	EnterpriseService	Да
59	GetSupervisedObjectActivityList	EnterpriseService	Да
60	GetAllCountryList	IkarService	Да
61	GetCountryByGuid	IkarService	Да
62	GetCountryByUuid	IkarService	Да
63	GetCountryChangesList	IkarService	Да
64	GetRegionListByCountry	IkarService	Да
65	GetRegionByGuid	IkarService	Да
66	GetRegionByUuid	IkarService	Да
67	GetRegionChangesList	IkarService	Да
68	GetDistrictListByRegion	IkarService	Да
69	GetDistrictByGuid	IkarService	Да
70	GetDistrictByUuid	IkarService	Да
71	GetDistrictChangesList	IkarService	Да
72	GetLocalityListByRegion	IkarService	Да
73	GetLocalityListByDistrict	IkarService	Да
74	GetLocalityListByLocality	IkarService	Да
75	GetStreetListByLocality	IkarService	Да
76	FindLocalityListByName	IkarService	Да
77	FindStreetListByName	IkarService	Да
78	GetLocalityChangesList	IkarService	Да
79	GetStreetChangesList	IkarService	Да
80	GetProductByGuid	ProductService	Да
81	GetProductByUuid	ProductService	Да
82	GetProductByTypeList	ProductService	Да
83	GetProductChangesList	ProductService	Да
84	GetSubProductByGuid	ProductService	Да
85	GetSubProductByUuid	ProductService	Да
86	GetSubProductByProductList	ProductService	Да
87	GetSubProductChangesList	ProductService	Да

Структура XSD

Базовые типы данных:

XSD-схема	Пространство имен
base_v2.1.xsd	xmlns:bs="http://api.vetrf.ru/schema/cdm/base"

Прикладные типы данных:

XSD-схема	Пространство имен
dictionary_v2.5.xsd	xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2"
document_v2.5.xsd	xmlns:vd="http://api.vetrf.ru/schema/cdm/mercury/vet-document/v2"
codelist_v2.5r3.xsd	xmlns:cl="http://api.vetrf.ru/schema/cdm/codelist/v2"

Профиль API интеграционного шлюза ВетИС.API для компонента Хорриот:

XSD-схема	Пространство имен
herriot_applications_v1.0.xsd	xmlns:hrt="http://api.vetrf.ru/schema/cdm/herriot/applications/v1"

Профиль API справочников и реестров:

XSD-схема	Пространство имен
registry_ws_definitions_v2.5.xsd	xmlns:ws="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2"

Типы данных транспортного уровня интеграционного шлюза ВетИС.API:

XSD-схема	Пространство имен
application_v2.1.xsd	xmlns:apl="http://api.vetrf.ru/schema/cdm/application"
application_ws_definitions_v2.1.xsd	xmlns:apldef="http://api.vetrf.ru/schema/cdm/application/ws-definitions"
base_ws_definitions_v2.1.xsd	xmlns:bsdef="http://api.vetrf.ru/schema/cdm/base/ws-definitions"

ApplicationManagementService (подсистема обработки заявок)

Параметры подключения

Продуктивный контур WSDL https://api.vetrf.ru/schema/platform/herriot/v1.0b-20240216/ams-herriot.service_v1.0.wsdl URL точки доступа (Endpoint) https://api.vetrf.ru/platform/services/2.1/ApplicationManagementService Описание типов заявок включено в WSDL Код сервиса (serviceId) herriot.service:1.0

Тестовый контур WSDL https://api.vetrf.ru/schema/platform/herriot/v1.0b-last/ams-herriot.service_v1.0.wsdl URL точки доступа (Endpoint) https://api2.vetrf.ru:8002/platform/services/2.1/ApplicationManagementService Описание типов заявок включено в WSDL Код сервиса (serviceId) herriot.service:1.0

Основные сущности и типы данных

Операции, выполняемые через ApplicationManagementService

Код	Название операции / ссылка на спецификацию	Описание операции ([ ... ] – входные и выходные данные, сценарии)
Операции по работе с учетной карточкой животного (группы животных) | Код: AMS.HRT.1
AMS.HRT.1.1.	RegisterAnimal	Регистрация животного или группы животных Входные данные: проект регистрационной карточки животного или группы животных, включая сведения об идентификации животного, ввозе на территорию РФ, текущем содержании, потомстве Выходные данные: зарегистрированная карточка животного или группы животного в статусе PREPARING или ACTIVE
AMS.HRT.1.2.	ModifyAnimalRegistration	Внесение изменений в основные сведения о зарегистрированном животном или группе животных Входные данные: проект изменений существующей регистрационной карточки с указанным идентификатором версии Выходные данные: обновленная карточка животного или группы животных в статусе ACTIVE
AMS.HRT.1.3.	RegisterAnimalMovementEvent	Регистрация сведения о перемещении/смене собственника зарегистрированного животного или групп животных Входные данные: сведения о перемещении сведения перемещаемых зарегистрированных животных или группах животных Выходные данные: обновленная карточка животного или группы животных в статусе RELOCATING или ACTIVE
AMS.HRT.1.4.	TerminateAnimalRegistration	Прекращение регистрации животного или группы животных (выбытие животного) Входные данные: сведения о выбытии животного сведения о зарегистрированных животных или группах животных, в отношении которых регистрируется выбытие Выходные данные: обновленная карточка животного или группы животных в статусе TERMINATED
AMS.HRT.1.5.	WithdrawAnimalRegistration	Аннулирование сведений о регистрации животного или группы животных Входные данные: сведения об аннулировании регистрационной карточки животного сведения о зарегистрированных животных или группах животных Выходные данные: обновленная карточка животного или группы животных в статусе WITHDRAWN
AMS.HRT.1.6.	GetAnimalRegistrationByGuid	Получение основных актуальных сведений о регистрации животного или группы животных по глобальному идентификатору Входные данные: глобальный идентификатор регистрационной карточки животного или группы животных Выходные данные: актуальная редакция регистрационной карточки животного или группы животных без сведений о ветеринарных профилактических мероприятиях
AMS.HRT.1.8.	GetAnimalRegistrationHistory	Получение всей истории изменений сведений о регистрации животного или группы животных по глобальному идентификатору Входные данные: глобальный идентификатор регистрационной карточки животного или группы животных Выходные данные: список версий регистрационной карточки животного или группы животных
AMS.HRT.1.9.	GetAnimalRegistrationChangesList	Получение списка изменений по основным сведениям о регистрации животных или групп животных за указанный период Входные данные: интервал дат, определяющий запрашиваемый период изменений зона обслуживания: субъект РФ, на территории которого содержатся животные зона обслуживания: место содержания животных поднадзорный объект, на котором осуществляется содержание животных Выходные данные: список созданных за указанный период времени версий регистрационных карточек животных или групп животных, которые содержатся в указанной зоне обслуживания
AMS.HRT.1.10.	GetAnimalRegistrationByUuid	Получение редакции основных сведений о регистрации животного или группы животных по идентификатору конкретной версии (редакции) Входные данные: уникальный идентификатор версии регистрационной карточки животного или группы животных Выходные данные: сведения о запрашиваемой версии регистрационной карточки животного или группы животных без сведений о ветеринарных профилактических мероприятиях
AMS.HRT.1.11.	GetAnimalRegistrationList	Получение списка актуальных сведений о регистрации животных или групп животных с возможностью фильтрации Входные данные: набор параметров фильтрации Выходные данные: список актуальных регистрационных карточек животных или групп животных, удовлетворяющих условиям фильтрации
AMS.HRT.1.13.	IncludeToAnimalGroup	Пополнение зарегистрированной группы животных Входные данные: сведения о численности пополнения сведения о зарегистрированных индивидуальных животных, включаемых в группу уникальный идентификатор группы животных, для которой выполняется пополнение Выходные данные: сведения о версии регистрационной карточки группы животных
AMS.HRT.1.14.	ExcludeFromAnimalGroup	Исключение животных из зарегистрированной группы Входные данные: сведения о численности исключаемых животных сведения о зарегистрированных индивидуальных животных, исключаемых из группы уникальный идентификатор группы животных, для которой выполняется исключение Выходные данные: сведения о версии регистрационной карточки группы животных
Операции по работе со сведениями об идентификации животного (группы животных) | Код: AMS.HRT.2
AMS.HRT.2.2.	RemoveAnimalIdentity	Прекращение регистрации сведений об идентификации зарегистрированного животного или группы животных (выбытие средства маркирования) Входные данные: сведения о выбытии зарегистрированного средства маркирования глобальный идентификатор сведений о зарегистрированных сведениях об идентификации животного, в отношении которых регистрируется выбытие Выходные данные: обновленные сведения об идентификации животного или группы животных
AMS.HRT.2.3.	ReplaceAnimalIdentity	Перерегистрация сведений об идентификации зарегистрированного животного или группы животных (замена средства маркирования) Входные данные: сведения о замене средства маркирования глобальный идентификатор сведений о зарегистрированных сведениях об идентификации животного Выходные данные: обновленные сведения об идентификации животного или группы животных зарегистрированные сведения о новой идентификации животного или группы животных
AMS.HRT.2.4.	ReplaceAnimalIdentityNotification	Уведомление о необходимости перерегистрации сведений об идентификации (замене средства маркирования) животного или группы животных Входные данные: сведения о замене средства маркирования глобальный идентификатор сведений о зарегистрированных сведениях об идентификации животного Выходные данные: обновленные сведения об идентификации животного или группы животных
AMS.HRT.2.6.	VerifyAnimalID	Проверка статусов выпущенных в оборот номеров средств маркирования животных Входные данные: список номеров для проверки Выходные данные: результаты проверки номеров из запроса
Операции по работе со сведениями о ветеринарных профилактических мероприятиях животного (группы животных) | Код: AMS.HRT.3
AMS.HRT.3.1.	RegisterAnimalVeterinaryEvent	Регистрация ветеринарного профилактического мероприятия Входные данные: проект сведений о ветеринарном профилактическом мероприятии список зарегистрированных животных или групп животных, в отношении которых осуществлялось данное мероприятие Выходные данные: зарегистрированные сведения о ветеринарном профилактическом мероприятии
AMS.HRT.3.2.	ModifyAnimalVeterinaryEvent	Редактирование сведений о ветеринарном профилактическом мероприятии Входные данные: проект обновленных сведений о зарегистрированном ветеринарном профилактическом мероприятии с указанным глобальным идентификатором Выходные данные: обновленная редакция сведений о зарегистрированном ветеринарном профилактическом мероприятии
AMS.HRT.3.3.	WithdrawAnimalVeterinaryEvent	Аннулирование сведений о ветеринарном профилактическом мероприятии Входные данные: сведения об аннулировании глобальный идентификатор аннулируемых сведений о ветеринарном профилактическом мероприятии Выходные данные: обновленная редакция сведений о зарегистрированном ветеринарном профилактическом мероприятии в статусе WITHDRAWN
AMS.HRT.3.4.	GetAnimalVeterinaryEventByGuid	Получение актуальных сведений о зарегистрированном ветеринарном профилактическом мероприятии по глобальному идентификатору Входные данные: глобальный идентификатор зарегистрированных сведений о ветеринарном профилактическом мероприятии Выходные данные: актуальная редакция зарегистрированных сведений о ветеринарном профилактическом мероприятии
AMS.HRT.3.5.	GetAnimalVeterinaryEventChangesList	Получение списка изменений сведений о зарегистрированных ветеринарных профилактических мероприятиях за указанный период Входные данные: интервал дат, определяющий запрашиваемый период изменений зона обслуживания: субъект РФ, на территории которого содержатся животные зона обслуживания: место содержания животных поднадзорный объект, на котором осуществляется содержание животных глобальный идентификатор зарегистрированной карточки животного или группы животных Выходные данные: список созданных за указанный период времени версий сведений о ветеринарных профилактических мероприятиях животных или групп животных, которые содержатся в указанной зоне обслуживания
AMS.HRT.3.6.	GetAnimalVeterinaryEventHistory	Получение всей истории изменений ветеринарного профилактического мероприятия по глобальному идентификатору Входные данные: глобальный идентификатор зарегистрированных сведений о ветеринарном профилактическом мероприятии Выходные данные: список версий сведений о ветеринарном профилактическом мероприятии
AMS.HRT.3.7.	GetAnimalVeterinaryEventByUuid	Получение сведений о редакции ветеринарного профилактического мероприятия по идентификатору версии Входные данные: уникальный идентификатор версии сведений о ветеринарном профилактическом мероприятии Выходные данные: сведения о запрашиваемой версии сведений о ветеринарном профилактическом мероприятии

EnterpriseService (реестр хозяйствующих субъектов и предприятий)

Параметры подключения

Продуктивный контур WSDL https://api.vetrf.ru/schema/platform/herriot/v1.0b-20240216/EnterpriseService_v1.0.wsdl URL точки доступа (Endpoint) https://api.vetrf.ru/platform/herriot/services/1.0/EnterpriseService

Тестовый контур WSDL https://api.vetrf.ru/schema/platform/herriot/v1.0b-last/EnterpriseService_v1.0.wsdl URL точки доступа (Endpoint) https://api2.vetrf.ru:8002/platform/herriot/services/1.0/EnterpriseService

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

Сервис EnterpriseService предназначен для работы с реестром хозяйствующих субъектов и предприятий.

Операции, выполняемые через EnterpriseService

Код	Название операции / ссылка на спецификацию	Описание операции
Реестр хозяйствующих субъектов | ES.HRT.1
ES.HRT.1.1	GetBusinessEntityByUuid	Получение заданной версии хозяйствующего субъекта
ES.HRT.1.2	GetBusinessEntityByGuid	Получение последней версии хозяйствующего субъекта по глобальному идентификатору
ES.HRT.1.3	GetBusinessEntityList	Получение списка хозяйствующих субъектов с возможностью фильтрации
ES.HRT.1.4	GetBusinessEntityChangesList	Получение истории изменений справочника хозяйствующих субъектов за заданный интервал времени
Реестр поднадзорных объектов | ES.HRT.2
ES.HRT.2.1	GetSupervisedObjectByUuid	Получение заданной версии поднадзорного объекта (ПО)
ES.HRT.2.2	GetSupervisedObjectByGuid	Получение поднадзорного объекта (ПО) по глобальному идентификатору
ES.HRT.2.3	GetBESupervisedObjectList	Получение списка поднадзорных объектов (ПО) заданного хозяйствующего субъекта
ES.HRT.2.4	GetSupervisedObjectActivityList	Получение справочника видов деятельности поднадзорных объектов (ПО)
ES.HRT.2.5	GetSupervisedObjectTypeList	Получение справочника видов поднадзорных объектов (ПО)
Реестр площадок РФ | ES.HRT.3
ES.HRT.3.1	GetEnterpriseByUuid	Получение заданной версии площадки
ES.HRT.3.2	GetEnterpriseByGuid	Получение площадки по глобальному идентификатору
ES.HRT.3.3	GetRussianEnterpriseList	Получение списка площадок, зарегистрированных на территории РФ, с возможностью фильтрации
ES.HRT.3.4	GetRussianEnterpriseChangesList	Получение истории изменений площадок, зарегистрированных на территории РФ, за заданный интервал времени

DictionaryService (реестр справочной информации)

Параметры подключения

Продуктивный контур WSDL https://api.vetrf.ru/schema/platform/herriot/v1.0b-20240216/DictionaryService_v1.0.wsdl URL точки доступа (Endpoint) https://api.vetrf.ru/platform/herriot/services/1.0/DictionaryService

Тестовый контур WSDL https://api.vetrf.ru/schema/platform/herriot/v1.0b-last/DictionaryService_v1.0.wsdl URL точки доступа (Endpoint) https://api2.vetrf.ru:8002/platform/herriot/services/1.0/DictionaryService

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

Сервис DictionaryService предназначен для получения справочной информации.

Операции, выполняемые через DictionaryService

Код	Название операции / ссылка на спецификацию	Описание операции
Породы животных | Код: DS.HRT.1
DS.HRT.1.1	GetAnimalBreedByUuid	Получение заданной версии породы животного
DS.HRT.1.2	GetAnimalBreedByGuid	Получение породы животного по глобальному идентификатору
DS.HRT.1.3	GetAnimalBreedList	Получение актуального списка пород животных
DS.HRT.1.4	GetAnimalBreedChangesList	Получение истории изменений справочника пород животных за указанный интервал времени
Биологические виды животных | Код: DS.HRT.2
DS.HRT.2.1	GetAnimalSpeciesByUuid	Получение заданной версии биологического вида животного
DS.HRT.2.2	GetAnimalSpeciesByGuid	Получение биологического вида животного по глобальному идентификатору
DS.HRT.2.3	GetAnimalSpeciesList	Получение актуального списка биологических видов животных
DS.HRT.2.4	GetAnimalSpeciesChangesList	Получение истории изменений справочника биологических видов за указанный интервал времени
Типы содержания животных | Код: DS.HRT.3
DS.HRT.3.1	GetAnimalKeepingTypeByUuid	Получение заданной версии типа содержания животных
DS.HRT.3.2	GetAnimalKeepingTypeByGuid	Получение типа содержания животных по глобальному идентификатору
DS.HRT.3.3	GetAnimalKeepingTypeList	Получение актуального списка типов содержания животных
DS.HRT.3.4	GetAnimalKeepingTypeChangesList	Получение истории изменений справочника типов содержания животных
Цели содержания животных | Код: DS.HRT.4
DS.HRT.4.1	GetAnimalKeepingPurposeByUuid	Получение заданной версии цели содержания животных
DS.HRT.4.2	GetAnimalKeepingPurposeByGuid	Получение цели содержания животных по глобальному идентификатору
DS.HRT.4.3	GetAnimalKeepingPurposeList	Получение актуального списка целей содержания животных
DS.HRT.4.4	GetAnimalKeepingPurposeChangesList	Получение истории изменений справочника целей содержания животных
Места нанесения средств маркирования | Код: DS.HRT.5
DS.HRT.5.1	GetAnimalMarkingLocationByUuid	Получение заданной версии места нанесения средств маркирования
DS.HRT.5.2	GetAnimalMarkingLocationByGuid	Получение места нанесения средств маркирования по глобальному идентификатору
DS.HRT.5.3	GetAnimalMarkingLocationList	Получение актуального списка мест нанесения средств маркирования
DS.HRT.5.4	GetAnimalMarkingLocationChangesList	Получение истории изменений справочника мест нанесения средств маркирования
Единицы измерения | Код: DS.HRT.6
DS.HRT.6.1	GetUnitByUuid	Получение заданной версии единицы измерения
DS.HRT.6.2	GetUnitByGuid	Получение единицы измерения по глобальному идентификатору
DS.HRT.6.3	GetUnitList	Получение актуального списка единиц измерения
DS.HRT.6.4	GetUnitChangesList	Получение истории изменений справочника единиц измерения

ProductService (реестр категорий продукции)

Параметры подключения

Продуктивный контур WSDL https://api.vetrf.ru/schema/platform/herriot/v1.0b-20240216/ProductService_v1.0.wsdl URL точки доступа (Endpoint) https://api.vetrf.ru/platform/herriot/services/1.0/ProductService

Тестовый контур WSDL https://api.vetrf.ru/schema/platform/herriot/v1.0b-last/ProductService_v1.0.wsdl URL точки доступа (Endpoint) https://api2.vetrf.ru:8002/platform/herriot/services/1.0/ProductService

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

Сервис ProductService предназначен для получения реестра категорий продукции.

Операции, выполняемые через ProductService

Код	Название операции / ссылка на спецификацию	Описание операции
Виды продукции (3 уровень справочника) | Код: PS.HRT.1
PS.HRT.1.1	GetSubProductByGuid	Получение вида продукции по глобальному идентификатору
PS.HRT.1.2	GetSubProductByUuid	Получение заданной версии вида продукции
PS.HRT.1.3	GetSubProductByProductList	Получение вида продукции по заданной продукции (2 уровень справочника)
PS.HRT.1.4	GetSubProductChangesList	Получение истории изменений справочника видов продукции
Продукция (2 уровень справочника) | Код: PS.HRT.2
PS.HRT.2.1	GetProductByGuid	Получение продукции по глобальному идентификатору
PS.HRT.2.2	GetProductByUuid	Получение заданной версии продукции
PS.HRT.2.3	GetProductByTypeList	Получение списка продукции по заданному типу продукции
PS.HRT.2.4	GetProductChangesList	Получение истории изменений справочника продукции

IkarService (адресный классификатор)

Параметры подключения

Продуктивный контур WSDL https://api.vetrf.ru/schema/platform/herriot/v1.0b-20240216/IkarService_v1.0.wsdl URL точки доступа (Endpoint) https://api.vetrf.ru/platform/herriot/services/1.0/IkarService

Тестовый контур WSDL https://api.vetrf.ru/schema/platform/herriot/v1.0b-last/IkarService_v1.0.wsdl URL точки доступа (Endpoint) https://api2.vetrf.ru:8002/platform/herriot/services/1.0/IkarService

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

Сервис IkarService предназначен для получения адресной информации.

Операции, выполняемые через IkarService

Код	Название операции / ссылка на спецификацию	Описание операции
Страны | Код: IS.HRT.1
IS.HRT.1.1	GetCountryByUuid	Получение заданной версии страны
IS.HRT.1.2	GetCountryByGuid	Получение страны по глобальному идентификатору
IS.HRT.1.3	GetAllCountryList	Получение списка всех стран
IS.HRT.1.4	GetCountryChangesList	Получение истории изменений справочника стран за заданный интервал времени
Регионы | Код: IS.HRT.2
IS.HRT.2.1	GetRegionByUuid	Получение заданной версии региона
IS.HRT.2.2	GetRegionByGuid	Получение региона по глобальному идентификатору
IS.HRT.2.3	GetRegionListByCountry	Получение списка всех регионов заданной страны
IS.HRT.2.4	GetRegionChangesList	Получение истории изменений справочника регионов за заданный интервал времени
Районы | Код: IS.HRT.3
IS.HRT.3.1	GetDistrictByUuid	Получение заданной версии района
IS.HRT.3.2	GetDistrictByGuid	Получение района по глобальному идентификатору
IS.HRT.3.3	GetDistrictListByRegion	Получение списка всех районов заданного региона
IS.HRT.3.4	GetDistrictChangesList	Получение истории изменений справочника районов за заданный интервал времени
Населённые пункты | Код: IS.HRT.4
IS.HRT.4.1	GetLocalityListByRegion	Получение населённых пунктов заданного региона
IS.HRT.4.2	GetLocalityListByDistrict	Получение населённых пунктов заданного района
IS.HRT.4.3	GetLocalityListByLocality	Получение населённых пунктов заданного населённого пункта
IS.HRT.4.4	GetLocalityChangesList	Получение истории изменений справочника населённых пунктов за заданный интервал времени
IS.HRT.4.5	FindLocalityListByName	Поиск населённых пунктов по названию
Улицы | Код: IS.HRT.5
IS.HRT.5.1	GetStreetListByLocality	Получение улиц заданного населённого пункта
IS.HRT.5.2	GetStreetChangesList	Получение истории изменений справочника улиц за заданный интервал времени
IS.HRT.5.3	FindStreetListByName	Поиск улиц по названию

Прочие классификаторы

Код	Ссылка на спецификацию	Описание
CL.HRT.1	AdditionalAttribute	Классификатор дополнительных атрибутов учётной карточки животного
CL.HRT.2	StatusChangeReason	Классификатор причин изменения статусов документа
CL.HRT.3	VeterinaryEventReason	Классификатор причин ветеринарных событий

Список обновлений

17.07.2024 прод

1. Обновлена версия форматов обмена до v1.0b-20240603. Актуальная версия форматов обмена доступна по адресу https://api.vetrf.ru/schema/platform/herriot/herriot-schemas-v1.0b-20240603.zip
2. Добавлены новые операции взаимодействия:
   • Регистрация сведения о перемещении/смене собственника зарегистрированного животного или групп животных – RegisterAnimalMovementEvent;
   • Прекращение регистрации животного или группы животных (выбытие животного) – TerminateAnimalRegistration;
   • Аннулирование сведений о регистрации животного или группы животных – WithdrawAnimalRegistration;
   • Прекращение регистрации сведений об идентификации зарегистрированного животного или группы животных (выбытие средства маркирования) – RemoveAnimalIdentity;
   • Перерегистрация сведений об идентификации зарегистрированного животного или группы животных (замена средства маркирования) – ReplaceAnimalIdentity;
   • Уведомление о необходимости перерегистрации сведений об идентификации (замене средства маркирования) животного или группы животных – ReplaceAnimalIdentityNotification;
   • Проверка статусов выпущенных в оборот номеров средств маркирования животных – VerifyAnimalID.
3. Добавлен новый атрибут "Статус средства маркирования" (поле AnimalRegistration/specifiedAnimalIdentity/identityStatus) в ответе операций:
   • GetAnimalRegistrationByUuid,
   • GetAnimalRegistrationByGuid,
   • GetAnimalRegistrationHistory,
   • GetAnimalRegistrationChangesList.
4. Изменён способ передачи причины выбытия животного (поле AnimalRegistration/animalLifecycleEvent/occurrenceReason). Вместо фиксированного перечня констант теперь передача осуществляется по идентификатору справочника.

   Изменение касается ответов сервиса для операций:

   • GetAnimalRegistrationByUuid,
   • GetAnimalRegistrationByGuid,
   • GetAnimalRegistrationHistory,
   • GetAnimalRegistrationChangesList.

   Изменение также касается сценария регистрации ранее выбывшего животного – запросов к сервису для операций:

   • RegisterAnimal,
   • ModifyAnimalRegistration.

Cправочник причин причин выбытия животного размещён в Справочной системе: https://help.vetrf.ru/wiki/Herriot:VeterinaryEventReason:v1.0.