MercuryG2B:Services:v3.0

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

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

История изменений

Описание основных изменений ВетИС.API v3.0 (ECR 2023-10-05.pdf)

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

№ Сервис Описание WSDL
1 ApplicationManagementService Подсистема обработки заявок https://api.vetrf.ru/schema/platform/services/v3.0b-last/ams-mercury-g2b.service_v3.0.wsdl
2 EnterpriseService Сервис реестров хозяйствующих субъектов и предприятий https://api.vetrf.ru/schema/platform/services/v3.0b-last/EnterpriseService_v3.0.wsdl
3 DictionaryService Сервис справочной информации https://api.vetrf.ru/schema/platform/services/v3.0b-last/DictionaryService_v3.0.wsdl
4 ProductService Сервис реестров категорий продукции https://api.vetrf.ru/schema/platform/services/v3.0b-last/ProductService_v3.0.wsdl
5 RegionalizationService Сервис проверки благополучия регионов и получения правил регионализации https://api.vetrf.ru/schema/platform/services/v3.0b-last/RegionalizationService_v3.0.wsdl
6 IkarService Сервис получения адресной информации https://api.vetrf.ru/schema/platform/services/v3.0b-last/IkarService_v3.0.wsdl


Операции, доступные для тестирования
№ Название операции Сервис Доступно для тестирования
1 RegisterProductionOperation ApplicationManagementService Да
2 PrepareOutgoingConsignment ApplicationManagementService Нет
3 ProcessIncomingConsignment ApplicationManagementService Нет
4 ProcessIncomingDelivery ApplicationManagementService Нет
5 WithdrawVetDocument ApplicationManagementService Нет
6 UpdateTransportMovementDetails ApplicationManagementService Нет
7 ResolveDiscrepancy ApplicationManagementService Нет
8 MergeStockEntries ApplicationManagementService Нет
9 UpdateVeterinaryEvents ApplicationManagementService Нет
10 CheckShipmentRegionalization ApplicationManagementService Нет
11 ModifyProducerStockList ApplicationManagementService Да
12 ModifyActivityLocations ApplicationManagementService Нет
13 ModifyBusinessEntity ApplicationManagementService Нет
14 ModifyEnterprise ApplicationManagementService Нет
15 GetVetDocumentByUuid ApplicationManagementService Да
16 GetVetDocumentList ApplicationManagementService Да
17 GetVetDocumentChangesList ApplicationManagementService Да
18 GetStockEntryByUuid ApplicationManagementService Да
19 GetStockEntryByGuid ApplicationManagementService Да
20 GetStockEntryVersionList ApplicationManagementService Да
21 GetStockEntryList ApplicationManagementService Да
22 GetStockEntryChangesList ApplicationManagementService Да
23 AddBussinessEntityUser ApplicationManagementService Нет
24 UpdateUserAuthorities ApplicationManagementService Нет
25 UnbindBusinessEntityUser ApplicationManagementService Нет
26 UpdateUserWorkingAreas ApplicationManagementService Нет
27 GetBusinessEntityUser ApplicationManagementService Нет
28 GetBusinessEntityUserList ApplicationManagementService Нет
29 GetApplicableUserAuthorityList ApplicationManagementService Нет
30 GetBusinessEntityByGuid EnterpriseService Нет
31 GetBusinessEntityByUuid EnterpriseService Нет
32 GetBusinessEntityList EnterpriseService Нет
33 GetBusinessEntityChangesList EnterpriseService Нет
34 GetEnterpriseByGuid EnterpriseService Нет
35 GetEnterpriseByUuid EnterpriseService Нет
36 GetRussianEnterpriseList EnterpriseService Нет
37 GetRussianEnterpriseChangesList EnterpriseService Нет
38 GetForeignEnterpriseList EnterpriseService Нет
39 GetForeignEnterpriseChangesList EnterpriseService Нет
40 GetActivityLocationList EnterpriseService Нет
41 GetBusinessMemberByGLN EnterpriseService Нет
42 GetPurposeByGuid DictionaryService Да
43 GetPurposeByUuid DictionaryService Да
44 GetPurposeList DictionaryService Да
45 GetPurposeChangesList DictionaryService Да
46 GetUnitByGuid DictionaryService Да
47 GetUnitByUuid DictionaryService Да
48 GetUnitList DictionaryService Да
49 GetUnitChangesList DictionaryService Да
50 GetDiseaseByGuid DictionaryService Да
51 GetDiseaseByUuid DictionaryService Да
52 GetDiseaseList DictionaryService Да
53 GetDiseaseChangesList DictionaryService Да
54 GetResearchMethodByGuid DictionaryService Нет
55 GetResearchMethodByUuid DictionaryService Нет
56 GetResearchMethodList DictionaryService Нет
57 GetResearchMethodChangesList DictionaryService Нет
58 GetProductByGuid ProductService Да
59 GetProductByUuid ProductService Да
60 GetProductByTypeList ProductService Да
61 GetProductChangesList ProductService Да
62 GetSubProductByGuid ProductService Да
63 GetSubProductByUuid ProductService Да
64 GetSubProductByProductList ProductService Да
65 GetSubProductChangesList ProductService Да
66 GetProductItemByGuid ProductService Да
67 GetProductItemByUuid ProductService Да
68 GetProductItemList ProductService Да
69 GetProductItemChangesList ProductService Да
70 GetR13nConditionList RegionalizationService Нет
71 GetActualR13nRegionStatusList RegionalizationService Нет
72 GetActualR13nShippingRuleList RegionalizationService Нет
73 GetAllCountryList IkarService Нет
74 GetCountryByGuid IkarService Нет
75 GetCountryByUuid IkarService Нет
76 GetCountryChangesList IkarService Нет
77 GetRegionListByCountry IkarService Нет
78 GetRegionByGuid IkarService Нет
79 GetRegionByUuid IkarService Нет
80 GetRegionChangesList IkarService Нет
81 GetDistrictListByRegion IkarService Нет
82 GetDistrictByGuid IkarService Нет
83 GetDistrictByUuid IkarService Нет
84 GetDistrictChangesList IkarService Нет
85 GetLocalityListByRegion IkarService Нет
86 GetLocalityListByDistrict IkarService Нет
87 GetLocalityListByLocality IkarService Нет
88 GetStreetListByLocality IkarService Нет
89 FindLocalityListByName IkarService Нет
90 FindStreetListByName IkarService Нет
91 GetLocalityChangesList IkarService Нет
92 GetStreetChangesList IkarService Нет

Структура 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-схема Пространство имен
mercury_g2b_applications_v3.0.xsd xmlns:merc="http://api.vetrf.ru/schema/cdm/mercury/g2b/applications/v3"

Профиль 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/services/v3.0b-last/ams-mercury-g2b.service_v3.0.wsdl
URL точки доступа (Endpoint) временно недоступно
Описание типов заявок включено в WSDL
Код сервиса (serviceId) mercury-g2b.service:3.0

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

WSDL https://api.vetrf.ru/schema/platform/services/v3.0b-last/ams-mercury-g2b.service_v3.0.wsdl
URL точки доступа (Endpoint) https://api2.vetrf.ru:8002/platform/services/3.0/ApplicationManagementService
Описание типов заявок включено в WSDL
Код сервиса (serviceId) mercury-g2b.service:3.0

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

№ Название операции / ссылка на спецификацию Описание операции
Операции над ветеринарными сопроводительными документами (ВСД)
... RegisterProductionOperation Операция оформления производственной транзакции (завершенное и незавершенное производство)
... PrepareOutgoingConsignment Операция оформления транспортной партии
... ProcessIncomingConsignment Операция оформления входящей партии (гашение ВСД)
... WithdrawVetDocument Операция аннулирования ВСД
... UpdateTransportMovementDetails Операция внесения номеров транспортных средств в пунктах перегрузки в оформленный транспортный ВСД
Операции над записями складского журнала
... ResolveDiscrepancy Операция инвентаризации записи складского журнала
... MergeStockEntries Операция объединения / присоединения записей складского журнала
... UpdateVeterinaryEvents Операция внесения сведений о ветеринарных мероприятиях (лабораторные исследования, иммунизация / обработка живых животных)
Регионализация
... CheckShipmentRegionalization Проверка возможности осуществления перевозки партии в рамках правил регионализации
Операции над справочниками
... ModifyProducerStockList Операция добавления / изменения / удаления записей справочника наименований продукции (номенклатуры)
... ModifyActivityLocations Операция добавления / удаления связи хозяйствующего субъекта с площадкой и обновления GLN
Получение ВСД
... GetVetDocumentByUuid Получение ВСД по его уникальному идентификатору
... GetVetDocumentList Получение списка ВСД с возможностью фильтрации
... GetVetDocumentChangesList Получение списка ВСД, созданных или измененных за указанный интервал времени
Получение записей складского журнала
... GetStockEntryByUuid Получение конкретной версии записи складского журнала по ее идентификатору
... GetStockEntryByGuid Получение последней (актуальной) версии записи складского журнала по ее глобальному идентификатору
... GetStockEntryVersionList Получение всех версий записи складского журнала по ее глобальному идентификатору
... GetStockEntryList Получение актуального списка записей складского журнала
... GetStockEntryChangesList Получение истории изменений записей складского журнала за указанный интервал времени
Операции над пользователями
... AddBussinessEntityUser Регистрация и привязка пользователей к хозяйствующему субъекту
... UpdateUserAuthorities Назначение прав пользователям
... UnbindBusinessEntityUser Удаление связи пользователей с хозяйствующим субъектом
... UpdateUserWorkingAreas Назначение зон ответственности пользователям
... GetBusinessEntityUser Получение сведений о пользователе по его логину
... GetBusinessEntityUserList Получение списка пользователей хозяйствующего субъекта
... GetApplicableUserAuthorityList Получение списка доступных для назначения прав пользователей

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

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

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

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

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

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

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

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

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

№ Название операции / ссылка на спецификацию Описание операции
Получение записей реестра хозяйствующих субъектов
1 GetBusinessEntityByGuid Получение последней версии хозяйствующего субъекта по глобальному идентификатору
2 GetBusinessEntityByUuid Получение заданной версии хозяйствующего субъекта
3 GetBusinessEntityList Получение списка хозяйствующих субъектов с возможностью фильтрации
4 GetBusinessEntityChangesList Получение истории изменений хозяйствующих субъектов за заданный интервал времени
Получение записей реестра предприятий (площадок)
5 GetEnterpriseByGuid Получение последней версии площадки по глобальному идентификатору
6 GetEnterpriseByUuid Получение заданной версии площадки
7 GetRussianEnterpriseList Получение списка площадок, зарегистрированных на территории РФ, с возможностью фильтрации
8 GetRussianEnterpriseChangesList Получение истории изменений площадок, зарегистрированных на территории РФ, за заданный интервал времени
9 GetForeignEnterpriseList Получение списка зарубежных площадок с возможностью фильтрации
10 GetForeignEnterpriseChangesList Получение истории изменений зарубежных площадок за заданный интервал времени
Получение связей
11 GetActivityLocationList Получение списка площадок, связанных с заданным хозяйствующим субъектом
12 GetBusinessMemberByGLN Получение пары "хозяйствующий субъект - площадка" по GLN

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

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

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

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

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

WSDL https://api.vetrf.ru/schema/platform/services/v3.0b-last/DictionaryService_v3.0.wsdl
URL точки доступа (Endpoint) https://api2.vetrf.ru:8002/platform/services/3.0/DictionaryService

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

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

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

№ Название операции / ссылка на спецификацию Описание операции
1 GetPurposeByGuid Получение направления по глобальному идентификатору
2 GetPurposeByUuid Получение направления по идентификатору версии
3 GetPurposeList Получение справочника направлений
4 GetPurposeChangesList Получение истории изменения справочника направлений

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

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

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

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

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

WSDL https://api.vetrf.ru/schema/platform/services/v3.0b-last/ProductService_v3.0.wsdl
URL точки доступа (Endpoint) https://api2.vetrf.ru:8002/platform/services/3.0/ProductService

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

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

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

№ Название операции / ссылка на спецификацию Описание операции
Типы продукции (1 уровень справочника)
- Метод получения отсутствует Фиксированный список типов продукции: тип ProductTypeContentType
Продукция (2 уровень справочника)
1 GetProductByGuid Получение продукции по глобальному идентификатору
2 GetProductByUuid Получение заданной версии продукции
3 GetProductByTypeList Получение списка продукции по заданному типу продукции (1 уровень справочника)
4 GetProductChangesList Получение истории изменений справочника продукции
Виды продукции (3 уровень справочника)
5 GetSubProductByGuid Получение вида продукции по глобальному идентификатору
6 GetSubProductByUuid Получение заданной версии вида продукции
7 GetSubProductByProductList Получение вида продукции по заданной продукции (2 уровень справочника)
8 GetSubProductChangesList Получение истории изменений справочника видов продукции
Наименования продукции / номенклатура (4 уровень справочника)
9 GetProductItemByGuid Получение наименования продукции (номенклатуры) по глобальному идентификатору
10 GetProductItemByUuid Получение заданной версии наименования продукции (номенклатуры)
11 GetProductItemList Получение списка наименований продукции (номенклатуры) с возможностью фильтрации
12 GetProductItemChangesList Получение истории изменений справочника наименований продукции (номенклатуры) с возможностью фильтрации

RegionalizationService (сервис правил регионализации)

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

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

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

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

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

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

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

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

Номер операции Название операции / ссылка на спецификацию Описание операции
1 Ссылка на страницу Описание операции

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

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

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

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

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

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

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

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

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

Номер операции Название операции / ссылка на спецификацию Описание операции
1 Ссылка на страницу Описание операции
Источник — http://help.vetrf.ru/index.php?title=MercuryG2B:Services:v3.0&oldid=39129