Вложенность элементов указывается через «→». Вложенность не должна быть нарушена.
Описание элементов | ||||
Наименование элемента | Необязательный элемент | Описание | Тип данных | Длина, знаков/ Формат |
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 тегов date или reason;
Спецификация на сервис передачи данных документа
Предисловие.
Данный документ является нормативным и должен применяться для реализации и использования функциональности SOAP сервиса. Документ содержит формат и структуру XML сообщений запроса и ответа, и описание сервиса. Структура описывается поэлементно с сохранением вложенности.
Технические требования
Список технических требований к сервису:
- Предоставить автоматически генерируемый ресурс описывающий сервис в формате WSDL v.1.1. Блокировать на время прием со стороны клиентов передающих дубликаты одинаковых сообщений для снижения нагрузки на сервис.
Список технических требований к клиенту:
Описание формата и структуры сообщений
Формат и структура сообщений участвующих в процессе коммуникации SOAP сервиса описаны на основании спецификации XML Schema 1.1 . XML схема вложена в описание сервиса формата WSDL (Приложение 1).
Сервис передачи данных документа
Данный сервис используется для передачи данных документов
Формат и структура сообщения данных
Вложенность элементов указывается через «→». Вложенность не должна быть нарушена.
Номер поля в форме | Наименование элемента | Тип | Формат | Обязат ельность | Описание поля |
1 | DocdataRequest ->DOCID | Long | Да | Идентификатор корректируемого документа | |
2 | DocdataRequest ->FORMNAME | String | Да | Наименование документа | |
3 | DocdataRequest ->XML | String | Да | Модель данных документа | |
4 | DocdataRequest ->BIN | String | Да | Документ в base64-gzip |
Пример сообщения запроса
Пример сообщения |
<soapenv:Envelope xmlns:soapenv="http://schemas. xmlsoap. org/soap/envelope/" xmlns:sign="http://xwww. ru/abcsign"><soapenv:Header/><soapenv:Body><sign:DocdataRequest><DOCID>57611591</DOCID><FORMNAME>Пакет документов</FORMNAME><DOCDATA><![CDATA[<data><formname>Пакет документов</formname><serviceTag1>2</serviceTag1><serviceTag2/></data>]]></DOCDATA><BIN>application/vnd. xfdl;content-encoding="base64-gzip"H4sIAAAAAAAAAO19eXMjyXXn3+anKFERYtNssu4C0M3GCDybzZsET4WCUQCKIJoACo2DBPjXaGxJdlixs5Ylr9ZrnetY78buhltzWKMZz8xXAL/CfpLNrCoAdWRWZeEoAN05HdONqnp5vXz58vi9fG/56HfTLOinJOtZZaIE3Ra2YSBx31FrcIta3muUhn9TCSnzITwJjVrk7bEv+hH8Yo950yr+XjnyGwSxUNp+WLd7sINg6xhWfSD536rBDhz+wiaBvOorEl/1Hc3NKJvsm7zrS+wLBs+mVeIdQoMW9q4BIM78r+MpJT7e4QBvcufBl2X2fGNtJ/n/AcPmYjr9yAMA</BIN><sign:DocdataRequest></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:DocdataResponse><docid>57611591</docid><code>0</code><description>ok</description> <sign:DocdataResponse></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">
<wsdl:types>
<schema xmlns="http://www. w3.org/2001/XMLSchema" attributeFormDefault="unqualified" elementFormDefault="unqualified" targetNamespace="http://xwww. ru/abcsign">
<element name="SignRequest">
<complexType>
<sequence>
<element name="DOCID" type="string"/>
<element minOccurs="0" name="FINISHED" type="int"/>
<element minOccurs="0" name="FIO" type="string"/>
<element name="FORMNAME" type="string"/>
<element minOccurs="0" name="PACKAGEID" type="string"/>
<element minOccurs="0" name="POST" type="string"/>
<element minOccurs="0" name="POSTANDNAME" type="string"/>
<element minOccurs="0" name="POSTREJECT" type="string"/>
<element minOccurs="0" name="REASON" type="string"/>
<element name="SIGNDATE" type="string"/>
<element minOccurs="0" name="SIGNNUM" type="int"/>
<element name="SIGNTIME" type="string"/>
</sequence>
</complexType>
</element>
<element name="SignResponse">
<complexType>
<sequence>
<element name="code" type="int"/>
<element name="description" type="string"/>
</sequence>
</complexType>
</element>
<element name="DocdataRequest">
<complexType>
<sequence>
<element name="DOCID" type="long"/>
<element name="FORMNAME" type="string"/>
<element name="XML" type="string"/>
<element name="BIN" type="string"/>
</sequence>
</complexType>
</element>
<element name="DocdataResponse">
<complexType>
<sequence>
<element name="code" type="int"/>
<element name="description" type="string"/>
<element name="docid" type="long"/>
</sequence>
</complexType>
</element>
</schema>
</wsdl:types>
<wsdl:message name="SignRequest">
<wsdl:part element="tns:SignRequest" name="SignRequest"></wsdl:part>
</wsdl:message>
<wsdl:message name="DocdataResponse">
<wsdl:part element="tns:DocdataResponse" name="DocdataResponse"></wsdl:part>
</wsdl:message>
<wsdl:message name="SignResponse">
<wsdl:part element="tns:SignResponse" name="SignResponse"></wsdl:part>
</wsdl:message>
<wsdl:message name="DocdataRequest">
<wsdl:part element="tns:DocdataRequest" name="DocdataRequest"></wsdl:part>
</wsdl:message>
<wsdl:portType name="SignAbc">
<wsdl:operation name="Sign">
<wsdl:input message="tns:SignRequest" name="SignRequest"></wsdl:input>
<wsdl:output message="tns:SignResponse" name="SignResponse"></wsdl:output>
</wsdl:operation>
<wsdl:operation name="Docdata">
<wsdl:input message="tns:DocdataRequest" name="DocdataRequest"></wsdl:input>
|
Из за большого объема этот материал размещен на нескольких страницах:
1 2 3 4 5 6 7 |


