Herriot:Services:v1.0

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

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

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

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

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

№ Сервис Описание 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

Структура 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.5r1.xsd xmlns:cl="http://api.vetrf.ru/schema/cdm/codelist/v2/r1"

Профиль 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:def="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-last/ams-herriot.service_v1.0.wsdl
URL точки доступа (Endpoint) временно недоступно
Описание типов заявок включено в 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

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

HerriotConceptualDataModel.png

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

№ Название операции / ссылка на спецификацию Описание операции ([ ... ] – входные и выходные данные, сценарии)
Операции по работе с учетной карточкой животного (группы животных)
1.1. RegisterAnimal

Регистрация животного или группы животных

Входные данные:

  • проект регистрационной карточки животного или группы животных, включая сведения об идентификации животного, ввозе на территорию РФ, текущем содержании, потомстве

Выходные данные:

  • зарегистрированная карточка животного или группы животного в статусе PREPARING или ACTIVE
1.2. ModifyAnimalRegistration

Внесение изменений в основные сведения о зарегистрированном животном или группе животных

Входные данные:

  • проект изменений существующей регистрационной карточки с указанным идентификатором версии

Выходные данные:

  • обновленная карточка животного или группы животных в статусе ACTIVE
1.3. RegisterAnimalMovementEvent

Регистрация сведения о перемещении/смене собственника зарегистрированного животного или групп животных

Входные данные:

  • сведения о перемещении
  • сведения перемещаемых зарегистрированных животных или группах животных

Выходные данные:

  • обновленная карточка животного или группы животных в статусе RELOCATING или ACTIVE
1.4. TerminateAnimalRegistration

Прекращение регистрации животного или группы животных (выбытие животного)

Входные данные:

  • сведения о выбытии животного
  • сведения о зарегистрированных животных или группах животных, в отношении которых регистрируется выбытие

Выходные данные:

  • обновленная карточка животного или группы животных в статусе TERMINATED
1.5. WithdrawAnimalRegistration

Аннулирование сведений о регистрации животного или группы животных

Входные данные:

  • сведения об аннулировании регистрационной карточки животного
  • сведения о зарегистрированных животных или группах животных

Выходные данные:

  • обновленная карточка животного или группы животных в статусе WITHDRAWN
1.6. GetAnimalRegistrationByGuid

Получение основных актуальных сведений о регистрации животного или группы животных по глобальному идентификатору

Входные данные:

  • глобальный идентификатор регистрационной карточки животного или группы животных

Выходные данные:

  • актуальная редакция регистрационной карточки животного или группы животных без сведений о ветеринарных профилактических мероприятиях
1.8. GetAnimalRegistrationHistory

Получение всей истории изменений сведений о регистрации животного или группы животных по глобальному идентификатору

Входные данные:

  • глобальный идентификатор регистрационной карточки животного или группы животных

Выходные данные:

  • список версий регистрационной карточки животного или группы животных
1.9. GetAnimalRegistrationChangesList

Получение списка изменений по основным сведениям о регистрации животных или групп животных за указанный период

Входные данные:

  • интервал дат, определяющий запрашиваемый период изменений
  • зона обслуживания: субъект РФ, на территории которого содержатся животные
  • зона обслуживания: место содержания животных
  • поднадзорный объект, на котором осуществляется содержание животных

Выходные данные:

  • список созданных за указанный период времени версий регистрационных карточек животных или групп животных, которые содержатся в указанной зоне обслуживания
1.10. GetAnimalRegistrationByUuid

Получение редакции основных сведений о регистрации животного или группы животных по идентификатору конкретной версии (редакции)

Входные данные:

  • уникальный идентификатор версии регистрационной карточки животного или группы животных

Выходные данные:

  • сведения о запрашиваемой версии регистрационной карточки животного или группы животных без сведений о ветеринарных профилактических мероприятиях
Операции по работе со сведениями об идентификации животного (группы животных)
2.1. RegisterAnimalIdentity

Регистрация сведений об идентификации зарегистрированного животного или группы животных (маркирование)

Входные данные:

  • проект сведений об идентификации, содержащий глобальный идентификатор зарегистрированного животного или группы животных

Выходные данные:

  • зарегистрированные сведения об идентификации животного
2.2. RemoveAnimalIdentity

Прекращение регистрации сведений об идентификации зарегистрированного животного или группы животных (выбытие средства маркирования)

Входные данные:

  • сведения о выбытии зарегистрированного средства маркирования
  • глобальный идентификатор сведений о зарегистрированных сведениях об идентификации животного, в отношении которых регистрируется выбытие

Выходные данные:

  • обновленные сведения об идентификации животного или группы животных в статусе TERMINATED
2.3. ReplaceAnimalIdentity

Перерегистрация сведений об идентификации зарегистрированного животного или группы животных (замена средства маркирования)

Входные данные:

  • сведения о замене средства маркирования
  • глобальный идентификатор сведений о зарегистрированных сведениях об идентификации животного

Выходные данные:

  • обновленные сведения об идентификации животного или группы животных в статусе TERMINATED
  • зарегистрированные сведения о новой идентификации животного или группы животных
2.4. WithdrawAnimalIdentity

Аннулирование сведений о регистрации сведений об идентификации животного или группы животных

Входные данные:

  • сведения об аннулировании сведений
  • глобальный идентификатор аннулируемых сведений об идентификации животного или группы животных

Выходные данные:

  • обновленные сведения об идентификации животного или группы животных в статусе WITHDRAWN
Операции по работе со сведениями о ветеринарных профилактических мероприятиях животного (группы животных)
4.1. RegisterAnimalVeterinaryEvent

Регистрация ветеринарного профилактического мероприятия

Входные данные:

  • проект сведений о ветеринарном профилактическом мероприятии
  • список зарегистрированных животных или групп животных, в отношении которых осуществлялось данное мероприятие

Выходные данные:

  • зарегистрированные сведения о ветеринарном профилактическом мероприятии
4.2. ModifyAnimalVeterinaryEvent

Редактирование сведений о ветеринарном профилактическом мероприятии

Входные данные:

  • проект обновленных сведений о зарегистрированном ветеринарном профилактическом мероприятии с указанным глобальным идентификатором

Выходные данные:

  • обновленная редакция сведений о зарегистрированном ветеринарном профилактическом мероприятии
4.3. WithdrawAnimalVeterinaryEvent

Аннулирование сведений о ветеринарном профилактическом мероприятии

Входные данные:

  • сведения об аннулировании
  • глобальный идентификатор аннулируемых сведений о ветеринарном профилактическом мероприятии

Выходные данные:

  • обновленная редакция сведений о зарегистрированном ветеринарном профилактическом мероприятии в статусе WITHDRAWN
4.4. GetAnimalVeterinaryEventByGuid

Получение актуальных сведений о зарегистрированном ветеринарном профилактическом мероприятии по глобальному идентификатору

Входные данные:

  • глобальный идентификатор зарегистрированных сведений о ветеринарном профилактическом мероприятии

Выходные данные:

  • актуальная редакция зарегистрированных сведений о ветеринарном профилактическом мероприятии
4.5. GetAnimalVeterinaryEventChangesList

Получение списка изменений сведений о зарегистрированных ветеринарных профилактических мероприятиях за указанный период

Входные данные:

  • интервал дат, определяющий запрашиваемый период изменений
  • зона обслуживания: субъект РФ, на территории которого содержатся животные
  • зона обслуживания: место содержания животных
  • поднадзорный объект, на котором осуществляется содержание животных
  • глобальный идентификатор зарегистрированной карточки животного или группы животных

Выходные данные:

  • список созданных за указанный период времени версий сведений о ветеринарных профилактических мероприятиях животных или групп животных, которые содержатся в указанной зоне обслуживания
4.6. GetAnimalVeterinaryEventHistory

Получение всей истории изменений ветеринарного профилактического мероприятия по глобальному идентификатору

Входные данные:

  • глобальный идентификатор зарегистрированных сведений о ветеринарном профилактическом мероприятии

Выходные данные:

  • список версий сведений о ветеринарном профилактическом мероприятии
4.7. GetAnimalVeterinaryEventByUuid

Получение сведений о редакции ветеринарного профилактического мероприятия по идентификатору версии

Входные данные:

  • уникальный идентификатор версии сведений о ветеринарном профилактическом мероприятии

Выходные данные:

  • сведения о запрашиваемой версии сведений о ветеринарном профилактическом мероприятии

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

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


Продуктивный контур

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

Тестовый контур

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

№ Название операции / ссылка на спецификацию Описание операции
1. Реестр хозяйствующих субъектов
1.1 GetBusinessEntityByUuid Получение заданной версии хозяйствующего субъекта
1.2 GetBusinessEntityByGuid Получение последней версии хозяйствующего субъекта по глобальному идентификатору
1.3 GetBusinessEntityList Получение списка хозяйствующих субъектов с возможностью фильтрации
1.4 GetBusinessEntityChangesList Получение истории изменений хозяйствующих субъектов за заданный интервал времени
2. Реестр поднадзорных объектов
2.1 GetSupervisedObjectByUuid Получение заданной версии поднадзорного объекта (ПО)
2.2 GetSupervisedObjectByGuid Получение поднадзорного объекта (ПО) по глобальному идентификатору
2.3 GetBESupervisedObjectList Получение списка поднадзорных объектов (ПО) заданного хозяйствующего субъекта

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

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


Продуктивный контур

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

Тестовый контур

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

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

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

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


Продуктивный контур

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

Тестовый контур

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

№ Название операции / ссылка на спецификацию Описание операции
1. Виды продукции (3 уровень справочника)
1.1 GetSubProductByGuid Получение вида продукции по глобальному идентификатору
1.2 GetSubProductByUuid Получение заданной версии вида продукции
1.3 GetSubProductByProductList Получение вида продукции по заданной продукции (2 уровень справочника)
1.4 GetSubProductChangesList Получение истории изменений справочника видов продукции

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

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


Продуктивный контур

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

Тестовый контур

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

Номер операции Название операции / ссылка на спецификацию Описание операции
- - -
Источник — http://help.vetrf.ru/index.php?title=Herriot:Services:v1.0&oldid=38948