Электронный сервис «Сервисный концентратор ФМС России» РУКОВОДСТВО ПОЛЬЗОВАТЕЛЯ

Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
Информационное управление ФМС России
РУКОВОДСТВО ПОЛЬЗОВАТЕЛЯ
ЭЛЕКТРОННОГО СЕРВИСА СМЭВ
Электронный сервис
«Сервисный концентратор ФМС России»
Дата:
11.03.2012
Версия:
1.04
Листов:
33
1
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
СОДЕРЖАНИЕ
ОБЩИЕ СВЕДЕНИЯ ......................................................................................................................5
1.1 Руководящие документы .................................................................................................................. 5
1.2 Описание электронного сервиса ...................................................................................................... 6
1.3 Операции (методы) электронного сервиса ..................................................................................... 7
1.4 Сценарии использования .................................................................................................................. 8
1.5 Схема взаимодействия...................................................................................................................... 9
1.6 Связи с другими электронными сервисами .................................................................................. 10
2
РУКОВОДСТВО ПОЛЬЗОВАТЕЛЯ...........................................................................................11
2.1 Операция «Запросить список типов запросов»............................................................................ 11
1
2.1.1 Общие сведения ....................................................................................................................... 11
2.1.2 Описание входных параметров .............................................................................................. 11
2.1.3 Описание выходных параметров ............................................................................................ 11
2.1.4 Коды возвратов ........................................................................................................................ 12
2.1.5 Контрольные примеры ............................................................................................................ 12
2.2 Операция «Исполнить запрос» ...................................................................................................... 13
2.2.1 Общие сведения ....................................................................................................................... 13
2.2.2 Описание входных параметров .............................................................................................. 13
2.2.3 Описание выходных параметров ............................................................................................ 13
2.2.4 Коды возвратов ........................................................................................................................ 13
2.2.5 Контрольные примеры ............................................................................................................ 14
2.3 Операция «Запросить исполнение» .............................................................................................. 15
2.3.1 Общие сведения ....................................................................................................................... 15
2.3.2 Описание входных параметров .............................................................................................. 15
2.3.3 Описание выходных параметров ............................................................................................ 15
2.3.4 Коды возвратов ........................................................................................................................ 15
2.3.5 Контрольные примеры ............................................................................................................ 16
2.4 Операция «Запросить результат» .................................................................................................. 17
2.4.1 Общие сведения ....................................................................................................................... 17
2.4.2 Описание входных параметров .............................................................................................. 17
2.4.3 Описание выходных параметров ............................................................................................ 17
2.4.4 Коды возвратов ........................................................................................................................ 17
2.4.5 Контрольные примеры ............................................................................................................ 17
2.5 Операция «Известить об ошибке»................................................................................................. 19
2.5.1 Общие сведения ....................................................................................................................... 19
2.5.2 Описание выходных параметров ............................................................................................ 19
2.5.3 Коды возвратов ........................................................................................................................ 19
2.5.4 Контрольные примеры ............................................................................................................ 19
3
МЕТОДИКА ИСПЫТАНИЙ .......................................................................................................21
2
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
3.1 Общие условия ................................................................................................................................ 21
3.2 Параметры испытаний на тестовой среде .................................................................................... 21
3.2.1 Контактные лица ...................................................................................................................... 21
3.2.2 Адрес площадки ....................................................................................................................... 21
3.2.3 Режим ........................................................................................................................................ 21
3.2.4 Сценарии тестирования сервиса ............................................................................................. 21
3.3 Параметры испытаний на продуктивной среде ........................................................................... 22
3.3.1 Контактные лица ...................................................................................................................... 22
3.3.2 Адрес площадки ....................................................................................................................... 22
3.3.3 Режим ........................................................................................................................................ 22
3.3.4 Сценарии тестирования сервиса ............................................................................................. 22
4
ПРИЛОЖЕНИЯ.............................................................................................................................23
4.1 Описание сервиса (WSDL) ............................................................................................................. 23
4.2 Описание общих структур данных................................................................................................ 24
4.2.1 tns:getTaskTypesMessageType ................................................................................................. 24
4.2.2 tns:serviceRequestMessageType ............................................................................................... 24
4.2.3 tns:user ....................................................................................................................................... 25
4.2.4 tns:person ................................................................................................................................... 25
4.2.5 tns:getTaskTypesResponseMessageType .................................................................................. 25
4.2.6 tns:service................................................................................................................................... 26
4.2.7 tns:taskParameterDefinition ....................................................................................................... 26
4.2.8 tns:taskParameter ....................................................................................................................... 27
4.2.9 tns:attachment ............................................................................................................................ 27
4.2.10 tns: getResultMessageType...................................................................................................... 27
4.2.11 tns:getResultResponseMessageType ....................................................................................... 28
4.2.12 tns:processTaskResponseMessageType................................................................................... 28
4.2.13 tns: sendErrorReportMessageType .......................................................................................... 28
4.2.14 tns: sendErrorReportResponseMessageType ........................................................................... 29
4.2.15 tns:taskResult ........................................................................................................................... 29
4.2.16 tns:bookRequestResponseMessageType ................................................................................. 30
4.3 Описания справочников ................................................................................................................. 31
4.3.1 Типы значений параметров (tns:taskParameterType): ........................................................... 31
4.3.2 Статусы (tns:taskState): ............................................................................................................ 31
4.4 Иные приложения ........................................................................................................................... 31
4.4.1 Дополнительная документация .............................................................................................. 31
4.4.2 Описание сервиса ..................................................................................................................... 31
4.4.3 Правила заполнения блока organization ................................................................................. 31
4.4.4 Контрольные примеры ............................................................................................................ 32
3
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
ИЗМЕНЕНИЯ
Версия
Дата
Автор
0.01
0.02
1.00
1.01
1.02
18.07.2011
26.07.2011
12.10.2011
24.11.2011
20.01.2011
Герасимов Н.А.
Кулямзин А.В.
Креславский Д.Г.
Акимов В.А.
Акимов В.А.
1.03
13.02.2012
Герасимов Н.А.
Изменения
Первая версия
Проверка и правка
Утверждение
Внесения изменений по интерфейсу сервиса
Обновлены схемы электронного сервиса в
соответсвии с методическими рекомендациями
версии 2.4.3
Обновлены ссылки на приложения
ТЕРМИНЫ/СОКРАЩЕНИЯ
Термин/сокращение
СМЭВ
Поставщик
WSDL
XSD
SOAP
XML
СК
Описание
Система межведомственного электронного взаимодействия
Организация-владелец электронного сервиса
Web Services Description Language — язык описания веб-сервисов.
XML Schema definition - язык описания структуры XML
документа.
Simple
Object
Access
Protocol
протокол
обмена
структурированными
сообщениями
в
распределённой
вычислительной среде.
eXtensible Markup Language — расширяемый язык разметки.
Сервисный Концентратор ФМС России – электронный сервис,
предназначенный для предоставления любой информации из
списка, предоставляемого ФМС России в рамках обмена
информацией с иными ФОИВ
4
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
1 ОБЩИЕ СВЕДЕНИЯ
1.1 Руководящие документы
Основанием для разработки данного документа является требование п. 48 Приказа
Министерства связи и массовых коммуникаций Российской Федерации от 27 декабря 2010 г. №
190 «Об утверждении технических требований к взаимодействию информационных систем в
единой системе межведомственного электронного взаимодействия» в соответствии с которым, для
подключения информационной системы к системе межведомственного электронного
взаимодействия Поставщик предоставляет Оператору СМЭВ следующие документы:

паспорт электронного сервиса, регистрируемого в системе взаимодействия;

методику испытаний электронного сервиса, регистрируемого в системе
взаимодействия, включая контрольный пример обращения к электронному сервису;

руководство пользователя электронного сервиса, регистрируемого в системе
взаимодействия.
Основанием для создания и использования электронного сервиса являются перечисленные
ниже документы.
Нормативно-правовые документы:
 Постановление Правительства Российской Федерации от 8 сентября 2010 г. № 697
«О единой системе межведомственного электронного взаимодействия»;
 Приказ Министерства связи и массовых коммуникаций Российской Федерации от 27
декабря 2010 г. № 190 «Об утверждении технических требований к взаимодействию
информационных систем в единой системе межведомственного электронного
взаимодействия».
 Федеральный закон 210-ФЗ «Об организации предоставления государственных и
муниципальных услуг»
 Распоряжение Правительства Российской Федерации от 17 марта 2011 г. №442-р
«Об утверждении перечня документов (сведений), обмен которыми между органами
и организациями при оказании государственных услуг и исполнении
государственных функций осуществляется в электронном виде»
 Распоряжение Правительства Российской Федерации от 15 апреля 2011 №654-р «О
базовых государственных информационных ресурсах»
Технологические стандарты:
 Методические рекомендации по разработке веб-сервисов для СМЭВ
 Рекомендации по применению ЭЦП при межведомственном взаимодействии
5
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
1.2 Описание электронного сервиса
Наименование:
Сервисный Концентратор ФМС России - электронный сервис предоставления
любой информации, предоставляемой ФМС России в рамках обмена
информацией с иными ФОИВ
Назначение:
Электронный сервис «Сервисный концентратор ФМС России» предназначен
для предоставления любой информации, из списка предоставляемой ФМС
России в рамках обмена информацией с иными ФОИВ.
СК предлагает два основных сценария работы для запросов со стороны ФОИВ:
1) Запрос с быстрым ответом
2) Запрос с отложенным ответом
Для Запросов с быстрым ответом ("Синхронный" режим) в СК реализован
метод "Исполнить запрос". В этом случае СК возвращает результат исполнения
запроса непосредственно в ответе на запрос. При этом временные затраты на
операцию не должны выходить за рамки таймаута, задаваемого СМЭВ.
Для запросов с отложенным ответом ("Асинхронный" режим) в СК
реализованы методы "Запросить исполнение" и "Запросить результат". При
таком сценарии ФОИВ вызывает метод «Запросить исполнение», который
возвращает № созданной задачи. Далее ИС ФОИВ должен периодически
вызывать метод «Запросить результат», который по № задачи возвращает либо
результат (если он уже готов), либо сообщение об ошибке (если результат ещё
не готов).
Поставщик:
Информационное управление Федеральной миграционной службы России
Область
применения:
Межведомственное взаимодействие;
Базовые реестры
6
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
1.3 Операции (методы) электронного сервиса
Метод
Назначение
Код: getTaskTypes
Наименование: Запросить список типов
запросов
Метод возвращает список типов запросов, доступных
для данного пользователя.
Код: processTask
Наименование: Исполнить запрос
Метод обрабатывает запрос с мгновенным ответом и
синхронно возвращает № задачи и Результат её
исполнения.
Код: bookRequest
Наименование: Запросить исполнение
Метод
инициирует
исполнение
запроса
с
отложенным ответом и возвращает № задачи,
инициированной на исполнение в СК.
Код: getResult
Наименование: Запросить результат
Метод по № задачи возвращает либо результат (если
он уже готов), либо сообщение об ошибке (если
результат ещё не готов).
Код: sendErrorReport
Наименование: Известить об ошибке
Метод используется для извещения ФМС о
некорректной информации, обнаруженной в одном из
базовых реестров ФМС в результате исполнения
одного из запросов
7
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
1.4 Сценарии использования
Данный сценарий описывает ситуацию, когда ИС ФОИВ вызывает СК с целью получения
от ФМС России какой-либо информации, требуемой в рамках 442-р из одного из базовых реестров
ФМС России. Далее будем именовать такие вызовы (типы запросов) входящими.
СК предлагает два основных сценария работы с входящими запросами:
1) Запрос с быстрым ответом
2) Запрос с отложенным ответом
В случае Запроса с быстрым ответом СК возвращает результат исполнения запроса
непосредственно в ответе на запрос. При этом временные затраты на операцию не должны
выходить за рамки таймаута, задаваемого СМЭВ.
В случае Запроса с отложенным ответом ИС ФОИВ вызывает Метод «Запросить
исполнение», который возвращает № задачи в ведомственной системе. Далее ИС ФОИВ может
периодически вызывать Метод «Запросить результат», который по № задачи возвращает либо
результат (если он уже готов), либо сообщение об ошибке (если результат ещё не готов).
8
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
1.5 Схема взаимодействия
В рамках взаимодействия запрашивающее ведомство для правильной работы с сервисами
должно выполнить следующую последовательность действий:
 Запросить список доступных ведомству типов запросов.
Для этого необходимо вызвать метод getTaskTypes, указав код ведомства в качестве
параметра user/organization/code. Полученный список доступных сервисов представляет
собой информацию по всем запросам, доступным данному запрашивающему ведомству, а
также метаданные, которые необходимо использовать для корректного вызова (список
параметров запроса).
Далее схема вызова варьируется в зависимости от типа запроса, который запрашивающее
ведомство собирается вызвать.
 Запрос c мгновенным ответом.
Для таких запросов необходимо вызвать метод processTask, заполнив список параметров в
соответствии с полученными ранее описаниями. Система произведет обработку запроса и в
синхронном режиме отдаст ответ, список параметров которого также будет заполнен в
соответствии с ранее полученными метаданными.
 Запрос c отложенным ответом.
Для таких запросов необходимо вызвать метод bookRequest, заполнив список параметров в
соответствии с полученными ранее описаниями. Система произведет инициацию запроса, а
в ответ отдаст номер задачи (тикет). Далее с определенной периодичностью
запрашивающему ведомству предлагается вызывать метод getResult, передавая ему в
качестве входного параметра полученный тикет. Как только задача в системе СК будет
обработана и ответ по ней будет сформирован, этот метод отдаст конечный ответ, список
параметров которого также будет заполнен в соответствии с ранее полученными
метаданными.
9
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
1.6 Связи с другими электронными сервисами
Данный сервис не имеет связей с другими сервисами.
10
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
2 РУКОВОДСТВО ПОЛЬЗОВАТЕЛЯ
2.1 Операция «Запросить список типов запросов»
2.1.1 Общие сведения
Код операции:
getTaskTypes
Наименование
операции:
Запросить список типов запросов
Назначение операции:
Данный метод возвращает список типов запросов, доступный для
данного пользователя
2.1.2 Описание входных параметров
Входные данные: getTaskTypesMessageData
№
Код параметра
AppData
1
Описание
параметра
Объект
Обязательность
+
Способ
заполнения/Тип
Комментарий
tns:
содержащий
getTaskTypesMessag
значимые данные
eType
2.1.3 Описание выходных параметров
Выходные данные: getTaskTypesResponseMessageData
№
Код параметра
AppData
1
Описание
параметра
Объект
Обязательность
+
Способ
заполнения/Тип
Комментарий
tns:
содержащий
getTaskTypesRespon
значимые данные
seMessageType
Параметры комплексного типа описаны в приложении «Описание общих структур
данных».
11
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
2.1.4 Коды возвратов
№
Код возврата
Описание кода
возврата
Условия возникновения
Данный
Организация
1
1
не
найдена
код
ситуации,
возврата
когда
Комментарий
соответствует
организация
с
запрошенным кодом не числится в реестре
ФМС
Пользователь
1
2
найден
не
Данный
код
возврата
соответствует
ситуации, когда пользователь не найден в
БД ФМС
2.1.5 Контрольные примеры
Запрос
getTaskTypes-request.xml
Ответ на запрос в случае успешного исполнения
getTaskTypes-response.xml
12
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
2.2 Операция «Исполнить запрос»
2.2.1 Общие сведения
Код операции:
processTask
Наименование
операции:
Исполнить запрос
Назначение операции:
Данный метод выполняет запрошенную задачу и возвращает №
задачи и Результат её исполнения.
2.2.2 Описание входных параметров
Входные данные: serviceRequestMessageData
№
Описание
параметра
Код параметра
Объект
AppData
1
Способ
заполнения/Тип
Обязательность
+
Комментарий
tns:
содержащий
serviceRequestMessa
значимые данные
geType
2.2.3 Описание выходных параметров
Выходные данные: processTaskResponseMessageData
№
Описание
параметра
Код параметра
Объект
AppData
1
Способ
заполнения/Тип
Обязательность
+
Комментарий
tns:
содержащий
processTaskResponse
значимые данные
MessageType
Параметры комплексного типа описаны в приложении «Описание общих структур
данных».
2.2.4 Коды возвратов
№
Код
возврата
Описание кода возврата
Условия возникновения
Комментарий
Данный код возврата соответствует
1
1
Организация не найдена
ситуации,
когда
организация
с
запрошенным кодом не числится в
реестре ФМС
Данный код возврата соответствует
2
2
Пользователь не найден
ситуации, когда пользователь не
найден в БД ФМС
Данный код возврата соответствует
Данный
3
3
тип
запроса
недоступен для организации
ситуации, когда к запрашиваемому
типа
запроса
организации
предоставлен доступ
13
не
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
№
Код
возврата
Описание кода возврата
Условия возникновения
Комментарий
Данный код возврата соответствует
ситуации,
4
Быстрый ответ невозможен
4
когда
запрашивает
тип
организация
запроса
“с
отложенным ответом” в рамках
данного метода
Ошибка ФЛК параметров
5
7
5
запроса
7
Данный код возврата соответствует
Информация о том, в чем
ситуации,
именно
состав
когда
запроса
первичный
реквизитный
не
проходит
форматно-логический
Для
запросов, в реквизитном составе
требуется
Регион в составе запроса не
которых присутствует в том или
значение в виде первых
соответствует справочному
ином виде код региона; при этом
четырех
передаваемое
справочника
значение
его
не
когда
запрос
с
гос.услуги + номер дела в системепотребителе) уже зарегистрирован
в системе.
Данный код возврата отправляется
Ошибка проверки ЭЦП
в случае неуспешной проверки ЭПСМЭВ, либо ЭП-ОВ, наложенных
на сообщение.
Данный код возврата отправляется
Отсутствует
10
10
заголовка СМЭВ
секция
в случае отсутствия в запросе
служебной
секции
(smev:Header)
2.2.5 Контрольные примеры
Запрос
p001-processTask-request.xml
Ответ на запрос в случае успешного исполнения
p001-processTask-response.xml
14
корректной
регионов.
аналогичным обоснованием (код
Дублирующий запрос
9
приводится в комментарии
Данный код возврата применим для
ситуации,
9
ФЛК,
к ответу
Данный код возврата соответствует
8
несоответствие
контроль.
соответствует справочному.
8
заключается
СМЭВ
работы
передавать
символов
ОКАТО
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
2.3 Операция «Запросить исполнение»
2.3.1 Общие сведения
Код операции:
bookRequest
Наименование
операции:
Запросить исполнение
Назначение операции:
Метод инициализирует обработку запроса соответствующим
обработчиком задач. В запросе необходимо указать код типа запроса
и его версию, а также список входных параметров. В ответ метод
отдает «Тикет» - уникальный идентификатор задачи, который в
дальнейшем следует использовать в качестве входного параметра к
методу «Запросить результат».
2.3.2 Описание входных параметров
Входные данные: serviceRequestMessageData
№
Описание
параметра
Код параметра
Объект
AppData
1
Способ
заполнения/Тип
Обязательность
+
Комментарий
tns:
содержащий
serviceRequestMessa
значимые данные
geType
2.3.3 Описание выходных параметров
Выходные данные: bookRequestResponseMessageData
№
Описание
параметра
Код параметра
AppData
1
Объект
Обязательность
+
Способ
заполнения/Тип
Комментарий
tns:
содержащий
bookRequestRespons
значимые данные
eMessageType
Параметры комплексного типа описаны в приложении «Описание общих структур
данных».
2.3.4 Коды возвратов
№
Код возврата
Описание кода
возврата
Условия возникновения
Данный
1
1
Организация не найдена
код
возврата
соответствует
ситуации, когда организация с запрошенным
кодом не числится в реестре ФМС
Данный
2
2
Пользователь не найден
код
возврата
соответствует
ситуации, когда пользователь не найден в БД
ФМС
15
Комментарий
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
№
Описание кода
возврата
Код возврата
Данный
3
тип
запроса
недоступен
3
Условия возникновения
для
организации
Данный
соответствует
запроса организации не предоставлен доступ
Быстрый
4
возврата
ситуации, когда к запрашиваемому типа
Данный
4
код
Комментарий
ответ
невозможен
код
возврата
соответствует
ситуации, когда организация запрашивает
тип запроса “с мгновенным ответом” в
рамках данного метода
Информация
Данный
Ошибка
5
5
ФЛК
параметров запроса
код
возврата
соответствует
ситуации, когда реквизитный состав запроса
не
проходит
первичный
форматно-
логический контроль.
о
том, в чем именно
заключается
несоответствие
ФЛК, приводится
в комментарии к
ответу
Для
Данный
7
7
код
возврата
применим
для
Регион в составе запроса
запросов, в реквизитном составе которых
не
присутствует в том или ином виде код
соответствует
справочному
региона; при этом передаваемое значение его
не соответствует справочному.
корректной
работы требуется
передавать
значение в виде
первых
четырех
символов
справочника
ОКАТО регионов.
8
Дублирующий запрос
8
Данный
код
возврата
ситуации,
когда
запрос
соответствует
с
аналогичным
обоснованием (код гос.услуги + номер дела в
системе-потребителе) уже зарегистрирован в
системе.
Данный код возврата отправляется в случае
9
Ошибка проверки ЭЦП
9
неуспешной проверки ЭП-СМЭВ, либо ЭПОВ, наложенных на сообщение.
Отсутствует
10
10
заголовка СМЭВ
секция
Данный код возврата отправляется в случае
отсутствия в запросе служебной секции
СМЭВ (smev:Header)
2.3.5 Контрольные примеры
Запрос
x00x-bookRequest-request.xml
Ответ на запрос в случае успешного исполнения
x00x-bookRequest-response.xml
16
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
2.4 Операция «Запросить результат»
2.4.1 Общие сведения
Код операции:
getResult
Наименование
операции:
Запросить результат задачи
Назначение операции:
Метод запрашивает текущее состояние задачи по ее уникальному
идентификатору. В случае, если обработка задачи завершена, в ответе
будет присутствовать список результирующих полей.
2.4.2 Описание входных параметров
Входные данные: getResultMessageData
№
Описание
параметра
Код параметра
Объект
AppData
1
Обязательность
+
Способ
заполнения/Тип
Комментарий
tns:
содержащий
getResultMessageTy
значимые данные
pe
2.4.3 Описание выходных параметров
Выходные данные: getResultResponseMessageData
№
Описание
параметра
Код параметра
AppData
1
Объект
Обязательность
+
Способ
заполнения/Тип
Комментарий
tns:
содержащий
getResultResponseM
значимые данные
essageType
Параметры комплексного типа описаны в приложении «Описание общих структур
данных».
2.4.4 Коды возвратов
№
Код
возврата
Описание кода возврата
Условия возникновения
Данный
1
Организация не найдена
1
код
возврата
соответствует
ситуации, когда организация с запрошенным
кодом не числится в реестре ФМС
Данный
2
Пользователь не найден
2
код
возврата
соответствует
ситуации, когда пользователь не найден в БД
ФМС
6
Задача не найдена
6
Задача
с
указанным
идентификатором не найдена
2.4.5 Контрольные примеры
Запрос
17
уникальным
Комментарий
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
x00x-getResult-request.xml
Ответ на запрос в случае успешного исполнения
x00x-getResult-response.xml
18
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
2.5 Операция «Известить об ошибке»
2.5.1 Общие сведения
Код операции:
sendErrorReport
Наименование
операции:
Известить об ошибке
Метод используется для извещения ФМС о некорректной
информации, обнаруженной в одном из базовых реестров ФМС в
результате исполнения одного из запросов.
Входные данные: sendErrorReportMessageData
Назначение операции:
№
Описание
параметра
Код параметра
Объект
AppData
1
Обязательность
+
Способ
заполнения/Тип
Комментарий
tns:
содержащий
sendErrorReportMess
значимые данные
ageType
2.5.2 Описание выходных параметров
Выходные данные: sendErrorReportResponseMessageData
№
Описание
параметра
Код параметра
AppData
1
Объект
Обязательность
+
Способ
заполнения/Тип
Комментарий
tns:
содержащий
sendErrorReportResp
значимые данные
onseMessageType
Параметры комплексного типа описаны в приложении «Описание общих структур
данных».
2.5.3 Коды возвратов
№
Код
возврата
Описание кода возврата
Условия возникновения
Данный
1
1
Организация не найдена
код
возврата
соответствует
ситуации, когда организация с запрошенным
кодом не числится в реестре ФМС
Данный
2
2
Пользователь не найден
код
возврата
соответствует
ситуации, когда пользователь не найден в БД
ФМС
6
6
Задача не найдена
Задача
с
указанным
идентификатором не найдена
2.5.4 Контрольные примеры
Запрос
sendErrorReport-request.xml
Ответ на запрос в случае успешного исполнения
19
уникальным
Комментарий
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
sendErrorReport-response.xml
20
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
3 МЕТОДИКА ИСПЫТАНИЙ
3.1 Общие условия
Проведение контрольных испытаний при регистрации электронного сервиса
регламентировано Приказом Министерства связи и массовых коммуникаций Российской
Федерации от 27 декабря 2010 г. № 190 «Об утверждении технических требований к
взаимодействию информационных систем в единой системе межведомственного электронного
взаимодействия».
Порядок проведения типовых испытаний предполагает следующие этапы:
 Проверка комплектности предоставленной документации;
 Проверка сетевой связности между узлом СМЭВ и точкой размещения электронного
сервиса;
 Регистрация сервиса и тестирование сервиса на контрольном примере.
3.2 Параметры испытаний на тестовой среде
Проведение испытаний на тестовой среде перед регистрацией электронного сервиса в
продуктивной среде СМЭВ является необходимым действием, обеспечивающим повышение
качества и эффективности процесса и позволяющим выявлять ошибки и несоответствия
разработанного сервиса заранее, а не в продуктивном контуре.
3.2.1 Контактные лица
Раздел
Ответственное лицо
Контакты
Эксплуатация
Кулямзин Алексей Владимирович,
8 (495) 636 97 13
[email protected]
Инспектор по особым поручениям
3.2.2 Адрес площадки
Адрес размещения тестового экземпляра сервиса Поставщика.
http://fms-sx.reksoft.ru:8080/serviceConcentrator/incomingRequests?wsdl
Площадка зарегистрирована в Тестовом СМЭВ.
3.2.3 Режим
Режим функционирования тестовой среды: 24/7
3.2.4 Сценарии тестирования сервиса
Для того чтоб протестировать сервис, необходимо:
 зарегистрировать сервис на тестовой среде во время ее доступности согласно
режиму функционирования,
 протестировать все операции на основании контрольных примеров.
21
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
3.3 Параметры испытаний на продуктивной среде
3.3.1 Контактные лица
Контактные сведения о лице, ответственном со стороны поставщика за решение вопросов,
необходимых для обеспечения регистрации сервиса в продуктивном контуре СМЭВ:
Раздел
Ответственное лицо
Контакты
Эксплуатация
Жук Максим Юрьевич,
8 (495) 636 91 57
[email protected]
главный специалист
Информация,
изменения
Медведкин А.В.,
начальник ОТЭ ИУ ФМС России
моб. +7(916) 207-37-66 /тел. +7 (495) 63690-18
[email protected]
3.3.2 Адрес площадки
Площадка недоступна напрямую из сети Интернет; вызов возможен только через средства
СМЭВ.
3.3.3 Режим
Режим функционирования тестовой среды: 24/7/365
3.3.4 Сценарии тестирования сервиса
Для того чтоб протестировать сервис, необходимо:
 зарегистрировать сервис на тестовой среде во время ее доступности согласно
режиму функционирования,
 протестировать все операции на основании контрольных примеров.
22
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
4 ПРИЛОЖЕНИЯ
4.1 Описание сервиса (WSDL)
В комплекте документации поставляются WSDL- и XSD-описания электронного сервиса
СК ФМС России в виде отдельных файлов, для двух видов реализаций - в соответствии с
методическими рекомендациями СМЭВ версий 2.3.4 и 2.4.3, как указано на рисунке ниже.
Рисунок 1. Описание сервиса во вложении.
23
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
4.2 Описание общих структур данных
Предложенные ниже текстовые описания актуальны для приложенного файла sxMessageTypes.xsd
Пространства имен в таблицах приняты следующим:
 tns - http://baseTypes.border.webservices.kernel.sx.fms.ru
 ds - http://www.w3.org/2000/09/xmldsig#
 xs - http://www.w3.org/2001/XMLSchema
4.2.1 tns:getTaskTypesMessageType
№
1
2
Код параметра
Описание параметра
signature
Подпись ЭП СП
user
Объект
информации
вызывающем лице
Обязательн
ость
о +
Способ заполнения/Тип
ds:Signature
Комментарий
Стандартный
объект,
спецификации xmldsig
соответствующий
tns:user
4.2.2 tns:serviceRequestMessageType
№
Код параметра
Описание параметра
Обязательн
ость
Способ заполнения/Тип
signature
Подпись ЭП СП
user
Пользователь
(организация), +
представляющий
запрашивающую сторону
tns:user
3
serviceCode
Код типа запроса
+
xs:string
4
versionCode
Версия типа запроса
+
xs:string
parameters
Параметры запроса
-
tns:taskParameter
1
2
5
-
ds:Signature
24
Комментарий
Стандартный
объект,
спецификации xmldsig
соответствующий
В случае множества параметров – заполняется
множество объектов этого типа (см. пример)
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
№
6
Код параметра
attachments
Описание параметра
Приложения
Обязательн
ость
-
Способ заполнения/Тип
tns:attachment
Комментарий
В случае множества параметров – заполняется
множество объектов этого типа (см. пример)
4.2.3 tns:user
№
Код параметра
Обязательн
ость
Способ заполнения/Тип
organization
Код
запрашивающего +
ФОИВа – заполняется в
соответствии с приложением
4.4.3
xs:string
person
Объект пользователя
tns:person
1
2
Описание параметра
-
Комментарий
Строка не может быть пустой
4.2.4 tns:person
№
Код параметра
Описание параметра
Обязательн
ость
Способ заполнения/Тип
1
id
ID пользователя
-
xs:string
2
firstName
Имя пользователя
-
xs:string
3
secondName
Отчество пользователя
-
xs:string
4
lastName
Фамилия пользователя
-
xs:string
Комментарий
4.2.5 tns:getTaskTypesResponseMessageType
№
1
2
Код параметра
Описание параметра
Обязательн
ость
Способ заполнения/Тип
signature
Подпись ЭП СП
-
ds:Signature
errorCode
Числовой код ответа
+
xs:int
25
Комментарий
Стандартный
объект,
спецификации xmldsig
соответствующий
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
№
3
4
Код параметра
Описание параметра
комментарий
Обязательн
ость
errorDescription
Текстовый
ответу
к -
services
Доступные
пользователю типы запросов
Способ заполнения/Тип
Комментарий
xs:string
tns:service
В случае множества параметров – заполняется
множество объектов этого типа (см. пример)
4.2.6 tns:service
№
1
2
3
Код параметра
Описание параметра
Обязательн
ость
Способ заполнения/Тип
Комментарий
code
Код возврата
+
xs:string
incomingParameters
Параметры запроса
+
tns:taskParameterDefinition
В случае множества параметров – заполняется
множество объектов этого типа (см. пример)
outgoingParameters
Параметры ответа
+
tns:taskParameterDefinition
В случае множества параметров – заполняется
множество объектов этого типа (см. пример)
4.2.7 tns:taskParameterDefinition
№
Код параметра
Описание параметра
Обязательн
ость
Способ заполнения/Тип
1
name
Наименование параметра
-
xs:string
2
type
Тип параметра
-
tns:taskParameterType
mandatory
Признак
параметра
pattern
Regexp-параметр
валидации
length
Максимальная
значения параметра
3
4
5
обязательности +
для длина -
Комментарий
xs:boolean
xs:string
xs:int
26
В случае формата типа «Дата» в этом поле
указывается шаблон даты.
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
4.2.8 tns:taskParameter
№
Код параметра
Описание параметра
Обязательн
ость
Способ заполнения/Тип
1
name
Наименование параметра
+
xs:string
2
value
Значение параметра
+
xs:string
Комментарий
4.2.9 tns:attachment
№
Код параметра
Описание параметра
Обязательн
ость
Способ заполнения/Тип
1
code
Код вложения
+
xs:string
2
fileName
Имя файла-вложения
-
xs:string
3
mimeType
MIME-тип вложения
+
xs:string
4
data
Содержимое вложения
+
xs:base64Binary
Комментарий
4.2.10 tns: getResultMessageType
№
1
Код параметра
Обязательн
ость
Способ заполнения/Тип
signature
Подпись ЭП СП
user
Пользователь (организация), +
представляющий
запрашивающую сторону
tns:user
taskId
Номер задачи
xs:string
2
3
Описание параметра
-
+
ds:Signature
27
Комментарий
Стандартный
объект,
спецификации xmldsig
соответствующий
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
4.2.11 tns:getResultResponseMessageType
№
1
2
3
4
Код параметра
Обязательн
ость
Описание параметра
Способ заполнения/Тип
signature
Подпись ЭП СП
-
ds:Signature
errorCode
Числовой код ответа
+
xs:int
errorDescription
Текстовый
ответу
taskResult
Объект
результата выполнения задачи
комментарий
к -
Комментарий
Стандартный
объект,
спецификации xmldsig
соответствующий
xs:string
tns:taskResult
4.2.12 tns:processTaskResponseMessageType
№
1
2
3
4
Код параметра
Описание параметра
Обязательн
ость
Способ заполнения/Тип
signature
Подпись ЭП СП
-
ds:Signature
errorCode
Числовой код ответа
+
xs:int
errorDescription
Текстовый
ответу
taskResult
Объект
результата выполнения задачи
комментарий
к -
Комментарий
Стандартный
объект,
спецификации xmldsig
соответствующий
xs:string
tns:taskResult
4.2.13 tns: sendErrorReportMessageType
№
1
Код параметра
signature
Описание параметра
Подпись ЭП СП
Обязательн
ость
-
Способ заполнения/Тип
ds:Signature
28
Комментарий
Стандартный
объект,
спецификации xmldsig
соответствующий
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
№
Код параметра
4
Обязательн
ость
Способ заполнения/Тип
user
Пользователь (организация), +
представляющий
запрашивающую сторону
tns:user
taskId
Уникальный идентификатор +
задачи
xs:string
errorReport
Сообщение об ошибке
xs:string
2
3
Описание параметра
+
Комментарий
4.2.14 tns: sendErrorReportResponseMessageType
№
1
2
3
4
Код параметра
Описание параметра
Обязательн
ость
Способ заполнения/Тип
signature
Подпись ЭП СП
-
ds:Signature
errorCode
Числовой код ответа
+
xs:int
errorDescription
Текстовый комментарий к ответу
xs:string
errorReportId
Уникальный идентификатор +
сообщения об ошибке
xs:string
Комментарий
Стандартный
объект,
спецификации xmldsig
соответствующий
4.2.15 tns:taskResult
№
1
2
3
Код параметра
Описание параметра
Обязательн
ость
Способ заполнения/Тип
taskId
Уникальный идентификатор +
задачи
xs:string
state
Текущее состояние запроса
tns:taskState
parameters
Результат
запроса в
параметров
+
выполнения виде набора
tns:taskParameter
29
Комментарий
В случае множества параметров – заполняется
множество объектов этого типа (см. пример)
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
№
4
Код параметра
attachments
Описание параметра
Приложение к результату
Обязательн
ость
-
Способ заполнения/Тип
tns:attachment
Комментарий
В случае множества параметров – заполняется
множество объектов этого типа (см. пример)
4.2.16 tns:bookRequestResponseMessageType
№
1
2
3
4
Код параметра
Описание параметра
Обязательн
ость
Способ заполнения/Тип
signature
Подпись ЭП СП
-
ds:Signature
errorCode
Числовой код ответа
+
xs:int
errorDescription
Текстовый комментарий к ответу
xs:string
taskId
Уникальный идентификатор задачи
xs:string
30
Комментарий
Стандартный
объект,
спецификации xmldsig
соответствующий
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
4.3 Описания справочников
4.3.1 Типы значений параметров (tns:taskParameterType):
INTEGER
LONG
FLOAT
STRING
BOOLEAN
DATE
TIME
DATE_TIME
LIST
4.3.2 Статусы (tns:taskState):
CHECKING
PROCESSING
OPERATOR_ANSWER_WAITING
DS_WAITING
READY
CLOSED
CANCELLED
RETURNED
4.4 Иные приложения
4.4.1 Дополнительная документация
Помимо данного документа, в комплектации поставляется документ «ФМС_СК_Входящие
запросы.doc». Указанный документ содержит конкретизированные описания каждого из типов
запросов, инициировать работу по которым позволяет электронный сервис СК ФМС, и данное
руководство. В частности, документ рассматривает динамические наборы входных и выходных
параметров, предусмотренных для работы по отдельным типам запросов, для заполнения
последовательности из множества блоков taskParameter.
4.4.2 Описание сервиса
В комплекте документации также поставляются WSDL и XSD описания электронного
сервиса СК ФМС России в виде отдельных файлов, для двух видов реализаций - в соответствии с
методическими рекомендациями СМЭВ версий 2.3.4 и 2.4.3.
4.4.3 Правила заполнения блока organization
1.
Запрашивающая организация – ФОИВ
В этом случае необходимо указать 11-значный код ФОИВ из сводного реестра государственных и
31
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
мунициальных услуг.
Пример: для МВД России:
<organization>10000001197</organization>
2.
Запрашивающая организация – регионального уровня
Блок заполняется следующей комбинацией:
 Префикс R;
 Первые 4 знака кода ОКАТО региона;
 6 нулей (зарезервировано).
Пример: для органа власти регионального уровня г. Санкт-Петербурга:
<organization>R4000000000</organization>
где 4000 - Первые 4 знака ОКАТО.
4.4.4 Контрольные примеры
Контрольные примеры приведены отдельно для тестирования двух видов реализаций - в
соответствии с методическими рекомендациями СМЭВ версий 2.3.4 и 2.4.3, отдельно для каждого
из типов запросов. Исполнение контрольного примера, в соответствии с требованиями СМЭВ, не
приводит к инициации какой-либо бизнес деятельности в системе.
Рисунок 2. Контрольные примеры сервиса во вложении.
32
Руководство пользователя электронного сервиса «Сервисный концентратор ФМС России»
От реальных запросов каждый из предложенных в примере отличается отсутствием
следующего блока (или заменой его содержимого на реальные данные):
<person>
<firstName>Тест</firstName>
<lastName>Тестов</lastName>
<secondName>Тестович</secondName>
</person>
33