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

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

Таблица 2.1

Наименование элемента	Описание
BlDocResponse →code	Код ошибки (int)
BlDocResponse →etddocid	Идентификатор документа (long)
BlDocResponse →description	URL ссылка на документ в системе или описание ошибки (string)

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

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas. xmlsoap. org/soap/envelope/">

  <SOAP-ENV:Header/>

  <SOAP-ENV:Body>

  <bld:BlDocResponse xmlns:con="http://xwww. ru/portal/bldoc">

        <etddocid>14207156</etddocid> 

       <code>0</code>

  <description>ok</description>

  </bld:BlDocResponse>

  </SOAP-ENV:Body>

</SOAP-ENV:Envelope>

Описание ошибок и их кодов

Таблица 2.2

Code	Description
-1	Неизвестная ошибка
0	Запрос успешно обработан
1	Ошибка обработки

Приложение 1

<wsdl:definitions xmlns:wsdl="http://schemas. xmlsoap. org/wsdl/" xmlns:sch="http://www. ru/xxxx/portal/bldoc" xmlns:soap="http://schemas. xmlsoap. org/wsdl/soap/"xmlns:tns="http://www. ru/xxxx/portal/bldoc" targetNamespace="http://www. ru/xxxx/portal/bldoc">

<wsdl:types>

<schema xmlns="http://www. w3.org/2001/XMLSchema" targetNamespace="http://www. ru/xxxx/portal/bldoc">

<element name="BlDocRequest" type="tns:RequestType"/>

<element name="BlDocResponse" type="tns:ResponseType"/>

<complexType name="ResponseType">

<sequence>

<element maxOccurs="1" minOccurs="1" name="etddocid" type="long"/>

<element maxOccurs="1" minOccurs="1" name="code" type="int"/>

<element maxOccurs="1" minOccurs="1" name="description" type="string"/>

</sequence>

</complexType>

<simpleType name="BlDoc">

<restriction base="string"/>

</simpleType>

<complexType name="RequestType">

<sequence>

<element maxOccurs="1" minOccurs="1" name="etddocid" type="long"/>

<element maxOccurs="1" minOccurs="1" name="formname" type="string"/>

<element maxOccurs="1" minOccurs="1" name="bldoc" type="tns:BlDoc"/>

</sequence>

</complexType>

</schema>

</wsdl:types>

<wsdl:message name="BlDocResponse">

<wsdl:part element="tns:BlDocResponse" name="BlDocResponse"></wsdl:part>

</wsdl:message>

<wsdl:message name="BlDocRequest">

<wsdl:part element="tns:BlDocRequest" name="BlDocRequest"></wsdl:part>

</wsdl:message>

<wsdl:portType name="bldoc">

<wsdl:operation name="BlDoc">

<wsdl:input message="tns:BlDocRequest" name="BlDocRequest"></wsdl:input>

<wsdl:output message="tns:BlDocResponse" name="BlDocResponse"></wsdl:output>

</wsdl:operation>

</wsdl:portType>

<wsdl:binding name="bldocSoap11" type="tns:bldoc">

<soap:binding style="document" transport="http://schemas. xmlsoap. org/soap/http"/>

<wsdl:operation name="BlDoc">

<soap:operation soapAction=""/>

<wsdl:input name="BlDocRequest">

<soap:body use="literal"/>

</wsdl:input>

<wsdl:output name="BlDocResponse">

<soap:body use="literal"/>

</wsdl:output>

</wsdl:operation>

</wsdl:binding>

<wsdl:service name="bldocService">

<wsdl:port binding="tns:bldocSoap11" name="bldocSoap11">

<soap:address location="http://10.0.0.46:48080/XXXX/bldoc/services"/>

</wsdl:port>

</wsdl:service>

</wsdl:definitions>

Спецификация на сервис передачи статуса документа.

Предисловие.

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

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

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

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

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

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

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

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

Сервис передачи статуса документа

Данный сервис используется для передачи уведомлений о подписании и отклонении документов

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

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

Номер поля в форме	Наименование элемента	Тип	Формат	Обязат ельность	Описание поля
1	SignRequest ->DOCID	String	Да	Идентификатор корректируемого документа
2	SignRequest ->FINISHED	Integer	Нет	Признак завершенного маршрута документа (1 — завершен, 0 — не завершен)
3	SignRequest ->FIO	String	Нет	ФИО подписанта
4	SignRequest ->FORMNAME	String	Да	Наименование документа
5	SignRequest ->PACKAGEID	String	Нет	Идентификатор пакета
6	SignRequest ->POST	String	Нет	Должность подписанта
7	SignRequest ->POSTANDNAME	String	Нет	ФИО отклонившего
8	SignRequest ->POSTREJECT	String	Нет	Должность отклонившего
9	SignRequest ->REASON	String	Нет	Причина отклонения
10	SignRequest ->SIGNDATE	String	dd. mm. yyyy	Да	Дата подписания/отклонения
11	SignRequest ->SIGNNUM	Integer	Нет	Количесвто подписей
12	SignRequest ->SIGNTIME	String	hh:mm:ss	Да	Время подписания/отклонения

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

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

<soapenv:Envelope xmlns:soapenv="http://schemas. xmlsoap. org/soap/envelope/" xmlns:sign="http://xwww. ru/abcsign">        <soapenv:Header/>        <soapenv:Body>                <sign:SignRequest> <DOCID>57611591</DOCID> <FINISHED>1</FINISHED> <FORMNAME>Пакет документов</FORMNAME> <FIO></FIO> <SIGNNUM>2</SIGNNUM> <SIGNDATE>23.04.2014</SIGNDATE> <SIGNTIME>09:10:37</SIGNTIME> <PACKAGEID>57611591</PACKAGEID> <POST>Представитель по доверенности</POST>                <sign:SignRequest>        </soapenv:Body> </soapenv:Envelope>

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

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

<soapenv:Envelope xmlns:soapenv="http://schemas. xmlsoap. org/soap/envelope/" xmlns:sign="http://xwww. ru/abcsign">   <soapenv:Header/>   <soapenv:Body>   <sign:SignRequest>   <DOCID>57590198</DOCID> <FORMNAME>Пакет документов</FORMNAME> <POSTANDNAME></POSTANDNAME> <REASON>В соответствии с п.2.4 РД32ЦВ-056-97 (при ТОР должны быть выявлены и устранены неисправности вагона, вне зависимости от причины поступления вагона в ремонт), а также с п.4.1.1,4.1.2. Договора работы проведённые по устранению дефекта в период действия гарантийного срока предоставленного ОАО "РЖД" на ТОР данного вагона выполняются за счёт ОАО "РЖД". Предыдущий ТР-2 был в ВЧДЭ-17 Пермь Сорт. 10.03.2014г.</REASON> <SIGNDATE>23.04.2014</SIGNDATE> <SIGNTIME>09:24:34</SIGNTIME> <PACKAGEID>57590198</PACKAGEID> <POSTREJECT>Старший специалист</POSTREJECT>   </sign:SignRequest>   </soapenv:Body> </soapenv:Envelope>

Описание ошибок и их кодов

Code	Description
-1	Неизвестная ошибка
0	Запрос успешно обработан

Приложение 1

<wsdl:definitions xmlns:wsdl="http://schemas. xmlsoap. org/wsdl/" xmlns:sch="http://xwww. ru/abcsign" xmlns:soap="http://schemas. xmlsoap. org/wsdl/soap/"xmlns:tns="http://xwww. ru/abcsign" targetNamespace="http://xwww. ru/abcsign">