SOAP сервис, реализующий передачу уведомлений о подписании и отклонении (стр. 1 )

SOAP сервис, реализующий передачу  уведомлений о подписании и отклонении.

Предисловие

Данный документ является нормативным и должен применяться для реализации и использования функциональности SOAP сервиса. Документ содержит формат и структуру XML сообщений, запроса и ответа, и описание сервиса. Структура описывается поэлементно с сохранением вложенности.

Описание процесса автоматизации

Уведомления о подписании и отклонении в описанном формате передаются в АСУ после каждого отклонения документа, а также после проставления подписи в электронном документе в момент его сохранения. Сервис АСУ производит проверку формата поступившего сообщения и при обнаружении ошибок возвращает текст и код ошибки. После обработки поступившего сообщения сервис создает сообщение отчета и возвращает его вызывающей стороне.

Технические требования

Список технических требований к сервису:

Предоставить автоматически генерируемый ресурс описывающий сервис в формате WSDL v.1.1. Обеспечить максимальную производительность равную обработок 100 вызовов в 1 секунду. Блокировать на время прием со стороны клиентов передающих дубликаты одинаковых сообщений для снижения нагрузки на сервис.

Список технических требований к клиенту:

Снизить к минимуму количество дубликатов одинаковых сообщений передаваемых сервису при помощи интерпретации сообщений отчетов; Все передаваемые сообщения должны соответствовать описанному в данном документе формату; Вызывающая сторона должна корректно обработать сообщение отчета и выполнить определенные действия на основе интерпретированных данных; Сообщение должны передаваться в кодировке UNICODE в частности UTF-8. Использовать вызов на основании спецификации SOAP версии 1.1

Описание формата и структуры сообщений

Формат и структура сообщений участвующих в процессе коммуникации SOAP сервиса описаны на основании спецификации XML Schema 1.1 . XML схема вложена в описание сервиса формата WSDL (Приложение 1).

Сообщение о подписании

Формат и структура сообщения данных

Вложенность элементов указывается через «→». Вложенность не должна быть нарушена.

Описание элементов
Наименование элемента	Необязательный элемент	Описание	Тип данных	Длина, знаков/ Формат
SignRequest → formtype	Наименование типа документа. Обязательный элемент, значение которого можно охарактеризовать набором символов.	STRING
SignRequest→ docid	Идентификатор документа в системе. Обязательный элемент, значение которого можно охарактеризовать целым числом.	LONG
SignRequest→ packageid	Идентификатор пакета в системе. Необязательный элемент, поскольку данное поле используется не во всех документах Портала. Значение поля можно охарактеризовать целым числом.	STRING
SignRequest → finished	Признак окончания оформления документа на Портале. Обязательный элемент. 0 – не оформлен, 1 - оформлен	INTEGER
SignRequest → signature→signnum	Номер подписи документа по порядку его оформления. Обязательный элемент, значение которого можно охарактеризовать целым числом.	INTEGER
SignRequest → signature→fio	ФИО подписанта. Обязательный элемент, значение которого можно охарактеризовать набором символов.	STRING
SignRequest → signature→signdate	Дата подписи. Обязательный элемент, значение которого можно охарактеризовать форматом дд. мм. гггг.	STRING
SignRequest → signature→signtime	Время подписи. Обязательный элемент, значение которого можно охарактеризовать форматом чч:мм.	STRING
SignRequest → text	Дополнительное поле. Необязательный элемент, значение которого можно охарактеризовать набором символов. Необходимость этого поля оговаривается отдельно. По умолчанию не входит в запрос.	STRING

       Элемент SignRequest / signature может быть в составе массива при необходимости.

Пример сообщения

<soapenv:Envelope xmlns:soapenv="http://schemas. xmlsoap. org/soap/envelope/" xmlns:sign=" http://www. ru/portal/sign/">   <soapenv:Header/>   <soapenv:Body>   <sign:SignRequest>   <formtype> XXXXX </formtype>   <docid>41101</docid>  <packageid>52213</packageid>   <finished>1</finished>   <signature>   <signnum>3</signnum>   <fio> </fio>   <signdate>21.12.2009</signdate>   <signtime>18:15</signtime>   </signature>   <text> текст(номер)…</ text>   </sign:SignRequest>   </soapenv:Body> </soapenv:Envelope>

Сообщение отчета

Сообщение отчета сообщает вызывающей стороне об окончании обработки полученных данных. Элемент «code» содержит код ошибки, элемент «description» - описание ошибки. Если сообщение успешно обработано, то код ошибки равен «0». Элемент id содержит значение поля SignRequest→docid.

Вложенность элементов указывается через «→». Вложенность не должна быть нарушена.

Описание элементов
Наименование элемента	Необязательный элемент	Описание	Тип данных	Длина, знаков/ Формат
SignResponse→id	Идентификатор соответствующего документа в системе	LONG
SignResponse→code	Код ошибки	LONG
SignResponse→description	Описание ошибки	STRING

Пример сообщения

<soapenv:Envelope xmlns:soapenv="http://schemas. xmlsoap. org/soap/envelope/" xmlns:sign=" http://xwww. ru/portal/sign/">   <soapenv:Header/>   <soapenv:Body>   <sign:SignResponse>   <id>41101</id>   <code>0</code>   <description>ok</description>   </sign:SignResponse>   </soapenv:Body> </soapenv:Envelope>

Примечание.  Отличительным свойством уведомления о подписании является наличие в Sign Request тегов finished или  signature;

Сообщение об отклонении

Формат и структура сообщения данных

Вложенность элементов указывается через «→». Вложенность не должна быть нарушена.

Описание элементов
Наименование элемента	Необязательный элемент	Описание	Тип данных	Длина, знаков/ Формат
SignRequest → formtype	Наименование типа документа. Обязательный элемент, значение которого можно охарактеризовать набором символов.	STRING
SignRequest → docid	Идентификатор отклоненного документа в системе	LONG
SignRequest→ packageid	Идентификатор пакета в системе. Необязательный элемент, поскольку данное поле используется не во всех документах Портала. Значение поля можно охарактеризовать целым числом.	STRING
SignRequest →date	Дата отклонения. Обязательный элемент, значение которого можно охарактеризовать форматом дд. мм. гггг.	STRING
SignRequest →time	Время отклонения. Обязательный элемент, значение которого можно охарактеризовать форматом чч:мм.	STRING
SignRequest →reason	Причина отклонения	STRING
SignRequest →postAndName	Должность и Ф. И.О. подписанта отклонившего документ	STRING
SignRequest →text	Дополнительное поле. Необязательный элемент, значение которого можно охарактеризовать набором символов. Необходимость этого поля оговаривается отдельно. По умолчанию не входит в запрос.	STRING

Пример сообщения

<soapenv:Envelope xmlns:soapenv="http://schemas. xmlsoap. org/soap/envelope/" xmlns:sign=" http://www. ru/portal/sign/">   <soapenv:Header/>   <soapenv:Body>   <sign:SignRequest>   <formtype> XXXXX </formtype>   <docid>41101</docid>    <packageid>52213</packageid>    <date>16.06.2010</date>   <time>04:00</time>   <reason>тестовое отклонение </reason>   <postAndName>Технолог  </postAndName>   <text> текст(номер)…</text>   </sign:SignRequest>   </soapenv:Body> </soapenv:Envelope>

Сообщение отчета

Сообщение отчета сообщает вызывающей стороне об окончании обработки полученных данных. Элемент «code» содержит код ошибки, элемент «description» - описание ошибки. Если сообщение успешно обработано, то код ошибки равен «0. Элемент id содержит значение поля SignRequest →docid.