Руководство Пользователя Электронного Сервиса Смэв (стр. 1 )

Руководство пользователя

электронного сервиса смэв

Веб-сервис обработки запросов на предоставление сведений о заключениях о привлечении и об использовании иностранных работников

Дата: 28.08.2013

Версия: 5.06

Листов: 42

СОДЕРЖАНИЕ

1 Общие сведения.. 5

1.1 Руководящие документы.. 5

1.2 Описание электронного сервиса. 6

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

1.4 Сценарии использования. 7

1.5 Схема взаимодействия. 7

1.6 Связи с другими электронными сервисами. 8

2 Руководство пользователя.. 9

2.1 Операция «processCanonicalService». 9

2.1.1 Общие сведения. 9

2.1.2 Описание входных параметров. 9

2.1.2.1 Инициирующий запрос. 9

2.1.2.2 Периодический запрос результата. 9

2.1.3 Описание выходных параметров. 10

2.1.3.1 Ответ на инициирующий запрос. 10

2.1.3.2 Ответ на периодический запрос результата. 10

2.1.4 Формирование вложения. 10

2.1.5 Коды возвратов. 11

2.1.6 Контрольные примеры.. 11

3 Методика испытаний.. 12

3.1 Общие условия. 12

3.2 Параметры испытаний на тестовой среде. 12

3.3 Особые условия. 12

4 Приложения.. 13

4.1 Приложение 1: Описание сервиса (WSDL и XSD) 13

4.1.1 smevMessageData. xsd. 13

4.1.2 xopInclude. xsd. 18

4.1.3 customMessageTypes. xsd. 18

4.1.4 xmldsig-core-schema. xsd. 19

4.1.5 XSD-описание форматов вложений. 23

4.1.5.1 XSD-схема, по которой должен быть сформирован документ запроса. 23

4.1.5.2 XSD-схема, по которой должен быть сформирован документ ответа. 25

4.1.5.3 Обе схемы ссылаются на общую схему данных: 26

4.2 Приложение 2: Описание общих структур данных. 29

4.2.1 impl:processCanonicalServiceMessageType. 29

4.2.2 impl:processCanonicalServiceResponseMessageType. 29

4.2.3 req:foreignWorkerRequest 30

4.2.4 req:employmentServiceRequest 31

4.2.5 req:position. 31

4.2.6 resp:foreignWorkerResponse. 32

4.2.7 resp:conclusion. 32

4.2.8 ct:attraction. 32

4.2.9 ct:emloyerType. 33

4.2.10 Вспомогательные типы.. 33

4.3 Приложение 3: Справочники. 34

4.3.1 Словарь «Страны». 34

4.3.2 Словарь «Регионы». 34

4.3.3 Словарь «ОКАТО». 36

4.3.4 Словарь «ОКТМО». 36

4.3.5 Словарь «Тип работодателя». 36

4.3.6 Словарь «ОКПДТР». 36

4.3.7 Словарь «ОКВЭД». 36

4.4 Приложение 4: Контрольные примеры.. 37

4.4.1 Инициирующий запрос. 37

4.4.1.1 SOAP-запрос. 37

4.4.1.2 XML-документ-вложение в запросе. 38

4.4.1.3 SOAP-ответ от ИС РОИВ.. 38

4.4.2 Периодический опрос результата. 39

4.4.2.1 SOAP-запрос. 39

4.4.2.2 SOAP-ответ от ИС РОИВ, сообщающий, что ответ еще не готов. 39

4.4.2.3 SOAP-ответ от ИС РОИВ.. 40

4.4.2.4 XML-документ-вложение в ответе. 41

4.5 Приложение 5: Коды возвратов. 41

изменения

Версия	Дата	Автор	Изменения
1.0	27.01.2012		Создан впервые
2.0	09.02.2012		Устранение замечаний
3.0	04.04.2012		Сервис изменен в соответствии с методическими рекомендациями 2.4.4.
4.0	24.10.2012		Внесены изменения в схему
5.0	24.10.2012		Внесены изменения в схему
5.02	04.03.2013		Внесены изменения в схему в части ОКАТО
5.04	10.04.2013		Добавлен контрольный пример, версия МР изменена на 2.4.5.
5.05	25.07.2013		В контрольный примерах используется код из справочников.
5.06	28.08.2013		Дополнительные ограничения на поля справочника ОКПДТР.

термины/СОКРАЩЕНИя

Термин/сокращение	Описание
СМЭВ	Система межведомственного электронного взаимодействия
Поставщик	Организация-владелец электронного сервиса
ИС	Информационная система поставщика информации
WSDL	Web Services Description Language – язык описания веб-сервисов.
XSD	XML Schema definition – язык описания структуры XML документа.
SOAP	Simple Object Access Protocol – протокол обмена структурированными сообщениями в распределённой вычислительной среде.
XML	eXtensible Markup Language – расширяемый язык разметки.
Методические рекомендации	Методические рекомендации по разработке электронных сервисов и применению технологии электронной подписи при межведомственном электронном взаимодействии Версия 2.4.5.

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

2.1  Руководящие документы

Основанием для разработки данного документа является требование п. 48 Приказа Министерства связи и массовых коммуникаций Российской Федерации от 27 декабря 2010 г. № 000 «Об утверждении технических требований к взаимодействию информационных систем в единой системе межведомственного электронного взаимодействия» в соответствии с которым, для подключения информационной системы к системе межведомственного электронного взаимодействия Поставщик предоставляет Оператору СМЭВ следующие документы:

-  паспорт электронного сервиса, регистрируемого в системе взаимодействия;

-  методику испытаний электронного сервиса, регистрируемого в системе взаимодействия, включая контрольный пример обращения к электронному сервису;

-  руководство пользователя электронного сервиса, регистрируемого в системе взаимодействия.

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

Нормативно-правовые документы:

-  Постановление Правительства Российской Федерации от 8 сентября 2010 г. № 000 «О единой системе межведомственного электронного взаимодействия»;

-  Приказ Министерства связи и массовых коммуникаций Российской Федерации от 01.01.01 г. № 000 «Об утверждении технических требований к взаимодействию информационных систем в единой системе межведомственного электронного взаимодействия».

Технологические стандарты:

-  Методические рекомендации по разработке электронных сервисов и применению технологии электронной подписи при межведомственном электронном взаимодействии Версия 2.4.5.

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

Наименование:	Веб-сервис обработки запросов на предоставление сведений о заключениях о привлечении и об использовании иностранных работников
Назначение:	Веб-сервис предназначена для приема запросов через СМЭВ, возвращения статусов обработки запросов и результата обработки запросов сведений о заключениях о привлечении и об использовании иностранных работников.
Поставщик:	Органы государственной власти субъекта Российской Федерации в области содействия занятости населения
Область применения:	Межведомственное взаимодействие

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

Метод	Назначение
Код: processCanonicalService Наименование: Запрос на регистрацию задачи и получение результата.	Метод предназначен как для регистрации запроса, так и для получения результата у Регионального поставщика типовых данных.

2.4  Сценарии использования

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

Сценарий предполагает асинхронный режим работы. Первый вызов осуществляет Потребитель данных. Последующие вызовы через определенные промежутки времени опрашивают Поставщика данных на предмет готовности ответных данных. В случае успешного получения данных работы по запросу прекращаются.

В случае каких-либо ошибок при обработке запроса ответ от ИС Поставщика данных будет содержать соответствующий код ошибки в поле errorCode, а также исчерпывающую текстовую информацию по ошибке в поле errorDescription.

2.5  Схема взаимодействия

Взаимодействие с СМЭВ осуществляется через интерфейсы web-сервисов подсистемы, путем приема soap-запросов и выполнения запрашиваемой процедуры.

Потребитель данных должен вызвать метод processCanonicalService сервиса Поставщика, при этом поле BinaryData блока MessageData \ AppDocument заполняется закодированной по Base64 строкой. Закодированная информация представляет собой zip-архив с XML-документом запроса в кодировке UTF-8, подготовленного по XSD-схемам запроса, приложенным в Приложении 2.

В ответ Поставщик данных, успешно зарегистрировав запрос, вернет уникальный номер заявки в блоке MessageData \ AppData, в поле taskId.

После этого Потребитель данных должен периодически опрашивать поставщика данных на предмет готовности Результата, заполняя унифицированное поле smev:Status значением «PING», и ранее полученным номером запроса в блоке MessageData \ AppData, в поле taskId. Далее возможны два варианта:

·  В случае, если Результат еще не сформирован, в ответе вернется блок smev:Status со значением «PROCESS»; при этом блок MessageData \ AppDocument \ BinaryData заполнен не будет.

·  В случае готовности Результата в ответе вернет блок smev:Status со значением «RESULT», а в блоке MessageData \ AppDocument поле BinaryData будет заполнено закодированной по Base64 строкой. Закодированная информация представляет собой zip-архив с XML-документом ответа в кодировке UTF-8, подготовленный по XSD-схемам ответа, приложенным в Приложении 2.

В случае каких-либо ошибок при обработке запроса Ответ должен содержать соответствующий код ошибки в поле errorCode, а также исчерпывающую текстовую информацию по ошибке в поле errorDescription.

2.6  Связи с другими электронными сервисами

Данный сервис не имеет связей с другими сервисами.

3  Руководство пользователя

3.1  Операция «processCanonicalService»

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

Метод:	processCanonicalService
Наименование:	Получение Руководство пользователя электронного сервиса СМЭВ
Назначение:	Метод предназначен как для регистрации запроса, так и для получения результата у Регионального поставщика типовых данных – регионального органа исполнительной власти. Разработанный метод в полной мере удовлетворяет концепции Типового сервиса регионов СМЭВ.

Здесь и далее пространства имен расшифровываются следующим образом:

·  smev – http://smev. *****/rev111111

·  impl - http://impl. *****

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

3.1.2.1  Инициирующий запрос

Следует отметить, что ключевой сущностью является отдельный документ запроса, сформированный в соответствии с XSD-схемой запроса соответствующей услуги и переданный в разделе AppDocument.

При формировании инициирующего запроса необходимо указывать следующую информацию:

№	Код параметра	Описание параметра	Обяз	Способ заполнения/Тип
3	smev:AppDocument	Блок вложения СМЭВ – заполняется в соответствии с разделом Формирование вложения.	+	smev:AppDocumentType

3.1.2.2  Периодический запрос результата

При формировании периодического запроса результата необходимо указывать следующую информацию:

№	Код параметра	Описание параметра	Обяз	Способ заполнения/Тип
1	impl:taskId	Идентификатор запроса в ИС РОИВ, полученный в ответе на инициирующий запрос	+	xs:string

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

3.1.3.1  Ответ на инициирующий запрос

Ответ на инициирующий запрос содержит следующую информацию:

№	Код параметра	Описание параметра	Обяз	Способ заполнения/Тип
1	impl:taskId	Идентификатор вновь-зарегистрированного запроса в Поставщике данных.	+	xs:string
2	impl:errorCode	Код ответа – отличие его от 0 говорит о произошедшей в ИС Поставщика данных ошибке при инициации запроса	+	xs:int
3	impl:errorDescription	В случае возникновения ошибки – ее описание	-	xs:string

3.1.3.2  Ответ на периодический запрос результата

Конечным ответом является отдельный документ, сформированный в соответствии с XSD-схемой ответа соответствующей услуги и переданный в разделе AppDocument.