Приложения
Описание сервиса (WSDL)
В комплекте документации поставляются WSDL- и XSD-описания электронного сервиса СК ФМС России в виде отдельных файлов, для двух видов реализаций - в соответствии с методическими рекомендациями СМЭВ версий 2.3.4 и 2.4.3, как указано на рисунке ниже.
Рисунок 1. Описание сервиса во вложении.
Описание общих структур данных
Предложенные ниже текстовые описания актуальны для приложенного файла 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
tns:getTaskTypesMessageType
№
|
Код параметра
|
Описание параметра
|
Обязательность
|
Способ заполнения/Тип
|
Комментарий
|
1
|
signature
|
Подпись ЭП СП
|
-
|
ds:Signature
|
Стандартный объект, соответствующий спецификации xmldsig
|
2
|
user
|
Объект информации о вызывающем лице
|
+
|
tns:user
|
|
tns:serviceRequestMessageType
№
|
Код параметра
|
Описание параметра
|
Обязательность
|
Способ заполнения/Тип
|
Комментарий
|
1
|
signature
|
Подпись ЭП СП
|
-
|
ds:Signature
|
Стандартный объект, соответствующий спецификации xmldsig
|
2
|
user
|
Пользователь (организация), представляющий запрашивающую сторону
|
+
|
tns:user
|
|
3
|
serviceCode
|
Код типа запроса
|
+
|
xs:string
|
|
4
|
versionCode
|
Версия типа запроса
|
+
|
xs:string
|
|
5
|
parameters
|
Параметры запроса
|
-
|
tns:taskParameter
|
В случае множества параметров – заполняется множество объектов этого типа (см. пример)
|
6
|
attachments
|
Приложения
|
-
|
tns:attachment
|
В случае множества параметров – заполняется множество объектов этого типа (см. пример)
|
tns:user
№
|
Код параметра
|
Описание параметра
|
Обязательность
|
Способ заполнения/Тип
|
Комментарий
|
1
|
organization
|
Код запрашивающего ФОИВа – заполняется в соответствии с приложением 4.4.3
|
+
|
xs:string
|
Строка не может быть пустой
|
2
|
person
|
Объект пользователя
|
-
|
tns:person
|
|
tns:person
№
|
Код параметра
|
Описание параметра
|
Обязательность
|
Способ заполнения/Тип
|
Комментарий
|
1
|
id
|
ID пользователя
|
-
|
xs:string
|
|
2
|
firstName
|
Имя пользователя
|
-
|
xs:string
|
|
3
|
secondName
|
Отчество пользователя
|
-
|
xs:string
|
|
4
|
lastName
|
Фамилия пользователя
|
-
|
xs:string
|
|
tns:getTaskTypesResponseMessageType
№
|
Код параметра
|
Описание параметра
|
Обязательность
|
Способ заполнения/Тип
|
Комментарий
|
1
|
signature
|
Подпись ЭП СП
|
-
|
ds:Signature
|
Стандартный объект, соответствующий спецификации xmldsig
|
2
|
errorCode
|
Числовой код ответа
|
+
|
xs:int
|
|
3
|
errorDescription
|
Текстовый комментарий к ответу
|
-
|
xs:string
|
|
4
|
services
|
Доступные пользователю типы запросов
|
-
|
tns:service
|
В случае множества параметров – заполняется множество объектов этого типа (см. пример)
|
tns:service
№
|
Код параметра
|
Описание параметра
|
Обязательность
|
Способ заполнения/Тип
|
Комментарий
|
1
|
code
|
Код возврата
|
+
|
xs:string
|
|
2
|
incomingParameters
|
Параметры запроса
|
+
|
tns:taskParameterDefinition
|
В случае множества параметров – заполняется множество объектов этого типа (см. пример)
|
3
|
outgoingParameters
|
Параметры ответа
|
+
|
tns:taskParameterDefinition
|
В случае множества параметров – заполняется множество объектов этого типа (см. пример)
|
tns:taskParameterDefinition
№
|
Код параметра
|
Описание параметра
|
Обязательность
|
Способ заполнения/Тип
|
Комментарий
|
1
|
name
|
Наименование параметра
|
-
|
xs:string
|
|
2
|
type
|
Тип параметра
|
-
|
tns:taskParameterType
|
|
3
|
mandatory
|
Признак обязательности параметра
|
+
|
xs:boolean
|
|
4
|
pattern
|
Regexp-параметр для валидации
|
-
|
xs:string
|
В случае формата типа «Дата» в этом поле указывается шаблон даты.
|
5
|
length
|
Максимальная длина значения параметра
|
-
|
xs:int
|
|
tns:taskParameter
№
|
Код параметра
|
Описание параметра
|
Обязательность
|
Способ заполнения/Тип
|
Комментарий
|
1
|
name
|
Наименование параметра
|
+
|
xs:string
|
|
2
|
value
|
Значение параметра
|
+
|
xs:string
|
|
tns:attachment
№
|
Код параметра
|
Описание параметра
|
Обязательность
|
Способ заполнения/Тип
|
Комментарий
|
1
|
code
|
Код вложения
|
+
|
xs:string
|
|
2
|
fileName
|
Имя файла-вложения
|
-
|
xs:string
|
|
3
|
mimeType
|
MIME-тип вложения
|
+
|
xs:string
|
|
4
|
data
|
Содержимое вложения
|
+
|
xs:base64Binary
|
|
tns: getResultMessageType
№
|
Код параметра
|
Описание параметра
|
Обязательность
|
Способ заполнения/Тип
|
Комментарий
|
1
|
signature
|
Подпись ЭП СП
|
-
|
ds:Signature
|
Стандартный объект, соответствующий спецификации xmldsig
|
2
|
user
|
Пользователь (организация), представляющий запрашивающую сторону
|
+
|
tns:user
|
|
3
|
taskId
|
Номер задачи
|
+
|
xs:string
|
|
tns:getResultResponseMessageType
№
|
Код параметра
|
Описание параметра
|
Обязательность
|
Способ заполнения/Тип
|
Комментарий
|
1
|
signature
|
Подпись ЭП СП
|
-
|
ds:Signature
|
Стандартный объект, соответствующий спецификации xmldsig
|
2
|
errorCode
|
Числовой код ответа
|
+
|
xs:int
|
|
3
|
errorDescription
|
Текстовый комментарий к ответу
|
-
|
xs:string
|
|
4
|
taskResult
|
Объект результата выполнения задачи
|
-
|
tns:taskResult
|
|
tns:processTaskResponseMessageType
№
|
Код параметра
|
Описание параметра
|
Обязательность
|
Способ заполнения/Тип
|
Комментарий
|
1
|
signature
|
Подпись ЭП СП
|
-
|
ds:Signature
|
Стандартный объект, соответствующий спецификации xmldsig
|
2
|
errorCode
|
Числовой код ответа
|
+
|
xs:int
|
|
3
|
errorDescription
|
Текстовый комментарий к ответу
|
-
|
xs:string
|
|
4
|
taskResult
|
Объект результата выполнения задачи
|
-
|
tns:taskResult
|
|
tns: sendErrorReportMessageType
№
|
Код параметра
|
Описание параметра
|
Обязательность
|
Способ заполнения/Тип
|
Комментарий
|
1
|
signature
|
Подпись ЭП СП
|
-
|
ds:Signature
|
Стандартный объект, соответствующий спецификации xmldsig
|
2
|
user
|
Пользователь (организация), представляющий запрашивающую сторону
|
+
|
tns:user
|
|
3
|
taskId
|
Уникальный идентификатор задачи
|
+
|
xs:string
|
|
4
|
errorReport
|
Сообщение об ошибке
|
+
|
xs:string
|
|
tns: sendErrorReportResponseMessageType
№
|
Код параметра
|
Описание параметра
|
Обязательность
|
Способ заполнения/Тип
|
Комментарий
|
1
|
signature
|
Подпись ЭП СП
|
-
|
ds:Signature
|
Стандартный объект, соответствующий спецификации xmldsig
|
2
|
errorCode
|
Числовой код ответа
|
+
|
xs:int
|
|
3
|
errorDescription
|
Текстовый комментарий к ответу
|
-
|
xs:string
|
|
4
|
errorReportId
|
Уникальный идентификатор сообщения об ошибке
|
+
|
xs:string
|
|
tns:taskResult
№
|
Код параметра
|
Описание параметра
|
Обязательность
|
Способ заполнения/Тип
|
Комментарий
|
1
|
taskId
|
Уникальный идентификатор задачи
|
+
|
xs:string
|
|
2
|
state
|
Текущее состояние запроса
|
+
|
tns:taskState
|
|
3
|
parameters
|
Результат выполнения запроса в виде набора параметров
|
-
|
tns:taskParameter
|
В случае множества параметров – заполняется множество объектов этого типа (см. пример)
|
4
|
attachments
|
Приложение к результату
|
-
|
tns:attachment
|
В случае множества параметров – заполняется множество объектов этого типа (см. пример)
|
tns:bookRequestResponseMessageType
№
|
Код параметра
|
Описание параметра
|
Обязательность
|
Способ заполнения/Тип
|
Комментарий
|
1
|
signature
|
Подпись ЭП СП
|
-
|
ds:Signature
|
Стандартный объект, соответствующий спецификации xmldsig
|
2
|
errorCode
|
Числовой код ответа
|
+
|
xs:int
|
|
3
|
errorDescription
|
Текстовый комментарий к ответу
|
-
|
xs:string
|
|
4
|
taskId
|
Уникальный идентификатор задачи
|
-
|
xs:string
|
|
Описания справочников
Типы значений параметров (tns:taskParameterType):
INTEGER
|
LONG
|
FLOAT
|
STRING
|
BOOLEAN
|
DATE
|
TIME
|
DATE_TIME
|
LIST
|
Статусы (tns:taskState):
CHECKING
|
PROCESSING
|
OPERATOR_ANSWER_WAITING
|
DS_WAITING
|
READY
|
CLOSED
|
CANCELLED
|
RETURNED
|
Иные приложения
Дополнительная документация
Помимо данного документа, в комплектации поставляется документ «ФМС_СК_Входящие запросы.doc». Указанный документ содержит конкретизированные описания каждого из типов запросов, инициировать работу по которым позволяет электронный сервис СК ФМС, и данное руководство. В частности, документ рассматривает динамические наборы входных и выходных параметров, предусмотренных для работы по отдельным типам запросов, для заполнения последовательности из множества блоков taskParameter.
Описание сервиса
В комплекте документации также поставляются WSDL и XSD описания электронного сервиса СК ФМС России в виде отдельных файлов, для двух видов реализаций - в соответствии с методическими рекомендациями СМЭВ версий 2.3.4 и 2.4.3.
Правила заполнения блока organization
Запрашивающая организация – ФОИВ
В этом случае необходимо указать 11-значный код ФОИВ из сводного реестра государственных и мунициальных услуг.
Пример: для МВД России:
10000001197
Запрашивающая организация – регионального уровня
Блок заполняется следующей комбинацией:
Префикс R;
Первые 4 знака кода ОКАТО региона;
6 нулей (зарезервировано).
Пример: для органа власти регионального уровня г. Санкт-Петербурга:
R4000000000
где 4000 - Первые 4 знака ОКАТО.
Контрольные примеры
Контрольные примеры приведены отдельно для тестирования двух видов реализаций - в соответствии с методическими рекомендациями СМЭВ версий 2.3.4 и 2.4.3, отдельно для каждого из типов запросов. Исполнение контрольного примера, в соответствии с требованиями СМЭВ, не приводит к инициации какой-либо бизнес деятельности в системе.
Рисунок 2. Контрольные примеры сервиса во вложении.
От реальных запросов каждый из предложенных в примере отличается отсутствием следующего блока (или заменой его содержимого на реальные данные):
Тест
Тестов
Тестович
|
