[Введите наименование организации-владельца электронного сервиса]
типовое описание формата электронного сервиса смэв и руководство пользователя электронного сервиса смэв
Сервис согласования маршрута транспортного средства, осуществляющего перевозки крупногабаритных и(или) тяжеловесных грузов
Версия 2.5.6
Дата: [введите дату последнего редактирования]
Версия: [введите номер последней версии]
Листов: [укажите количество листов]
АННОТАЦИЯ
Данный документ является шаблоном типового описания формата электронного сервиса и типового руководства пользователя электронного сервиса СМЭВ, которое в соответствии с пунктом 48 приказа Министерства связи и массовых коммуникаций Российской Федерации «Об утверждении технических требований к взаимодействию информационных систем в единой системе межведомственного электронного взаимодействия» является обязательным для предоставления поставщиком в адрес оператора СМЭВ.
Инструкция по использованию:
· [Текст], написанный серым шрифтом в квадратных скобках, является руководством по заполнению разделов шаблона и при формировании документа должен быть удален.
· Текст, выделенный курсивом, является примером заполнения раздела и при формировании документа должен быть удален.
· Текст без специальных выделений является обязательным для использования в документе и не подлежит удалению.
Заполнение разделов необходимо выполнять согласно приведенной инструкции. Полное и корректное заполнение разделов позволит избежать многоитерационной процедуры редактирования документа. Предоставленные сведения необходимы потребителям информации для успешной интеграции с электронным сервисом и оператору СМЭВ для организации эффективной эксплуатации сервиса и поддержки его работоспособности.
До подачи сервиса поставщика на регистрацию в продуктивном контуре СМЭВ не является обязательным заполнение ряда разделов данного документа, которые могут дорабатываться по мере разработки. Предварительное заполнение обязательных разделов, относящихся к описанию формата электронного сервиса необходимо осуществлять для спецификации интерфейсов сервиса, пригодных для использования разработчиками участников, осуществляющих интеграцию с использованием данного сервиса.
Заполнение шаблона при разработке электронного сервиса СМЭВ по ранее утвержденному формату
На момент подачи на регистрацию разработанного электронного сервиса поставщик сервиса обязан заполнить недостающие разделы документа.
В момент подачи на регистрацию в продуктивном контуре СМЭВ электронного сервиса поставщика, подготовленное руководство пользователя предоставляется оператору СМЭВ в zip-архиве специальной структуры, помимо данного руководства содержащем паспорт сервиса утвержденного формата, описание сервиса (WSDL), описания структур данных (XSD) и контрольных примеров к каждой операции электронного сервиса в виде отдельных текстовых файлов в формате XML.
Формат zip-архива должен быть следующей структуры:
\Руководство пользователя \Паспорт сервиса \Описание сервиса\{множество WSDL и XSD файлов описаний} \Контрольные примеры\[Операция n]\{пара запрос-ответ в виде отдельных файлов} |
На момент публикации для ознакомления потребителей описания электронного сервиса, выполненного по данному шаблону, допускается не включать в zip-архив паспорт сервиса, а также контрольные примеры.
СОДЕРЖАНИЕ
1 Общие сведения.. 7
1.1 Руководящие документы.. 7
1.2 Описание электронного сервиса. 7
1.3 Операции (методы) электронного сервиса. 8
1.4 Сценарии использования. 8
1.5 Схема взаимодействия. 9
1.6 Связи с другими электронными сервисами. 9
2 Руководство пользователя.. …………………………………………………………….....9
2.1 Операция «Подача заявки на согласование». 9
2.1.1 Общие сведения. 9
2.1.2 Описание входных параметров. 9
2.1.3 Описание выходных параметров. 10
2.1.4 Контрольные примеры.. 10
2.2 Операция «Предоставление дополнительных материалов». 11
2.2.1 Общие сведения. 11
2.2.2 Описание входных параметров. 11
2.2.3 Описание выходных параметров. 11
2.2.4 Контрольные примеры.. 11
2.3 Операция «Запрос состояния заявки». 12
2.3.1 Общие сведения. 12
2.3.2 Описание входных параметров. 12
2.3.3 Описание выходных параметров. 12
2.3.4 Контрольные примеры.. 12
2.4 Операция «Запрос на отзыв заявки на согласование». 13
2.4.1 Общие сведения. 13
2.4.2 Описание входных параметров. 13
2.4.3 Описание выходных параметров. 13
2.4.4 Контрольные примеры.. 13
2.5 Операция [введите наименование операции сервиса] 13
3 Методика испытаний.. ………………………………………………………………………14
3.1 Общие условия. 14
3.2 Параметры испытаний на тестовой среде. 14
3.3 Параметры испытаний на продуктивной среде. 15
3.4 Особые условия. 15
4 Приложения.. ………………………………………………………………………………….....15
4.1 Описание сервиса (WSDL) 15
4.2 Описание общих структур данных. 17
4.2.1 XmlDataType. 17
4.2.2 MessageRootType. 17
4.2.3 MessageResponseType. 18
4.2.4 ArrayOfMessageFieldType. 18
4.2.5 MessageFieldType. 18
4.3 Описания справочников. 18
4.4 Иные приложения. 18
изменения
[Приведите в таблице сведения о последних изменениях документа, включая версию, дату, автора и краткое описание изменений.]
Версия | Дата | Автор | Изменения |
термины/СОКРАЩЕНИя
[Дополните таблицу используемыми в документе терминами, определениями и сокращениями.]
Термин/сокращение | Описание |
СМЭВ | Система межведомственного электронного взаимодействия |
Поставщик | Организация-владелец электронного сервиса |
WSDL | Web Services Description Language — язык описания веб-сервисов. |
XSD | XML Schema definition - язык описания структуры XML документа. |
SOAP | Simple Object Access Protocol - протокол обмена структурированными сообщениями в распределённой вычислительной среде. |
XML | eXtensible Markup Language — расширяемый язык разметки. |
КТГ | Крупногабаритные и (или) тяжеловесные грузы |
ФДА или Росавтодор | Федеральное дорожное агентство Министерства транспорта Российской Федерации |
1 Общие сведения
1.1 Руководящие документы
Основанием для разработки данного документа является требование п. 48 Приказа Министерства связи и массовых коммуникаций Российской Федерации от 27 декабря 2010 г. № 000 «Об утверждении технических требований к взаимодействию информационных систем в единой системе межведомственного электронного взаимодействия» в соответствии с которым, для подключения информационной системы к системе межведомственного электронного взаимодействия Поставщик предоставляет Оператору СМЭВ следующие документы:
- паспорт электронного сервиса, регистрируемого в системе взаимодействия;
- методику испытаний электронного сервиса, регистрируемого в системе взаимодействия, включая контрольный пример обращения к электронному сервису;
- руководство пользователя электронного сервиса, регистрируемого в системе взаимодействия.
Основанием для создания и использования электронного сервиса являются перечисленные ниже документы.
Нормативно-правовые документы:
- Постановление Правительства Российской Федерации от 8 сентября 2010 г. № 000 «О единой системе межведомственного электронного взаимодействия»;
- Приказ Министерства связи и массовых коммуникаций Российской Федерации от 01.01.01 г. № 000 «Об утверждении технических требований к взаимодействию информационных систем в единой системе межведомственного электронного взаимодействия».
- [Дополните перечень нормативно-правовыми документами, на основании которых создается и используется сервис.]
Технологические стандарты:
- [Перечислите технологические документы, на основании которых создается и используется сервис (при их наличии).]
[Дополните перечень документов, группируя их по типу (при их наличии).]
1.2 Описание электронного сервиса
Наименование: | Сервис согласования маршрута транспортного средства, осуществляющего перевозки крупногабаритных и(или) тяжеловесных грузов |
Назначение: | Сервис предназначен для предоставления сведений о согласовании маршрута транспортного средства, осуществляющего перевозки крупногабаритных и(или) тяжеловесных грузов, необходимого для предоставления государственных услуг Федеральным дорожным агентством Министерства транспорта Российской Федерации. |
Поставщик: | [Введите полное наименование Поставщика (организации-владельца) электронного сервиса без использования аббревиатур.] |
Область применения: | Межведомственное взаимодействие |
1.3 Операции (методы) электронного сервиса
[Перечислите операции (методы) электронного сервиса с указанием назначения и используемых объектов.]
Электронный сервис согласования маршрута транспортного средства, осуществляющего перевозки крупногабаритных и(или) тяжеловесных грузов обеспечивает обмен данными в рамках взаимодействия подведомственных организаций Росавтодора с балансодержателем дорог при выдаче специальных разрешений на автомобильную перевозку крупногабаритных и(или) тяжеловесных грузов. Электронный сервис включает методы, обеспечивающие:
- получение заявки на согласование;
- получение дополнительных материалов;
- возврат текущего статуса или результатов согласования;
- отзыв заявки на согласование.
Метод | Назначение |
Register Подача заявки на согласование | Принимает электронное сообщение с описанием заявки на согласование в формате XML и возвращает идентификатор зарегистрированной заявки. |
SendFiles Предоставление дополнительных материалов | Принимает на вход дополнительные материалы по заявке |
Check Запрос состояния заявки | Принимает на вход номер заявки и возвращает состояние заявки. |
Cancel Запрос на отзыв заявки на согласование | Принимает на вход номер заявки и возвращает подтверждение об отмене. |
1.4 Сценарии использования
Информационная система ФДА вызывает сервис и передает информацию о заявке на согласование и вложения при помощи метода Register.
Для получения информации о результатах согласования используется модель асинхронного взаимодействия с повторным опросом при помощи метода Check, в ответ на который получается информация о текущем статусе согласования. В случае получения статуса «Требуется дополнительное согласование», информационная система ФДА должна предоставить дополнительные материалы, в т. ч. согласие на проведение оценки технического состояния автомобильных дорог, их укрепление или принятие специальных мер по обустройству автомобильных дорог, их участков, а также пересекающих автомобильную дорогу сооружений и инженерных коммуникаций, при помощи метода SendFiles.
1.5 Схема взаимодействия
Схема взаимодействия ИС Федерального дорожного агентства и ИС согласующей организации в процессе согласования приведена на Рис. 1.
Рис. 1 Схема работы сервиса согласования заявок.
1.6 Связи с другими электронными сервисами
Данный сервис не имеет связей с другими сервисами.
2 Руководство пользователя
2.1 Операция «Подача заявки на согласование»
2.1.1 Общие сведения
Код операции: | Register |
Наименование операции: | Подача заявки на согласование |
Назначение операции: | Операция предназначена для передачи электронного сообщения с описанием заявки на согласование. |
2.1.2 Описание входных параметров
Входные данные: RegisterRequest
№ | Код параметра | Описание параметра | Обязательность | Способ заполнения/Тип | Комментарий |
1 | XMLData | Данные заявки | + | xml, типа XmlDataType | Описание см. 4.2.1 |
2.1.3 Описание выходных параметров
Выходные данные: RegisterResponse
№ | Код параметра | Описание параметра | Обязательность | Способ заполнения/Тип | Комментарий |
1 | XMLData | Результат обработки запроса | + | xml, типа XmlDataType | Описание см. 4.2.1 |
Параметры комплексного типа описаны в приложении «Описание общих структур данных».
|
Из за большого объема этот материал размещен на нескольких страницах:
1 2 |
