Herriot:Services:v1.0
Общие сведения
Сервис позволяет вносить в компонент Хорриот информацию, связанную с маркировкой и учетом животных, и получать от компонента Хорриот эту информацию.
Версии профиля API
- v1.0 – Herriot:Services:v1.0
- 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 | RegisterAnimalVeterinaryEvent | ApplicationManagementService | Нет |
15 | ModifyAnimalVeterinaryEvent | ApplicationManagementService | Нет |
16 | ConfirmAnimalVeterinaryEvent | ApplicationManagementService | Нет |
17 | WithdrawAnimalVeterinaryEvent | ApplicationManagementService | Нет |
18 | GetAnimalVeterinaryEventByGuid | ApplicationManagementService | Нет |
19 | GetAnimalVeterinaryEventChangesList | ApplicationManagementService | Нет |
20 | GetAnimalVeterinaryEventHistory | ApplicationManagementService | Нет |
21 | GetAnimalVeterinaryEventByUuid | ApplicationManagementService | Нет |
22 | GetUnitByGuid | DictionaryService | Да |
23 | GetUnitByUuid | DictionaryService | Да |
24 | GetUnitList | DictionaryService | Да |
25 | GetUnitChangesList | DictionaryService | Да |
26 | GetAnimalSpeciesByGuid | DictionaryService | Да |
27 | GetAnimalSpeciesByUuid | DictionaryService | Да |
28 | GetAnimalSpeciesList | DictionaryService | Да |
29 | GetAnimalSpeciesChangesList | DictionaryService | Да |
30 | GetAnimalBreedByGuid | DictionaryService | Да |
31 | GetAnimalBreedByUuid | DictionaryService | Да |
32 | GetAnimalBreedList | DictionaryService | Да |
33 | GetAnimalBreedChangesList | DictionaryService | Да |
34 | GetAnimalKeepingTypeByGuid | DictionaryService | Да |
35 | GetAnimalKeepingTypeByUuid | DictionaryService | Да |
36 | GetAnimalKeepingTypeList | DictionaryService | Да |
37 | GetAnimalKeepingTypeChangesList | DictionaryService | Да |
38 | GetAnimalKeepingPurposeByGuid | DictionaryService | Да |
39 | GetAnimalKeepingPurposeByUuid | DictionaryService | Да |
40 | GetAnimalKeepingPurposeList | DictionaryService | Да |
41 | GetAnimalKeepingPurposeChangesList | DictionaryService | Да |
42 | GetAnimalMarkingLocationByGuid | DictionaryService | Да |
43 | GetAnimalMarkingLocationByUuid | DictionaryService | Да |
44 | GetAnimalMarkingLocationList | DictionaryService | Да |
45 | GetAnimalMarkingLocationChangesList | DictionaryService | Да |
46 | GetBusinessEntityByGuid | EnterpriseService | Да |
47 | GetBusinessEntityByUuid | EnterpriseService | Да |
48 | GetBusinessEntityList | EnterpriseService | Да |
49 | GetBusinessEntityChangesList | EnterpriseService | Да |
50 | GetEnterpriseByGuid | EnterpriseService | Да |
51 | GetEnterpriseByUuid | EnterpriseService | Да |
52 | GetRussianEnterpriseList | EnterpriseService | Да |
53 | GetRussianEnterpriseChangesList | EnterpriseService | Да |
54 | GetSupervisedObjectByGuid | EnterpriseService | Да |
55 | GetSupervisedObjectByUuid | EnterpriseService | Да |
56 | GetBESupervisedObjectList | EnterpriseService | Да |
57 | GetSupervisedObjectTypeList | EnterpriseService | Да |
58 | GetSupervisedObjectActivityList | EnterpriseService | Да |
59 | GetAllCountryList | IkarService | Да |
60 | GetCountryByGuid | IkarService | Да |
61 | GetCountryByUuid | IkarService | Да |
62 | GetCountryChangesList | IkarService | Да |
63 | GetRegionListByCountry | IkarService | Да |
64 | GetRegionByGuid | IkarService | Да |
65 | GetRegionByUuid | IkarService | Да |
66 | GetRegionChangesList | IkarService | Да |
67 | GetDistrictListByRegion | IkarService | Да |
68 | GetDistrictByGuid | IkarService | Да |
69 | GetDistrictByUuid | IkarService | Да |
70 | GetDistrictChangesList | IkarService | Да |
71 | GetLocalityListByRegion | IkarService | Да |
72 | GetLocalityListByDistrict | IkarService | Да |
73 | GetLocalityListByLocality | IkarService | Да |
74 | GetStreetListByLocality | IkarService | Да |
75 | FindLocalityListByName | IkarService | Да |
76 | FindStreetListByName | IkarService | Да |
77 | GetLocalityChangesList | IkarService | Да |
78 | GetStreetChangesList | IkarService | Да |
79 | GetProductByGuid | ProductService | Да |
80 | GetProductByUuid | ProductService | Да |
81 | GetProductByTypeList | ProductService | Да |
82 | GetProductChangesList | ProductService | Да |
83 | GetSubProductByGuid | ProductService | Да |
84 | GetSubProductByUuid | ProductService | Да |
85 | GetSubProductByProductList | ProductService | Да |
86 | 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 (подсистема обработки заявок)
Параметры подключения
Продуктивный контур
|
Тестовый контур
|
Основные сущности и типы данных
Операции, выполняемые через ApplicationManagementService
Код | Название операции / ссылка на спецификацию | Описание операции ([ ... ] – входные и выходные данные, сценарии) |
---|---|---|
Операции по работе с учетной карточкой животного (группы животных) | Код: AMS.HRT.1 | ||
AMS.HRT.1.1. | RegisterAnimal | Регистрация животного или группы животных Входные данные:
Выходные данные:
|
AMS.HRT.1.2. | ModifyAnimalRegistration | Внесение изменений в основные сведения о зарегистрированном животном или группе животных Входные данные:
Выходные данные:
|
AMS.HRT.1.3. | RegisterAnimalMovementEvent | Регистрация сведения о перемещении/смене собственника зарегистрированного животного или групп животных Входные данные:
Выходные данные:
|
AMS.HRT.1.4. | TerminateAnimalRegistration | Прекращение регистрации животного или группы животных (выбытие животного) Входные данные:
Выходные данные:
|
AMS.HRT.1.5. | WithdrawAnimalRegistration | Аннулирование сведений о регистрации животного или группы животных Входные данные:
Выходные данные:
|
AMS.HRT.1.6. | GetAnimalRegistrationByGuid | Получение основных актуальных сведений о регистрации животного или группы животных по глобальному идентификатору Входные данные:
Выходные данные:
|
AMS.HRT.1.8. | GetAnimalRegistrationHistory | Получение всей истории изменений сведений о регистрации животного или группы животных по глобальному идентификатору Входные данные:
Выходные данные:
|
AMS.HRT.1.9. | GetAnimalRegistrationChangesList | Получение списка изменений по основным сведениям о регистрации животных или групп животных за указанный период Входные данные:
Выходные данные:
|
AMS.HRT.1.10. | GetAnimalRegistrationByUuid | Получение редакции основных сведений о регистрации животного или группы животных по идентификатору конкретной версии (редакции) Входные данные:
Выходные данные:
|
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. | CheckAnimalMarkingMeansNumber | Проверка статусов выпущенных в оборот номеров средств маркирования животных Входные данные:
Выходные данные:
|
Операции по работе со сведениями о ветеринарных профилактических мероприятиях животного (группы животных) | Код: AMS.HRT.3 | ||
AMS.HRT.3.1. | RegisterAnimalVeterinaryEvent | Регистрация ветеринарного профилактического мероприятия Входные данные:
Выходные данные:
|
AMS.HRT.3.2. | ModifyAnimalVeterinaryEvent | Редактирование сведений о ветеринарном профилактическом мероприятии Входные данные:
Выходные данные:
|
AMS.HRT.3.3. | WithdrawAnimalVeterinaryEvent | Аннулирование сведений о ветеринарном профилактическом мероприятии Входные данные:
Выходные данные:
|
AMS.HRT.3.4. | GetAnimalVeterinaryEventByGuid | Получение актуальных сведений о зарегистрированном ветеринарном профилактическом мероприятии по глобальному идентификатору Входные данные:
Выходные данные:
|
AMS.HRT.3.5. | GetAnimalVeterinaryEventChangesList | Получение списка изменений сведений о зарегистрированных ветеринарных профилактических мероприятиях за указанный период Входные данные:
Выходные данные:
|
AMS.HRT.3.6. | GetAnimalVeterinaryEventHistory | Получение всей истории изменений ветеринарного профилактического мероприятия по глобальному идентификатору Входные данные:
Выходные данные:
|
AMS.HRT.3.7. | GetAnimalVeterinaryEventByUuid | Получение сведений о редакции ветеринарного профилактического мероприятия по идентификатору версии Входные данные:
Выходные данные:
|
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 (реестр справочной информации)
Параметры подключения
Продуктивный контур
|
Тестовый контур
|
Общие сведения
Сервис 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 (реестр категорий продукции)
Параметры подключения
Продуктивный контур
|
Тестовый контур
|
Общие сведения
Сервис 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 | Получение истории изменений справочника видов продукции |
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 | Классификатор причин ветеринарных событий |