Подсистема обработки заявок в Ветис.API: различия между версиями
(не показано 50 промежуточных версий 7 участников) | |||
Строка 1: | Строка 1: | ||
=Общие сведения= | =Общие сведения= | ||
В | Это сервис для выполнения бизнес-операций в специализированных информационных системах Аргус, Меркурий, Веста и т.д. В подсистеме реализован сервис '''ApplicationManagementService''' суть работы которого заключается в приеме, авторизации и маршрутизации заявки к той или иной целевой специализированной информационной системе, получение и предоставление внешней системе результатов обработки заявки. | ||
==Принципы взаимодействия== | ==Принципы взаимодействия== | ||
Работа с сервисом '''ApplicationManagementService''' реализована по псевдо-асинхронному принципу и осуществляется в два шага (оба из которых выполняются синхронно): | |||
* Взаимодействие реализуется посредством запросов | * '''1 шаг''' – подача запроса с заявкой на выполнение бизнес-операции и получение результата приема заявки (идентификатора заявки); | ||
* Любая операция в рамках информационного взаимодействия с | * '''2 шаг''' – подача запроса на получение результата обработки заявки/выполнения бизнес-операции. | ||
Для данной схемы действуют следующие правила: | |||
* Взаимодействие реализуется посредством запросов внешних информационных систем к ApplicationManagementService. "Ветис.API" не может выступать в роли инициатора запроса. Передача информации из "Ветис.API" осуществляется в виде ответа на запрос от внешней информационной системы. | |||
* Любая операция в рамках информационного взаимодействия с "Ветис.API" представляет собой заявку на выполнение бизнес-операции. Заявка от внешней информационной системы попадает в ApplicationManagementService, где обрабатывается. Заявка проходит форматно-логический контроль, регистрацию (ей присваивается уникальный идентификатор), маршрутизируется на целевой внутренний сервис. ApplicationManagementService позволяет отслеживать состояние данной заявки и получать результат ее выполнения. | |||
==Предоставляемые сервисы== | |||
ApplicationManagementService является единой внешней точкой доступа ко всем внутренним бизнес-сервисам специализированных информационных систем. При обращении к ApplicationManagementService для маршрутизации заявки клиент в запросе должен указать идентификатор целевого внутреннего сервиса '''serviceId'''. | |||
ApplicationManagementService предоставляет возможность обращения к следующим целевым сервисам (serviceId) специализированных информационных систем: | |||
* '''mercury-g2b.service''' – сервис системы Меркурий, который обрабатывает заявки от информационных систем хозяйствующих субъектов; | |||
* '''mercury-vu.service''' – сервис системы Меркурий, который обрабатывает заявки от информационных систем ветеринарных управлений. | |||
==Безопасность== | ==Безопасность== | ||
Доступ к сервису ограничивается с помощью ключей доступа к API (APIKey). Ключи доступа | Доступ к сервису ApplicationManagementService ограничивается с помощью ключей доступа к API (APIKey). Ключи доступа предоставляются при [[Ветис.API#Предоставление доступа|регистрации]] внешней информационной системы в качестве клиента "Ветис.API". APIKey - ключ, который идентифицирует клиентскую информационную систему. В сочетании с идентификатором пользователя (issuerId), этот ключ позволяет получать доступ к информации о клиенте сервиса (хозяйствующем субъекте или ветеринарном управлении). | ||
Также перед проверкой APIKey производится базовая аутентификация с помощью логина и пароля, предоставляемых в ответном письме при [[Ветис.API#Предоставление доступа|получении доступа]]. | |||
Процесс авторизации при подключении к универсальному шлюзу "Ветис.API" описан [[Процесс авторизации в шлюзе|здесь]]. | |||
Процесс авторизации при подключении к универсальному шлюзу Ветис.API описан [[Процесс авторизации в шлюзе|здесь]]. | |||
==Бизнес-операции== | ==Бизнес-операции== | ||
Через "Ветис.API" реализована возможность подачи заявок на выполнение следующих операций: | |||
===Меркурий=== | ===Меркурий=== | ||
* [[ | Целевые сервисы '''mercury-g2b.service''' (для хозяйствующих субъектов) и '''mercury-vu.service''' (для ветеринарных управлений), набор операций в каждом сервисе совпадает. | ||
'''Операции версии 2.*''' (целевой сервис '''mercury-g2b.service:2.1''' - для хозяйствующих субъектов) | |||
# [[RegisterProductionOperation_v2|оформление производственной партии]] <!--- - registerProductiveBatch; --> | |||
# [[PrepareOutgoingConsignmentOperation_v2|оформление транспортной партии]] <!--- - prepareOutcomingRequest; --> | |||
# [[ProcessIncomingConsignment_v2|оформление входящей партии]] <!--- - prepareIncomingRequest; --> | |||
# [[ResolveDiscrepancyOperation_v2|оформление результатов инвентаризации]] <!--- - resolveDiscrpepancy; --> | |||
# [[MergeOperation_v2|объединение записей складского журнала]] <!--- - mergeStockEntries; --> | |||
# [[GetVetDocumentByUuidOperation_v2|получение ВСД по его идентификатору]] <!--- - getVetDocumentByUUID; --> | |||
# [[GetVetDocumentChangesListOperation_v2|получение ВСД, созданных или измененных за указанный интервал дат (получение истории изменений)]] <!--- - getVetDocumentChangsList; --> | |||
# [[GetVetDocumentListOperation_v2|получение всех ВСД предприятия с возможностью фильтрации]] <!--- - getVetDocumentList; --> | |||
# [[GetStockEntryByUuidOperation_v2|получение конкретной версии записи складского журнала по ее идентификатору]] <!--- - getStockEntryByUUID; --> | |||
# [[GetStockEntryByGuidOperation_v2|получение последней (актуальной) версии записи складского журнала по ее идентификатору]] <!--- - getStockEntryByGUID; --> | |||
# [[GetStockEntryVersionListOperation_v2|получение всех версий записи складского журнала по ее идентификатору]] <!--- - getStockEntryVersionList; --> | |||
# [[GetStockEntryListOperation_v2|получение актуального списка записей журнала]] <!--- - getStockEntryList; --> | |||
# [[GetStockEntryChangesListOperation_v2|получение списка версий записей журнала, созданных или измененных за указанный интервал дат (получение истории изменений)]] <!--- - getStockEntryChangesList; --> | |||
# [[ModifyBusinessEntityOperation_v2|добавление/изменение сведений о хозяйствующем субъекте]] <!--- - modifyBusinessEntity; --> | |||
# [[ModifyEnterpriseOperation_v2|добавление/изменение сведений о поднадзорном объекте]] <!--- - modifyEnterprise; --> | |||
# [[WithdrawVetDocumentOperation_v2|аннулирование ВСД]] <!--- - withdrawVetDocument; --> | |||
# [[ModifyActivityLocationsOperation_v2|создание/удаление связи с площадкой]] <!--- - modifyActivityLocations; --> | |||
# [[ModifyProducerStockListOperation_v2|добавление номенклатуры производителя в справочник]] <!--- - modifyProducerStockList --> | |||
# [[UpdateTransportMovementDetailsOperation_v2|внесение номеров транспортных средств в пунктах перегрузки в оформленный ВСД]] <!--- - updateTransportMovementDetails--> | |||
# [[UpdateVeterinaryEventsOperation_v2|внесение сведений о ветеринарных мероприятиях]] <!--- - UpdateVeterinaryEvents--> | |||
# [[CheckShipmentRegionalizationOperation_v2|проверка возможности осуществления перевозки партии в рамках регионализации]] <!--- - CheckShipmentRegionalization--> | |||
# [[AddBussinessEntityUser_v2|регистрация и привязка пользователей к хозяйствующему субъекту]] | |||
# [[UpdateUserAuthorities_v2|назначение прав пользователям]] | |||
# [[UnbindBusinessEntityUser_v2|удаление связи пользователей с хозяйствующим субъектом]] | |||
# [[UpdateUserWorkingAreas_v2|назначение зон ответственности пользователей]] | |||
# [[GetBusinessEntityUser_v2|получение пользователя по login]] | |||
# [[GetBusinessEntityUserList_v2|получение списка пользователей хозяйствующего субъекта]] | |||
# [[GetApplicableUserAuthorityList_v2|получение списка доступных для назначения прав пользователей]] | |||
===Хорриот=== | |||
Целевой сервис [[Herriot:Services:v1.0|'''herriot.service:1.0''']]. | |||
Сервис позволяет вносить в [[Компонент Хорриот|компонент Хорриот]] информацию, связанную с маркировкой и учетом животных, и получать от компонента Хорриот эту информацию. | |||
# [[Herriot:RegisterAnimal:v1.0|Регистрация животного или группы животных]] <!--- - RegisterAnimal; --> | |||
# [[Herriot:ModifyAnimalRegistration:v1.0|Внесение изменений в основные сведения о зарегистрированном животном или группе животных]] <!--- - ModifyAnimalRegistration; --> | |||
# [[Herriot:RegisterAnimalMovementEvent:v1.0|Регистрация сведения о перемещении/смене собственника зарегистрированного животного или групп животных]] <!--- - RegisterAnimalMovementEvent; --> | |||
# [[Herriot:TerminateAnimalRegistration:v1.0|Прекращение регистрации животного или группы животных (выбытие животного)]] <!--- - TerminateAnimalRegistration; --> | |||
# [[Herriot:WithdrawAnimalRegistration:v1.0|Аннулирование сведений о регистрации животного или группы животных]] <!--- - WithdrawAnimalRegistration; --> | |||
# [[Herriot:GetAnimalRegistrationByGuid:v1.0|Получение основных актуальных сведений о регистрации животного или группы животных по глобальному идентификатору]] <!--- - GetAnimalRegistrationByGuid; --> | |||
# [[Herriot:GetAnimalRegistrationHistory:v1.0|Получение всей истории изменений сведений о регистрации животного или группы животных по глобальному идентификатору]] <!--- - GetAnimalRegistrationHistory; --> | |||
# [[Herriot:GetAnimalRegistrationChangesList:v1.0|Получение списка изменений по основным сведениям о регистрации животных или групп животных за указанный период]] <!--- - GetAnimalRegistrationChangesList; --> | |||
# [[Herriot:GetAnimalRegistrationByUuid:v1.0|Получение редакции основных сведений о регистрации животного или группы животных по идентификатору конкретной версии (редакции)]] <!--- - GetAnimalRegistrationByUuid; --> | |||
# [[Herriot:RegisterAnimalIdentity:v1.0|Регистрация сведений об идентификации зарегистрированного животного или группы животных (маркирование)]] <!--- - RegisterAnimalIdentity; --> | |||
# [[Herriot:RemoveAnimalIdentity:v1.0|Прекращение регистрации сведений об идентификации зарегистрированного животного или группы животных (выбытие средства маркирования)]] <!--- - RemoveAnimalIdentity; --> | |||
# [[Herriot:ReplaceAnimalIdentity:v1.0|Перерегистрация сведений об идентификации зарегистрированного животного или группы животных (замена средства маркирования)]] <!--- - ReplaceAnimalIdentity; --> | |||
# [[Herriot:WithdrawAnimalIdentity:v1.0|Аннулирование сведений о регистрации сведений об идентификации животного или группы животных]] <!--- - WithdrawAnimalIdentity; --> | |||
# [[Herriot:RegisterAnimalVeterinaryEvent:v1.0|Регистрация ветеринарного профилактического мероприятия]] <!--- - RegisterAnimalVeterinaryEvent; --> | |||
# [[Herriot:ModifyAnimalVeterinaryEvent:v1.0|Редактирование сведений о ветеринарном профилактическом мероприятии]] <!--- - ModifyAnimalVeterinaryEvent; --> | |||
# [[Herriot:WithdrawAnimalVeterinaryEvent:v1.0|Аннулирование сведений о ветеринарном профилактическом мероприятии]] <!--- - WithdrawAnimalVeterinaryEvent; --> | |||
# [[Herriot:GetAnimalVeterinaryEventByGuid:v1.0|Получение актуальных сведений о зарегистрированном ветеринарном профилактическом мероприятии по глобальному идентификатору]] <!--- - GetAnimalVeterinaryEventByGuid; --> | |||
# [[Herriot:GetAnimalVeterinaryEventChangesList:v1.0|Получение списка изменений сведений о зарегистрированных ветеринарных профилактических мероприятиях за указанный период]] <!--- - GetAnimalVeterinaryEventChangesList; --> | |||
# [[Herriot:GetAnimalVeterinaryEventHistory:v1.0|Получение всей истории изменений ветеринарного профилактического мероприятия по глобальному идентификатору]] <!--- - GetAnimalVeterinaryEventHistory; --> | |||
# [[Herriot:GetAnimalVeterinaryEventByUuid:v1.0|Получение сведений о редакции ветеринарного профилактического мероприятия по идентификатору версии]] <!--- - GetAnimalVeterinaryEventByUuid; --> | |||
===Маркировка товаров (ГИС МТ)=== | |||
Целевой сервис '''crpt-gateway.service''' | |||
'''Операции версии 1.*''' | |||
# [[DispatchICOrder|создание заказов на эмиссию кодов маркировки]] <!--- - registerProductiveBatch; --> | |||
# [[GetICCommitReportList|получение списка отчетов о вводе в оборот]] <!--- - prepareOutcomingRequest; --> | |||
==Возможные сценарии== | ==Возможные сценарии== | ||
Строка 46: | Строка 102: | ||
::* Внутренняя ошибка системы.<br /> | ::* Внутренняя ошибка системы.<br /> | ||
На вход сервиса ''' | На вход сервиса '''ApplicationManagementService''' передаются следующие сведения: | ||
* API key; | * API key; | ||
* код запрашиваемого сервиса; | * код запрашиваемого сервиса; | ||
Строка 56: | Строка 112: | ||
* статус готовности результата. | * статус готовности результата. | ||
Для получения результата обработки заявки необходимо [[ | Для получения результата обработки заявки необходимо [[#Получение результата обработки заявки|запросить результат по идентификатору заявки]]. | ||
==Используемые пространства имен и типы== | ==Используемые пространства имен и типы== | ||
Строка 115: | Строка 171: | ||
|- | |- | ||
| '''serviceId''' || Код запрашиваемого сервиса (системы, к которой обращается пользователь). | | '''serviceId''' || Код запрашиваемого сервиса (системы, к которой обращается пользователь). | ||
* '''mercury-g2b.service''' - сервис системы Меркурий. | * '''mercury-g2b.service''' - сервис системы Меркурий, который обрабатывает заявки от хозяйствующих субъектов. | ||
* '''mercury-vu.service''' - сервис системы Меркурий, который обрабатывает заявки от ветеринарных управлений. | |||
|| [http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName] || 1 | || [http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName] || 1 | ||
|- | |- | ||
| '''issuerId''' || Идентификатор хозяйствующего субъекта от имени которого происходит обращение к Ветис.API. Указанный хозяйствующий субъект должен быть одним из хозяйствующих субъектов, обслуживаемых данной программной системой. Перечень обслуживаемых программной системой хозяйствующих субъектов устанавливается при предоставлении доступа к Ветис.API. || [[UUID|bs:UUID]] || 1 | | '''issuerId''' || Идентификатор хозяйствующего субъекта от имени которого происходит обращение к Ветис.API. Указанный хозяйствующий субъект должен быть одним из хозяйствующих субъектов, обслуживаемых данной программной системой. Перечень обслуживаемых программной системой хозяйствующих субъектов устанавливается при предоставлении доступа к Ветис.API. || [[UUID|bs:UUID]] || 1 | ||
|- | |- | ||
| '''issueDate''' || Дата обращения пользователя к заявочной системе. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1 | | '''issueDate''' || Дата и время обращения пользователя к заявочной системе. Устанавливается разработчиком клиентской системы. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1 | ||
|- | |- | ||
| '''data''' || Сведения о заявке.|| [[ApplicationDataWrapper|app:ApplicationDataWrapper]] || 1 | | '''data''' || Сведения о заявке.|| [[ApplicationDataWrapper|app:ApplicationDataWrapper]] || 1 | ||
Строка 166: | Строка 223: | ||
| '''issuerId''' || Идентификатор хозяйствующего субъекта от имени которого происходит обращение к Ветис.API. Указанный хозяйствующий субъект должен быть одним из хозяйствующих субъектов, обслуживаемых данной программной системой. Перечень обслуживаемых программной системой хозяйствующих субъектов устанавливается при предоставлении доступа к Ветис.API. || [[UUID|bs:UUID]] || 1 | | '''issuerId''' || Идентификатор хозяйствующего субъекта от имени которого происходит обращение к Ветис.API. Указанный хозяйствующий субъект должен быть одним из хозяйствующих субъектов, обслуживаемых данной программной системой. Перечень обслуживаемых программной системой хозяйствующих субъектов устанавливается при предоставлении доступа к Ветис.API. || [[UUID|bs:UUID]] || 1 | ||
|- | |- | ||
| '''issueDate''' || Дата и время | | '''issueDate''' || Дата и время обращения пользователя к заявочной системе. Устанавливается разработчиком клиентской системы. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1 | ||
|- | |- | ||
| '''rcvDate''' || Дата и время формирования результата. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1 | | '''rcvDate''' || Дата и время формирования результата. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1 | ||
Строка 196: | Строка 253: | ||
| '''issuerId''' || Идентификатор пользователя, обратившегося к заявочной системе. || [[UUID|bs:UUID]] || 1 | | '''issuerId''' || Идентификатор пользователя, обратившегося к заявочной системе. || [[UUID|bs:UUID]] || 1 | ||
|- | |- | ||
| '''applicationId''' || Идентификатор заявки, в заявочной системе. || [[UUID|bs:UUID]] || 1 | | '''applicationId''' || Идентификатор заявки, в заявочной системе. Хранится в базе в течение 3-х дней. По истечении 3-х дней получить ответ по applicationId будет невозможно.|| [[UUID|bs:UUID]] || 1 | ||
|} | |} | ||
Строка 244: | Строка 301: | ||
| '''issuerId''' || Идентификатор хозяйствующего субъекта от имени которого происходит обращение к Ветис.API. Указанный хозяйствующий субъект должен быть одним из хозяйствующих субъектов, обслуживаемых данной программной системой. Перечень обслуживаемых программной системой хозяйствующих субъектов устанавливается при предоставлении доступа к Ветис.API. || [[UUID|bs:UUID]]|| 1 | | '''issuerId''' || Идентификатор хозяйствующего субъекта от имени которого происходит обращение к Ветис.API. Указанный хозяйствующий субъект должен быть одним из хозяйствующих субъектов, обслуживаемых данной программной системой. Перечень обслуживаемых программной системой хозяйствующих субъектов устанавливается при предоставлении доступа к Ветис.API. || [[UUID|bs:UUID]]|| 1 | ||
|- | |- | ||
| '''issueDate''' || Дата и время | | '''issueDate''' || Дата и время обращения пользователя к заявочной системе. Устанавливается разработчиком клиентской системы. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1 | ||
|- | |- | ||
| '''rcvDate''' || Дата и время формирования результата. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1 | | '''rcvDate''' || Дата и время формирования результата. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1 |
Текущая версия на 10:33, 8 февраля 2024
Общие сведения
Это сервис для выполнения бизнес-операций в специализированных информационных системах Аргус, Меркурий, Веста и т.д. В подсистеме реализован сервис ApplicationManagementService суть работы которого заключается в приеме, авторизации и маршрутизации заявки к той или иной целевой специализированной информационной системе, получение и предоставление внешней системе результатов обработки заявки.
Принципы взаимодействия
Работа с сервисом ApplicationManagementService реализована по псевдо-асинхронному принципу и осуществляется в два шага (оба из которых выполняются синхронно):
- 1 шаг – подача запроса с заявкой на выполнение бизнес-операции и получение результата приема заявки (идентификатора заявки);
- 2 шаг – подача запроса на получение результата обработки заявки/выполнения бизнес-операции.
Для данной схемы действуют следующие правила:
- Взаимодействие реализуется посредством запросов внешних информационных систем к ApplicationManagementService. "Ветис.API" не может выступать в роли инициатора запроса. Передача информации из "Ветис.API" осуществляется в виде ответа на запрос от внешней информационной системы.
- Любая операция в рамках информационного взаимодействия с "Ветис.API" представляет собой заявку на выполнение бизнес-операции. Заявка от внешней информационной системы попадает в ApplicationManagementService, где обрабатывается. Заявка проходит форматно-логический контроль, регистрацию (ей присваивается уникальный идентификатор), маршрутизируется на целевой внутренний сервис. ApplicationManagementService позволяет отслеживать состояние данной заявки и получать результат ее выполнения.
Предоставляемые сервисы
ApplicationManagementService является единой внешней точкой доступа ко всем внутренним бизнес-сервисам специализированных информационных систем. При обращении к ApplicationManagementService для маршрутизации заявки клиент в запросе должен указать идентификатор целевого внутреннего сервиса serviceId.
ApplicationManagementService предоставляет возможность обращения к следующим целевым сервисам (serviceId) специализированных информационных систем:
- mercury-g2b.service – сервис системы Меркурий, который обрабатывает заявки от информационных систем хозяйствующих субъектов;
- mercury-vu.service – сервис системы Меркурий, который обрабатывает заявки от информационных систем ветеринарных управлений.
Безопасность
Доступ к сервису ApplicationManagementService ограничивается с помощью ключей доступа к API (APIKey). Ключи доступа предоставляются при регистрации внешней информационной системы в качестве клиента "Ветис.API". APIKey - ключ, который идентифицирует клиентскую информационную систему. В сочетании с идентификатором пользователя (issuerId), этот ключ позволяет получать доступ к информации о клиенте сервиса (хозяйствующем субъекте или ветеринарном управлении).
Также перед проверкой APIKey производится базовая аутентификация с помощью логина и пароля, предоставляемых в ответном письме при получении доступа.
Процесс авторизации при подключении к универсальному шлюзу "Ветис.API" описан здесь.
Бизнес-операции
Через "Ветис.API" реализована возможность подачи заявок на выполнение следующих операций:
Меркурий
Целевые сервисы mercury-g2b.service (для хозяйствующих субъектов) и mercury-vu.service (для ветеринарных управлений), набор операций в каждом сервисе совпадает.
Операции версии 2.* (целевой сервис mercury-g2b.service:2.1 - для хозяйствующих субъектов)
- оформление производственной партии
- оформление транспортной партии
- оформление входящей партии
- оформление результатов инвентаризации
- объединение записей складского журнала
- получение ВСД по его идентификатору
- получение ВСД, созданных или измененных за указанный интервал дат (получение истории изменений)
- получение всех ВСД предприятия с возможностью фильтрации
- получение конкретной версии записи складского журнала по ее идентификатору
- получение последней (актуальной) версии записи складского журнала по ее идентификатору
- получение всех версий записи складского журнала по ее идентификатору
- получение актуального списка записей журнала
- получение списка версий записей журнала, созданных или измененных за указанный интервал дат (получение истории изменений)
- добавление/изменение сведений о хозяйствующем субъекте
- добавление/изменение сведений о поднадзорном объекте
- аннулирование ВСД
- создание/удаление связи с площадкой
- добавление номенклатуры производителя в справочник
- внесение номеров транспортных средств в пунктах перегрузки в оформленный ВСД
- внесение сведений о ветеринарных мероприятиях
- проверка возможности осуществления перевозки партии в рамках регионализации
- регистрация и привязка пользователей к хозяйствующему субъекту
- назначение прав пользователям
- удаление связи пользователей с хозяйствующим субъектом
- назначение зон ответственности пользователей
- получение пользователя по login
- получение списка пользователей хозяйствующего субъекта
- получение списка доступных для назначения прав пользователей
Хорриот
Целевой сервис herriot.service:1.0. Сервис позволяет вносить в компонент Хорриот информацию, связанную с маркировкой и учетом животных, и получать от компонента Хорриот эту информацию.
- Регистрация животного или группы животных
- Внесение изменений в основные сведения о зарегистрированном животном или группе животных
- Регистрация сведения о перемещении/смене собственника зарегистрированного животного или групп животных
- Прекращение регистрации животного или группы животных (выбытие животного)
- Аннулирование сведений о регистрации животного или группы животных
- Получение основных актуальных сведений о регистрации животного или группы животных по глобальному идентификатору
- Получение всей истории изменений сведений о регистрации животного или группы животных по глобальному идентификатору
- Получение списка изменений по основным сведениям о регистрации животных или групп животных за указанный период
- Получение редакции основных сведений о регистрации животного или группы животных по идентификатору конкретной версии (редакции)
- Регистрация сведений об идентификации зарегистрированного животного или группы животных (маркирование)
- Прекращение регистрации сведений об идентификации зарегистрированного животного или группы животных (выбытие средства маркирования)
- Перерегистрация сведений об идентификации зарегистрированного животного или группы животных (замена средства маркирования)
- Аннулирование сведений о регистрации сведений об идентификации животного или группы животных
- Регистрация ветеринарного профилактического мероприятия
- Редактирование сведений о ветеринарном профилактическом мероприятии
- Аннулирование сведений о ветеринарном профилактическом мероприятии
- Получение актуальных сведений о зарегистрированном ветеринарном профилактическом мероприятии по глобальному идентификатору
- Получение списка изменений сведений о зарегистрированных ветеринарных профилактических мероприятиях за указанный период
- Получение всей истории изменений ветеринарного профилактического мероприятия по глобальному идентификатору
- Получение сведений о редакции ветеринарного профилактического мероприятия по идентификатору версии
Маркировка товаров (ГИС МТ)
Целевой сервис crpt-gateway.service
Операции версии 1.*
Возможные сценарии
При обработке запроса возможны следующие сценарии.
1. Запрос успешно обработан.
- Заявка требует обработки.
- Результат сформирован в рамках запроса(cтатус заявки-completed).
- Заявка требует обработки.
2. Произошла ошибка при обработке запроса.
- Некорректный запрос.
- Запрос не прошёл проверку на бизнес-правила.
- Внутренняя ошибка системы.
- Некорректный запрос.
На вход сервиса ApplicationManagementService передаются следующие сведения:
- API key;
- код запрашиваемого сервиса;
- идентификатор пользователя;
- заявка на выполнение операции.
Результатом обработки заявки в заявочной системе является:
- сгенерированный идентификатор заявки;
- статус готовности результата.
Для получения результата обработки заявки необходимо запросить результат по идентификатору заявки.
Используемые пространства имен и типы
|
Подача заявки
Данные запроса
Структура данных запроса в формате ХML.
<ws:submitApplicationRequest>
<ws:apiKey>{app:APIKey}</ws:apiKey>
<app:application>
<app:serviceId>{xs:NCName}</app:serviceId>
<app:issuerId>{bs:UUID}</app:issuerId>
<app:issueDate>{xs:dateTime}</app:issueDate>
<app:data>{app:ApplicationDataWrapper}</app:data>
</app:application>
</ws:submitApplicationRequest>
Объект submitApplicationRequest
Заявка в единой заявочной системе на выполнение определенной операции, определяет пользователя, который инициирует запрос и содержит сведения самого запроса.
Поле | Описание | Тип | Обязательность |
---|---|---|---|
apiKey | Специальный код, который идентифицирует учетную запись пользователя и позволяет веб-сервису получить доступ к информации о хозяйствующем субъекте и обслуживаемых предприятиях, к которым данный пользователь относится. | app:APIKey | 1 |
application | Сведения о заявке. | app:application | 1 |
Объект submitApplicationRequest/application
Сведения о заявке.
Поле | Описание | Тип | Обязательность |
---|---|---|---|
serviceId | Код запрашиваемого сервиса (системы, к которой обращается пользователь).
|
xs:NCName | 1 |
issuerId | Идентификатор хозяйствующего субъекта от имени которого происходит обращение к Ветис.API. Указанный хозяйствующий субъект должен быть одним из хозяйствующих субъектов, обслуживаемых данной программной системой. Перечень обслуживаемых программной системой хозяйствующих субъектов устанавливается при предоставлении доступа к Ветис.API. | bs:UUID | 1 |
issueDate | Дата и время обращения пользователя к заявочной системе. Устанавливается разработчиком клиентской системы. | xs:dateTime | 1 |
data | Сведения о заявке. | app:ApplicationDataWrapper | 1 |
Данные ответа
Структура данных запроса в формате ХML.
<submitApplicationResponse xmlns="http://api.vetrf.ru/schema/cdm/application/ws-definitions">
<application xmlns="http://api.vetrf.ru/schema/cdm/application">
<applicationId>{bs:UUID}</applicationId>
<status>{app:ApplicationStatus}</status>
<serviceId>{xs:NCName}</serviceId>
<issuerId>{bs:UUID}</issuerId>
<issueDate>{xs:dateTime}</issueDate>
<rcvDate>{xs:dateTime}</rcvDate>
</application>
</submitApplicationResponse>
Объект submitApplicationResponse
Заявка в заявочной системе, содержит сведения запроса.
Поле | Описание | Тип | Обязательность |
---|---|---|---|
application | Сведения о заявке. | app:Application | 1 |
Объект submitApplicationResponse/application
Поле | Описание | Тип | Обязательность |
---|---|---|---|
applicationId | Сгенерированный идентификатор заявки. | bs:UUID | 1 |
status | Статус готовности результата. | app:ApplicationStatus | 1 |
serviceId | Код запрашиваемого сервиса (системы, к которой обращается пользователь). | xs:NCName | 1 |
issuerId | Идентификатор хозяйствующего субъекта от имени которого происходит обращение к Ветис.API. Указанный хозяйствующий субъект должен быть одним из хозяйствующих субъектов, обслуживаемых данной программной системой. Перечень обслуживаемых программной системой хозяйствующих субъектов устанавливается при предоставлении доступа к Ветис.API. | bs:UUID | 1 |
issueDate | Дата и время обращения пользователя к заявочной системе. Устанавливается разработчиком клиентской системы. | xs:dateTime | 1 |
rcvDate | Дата и время формирования результата. | xs:dateTime | 1 |
Получение результата обработки заявки
Данные запроса
Структура данных запроса в формате ХML.
<ws:receiveApplicationResultRequest>
<ws:apiKey>{xs:string}</ws:apiKey>
<ws:issuerId>{bs:UUID}</ws:issuerId>
<ws:applicationId>{bs:UUID}</ws:applicationId>
</ws:receiveApplicationResultRequest>
Объект receiveApplicationResultRequest
Запрос на получение результатов обработки заявки.
Поле | Описание | Тип | Обязательность |
---|---|---|---|
apiKey | Специальный код, который идентифицирует учетную запись пользователя и позволяет веб-сервису получить доступ к информации о хозяйствующем субъекте и обслуживаемых предприятиях, к которым данный пользователь относится. | xs:string | 1 |
issuerId | Идентификатор пользователя, обратившегося к заявочной системе. | bs:UUID | 1 |
applicationId | Идентификатор заявки, в заявочной системе. Хранится в базе в течение 3-х дней. По истечении 3-х дней получить ответ по applicationId будет невозможно. | bs:UUID | 1 |
Данные ответа
Структура данных ответа в формате ХML.
<receiveApplicationResultResponse xmlns="http://api.vetrf.ru/schema/cdm/application/ws-definitions">
<application xmlns="http://api.vetrf.ru/schema/cdm/application">
<applicationId>{bs:UUID}</applicationId>
<status>{app:ApplicationStatus}</status>
<serviceId>{xs:NCName}</serviceId>
<issuerId>{bs:UUID}</issuerId>
<issueDate>{xs:dateTime}</issueDate>
<rcvDate>{xs:dateTime}</rcvDate>
<prdcRsltDate>{xs:dateTime}</prdcRsltDate>
<result>
<...>
</result>
</application>
</receiveApplicationResultResponse>
Объект receiveApplicationResultResponse
Получение результатов обработки заявки.
Поле | Описание | Тип | Обязательность |
---|---|---|---|
application | Сведения о заявке. | app:Application | 1 |
Объект receiveApplicationResultResponse/application
Поле | Описание | Тип | Обязательность |
---|---|---|---|
applicationId | Сгенерированный идентификатор заявки. | bs:UUID | 1 |
status | Статус готовности результата. | app:ApplicationStatus | 1 |
serviceId | Код запрашиваемого сервиса (системы, к которой обращается пользователь). | xs:NCName | 1 |
issuerId | Идентификатор хозяйствующего субъекта от имени которого происходит обращение к Ветис.API. Указанный хозяйствующий субъект должен быть одним из хозяйствующих субъектов, обслуживаемых данной программной системой. Перечень обслуживаемых программной системой хозяйствующих субъектов устанавливается при предоставлении доступа к Ветис.API. | bs:UUID | 1 |
issueDate | Дата и время обращения пользователя к заявочной системе. Устанавливается разработчиком клиентской системы. | xs:dateTime | 1 |
rcvDate | Дата и время формирования результата. | xs:dateTime | 1 |
prdcRsltDate | Дата и время получения результата выполнения заявки. | xs:dateTime | 1 |
result | Результат выполнения заявки. | app:ApplicationResultWrapper | 1 |