Приложение 5. Описание вэб-сервиса статуса заявления на выдачу СК

Приложение 5

Описание вэб-сервиса статуса заявления на выдачу СК

Общая информация

Веб-сервис получения статуса заявления предназначен для получения данных о ходе выпуска СК.

Наименование веб-сервиса: FormStatusService.

Наименования операции: getFormStatusByFormNo.

Состав реквизитов входных и выходных параметров веб-сервиса приведен в Таблице 6.

Таблица 6. Состав реквизитов входных и выходных параметров веб-сервиса

N п/п	Наименование реквизита	Наименование тэга	Обязательность тэга	Примечание
Входные реквизиты
1.	Тип заявления	formType	Да	Тип заявления
2.	Номер заявления	formNumber	Да	Номер заявления
Выходные реквизиты при успешной обработке
1.	Тип заявления	formType	Нет	Тип заявления
2.	Номер заявления	formNumber	Нет	Номер заявления
3.	Код статуса	statusCode	Да	Код статуса
4.	Наименование статуса	statusName	Да	Наименование статуса
5.	Код ошибки	errorCode	Нет	Код ошибки
6.	Описание ошибки	errorName	Нет	Описание ошибки
Выходные реквизиты при ошибке (передаются в контейнере SOAPfault)
1.	Код ошибки	errorCode	Да
2.	Комментарий	comment	Нет

Начальный перечень значений исключений приведен в Таблице 7.

Таблица 7. Начальный перечень значений исключений

N п/п	Код исключения (code)	Наименование исключения (message)	Комментарий (comment)
1.	1	Неверные входные данные
2.	999	Внутренняя системная ошибка

WSDL-схема веб-сервиса

<definitions targetNamespace="http://minbws.webservice.msr.com" name="EduFormStatusService" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecu rity-utility-1.0.xsd" xmlns:wsp="http://www.w3.org/ns/ws-policy" xmlns:wsp1_2="http://schemas.xmlsoap.org/ws/2004/09/policy" xmlns:wsam="http://www.w3.org/2007/05/addressing/metadata" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:tns="http://minbws.webservice.msr.com" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.xmlsoap.org/wsdl/">

<types>

<xsd:schema>

<xsd:import namespace="http://minbws.webservice.msr.com/schemas" schemaLocation="http://dmz1stand.msr.lan:7001/minbws/EduFormStatusService ?xsd=1"/>

</xsd:schema>

</types>

<message name="EduFormStatusException">

<part name="fault" element="ns3:eduFormStatusException" xmlns:ns3="http://minbws.webservice.msr.com/schemas"/>

</message>

<message name="getFormStatusByFormNo">

<part name="parameters" element="ns4:getFormStatusByFormNo" xmlns:ns4="http://minbws.webservice.msr.com/schemas"/>

</message>

<message name="getFormStatusByFormNoResponse">

<part name="parameters" element="ns5:getFormStatusByFormNoResponse" xmlns:ns5="http://minbws.webservice.msr.com/schemas"/>

</message>

<portType name="EduFormStatusServicePortType">

<operation name="getFormStatusByFormNo">

<documentation>Сервис получения статуса поданного заявления по типу и номеру заявления</documentation>

<input wsam:Action="getFormStatusByFormNo" message="tns:getFormStatusByFormNo"/>

<output wsam:Action="http://minbws.webservice.msr.com/EduFormStatusService/getFor mStatusByFormNoResponse" message="tns:getFormStatusByFormNoResponse"/>

<fault message="tns:EduFormStatusException" name="EduFormStatusException" wsam:Action="http://minbws.webservice.msr.com/EduFormStatusService/getFor mStatusByFormNo/Fault/EduFormStatusException"/>

</operation>

</portType>

<binding name="EduFormStatusServicePortBinding" type="tns:EduFormStatusServicePortType">

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

<operation name="getFormStatusByPersData">

<soap:operation soapAction="getFormStatusByPersData"/>

<input>

<soap:body use="literal"/>

</input>

<output>

<soap:body use="literal"/>

</output>

<fault name="EduFormStatusException">

<soap:fault name="EduFormStatusException" use="literal"/>

</fault>

</operation>

<operation name="getFormStatusByFormNo">

<soap:operation soapAction="getFormStatusByFormNo"/>

<input>

<soap:body use="literal"/>

</input>

<output>

<soap:body use="literal"/>

</output>

<fault name="EduFormStatusException">

<soap:fault name="EduFormStatusException" use="literal"/>

</fault>

</operation>

</binding>

<service name="EduFormStatusService">

<port name="EduFormStatusServicePort" binding="tns:EduFormStatusServicePortBinding">

<soap:address location="http://dmz1stand.msr.lan:7001/minbws/EduFormStatusService"/>

</port>

</service>

</definitions>

XSD-схема веб-сервиса

<xsd:schema targetNamespace="http://minbws.webservice.msr.com/schemas" xmlns:ns0="http://minbws.webservice.msr.com/schemas" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<xsd:complexType name="submitFormExceptionBean">

<xsd:sequence>

<xsd:element name="errorCode" type="xsd:int"/>

<xsd:element name="comment" type="xsd:string" minOccurs="0" nillable="true"/>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="getFormStatusByFormNoResponse">

<xsd:sequence>

<xsd:element name="formStatus" type="ns0:formStatus" form="qualified" minOccurs="0">

<xsd:annotation>

<xsd:documentation>Статус заявления</xsd:documentation>

</xsd:annotation>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="getFormStatusByFormNo">

<xsd:sequence>

<xsd:element name="formType" type="xsd:int" form="qualified">

<xsd:annotation>

<xsd:documentation>Тип заявления</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:element name="formNumber" type="xsd:string" form="qualified">

<xsd:annotation>

<xsd:documentation>Номер заявления</xsd:documentation>

</xsd:annotation>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="formStatus">

<xsd:sequence>

<xsd:element name="formType" type="xsd:int" nillable="true" minOccurs="0">

<xsd:annotation>

<xsd:documentation>Тип заявления</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:element name="formNumber" type="xsd:string" minOccurs="0" nillable="true">

<xsd:annotation>

<xsd:documentation>Номер заявления</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:element name="statusCode" type="xsd:string">

<xsd:annotation>

<xsd:documentation>Код статуса</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:element name="statusName" type="xsd:string">

<xsd:annotation>

<xsd:documentation>Наименование статуса</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:element name="errorCode" type="xsd:string" minOccurs="0" nillable="true">

<xsd:annotation>

<xsd:documentation>Код ошибки</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:element name="errorName" type="xsd:string" minOccurs="0" nillable="true">

<xsd:annotation>

<xsd:documentation>Описание ошибки</xsd:documentation>

</xsd:annotation>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

<xsd:element name="getFormStatusByFormNoResponse" type="ns0:getFormStatusByFormNoResponse"/>

<xsd:element name="getFormStatusByFormNo" type="ns0:getFormStatusByFormNo"/>

<xsd:element name="eduFormStatusException" type="ns0:submitFormExceptionBean"/>

</xsd:schema>