Форма описания формата электронного сервиса СМЭВ и руководства пользователя электронного сервиса СМЭВ

Данный документ является шаблоном типового описания формата электронного сервиса СМЭВ и типового руководства пользователя электронного сервиса СМЭВ, которое в соответствии с п. 44 приказа департамента информационно-коммуникационных технологий и безопасности информации Курской области от 07.02.2012 №13 «Об утверждении Технических требований к взаимодействию информационных систем в системе межведомственного электронного взаимодействия Курской области» является обязательным для предоставления Поставщиком в адрес Оператора СМЭВ.

Инструкция по использованию:

• [Текст], написанный серым шрифтом в квадратных скобках, является руководством по заполнению разделов шаблона и при формировании документа должен быть удален.
• Текст, выделенный курсивом, является примером заполнения раздела и при формировании документа должен быть удален.
• Текст без специальных выделений является обязательным для использования в документе и не подлежит удалению.

Заполнение разделов необходимо выполнять согласно приведенной инструкции. Полное и корректное заполнение разделов позволит избежать многоитерационной процедуры редактирования документа. Предоставленные сведения необходимы потребителям информации для успешной интеграции с электронным сервисом и оператору СМЭВ для организации эффективной эксплуатации сервиса и поддержки его работоспособности.

До подачи сервиса поставщика на регистрацию в продуктивном контуре СМЭВ не является обязательным заполнение ряда разделов данного документа, которые могут дорабатываться по мере разработки. Предварительное заполнение обязательных разделов, относящихся к описанию формата электронного сервиса необходимо осуществлять для спецификации интерфейсов сервиса, пригодных для использования разработчиками участников, осуществляющих интеграцию с использованием данного сервиса.

На этапе разработки описания формата электронного сервиса обязательными для заполнения являются нижеперечисленные пункты:

• в разделе «Общие сведения»:

Описание электронного сервиса;

Операции (методы) электронного сервиса;

• в разделе «Руководство пользователя» для каждой операции:

Общие сведения;

Описание входных параметров;

Описание выходных параметров;

• в разделе «Приложения»:

Описание сервиса (WSDL);

Описание общих структур данных.

На момент подачи на регистрацию разработанного электронного сервиса поставщик сервиса обязан заполнить недостающие разделы документа.

В момент подачи на регистрацию в продуктивном контуре СМЭВ электронного сервиса поставщика, подготовленное руководство пользователя предоставляется оператору СМЭВ в zip-архиве специальной структуры, помимо данного руководства содержащем паспорт сервиса утвержденного формата, описание сервиса (WSDL), описания общих структур данных (XSD) и контрольных примеров к каждой операции электронного сервиса в виде отдельных текстовых файлов в формате XML.

Формат zip-архива должен быть следующей структуры:

На момент публикации для ознакомления потребителей описания электронного сервиса, выполненного по данному шаблону, допускается не включать в zip-архив паспорт сервиса, а также контрольные примеры.