Herriot:Services:v1.0: различия между версиями

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 323: Строка 323:
| style="text-align:left; vertical-align:top;" |Получение всей истории изменений ветеринарного профилактического мероприятия по глобальному идентификатору
| style="text-align:left; vertical-align:top;" |Получение всей истории изменений ветеринарного профилактического мероприятия по глобальному идентификатору
<span style="text-decoration:underline;">Входные данные:</span>
<span style="text-decoration:underline;">Входные данные:</span>
* глобальный идентификатор зарегистрированных сведений о ветеринарном профилактическом мероприятии
* глобальный идентификатор зарегистрированных сведений о ветеринарном профилактическом мероприятии (тип bs:UUID)
<span style="text-decoration:underline;">Выходные данные:</span>
<span style="text-decoration:underline;">Выходные данные:</span>
* список версий сведений о ветеринарном профилактическом мероприятии (тип vd:AnimalMedicationEventList)
* список версий сведений о ветеринарном профилактическом мероприятии (тип vd:AnimalMedicationEventList)

Версия 15:38, 10 ноября 2023

Версии профиля 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

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) временно недоступно
Описание типов заявок включено в WSDL
Код сервиса (serviceId) herriot.service:1.0

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

HerriotConceptualDataModel.png

Используемые пространства имён

Пространство имён (xmlns) XSD-схема, содержащая описание типов
xmlns:xs="http://www.w3.org/2001/XMLSchema" http://www.w3.org/2001/XMLSchema.xsd
xmlns:bs="http://api.vetrf.ru/schema/cdm/base" base_v2.1.xsd
xmlns:apl="http://api.vetrf.ru/schema/cdm/application" application_v2.1.xsd
xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2" dictionary_v2.5.xsd
xmlns:vd="http://api.vetrf.ru/schema/cdm/mercury/vet-document/v2" document_v2.5.xsd
xmlns:hrt="http://api.vetrf.ru/schema/cdm/herriot/applications/v1" herriot_applications_v1.0.xsd

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

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

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

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

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

  • зарегистрированная карточка животного или группы животного в статусе PREPARING или ACTIVE (тип vd:AnimalRegistration)
1.2. ModifyAnimalRegistration Внесение изменений в основные сведения о зарегистрированном животном или группе животных

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

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

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

  • обновленная карточка животного или группы животных в статусе ACTIVE (тип vd:AnimalRegistration)
1.3. RegisterAnimalMovementEvent Регистрация сведения о перемещении/смене собственника зарегистрированного животного или групп животных

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

  • сведения о перемещении (тип vd:AnimalMovementEvent)
  • сведения перемещаемых зарегистрированных животных или группах животных (тип vd:AnimalRegistration)

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

  • обновленная карточка животного или группы животных в статусе RELOCATING или ACTIVE (тип vd:AnimalRegistration)
1.4. TerminateAnimalRegistration Прекращение регистрации животного или группы животных (выбытие животного)

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

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

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

  • обновленная карточка животного или группы животных в статусе TERMINATED (тип vd:AnimalRegistration)
1.5. WithdrawAnimalRegistration Аннулирование сведений о регистрации животного или группы животных

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

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

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

  • обновленная карточка животного или группы животных в статусе WITHDRAWN (тип vd:AnimalRegistration)
1.6. GetAnimalRegistrationByGuid Получение основных актуальных сведений о регистрации животного или группы животных по глобальному идентификатору

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

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

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

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

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

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

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

  • список версий регистрационной карточки животного или группы животных (тип vd:AnimalRegistrationList)
1.9. GetAnimalRegistrationChangesList Получение списка изменений по основным сведениям о регистрации животных или групп животных за указанный период

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • обновленные сведения об идентификации животного или группы животных в статусе TERMINATED (тип vd:AnimalIdentity)
2.3. ReplaceAnimalIdentity Перерегистрация сведений об идентификации зарегистрированного животного или группы животных (замена средства маркирования)

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

  • сведения о замене средства маркирования (тип vd:AnimalMarkingEvent)
  • глобальный идентификатор сведений о зарегистрированных сведениях об идентификации животного (тип vd:AnimalIdentity)

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

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

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

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

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

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

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

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

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

  • зарегистрированные сведения о ветеринарном профилактическом мероприятии (тип vd:AnimalMedicationEvent)
4.2. ModifyAnimalVeterinaryEvent Редактирование сведений о ветеринарном профилактическом мероприятии

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

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

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

  • обновленная редакция сведений о зарегистрированном ветеринарном профилактическом мероприятии (тип vd:AnimalMedicationEvent)
4.3. WithdrawAnimalVeterinaryEvent Аннулирование сведений о ветеринарном профилактическом мероприятии

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

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

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

  • обновленная редакция сведений о зарегистрированном ветеринарном профилактическом мероприятии в статусе WITHDRAWN (тип vd:AnimalMedicationEvent)
4.4. GetAnimalVeterinaryEventByGuid Получение актуальных сведений о зарегистрированном ветеринарном профилактическом мероприятии по глобальному идентификатору

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

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

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

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

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

  • интервал дат, определяющий запрашиваемый период изменений (тип bs:updateDateInterval)
  • зона обслуживания: субъект РФ, на территории которого содержатся животные (тип dt:Region)
  • зона обслуживания: место содержания животных (тип dt:Location)
  • поднадзорный объект, на котором осуществляется содержание животных (тип dt:SupervisedObject)
  • глобальный идентификатор зарегистрированной карточки животного или группы животных (тип bs:UUID)

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

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

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

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

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

  • список версий сведений о ветеринарном профилактическом мероприятии (тип vd:AnimalMedicationEventList)
4.7. GetAnimalVeterinaryEventByUuid Получение сведений о редакции ветеринарного профилактического мероприятия по идентификатору версии

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

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

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

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