Romanov-av-170814: Новая страница: «==Общие сведения== Операция '''GetICCommitReportList''' предназначена для получения списка отчетов о …»

2020-07-07T05:54:19Z

Новая страница: «==Общие сведения== Операция '''GetICCommitReportList''' предназначена для получения списка отчетов о …»

Новая страница

==Общие сведения==
Операция '''GetICCommitReportList''' предназначена для получения списка отчетов о вводе в оборот в государственной информационной системе мониторинга за оборотом товаров (далее – ГИС МТ). В результате возвращается 100 последних отчетов о вводе в оборот.

==Подача заявки==
Работа с сервисом реализована по псевдо-асинхронному принципу и осуществляется в два шага:

'''1 шаг''' – подача заявки на выполнение бизнес-операции, получение результата приема заявки (выполняется синхронно);

'''2 шаг''' – подача запроса на получение результатов обработки заявки/выполнения бизнес-операции (выполняется синхронно).

===Данные запроса===
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Структура данных запроса в формате ХML.
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<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>
</syntaxhighlight>
</div>
</div>

===Объект submitApplicationRequest===
Заявка в единой заявочной системе на выполнение определенной операции, определяет пользователя, который инициирует запрос и содержит сведения самого запроса.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''apiKey''' || Специальный код, который идентифицирует учетную запись пользователя и позволяет веб-сервису получить доступ к информации о хозяйствующем субъекте и обслуживаемых предприятиях, к которым данный пользователь относится. || [[APIKey|app:APIKey]] || 1
|-
| [[#Объект submitApplicationRequest/application|'''application''']] || Сведения о заявке.|| [[application|app:application]] || 1
|}

===Объект [[#Объект submitApplicationRequest|submitApplicationRequest]]/'''application'''===
Сведения о заявке.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''serviceId''' || Код запрашиваемого сервиса (системы, к которой обращается пользователь).
* '''crpt-gateway.service:1.0'''
|| [http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName] || 1
|-
| '''issuerId''' || Идентификатор хозяйствующего субъекта от имени которого происходит обращение к Ветис.API. Указанный хозяйствующий субъект должен быть одним из хозяйствующих субъектов, обслуживаемых данной программной системой. Перечень обслуживаемых программной системой хозяйствующих субъектов устанавливается при предоставлении доступа к Ветис.API. || [[UUID|bs:UUID]] || 1
|-
| '''issueDate''' || Дата и время обращения пользователя к заявочной системе. Устанавливается разработчиком клиентской системы. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
|-
| '''data''' || Сведения о заявке.|| [[ApplicationDataWrapper|app:ApplicationDataWrapper]] || 1
|}

===Данные ответа===
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Структура данных запроса в формате ХML.
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<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>
</syntaxhighlight>
</div>
</div>

===Объект submitApplicationResponse===
Заявка в заявочной системе, содержит сведения запроса.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| [[#Объект submitApplicationResponse/application|'''application''']] || Сведения о заявке.|| |[[Application|app:Application]] || 1
|}

===Объект [[#Объект submitApplicationResponse|submitApplicationResponse]]/'''application'''===
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''applicationId''' || Сгенерированный идентификатор заявки. || [[UUID|bs:UUID]] || 1
|-
| '''status''' || Статус готовности результата. || [[ApplicationStatus|app:ApplicationStatus]] || 1
|-
| '''serviceId''' || Код запрашиваемого сервиса (системы, к которой обращается пользователь). || [http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName] || 1
|-
| '''issuerId''' || Идентификатор хозяйствующего субъекта от имени которого происходит обращение к Ветис.API. Указанный хозяйствующий субъект должен быть одним из хозяйствующих субъектов, обслуживаемых данной программной системой. Перечень обслуживаемых программной системой хозяйствующих субъектов устанавливается при предоставлении доступа к Ветис.API. || [[UUID|bs:UUID]] || 1
|-
| '''issueDate''' || Дата и время обращения пользователя к заявочной системе. Устанавливается разработчиком клиентской системы. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
|-
| '''rcvDate''' || Дата и время формирования результата. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
|}

==Получение результата обработки заявки==
===Данные запроса===
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Структура данных запроса в формате ХML.
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<ws:receiveApplicationResultRequest>
<ws:apiKey>{xs:string}</ws:apiKey>
<ws:issuerId>{bs:UUID}</ws:issuerId>
<ws:applicationId>{bs:UUID}</ws:applicationId>
</ws:receiveApplicationResultRequest>
</syntaxhighlight>
</div>
</div>

===Объект receiveApplicationResultRequest===
Запрос на получение результатов обработки заявки.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''apiKey''' || Специальный код, который идентифицирует учетную запись пользователя и позволяет веб-сервису получить доступ к информации о хозяйствующем субъекте и обслуживаемых предприятиях, к которым данный пользователь относится. || [http://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
|-
| '''issuerId''' || Идентификатор пользователя, обратившегося к заявочной системе. || [[UUID|bs:UUID]] || 1
|-
| '''applicationId''' || Идентификатор заявки, в заявочной системе. Хранится в базе в течение 3-х дней. По истечении 3-х дней получить ответ по applicationId будет невозможно.|| [[UUID|bs:UUID]] || 1
|}

===Данные ответа===
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Структура данных ответа в формате ХML.
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<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>
</syntaxhighlight>
</div>
</div>

===Объект receiveApplicationResultResponse===
Получение результатов обработки заявки.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| [[#Объект receiveApplicationResultResponse/application|'''application''']] || Сведения о заявке.|| [[Application|app:Application]] || 1
|}

===Объект [[#Объект receiveApplicationResultResponse|receiveApplicationResultResponse]]/'''application'''===
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''applicationId''' || Сгенерированный идентификатор заявки. || [[UUID|bs:UUID]] || 1
|-
| '''status''' || Статус готовности результата. || [[ApplicationStatus|app:ApplicationStatus]] || 1
|-
| '''serviceId''' || Код запрашиваемого сервиса (системы, к которой обращается пользователь). || [http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName] || 1
|-
| '''issuerId''' || Идентификатор хозяйствующего субъекта от имени которого происходит обращение к Ветис.API. Указанный хозяйствующий субъект должен быть одним из хозяйствующих субъектов, обслуживаемых данной программной системой. Перечень обслуживаемых программной системой хозяйствующих субъектов устанавливается при предоставлении доступа к Ветис.API. || [[UUID|bs:UUID]]|| 1
|-
| '''issueDate''' || Дата и время обращения пользователя к заявочной системе. Устанавливается разработчиком клиентской системы. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
|-
| '''rcvDate''' || Дата и время формирования результата. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
|-
| '''prdcRsltDate''' ||Дата и время получения результата выполнения заявки. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
|-
| '''result''' ||Результат выполнения заявки. || [[ApplicationResultWrapper|app:ApplicationResultWrapper]] || 1
|}

== Данные запроса (submitApplicationRequest/application/data)==

== Данные ответа (receiveApplicationResultResponse/application/result)==

== Пример запроса и ответа ==

<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Запрос на получение списка отчётов о вводе в оборот
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">

</syntaxhighlight>
</div>
</div>
<br />
<div class = "mw-collapsible-content">
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Ответ на запрос
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">

</syntaxhighlight>
</div>

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

Romanov-av-170814: Новая страница: «==Общие сведения== Операция '''GetICCommitReportList''' предназначена для получения списка отчетов о …»