Наименование ОГВ-Разработчика формата вида сведений
Руководство пользователя
ВИДА СВЕДЕНИЙ В ЕДИНОЙ СИСТЕМЕ МЕЖВЕДОМСТВЕННОГО ЭЛЕКТРОННОГО ВЗАИМОДЕЙСТВИЯ
Сведение «Наименование вида сведений»
ID вида сведений в ФРГУ
Дата: XX.XX.XXXX
Версия: X.X
АННОТАЦИЯ
Данный документ является шаблоном руководства пользователя вида сведений СМЭВ, которое в соответствии с пунктом 48 приказа Министерства связи и массовых коммуникаций Российской Федерации от 27.12.2010 № 190 «Об утверждении технических требований к взаимодействию информационных систем в единой системе межведомственного электронного взаимодействия» является обязательным для предоставления поставщиком в адрес оператора СМЭВ.
Инструкция по использованию:
• Текст, выделенный курсивом, является примером заполнения раздела, либо является руководством по заполнению разделов шаблона и при формировании документа должен быть удален.
• Текст без специальных выделений является обязательным для использования в документе и не подлежит удалению.
Заполнение разделов необходимо выполнять согласно приведенной инструкции. Полное и корректное заполнение разделов позволит избежать многоитерационной процедуры редактирования документа. Предоставленные сведения необходимы потребителям информации для успешной интеграции с видом сведений и оператору СМЭВ для организации эффективной эксплуатации вида сведений и поддержки его работоспособности.
Заполнение шаблона при разработке вида сведений СМЭВ по ранее утвержденному формату
На момент подачи на регистрацию разработанного вида сведений поставщик обязан заполнить полностью все разделы документа.
В момент подачи на регистрацию в СМЭВ вида сведений поставщика, подготовленное руководство пользователя предоставляется оператору СМЭВ в zip-архиве специальной структуры, содержащем помимо данного руководства:
– заявку на регистрацию вида сведений;
– XSD-схема(ы) вида сведений, если схема вида сведений содержит вложенные схемы, необходимо предоставлять zip-архив, со следующей структурой: в корневой папке находится целевая схема и папка, в этой папке – все импортируемые схемы;
– эталонный(е) запрос(ы) и ответ(ы), эталонные запросы и ответы для вида сведений необходимо именовать Request.xml и Response.xml соответственно (если эталонных запросов и ответов не одна пара, а несколько, тогда они должны быть заархивированы в zip-архив, причем каждая пара запрос-ответ в отдельной папке):
– описание тестового сценария и XSL-схема(ы) тестового(ых) сценария(ев).
Формат zip-архива должен быть следующей структуры:
\Руководство пользователя
\Заявка на регистрацию вида сведений
\Схема.zip
\Эталоны.zip
\Тестовый сценарий.zip
СОДЕРЖАНИЕ
1.Общие сведения 5
1.1.Руководящие документы 5
1.2.Описание вида сведения 5
2.Схема вида сведений и эталонные запросы и ответы 7
2.1Схема вида сведений 7
2.2Эталонные запросы и ответы 7
3.Тестовые сценарии 8
3.1Тестовый сценарий 8
4.Состав передаваемой информации 9
4.1Описание полей запроса 9
4.2Описание полей ответа на запрос 9
4.3Описание комплексных типов полей (при наличии) 9
4.4Описание проверок запроса на стороне поставщика 9
4.5Описание кодов возвратов при ошибках и неуспешных проверок 10
4.6Описание вложений 10
5.Дополнительная информация 11
5.1Состав справочной информации 11
5.2Контактная информация 11
5.3Примечания 11
изменения
-
Версия
|
Дата
|
Автор
|
Изменения
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
термины/СОКРАЩЕНИя
-
Термин/сокращение
|
Описание
|
СМЭВ
|
Система межведомственного электронного взаимодействия
|
Поставщик
|
Организация – владелец вида сведений
|
WSDL
|
Web Services Description Language — язык описания веб- сервисов.
|
XSD
|
XML Schema definition - язык описания структуры XML документа.
|
SOAP
|
Simple Object Access Protocol - протокол обмена структурированными сообщениями в распределённой вычислительной среде.
|
XML
|
extensible Markup Language — расширяемый язык разметки.
|
|
|
-
Общие сведения
Описание НПА, в соответствии и во исполнение которых разработан формат вида сведений.
Наименование
|
Наименование вида сведений
|
ID вида сведений в ФРГУ
|
Идентификатор вида сведений в Федеральном реестре государственных и муниципальных услуг
|
Содержание
|
Краткое описание передаваемой информации
|
Поставщик
|
Наименование поставщика вида сведений
|
Потребители
|
Наименование потребителя/ей вида сведений (возможно использование категорий потребителей)
|
Назначение
|
Краткое описание назначения данного вида сведений
|
Область применения
|
Государственные услуги/государственные функции/обеспечивающие взаимодействие/
|
Тип запроса
|
Запрос или рассылка
|
Тип маршрутизации
|
Фиксированная или табличная
|
Версия ВС*
|
Версия вида сведений (формат X.Y.Z)
|
Версия МР
|
Версия Методических рекомендаций по работе в Единой системе межведомственного электронного взаимодействия, в соответствии с которой разработан формат вида сведений
|
*Примечание: при разработке новой версии ВС в новой версии руководства пользователя обязательно необходимо отмечать (с комментариями) по тексту руководства сделанные изменения XSD-схем, XML-сообщений, тестовых сценариев и т.д.
-
Схема вида сведений и эталонные запросы и ответы
Основная схема «название.xsd»:
Примечание: если схема содержит импортированные схемы, их текст также необходимо указывать отдельно.
Импортированная схема «название.xsd»:
Примечание: указывается при наличии; если таких схем несколько, тогда необходимо указывать их все.
-
Эталонные запросы и ответы
Эталонный запрос:
Эталонный ответ:
Примечание: указывается не полный конверт, а часть бизнес-данных запроса и ответа; если у вида сведений существует несколько пар эталонных запросов и ответов, тогда необходимо указывать их все, причем в связке запрос–ответ.
-
Тестовые сценарии
Наименование сценария
Идентификатор сценария (xpath)
|
Пространство имен, используемое в xpath
|
Идентификатор сценария (xpath)
|
Пространство имен используемое в xpath
|
Примечание: если у вида сведений несколько тестовых сценариев, необходимо указывать каждый сценарий в отдельном пункте.
Наименование XSL-файла, используемого для генерации автоматического ответа в данном сценарии.
Контрольные примеры
Контрольный пример
|
Идентификатор контрольного примера (xpath)
|
Пространство имен, используемое в xpath
|
XSL файл для сценария
|
КП 1
|
Идентификатор контрольного примера (xpath)
|
Пространство имен, используемое в xpath
|
Наименование XSL-файла
|
КП N
|
Идентификатор контрольного примера (xpath)
|
Пространство имен, используемое в xpath
|
-
Состав передаваемой информации
№
|
Код поля
|
Описание поля
|
Требования к заполнению
|
Способ заполнения/Тип
|
Комментарий
|
1
|
Код поля в XSD-схеме
|
Описание информации, передаваемой в поле
|
Описание требований к содержанию поля
|
Описание типа заполнения
|
При необходимости указывается дополнительная информация
|
-
Описание полей ответа на запрос
№
|
Код поля
|
Описание поля
|
Требования к заполнению
|
Способ заполнения/Тип
|
Комментарий
|
1
|
Код поля в XSD-схеме
|
Описание информации, передаваемой в поле
|
Описание требований к содержанию поля
|
Описание типа заполнения
|
При необходимости указывается дополнительная информация
|
-
Описание комплексных типов полей (при наличии)
№
|
Код поля
|
Описание поля
|
Требования к заполнению
|
Способ заполнения/Тип
|
Комментарий
|
1
|
Код поля в XSD-схеме
|
Описание информации, передаваемой в поле
|
Описание требований к содержанию поля
|
Описание типа заполнения
|
При необходимости указывается дополнительная информация
|
-
Описание проверок запроса на стороне поставщика
№
|
Местоположение поля
|
Код поля
|
Проверка
|
Результат проверки
|
Комментарий
|
1
|
Технологические поля СМЭВ/Бизнес поля запроса/блок ЭП
|
Код поля
|
Описание процедуры проверки
|
Описание возможных результатов проверки и соответствующих ответов сервиса
|
При необходимости указывается дополнительная информация
|
-
Описание кодов возвратов при ошибках и неуспешных проверок
№
|
Код поля
|
Значение поля
|
Причина
|
Комментарий
|
1
|
Код поля
|
Описание значения, содержащегося в поле
|
Описание причины возникновения ошибки/отказа в предоставлении сведений
|
При необходимости указывается дополнительная информация
|
Примечание: обязательно должны в явном виде присутствовать коды мотивированного отказа в предоставлении сведений по причинам:
а) Отсутствия запрашиваемой информации
б) Отказа в предоставлении доступа к запрашиваемой информации
Если формат вида сведения подразумевает наличие вложений, то необходимо в данном разделе описать требования по формату файлов и ограничение по объему к вложениям, но с учетом ограничения СМЭВ: суммарный объем файлов, передаваемых одним сообщением не должен превышать 1 Гб.
-
Дополнительная информация
-
Состав справочной информации
Перечень используемых справочников*
*Примечание: все используемые справочники необходимо вносить в Единую систему нормативно справочной информации (ЕСНСИ).
При отсутствии справочников, владельцем которых не является разработчик формата вида сведения, в ЕСНСИ, необходимо давать прямую отсылку на ресурс где опубликован справочник и размещать актуальную версию с обязательным указанием даты в приложении к руководству пользователя.
Контактные данные представителя разработчика формата вида сведений для обращения пользователей в случае возникновения вопросов*
*Примечание: заполнение контактной информации обязательно только в случае отсутствия разработчика формата вида сведения в Ситуационном центре электронного правительства (СЦ). В случае, когда разработчик формата вида сведения, подключен к СЦ, предоставление иной контактной информации является добровольным.
Иные сведения, которые необходимы потребителям и поставщикам вида сведения.
|
