Подсистема обработки заявок в Ветис.API

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

Общая информация

В целях обеспечения эффективного информационного обмена между внешними информационными системами и ГИС «Ветис» взаимодействие организуется через универсальный шлюз Ветис.API с использованием заявочной системы. Информационный обмен реализован по асинхронной схеме. Для данной схемы действуют следующие правила:

  1. Взаимодействие реализуется посредством запросов ИС Предприятий к заявочной системе. ГИС «Ветис» не может выступать в роли инициатора запроса к системе предприятия. Передача информации из ГИС «Ветис» осуществляется в виде ответа на запрос ИС предприятия.
  2. Любая операция в рамках информационного взаимодействия с ГИС «Ветис» представляет собой заявку на осуществление некоторых действий. Заявка от ИС Предприятия попадает в заявочную систему, где обрабатывается. Заявка проходит форматно-логический контроль, регистрацию и ей присваивается уникальный идентификатор. По каждой заявке сервис формирует ответ, который может быть запрошен учетной системой предприятия по ее идентификатору с использованием отдельной операции.
  3. Любой запрос в рамках информационного взаимодействия через универсальный шлюз "Ветис.API" должен содержать идентификационные данные хозяйствующего субъекта, производственной площадки, на которой осуществляется бизнес-операция, а также персональные аутентификационные данные сотрудника организации в ИС «Меркурий», осуществляющего действия в ИС предприятия, инициирующие операции по информационному обмену. Таким образом, важным условием осуществления информационного взаимодействия является предварительная регистрация хозяйствующего субъекта, его производственной площадки и ответственных лиц в ИС «Меркурий».

Операция Application предназначена для подачи заявки к универсальному шлюзу "Ветис.API". На вход системы, в зависимости от сценария, передаются следующие сведения:

Для получения результата обработки заявки необходимо запросить результат по идентификатору заявки.

Возможные сценарии

При обработке запроса возможны следующие сценарии.
2.1 Запрос успешно обработан.
2.1.1 Заявка требует обработки.
2.1.2 Результат сформирован в рамках запроса(cтатус заявки-completed).
2.2 Произошла ошибка при обработке запроса.
2.2.1 Некорректный запрос.
2.2.2 Запрос не прошёл проверку на бизнес-правила.
2.2.3 Внутренняя ошибка системы.

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

Запрос статуса заявки

Данные запроса

Структура данных запроса в формате ХML. 

   <ws:submitApplicationRequest>
         <ws:apiKey>ZmUyMGM3M2EyMThhMTFlMmE2OWJiNDk5YmFiYWU3ZWHQodGAINGP0L3QsiAxNCAxMjoxOTo1NyBNU0sgMjAxNQ==</ws:apiKey>
         <app:application>
            <app:serviceId>mercury-g2b.service</app:serviceId>
            <app:issuerId>fc479683-26f8-49b3-a76c-f35a289eadcd</app:issuerId>
            <app:issueDate>2015-01-10T17:03:00</app:issueDate>
            <app:data>
                <…>
            </app:data>
         </app:application>
      </ws:submitApplicationRequest>


Объект submitApplicationRequest

Заявка в заявочной системе, определяет пользователя, который инициирует запрос и содержит сведения самого запроса.

Поле Описание Тип Обязательность
apiKey Специальный код, который идентифицирует учетную запись пользователя и позволяет веб-сервису получить доступ к информации о хозяйствующем субъекте и обслуживаемых предприятиях, к которым данный пользователь относится. 1
application Сведения о заявке. 1

Объект application

Поле Описание Тип Обязательность
serviceId Код запрашиваемого сервиса (системы, к которой обращается пользователь). 1
issuerId Идентификатор пользователя, обратившегося к заявочной системе. 1
issueDate Дата обращения пользователя к заявочной системе. 1
data Сведения о заявке. 1

Данные ответа

Структура данных запроса в формате ХML. 

      <submitApplicationResponse xmlns="http://api.vetrf.ru/schema/cdm/application/ws-definitions">
         <application xmlns="http://api.vetrf.ru/schema/cdm/application">
            <applicationId>433551e9-8077-431c-9a0f-80eec7fd6fb3</applicationId>
            <status>ACCEPTED</status>
            <serviceId>mercury-g2b.service</serviceId>
            <issuerId>fc479683-26f8-49b3-a76c-f35a289eadcd</issuerId>
            <issueDate>2015-04-20T08:29:28</issueDate>
            <rcvDate>2015-05-05T15:41:00</rcvDate>
         </application>
      </submitApplicationResponse>

Объект submitApplicationResponse

Заявка в заявочной системе, определяет пользователя, который инициирует запрос и содержит сведения самого запроса.

Поле Описание Тип Обязательность
application Сведения о заявке. 1

Объект application

Поле Описание Тип Обязательность
applicationId Сгенерированный идентификатор заявки. 1
status Статус готовности результата. 1
serviceId Код запрашиваемого сервиса (системы, к которой обращается пользователь). 1
issuerId Идентификатор пользователя, обратившегося к заявочной системе. 1
issueDate Дата и время получения заявки сервисом. 1
rcvDate Дата и время формирования результата. 1

Запрос результата обработки заявки

Данные запроса

Структура данных запроса в формате ХML. 

<ws:receiveApplicationResultRequest>
    <ws:apiKey>ZmUyMGM3M2EyMThhMTFlMmE2OWJiNDk5YmFiYWU3ZWHQodGAINGP0L3QsiAxNCAxMjoxOTo1NyBNU0sgMjAxNQ==</ws:apiKey>
    <ws:issuerId>fd2e641c-218a-11e2-a69b-b499babae7ea</ws:issuerId>
    <ws:applicationId>1d6897cc-4891-4432-9202-31431991869f</ws:applicationId>
</ws:receiveApplicationResultRequest>

Объект receiveApplicationResultRequest

Поле Описание Тип Обязательность
apiKey Специальный код, который идентифицирует учетную запись пользователя и позволяет веб-сервису получить доступ к информации о хозяйствующем субъекте и обслуживаемых предприятиях, к которым данный пользователь относится. 1
issuerId Идентификатор пользователя, обратившегося к заявочной системе. 1
applicationId Идентификатор заявки, в заявочной системе. 1


Данные ответа

Структура данных ответа в формате ХML. 

<receiveApplicationResultResponse xmlns="http://api.vetrf.ru/schema/cdm/application/ws-definitions">
    <application xmlns="http://api.vetrf.ru/schema/cdm/application">
        <applicationId>1d6897cc-4891-4432-9202-31431991869f</applicationId>
        <status>COMPLETED</status>
        <serviceId>mercury-g2b.service</serviceId>
        <issuerId>fd2e641c-218a-11e2-a69b-b499babae7ea</issuerId>
        <issueDate>2014-11-11T23:00:00.000+03:00</issueDate>
        <rcvDate>2015-05-08T11:52:31.000+03:00</rcvDate>
        <prdcRsltDate>2015-05-08T11:52:34.000+03:00</prdcRsltDate>
        <result>
            <...>
        </result>
    </application>
</receiveApplicationResultResponse>

Объект receiveApplicationResultResponse

Заявка в заявочной системе, определяет пользователя, который инициирует запрос и содержит сведения самого запроса.

Поле Описание Тип Обязательность
application Сведения о заявке. 1

Объект application

Поле Описание Тип Обязательность
applicationId Сгенерированный идентификатор заявки. 1
status Статус готовности результата. 1
serviceId Код запрашиваемого сервиса (системы, к которой обращается пользователь). 1
issuerId Идентификатор пользователя, обратившегося к заявочной системе. 1
issueDate Дата и время получения заявки сервисом. 1
rcvDate Дата и время формирования результата. 1
prdcRsltDate 1
result 1
Источник — http://help.vetrf.ru/index.php?title=Подсистема_обработки_заявок_в_Ветис.API&oldid=10153