6.1 Запрос списка доступных отчетов из СППР
Перечень отчетов, доступных для участника информационного взаимодействия, задается регуляторами информационного взаимодействия. Для получения списка доступных участнику видов отчетов и xsd-схем запросов необходимо направить электронное сообщение вида «Запрос шаблонов доступных отчётов» в сервис СППР.
Запрос на получение списка доступных участнику видов отчетов должен быть направлен по каналу МЭДО или через ШПД ГосЭДО в сообщении формата МЭДО 2.7.1 в адрес Организатора ГосЭДО (GUID 00000000-0000-0000-0000-000000000001, адрес МЭДО GOSEDO~MEDOGU).
Тип транспортного контейнера, указываемый в файле описания электронного сообщения, должен иметь значение «Сведения СППР» (обязательно для заполнения). Файл паспорта ТК должен иметь название «passport.xml», оформляется в кодировке «UTF-8», первая строка содержит текст: «<?xml version-"1.0" encoding="UTF-8"?>». Номер версии формата файла описания ТК — 2.7.1.
Пример электронного сообщения вида «Запрос шаблонов доступных отчётов» можно загрузить по ссылке: msg_sppr_reportMetaRequest.zip.
Пример содержания паспорта ТК приведен на Рисунок 6.1.
Рисунок 6.1. Пример паспорта ТК с запросом списка доступных отчетов
Описание элементов паспорта транспортного контейнера запроса на получение списка доступных отчетов приведен в Таблица 7.
Кратность элемента в таблице определяет его минимальное и максимальное допустимое число повторений в файле, а также обязательность его заполнения:
- 1 - элемент указывается один раз и заполняется обязательно;
- 1..n - элемент повторяется необходимое число раз и заполняется обязательно;
- 0..1 - элемент либо не указывается, либо указывается один раз и заполняется обязательно, если выполняются условия его обязательного заполнения, указанные в описании элемента;
- 0..n - элемент либо не указывается, либо повторяется необходимое число раз и заполняется обязательно, если выполняются условия его обязательного заполнения, указанные в описании элемента.
Таблица 7. Описание элементов паспорта ТК запроса «Запрос списка доступных отчетов»
| Пункт | Идентификатор | Тип | Крат-ность | Описание элемента |
| Описание корневых типов данных | ||||
| 1 | container | Сложный | 1 | Паспорт транспортного контейнера ГАС |
| 1.1 | @version | Строка | 1 | Версия XML-схемы паспорта: "2.7.1" |
| 1.2 | header | Сложный | 1 | Описание транспортного контейнера |
| 1.2.1 | uid | Заданный | 1 | Уникальный идентификатор контейнера Заданный тип: "globalUniqueIdentifier" (пункт 6 настоящей таблицы) |
| 1.2.2 | created | Заданный | 1 | Дата и время создания контейнера Заданный тип: "dateTimeZone" (пункт 7 настоящей таблицы) |
| Данные технологического сообщения | ||||
| 1.3 | reportMetaRequest | Заданный | 1 | Запрос шаблонов доступных отчётов Заданный тип: "reportMetaRequest" (пункт 8 настоящей таблицы) |
| Описание задаваемых типов данных: | ||||
| 6 | globalUniqueIdentifier | Простой | -- | Простой Универсальный уникальный идентификатор Вид:"iiiiiiii-iiii-iiii-iiii-iiiiiiiiiiii"  |
| 7 | dateTimeZone | Простой | -- | Дата и время с указанием часового пояса Вид: "YYYY-MM-DDThh:mm:ss+/-hh:mm" |
| Описание элементов | ||||
| 8 | reportMetaRequest | Сложный | -- | Структура запроса "Запрос шаблонов доступных отчётов" |
| 8.1 | @requestUid | Заданный | 1 | Уникальный идентификатор запроса (сгенерированный программой, формирующей запрос) Заданный тип: "globalUniqueIdentifier" (пункт 6 настоящей таблицы) |
| 8.2 | sourceUid | Заданный | 1 | Идентификатор источника запроса (GUID организации-автора запроса согласно ГАС) Заданный тип: "globalUniqueIdentifier" (пункт 6 настоящей таблицы) |
В ответ на запрос списка доступных отчетов с узла Организатора ГосЭДО будет автоматически направлено электронное сообщение формата 2.7.1 инициатору запроса, содержащее транспортный контейнер типа «Сведения СППР» со списком и шаблонами запроса отчетов, доступных участнику.
Пример электронного сообщения с ответом на запрос доступных отчетов можно загрузить по ссылке: msg_sppr_reportMetaResponse.zip.
В составе ТК:
- файл паспорта ТК passport.xml – с ответом на запрос, содержащий список отчетов, доступных инициатору запроса;
- файлы xsd-схем (Rep*.xsd) - с описанием параметров запросов на получение отчетов.
Пример содержания паспорта ТК приведен на Рисунок 6.2.
Рисунок 6.2. Пример фрагмента паспорта ТК с ответом на запрос на получение списка доступных отчетов
Описание элементов паспорта транспортного контейнера со списком доступных отчетов приведен в Таблица 8.
Кратность элемента определяет его минимальное и максимальное допустимое число повторений в файле, а также обязательность его заполнения:
- 1 - элемент указывается один раз и заполняется обязательно;
- 1..n - элемент повторяется необходимое число раз и заполняется обязательно;
- 0..1 - элемент либо не указывается, либо указывается один раз и заполняется обязательно, если выполняются условия его обязательного заполнения, указанные в описании элемента;
- 0..n - элемент либо не указывается, либо повторяется необходимое число раз и заполняется обязательно, если выполняются условия его обязательного заполнения, указанные в описании элемента.
Таблица 8. Описание элементов паспорта ТК со списком доступных отчетов
| Пункт | Идентификатор | Тип | Кратность | Описание элемента |
| Описание корневых типов данных: | ||||
| 1 | container | Сложный | 1 | Паспорт транспортного контейнера СППР |
| 1.1 | @version | Строка | 1 | Версия XML-схемы паспорта: "2.7.1" |
| 1.2 | header | Сложный | 1 | Описание транспортного контейнера |
| 1.2.1 | uid | Заданный | 1 | Уникальный идентификатор контейнера. Заданный тип: "globalUniqueIdentifier" (пункт 6 настоящей таблицы) |
| 1.2.2 | created | Заданный | 1 | Дата и время создания контейнера. Заданный тип: "dateTimeZone" (пункт 7 настоящей таблицы) |
| 1.2.3 | previewFile | Заданный | 0..1 | Название файла визуализации технологического сообщения. Заданный тип: "fileName" (пункт 5 настоящей таблицы) |
| 1.2.4 | signatureFile | Заданный | 0..1 | Название файла электронной подписи транспортного контейнера. Заданный тип: "fileName" (пункт 5 настоящей таблицы) |
| 1.3 | Данные технологического сообщения | |||
| reportMeta | Заданный | 1..n | Шаблоны отчётов (метаданные) Заданный тип: "reportMeta" (пункт 10 настоящей таблицы) |
|
| reportMetaResponse | Заданный | 1 | Отправка шаблонов доступных отчётов в ответ на запрос Заданный тип: "reportMetaResponse" (пункт 11 настоящей таблицы) |
|
| Описание задаваемых типов данных: | ||||
| 2 | numberValue | Простой | -- | Базовый тип: число (от 1 до 109-1) |
| 3 | stringValue | Простой | -- | Базовый тип: строка (от 1 до 511 символов) |
| 4 | identityValue | Простой | -- | Идентификатор объекта (код) Символьный тип (token) (от 1 до 127 символов) |
| 5 | fileName | Простой | -- | Имя файла внутри контейнера |
| 6 | globalUniqueIdentifier | Простой | -- | Универсальный уникальный идентификатор Вид: "iiiiiiii-iiii-iiii-iiii-iiiiiiiiiiii" i=[a-f0-9] |
| 7 | dateTimeZone | Простой | -- | Дата и время с указанием часового пояса Вид: "YYYY-MM-DDThh:mm:ss±hh:mm" |
| 8 | semverValue | Простой | -- | Семантический номер версии в формате Вид: "MM.mmm.ppp" (https://semver.org/) |
| 9 | qualifiedValue | Сложный | -- | Справочное значение Базовый тип: Строка |
| 9.1 | @id | Заданный | 1 | Идентификатор объекта (код) Заданный тип: "identityValue" (пункт 4 настоящей таблицы) |
| 10 | reportMeta | -- | Структура для публикации шаблона отчёта (метаданных) | |
| 10.1 | domain | Заданный | 1 | Домен (верхняя группировка, из классификатора доменов) Заданный тип: "qualifiedValue" (пункт 9 настоящей таблицы) |
| 10.2 | process | Заданный | 1 | Процесс (нижняя группировка, из классификатора процессов) Заданный тип: "qualifiedValue" (пункт 9 настоящей таблицы) |
| 10.3 | reportId | Строка | 1 | Локальный код отчёта по классификатору форматов отчётов |
| 10.4 | reportUid | Строка | 1 | Уникальный код отчёта по классификатору форматов отчётов |
| 10.5 | reportName | Строка | 1 | Название отчёта по классификатору форматов отчётов |
| 10.6 | metaVersion | Заданный | 0..1 | Семантический номер версии метаданных в формате MM.mmm.nnn Заданный тип: "semverValue" (пункт 8 настоящей таблицы) |
| 10.7 | metaSchemaFile | Заданный | 0..1 | Название файла XML-схемы параметров формирования отчёта Заданный тип: "fileName" (пункт 5 настоящей таблицы) |
| 11 | reportMetaResponse | Сложный | -- | Структура ответа на запрос шаблонов доступных отчётов |
| 11.1 | @responseUid | Заданный | 1 | Уникальный идентификатор ответа Заданный тип: "globalUniqueIdentifier" (пункт 6 настоящей таблицы) |
| 11.2 | sourceUid | Заданный | 1 | Уникальный идентификатор отправителя ответа (согласно ГАС). Заданный тип: "globalUniqueIdentifier" (пункт 6 настоящей таблицы) |
| 11.3 | requestUid | Заданный | 1 | Идентификатор запроса, на который подготовлен ответ. Заданный тип: "globalUniqueIdentifier" (пункт 6 настоящей таблицы) |
| 11.4 | generalResponse | Сложный | 1 | Ответ на запрос |
| 11.4.1 | Данные ответа на запрос – одно из следующих значений: requestInvalid (подпункт 11.4.2 настоящей таблицы) или queriesResponse (подпункт 11.4.3 настоящей таблицы) |
|||
| 11.4.2 | requestInvalid | Сложный | 1 | Структура ответа "Запрос некорректный" |
| 11.4.2.1 | rejectionReason | Строка | 1 | Комментарий организатора с причиной отклонения запроса |
| 11.4.3 | queriesResponse | Сложный | 1 | Структура ответа на корректный запрос |
| 11.4.3.1 | reportMeta | Заданный | 0..n | Шаблоны доступных отчётов (массив может быть пустым) Заданный тип: "reportMeta" (пункт 10 настоящей таблицы) |