MercuryG2B:Services:v3.0
Версия от 11:07, 13 июня 2024; Dovgan-aj-230414 (обсуждение | вклад) (→Операции, выполняемые через IkarService)
Версии профиля API
- v3.0 – MercuryG2B:Services:v3.0
- v3.0b-20231110 – mercury-g2b-schemas-v3.0b-20231110.zip
- v3.0b-20231005 – mercury-g2b-schemas-v3.0b-20231005.zip
История изменений
Описание основных изменений ВетИС.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 | Да |
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) | https://api2.vetrf.ru:8002/platform/services/3.0/EnterpriseService |
Общие сведения
Сервис EnterpriseService предназначен для работы с реестром хозяйствующих субъектов и предприятий.
Операции, выполняемые через EnterpriseService
Код операции | Название операции / ссылка на спецификацию | Описание операции |
---|---|---|
Получение записей реестра хозяйствующих субъектов | ||
1 | GetBusinessEntityByUuid | Получение заданной версии хозяйствующего субъекта |
2 | GetBusinessEntityByGuid | Получение последней версии хозяйствующего субъекта по глобальному идентификатору |
3 | GetBusinessEntityList | Получение списка хозяйствующих субъектов с возможностью фильтрации |
4 | GetBusinessEntityChangesList | Получение истории изменений хозяйствующих субъектов за заданный интервал времени |
Получение записей реестра предприятий (площадок) | ||
5 | GetEnterpriseByUuid | Получение заданной версии площадки |
6 | GetEnterpriseByGuid | Получение последней версии площадки по глобальному идентификатору |
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
Код операции | Название операции / ссылка на спецификацию | Описание операции |
---|---|---|
Заболевания | ||
... | GetDiseaseByUuid | Получение заболевания по идентификатору |
... | GetDiseaseByGuid | Получение заболевания по глобальному идентификатору |
... | GetDiseaseList | Получение списка заболеваний |
... | GetDiseaseChangesList | Получение списка измененных заболеваний за определенный период времени |
Код операции | Название операции / ссылка на спецификацию | Описание операции |
Направления | ||
1 | GetPurposeByGuid | Получение направления по глобальному идентификатору |
2 | GetPurposeByUuid | Получение направления по идентификатору версии |
3 | GetPurposeList | Получение справочника направлений |
4 | GetPurposeChangesList | Получение истории изменения справочника направлений |
Код операции | Название операции / ссылка на спецификацию | Описание операции |
Единицы измерений | ||
... | GetUnitByUuid | Получение заданной версии единицы измерения |
... | GetUnitByGuid | Получение единицы измерения по глобальному идентификатору |
... | GetUnitList | Получение актуального списка единиц измерения |
... | GetUnitChangesList | Получение истории изменений справочника единиц измерения |
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) | https://api2.vetrf.ru:8002/platform/services/3.0/RegionalizationService |
Общие сведения
Сервис RegionalizationService предназначен для проверки благополучия регионов и получения правил регионализации.
Операции, выполняемые через RegionalizationService
Код операции | Название операции / ссылка на спецификацию | Описание операции |
---|---|---|
RS.MERC.1.1 | GetR13nConditionList | Получение списка условий перемещения груза по правилам регионализации |
RS.MERC.1.2 | GetActualR13nRegionStatusList | Получение списка статусов регионов по конкретному заболеванию |
RS.MERC.1.3 | GetActualR13nShippingRuleList | Получение списка правил перемещения по конкретному заболеванию |
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) | https://api2.vetrf.ru:8002/platform/services/3.0/IkarService |
Общие сведения
Сервис IkarService предназначен для получения адресной информации.
Операции, выполняемые через IkarService
Код операции | Название операции / ссылка на спецификацию | Описание операции |
---|---|---|
Страны | Код: IS.MERC.1 | ||
IS.MERC.1.1 | GetCountryByUuid | Получение заданной версии страны |
IS.MERC.1.2 | GetCountryByGuid | Получение страны по глобальному идентификатору |
IS.MERC.1.3 | GetAllCountryList | Получение списка всех стран |
IS.MERC.1.4 | GetCountryChangesList | Получение истории изменений справочника стран за заданный интервал времени |
Регионы | Код: IS.MERC.2 | ||
IS.MERC.2.1 | GetRegionByUuid | Получение заданной версии региона |
IS.MERC.2.2 | GetRegionByGuid | Получение региона по глобальному идентификатору |
IS.MERC.2.3 | GetRegionListByCountry | Получение списка всех регионов заданной страны |
IS.MERC.2.4 | GetRegionChangesList | Получение истории изменений справочника регионов за заданный интервал времени |
Районы | Код: IS.MERC.3 | ||
IS.MERC.3.1 | GetDistrictByUuid | Получение заданной версии района |
IS.MERC.3.2 | GetDistrictByGuid | Получение района по глобальному идентификатору |
IS.MERC.3.3 | GetDistrictListByRegion | Получение списка всех районов заданного региона |
IS.MERC.3.4 | GetDistrictChangesList | Получение истории изменений справочника районов за заданный интервал времени |
Населённые пункты | Код: IS.MERC.4 | ||
IS.MERC.4.1 | GetLocalityListByRegion | Получение населённых пунктов заданного региона |
IS.MERC.4.2 | GetLocalityListByDistrict | Получение населённых пунктов заданного района |
IS.MERC.4.3 | GetLocalityListByLocality | Получение населённых пунктов заданного населённого пункта |
IS.MERC.4.4 | GetLocalityChangesList | Получение истории изменений справочника населённых пунктов за заданный интервал времени |
IS.MERC.4.5 | FindLocalityListByName | Поиск населённых пунктов по названию |
Улицы | Код: IS.MERC.5 | ||
IS.MERC.5.1 | GetStreetListByLocality | Получение улиц заданного населённого пункта |
IS.MERC.5.2 | GetStreetChangesList | Получение истории изменений справочника улиц за заданный интервал времени |
IS.MERC.5.3 | FindStreetListByName | Поиск улиц по названию |