Servicio común de consulta por CSV para aplicaciones productoras

Transcripción

1 Servicio común de consulta por CSV para aplicaciones productoras Servicio común de consulta por CSV Documento de Integración Sistemas Desarrollo Versión 005 Fecha de revisión 09/02/2016 Realizado por Sistemas Desarrollo Servicio común de consulta por CSV v1.0 / 1

2 ÍNDICE 1 Control de modificaciones Objetivo del documento Descripción funcional Especificación Estructuras de datos WSCredential CSVQueryDocumentRequest CSVQueryDocumentResponse CSVQueryDocumentException documentresponse waitresponse Ejemplo de peticiones SOAP CSV encontrado y documento disponible en el momento Petición Respuesta CSV encontrado y documento no disponible en el momento Petición Respuesta CSV no encontrado Petición Respuesta Error en el servidor Petición Respuesta Definición del servicio WSDL WSDL + XSD Servicio común de consulta por CSV v1.0 / 2

3 1 Control de modificaciones Revisión Actual: 005 Fecha: 09/02/2016 Autor: Sistemas Desarrollo Descripción: - Actualización del punto 7 para detallar mejor el wsdl a implementar. Revisión Actual: 004 Fecha: 13/01/2016 Autor: Sistemas Desarrollo Descripción: - Corrección del punto 6 de los ejemplos de peticiones SOAP. Revisión Actual: 003 Fecha: 01/07/2015 Autor: Sistemas Desarrollo Descripción: Se define un atributo descripción para los códigos de respuesta del servicio y los textos de cada uno de ellos. Revisión Anterior: 002 Fecha: 30/06/2015 Autor: Sistemas Desarrollo Descripción: Se incluye el objeto con las credenciales para la autenticación en el servicio. Modificaciones en estructuras de datos y espacios de nombres. Revisión Anterior: 001 Fecha: 11/02/2015 Autor: Sistemas Desarrollo Descripción: Versión inicial del documento. Especificación y guía del servicio de consulta de documentos. Servicio común de consulta por CSV v1.0 / 3

4 2 Objetivo del documento El objetivo del presente documento es hacer una descripción funcional del servicio de consulta de documentos por medio del CSV, que deben implementar las aplicaciones denominadas productoras (aplicaciones a las que debe acudir el CSV Broker para poder recuperar el documento en cuestión), además de una descripción de la especificación del mismo. Servicio común de consulta por CSV v1.0 / 4

5 3 Descripción funcional El servicio de consulta por CSV debe devolver el documento asociado a un CSV concreto. Servicio común de consulta por CSV v1.0 / 5

6 4 Especificación El servicio CSVQueryDocumentService_Rev008 tendrá una sola operación, csvquerydocument, que recibirá como entrada un elemento de tipo csvquerydocumentrequest y devolverá un elemento de tipo csvquerydocumentresponse. Servicio común de consulta por CSV v1.0 / 6

7 5 Estructuras de datos 5.1 WSCredential A continuación, se explica la estructura del tipo: <xs:complextype name="wscredential"> <xs:element name="idaplicacion" type="xs:string" /> <xs:element name="password" type="xs:string" /> 5.2 CSVQueryDocumentRequest A continuación, se explica la estructura del tipo: <xs:complextype name="csvquerydocumentrequest"> <xs:element name="csv" type="xs:string" /> <xs:element name="dir3" type="xs:string" /> Contiene dos elementos: csv: Código CSV. Obligatorio. Dir3: Código dir3. Opcional Servicio común de consulta por CSV v1.0 / 7

8 5.3 CSVQueryDocumentResponse A continuación, se explica la estructura del tipo: <xs:complextype name="csvquerydocumentresponse"> <xs:element name="code" type="xs:string" /> <xs:element name="description" type="xs:string" /> <xs:element minoccurs="0" maxoccurs="1" name="documentresponse" type="tns:documentresponse" /> <xs:element minoccurs="0" name="waitresponse" type="tns:waitresponse" /> El tipo se compone de los siguientes elementos: code: Código para indicar el resultado de la operación. Los valores que se deben devolver en de este código son: 0: La operación se ha realizado con éxito, es decir, se devuelve el documento asociado al CSV. 1: El documento no puede recuperarse, pero puede consultarse pasados unos segundos. 2: CSV no encontrado. description: Breve descripción del resultado según el código de respuesta: 0: La operación se ha realizado con éxito. 1: El documento no puede recuperarse. Puede consultarse pasado un tiempo. 2: CSV no encontrado. documentresponse: Elemento utilizado para devolver el documento. Se describe con detalle en el apartado 5.5. En caso de devolver este elemento, el elemento code deberá tener el valor 0. Elemento opcional. waitresponse: Elemento utilizado para indicar el número de segundos a esperar para tener disponible el documento. Se describe en detalle en el apartado 5.6. En caso de devolver este elemento, el elemento code deberá tener el valor 1. Elemento opcional. Servicio común de consulta por CSV v1.0 / 8

9 5.4 CSVQueryDocumentException Excepción que se levantará cuando se produzca algún error. <xs:element name="csvquerydocumentexception" nillable="true"> <xs:complextype> <xs:element name="code" type="xs:string" /> <xs:element name="description" type="xs:string" /> </xs:element> Contiene los siguientes elementos: code: Código del mensaje de error. description: Descripción del mensaje de error. 5.5 documentresponse Este elemento sirve para contener tanto el documento asociado a un CSV como información de este documento. <xs:complextype name="documentresponse"> <xs:element name="content" type="xs:base64binary" /> <xs:element name="name" type="xs:string" /> <xs:element name="mime" type="xs:string" /> Se compone de los siguientes elementos: content: Contenido en Base64 del documento. name: Nombre del documento. mime: Tipo mime del documento. 5.6 waitresponse Este elemento sirve para informar al consumidor de que el documento estará disponible en un tiempo especificado en segundos. <xs:complextype name="waitresponse"> <xs:element name="secondstowait" type="xs:long" /> Se compone de los siguientes elementos: secondstowait: Segundos a esperar para volver a intentar recuperar el documento. Servicio común de consulta por CSV v1.0 / 9

10 6 Ejemplo de peticiones SOAP En este apartado se enumeran ejemplos de peticiones y respuestas SOAP para cada uno de los casos: 6.1 CSV encontrado y documento disponible en el momento Petición <soapenv:envelope xmlns:soapenv=" xmlns:urn="urn:es:gob:aapp:csvbroker:webservices:querydocument:v1.0"> <soapenv:header/> <soapenv:body> <urn:csvquerydocument> <credential> <idaplicacion>prueba</idaplicacion> <password>test</password> </credential> <querydocumentrequest> <csv>123456abcdef987654zwyvijk</csv> <dir3>a </dir3> </querydocumentrequest> </urn:csvquerydocument> </soapenv:body> </soapenv:envelope> Respuesta <soap:body> <ns2:csvquerydocumentresponse xmlns:ns2="urn:es:gob:aapp:pgecsv:query:v1.0" xmlns:ns3="urn:es:gob:aapp:pgecsv:query:type:v1.0"> <csvquerydocumentresponse> <code>0</code> <documentresponse> <content>jvber...base64...</content> <name>fichero.pdf</name> <mime>application/pdf</mime> </documentresponse> </csvquerydocumentresponse> </ns2:csvquerydocumentresponse> </soap:body> Servicio común de consulta por CSV v1.0 / 10

11 6.2 CSV encontrado y documento no disponible en el momento Petición <soapenv:envelope xmlns:soapenv=" xmlns:urn="urn:es:gob:aapp:csvbroker:webservices:querydocument:v1.0"> <soapenv:header/> <soapenv:body> <urn:csvquerydocument> <credential> <idaplicacion>prueba</idaplicacion> <password>test</password> </credential> <querydocumentrequest> <csv>123456abcdef987654zwyvijk</csv> <dir3>a </dir3> </querydocumentrequest> </urn:csvquerydocument> </soapenv:body> </soapenv:envelope> Respuesta <soap:body> <ns2:csvquerydocumentresponse xmlns:ns2="urn:es:gob:aapp:pgecsv:query:v1.0" xmlns:ns3="urn:es:gob:aapp:pgecsv:query:type:v1.0"> <csvquerydocumentresponse> <code>1</code> <waitresponse> <secondstowait>3600</secondstowait> </waitresponse> </csvquerydocumentresponse> </ns2:csvquerydocumentresponse> </soap:body> Servicio común de consulta por CSV v1.0 / 11

12 6.3 CSV no encontrado Petición <soapenv:envelope xmlns:soapenv=" xmlns:urn="urn:es:gob:aapp:csvbroker:webservices:querydocument:v1.0"> <soapenv:header/> <soapenv:body> <urn:csvquerydocument> <credential> <idaplicacion>prueba</idaplicacion> <password>test</password> </credential> <querydocumentrequest> <csv>123456abcdef987654zwyvijk</csv> <dir3>a </dir3> </querydocumentrequest> </urn:csvquerydocument> </soapenv:body> </soapenv:envelope> Respuesta <soap:body> <ns2:csvquerydocumentresponse xmlns:ns2="urn:es:gob:aapp:pgecsv:query:v1.0" xmlns:ns3="urn:es:gob:aapp:pgecsv:query:type:v1.0"> <csvquerydocumentresponse> <code>2</code> </csvquerydocumentresponse> </ns2:csvquerydocumentresponse> </soap:body> Servicio común de consulta por CSV v1.0 / 12

13 6.4 Error en el servidor Petición <soapenv:envelope xmlns:soapenv=" xmlns:urn="urn:es:gob:aapp:csvbroker:webservices:querydocument:v1.0"> <soapenv:header/> <soapenv:body> <urn:csvquerydocument> <credential> <idaplicacion>prueba</idaplicacion> <password>test</password> </credential> <querydocumentrequest> <csv>123456abcdef987654zwyvijk</csv> <dir3>a </dir3> </querydocumentrequest> </urn:csvquerydocument> </soapenv:body> </soapenv:envelope> Respuesta <soap:body> <soap:fault> <faultcode>soap:server</faultcode> <faultstring>error Interno</faultstring> <detail> <ns3:errorinfo xmlns:ns2="urn:es:gob:aapp:pgecsv:query:v1.0" xmlns:ns3="urn:es:gob:aapp:pgecsv:query:type:v1.0"> <code>500</code> <description>error interno en el servidor</description> </ns3:errorinfo> </detail> </soap:fault> </soap:body> Servicio común de consulta por CSV v1.0 / 13

14 7 Definición del servicio En este punto se muestran 2 formas de definir del endpoint que deben implementar las aplicaciones productoras. Nota: Es importante que en la definición del servicio CSVQueryDocumentService el name y el targetnamespace sean los indicados en este punto para que CSV Broker funcione correctamente al llamar al endpoint difinido. 7.1 WSDL <?xml version="1.0" encoding="utf-8"?> <wsdl:definitions name="csvquerydocumentservice" targetnamespace="urn:es:gob:aapp:csvbroker:webservices:querydocument:v1.0" xmlns:xsd=" xmlns:wsdl=" xmlns:tns="urn:es:gob:aapp:csvbroker:webservices:querydocument:v1.0" xmlns:soap=" xmlns:ns2=" xmlns:ns1="urn:es:gob:aapp:csvbroker:webservices:querydocument:model:v1.0"> <wsdl:types> <xs:schema elementformdefault="unqualified" targetnamespace="urn:es:gob:aapp:csvbroker:webservices:querydocument:v1.0" version="1.0" xmlns:xs=" <xs:import namespace="urn:es:gob:aapp:csvbroker:webservices:querydocument:model:v1.0"/> <xs:element name="csvquerydocument" type="tns:csvquerydocument"/> <xs:element name="csvquerydocumentresponse" type="tns:csvquerydocumentresponse"/> <xs:complextype name="csvquerydocument"> <xs:element name="credential" type="ns1:wscredential"/> <xs:element name="querydocumentrequest" type="ns1:csvquerydocumentrequest"/> <xs:complextype name="csvquerydocumentresponse"> <xs:element minoccurs="0" ref="ns1:csvquerydocumentresponse"/> </xs:schema> <xs:schema attributeformdefault="unqualified" elementformdefault="unqualified" targetnamespace="urn:es:gob:aapp:csvbroker:webservices:querydocument:model:v1.0" xmlns:xs=" xmlns:tns="urn:es:gob:aapp:csvbroker:webservices:querydocument:model:v1.0"> <xs:element name="csvquerydocumentexception" nillable="true"> <xs:complextype> <xs:element name="code" type="xs:string"/> <xs:element name="description" type="xs:string"/> </xs:element> <xs:element name="csvquerydocumentresponse" type="tns:csvquerydocumentresponse"/> <xs:complextype name="wscredential"> <xs:element name="idaplicacion" type="xs:string"/> Servicio común de consulta por CSV v1.0 / 14

15 <xs:element name="password" type="xs:string"/> <xs:complextype name="csvquerydocumentrequest"> <xs:element name="csv" type="xs:string"/> <xs:complextype name="csvquerydocumentresponse"> <xs:element name="code" type="xs:string"/> <xs:element name="description" type="xs:string"/> <xs:element minoccurs="0" maxoccurs="1" name="documentresponse" type="tns:documentresponse"/> <xs:element minoccurs="0" name="waitresponse" type="tns:waitresponse"/> <xs:complextype name="documentresponse"> <xs:element name="content" type="xs:base64binary"/> <xs:element name="name" type="xs:string"/> <xs:element name="mime" type="xs:string"/> <xs:complextype name="waitresponse"> <xs:element name="secondstowait" type="xs:long"/> <xs:element name="errorinfo" nillable="true"/> </xs:schema> </wsdl:types> <wsdl:message name="csvquerydocument"> <wsdl:part element="tns:csvquerydocument" name="parameters"/> </wsdl:message> <wsdl:message name="csvquerydocumentresponse"> <wsdl:part element="tns:csvquerydocumentresponse" name="parameters"/> </wsdl:message> <wsdl:message name=" CSVQueryDocumentException "> <wsdl:part element="ns1:errorinfo" name="csvquerydocumentexception"/> </wsdl:message> <wsdl:porttype name="csvquerydocumentservice"> <wsdl:operation name="csvquerydocument"> <wsdl:input message="tns:csvquerydocument" name="csvquerydocument"/> <wsdl:output message="tns:csvquerydocumentresponse" name="csvquerydocumentresponse"/> <wsdl:fault message="tns:csvquerydocumentexception" name="csvquerydocumentexception"/> </wsdl:operation> </wsdl:porttype> <wsdl:binding name="csvquerydocumentservicesoapbinding" type="tns:csvquerydocumentservice"> <soap:binding style="document" transport=" <wsdl:operation name="csvquerydocument"> <soap:operation soapaction="urn:csvquerydocument" style="document"/> <wsdl:input name="csvquerydocument"> <soap:body use="literal"/> </wsdl:input> <wsdl:output name="csvquerydocumentresponse"> <soap:body use="literal"/> </wsdl:output> Servicio común de consulta por CSV v1.0 / 15

16 <wsdl:fault name="csvquerydocumentexception"> <soap:fault name="csvquerydocumentexception" use="literal"/> </wsdl:fault> </wsdl:operation> </wsdl:binding> <wsdl:service name="csvquerydocumentservice"> <wsdl:port binding="tns:csvquerydocumentservicesoapbinding" name="csvquerydocumentserviceport"> <soap:address location=" </wsdl:port> </wsdl:service> </wsdl:definitions> 7.2 WSDL + XSD WSDL <?xml version="1.0" encoding="utf-8" standalone="no"?> <wsdl:definitions xmlns:ns1="urn:es:gob:aapp:csvbroker:webservices:querydocument:model:v1.0" xmlns:ns2=" xmlns:s0="urn:es:gob:aapp:csvbroker:webservices:querydocument:v1.0" xmlns:soap=" xmlns:tns="urn:es:gob:aapp:csvbroker:webservices:querydocument:v1.0" xmlns:wsam=" xmlns:wsdl=" xmlns:wsp=" xmlns:wsp1_2=" xmlns:wsu=" xmlns:xsd=" name="csvquerydocumentservice" targetnamespace="urn:es:gob:aapp:csvbroker:webservices:querydocument:v1.0"> <wsdl:types> <xs:schema xmlns:xs=" elementformdefault="unqualified" targetnamespace="urn:es:gob:aapp:csvbroker:webservices:querydocument:v1.0" version="1.0"> <xsd:import namespace="urn:es:gob:aapp:csvbroker:webservices:querydocument:model:v1.0" schemalocation=" <xs:element name="csvquerydocument" type="tns:csvquerydocument"/> <xs:element name="csvquerydocumentresponse" type="tns:csvquerydocumentresponse"/> <xs:complextype name="csvquerydocument"> <xs:element maxoccurs="1" minoccurs="0" name="credential" type="ns1:wscredential"/> <xs:element maxoccurs="1" minoccurs="0" name="querydocumentrequest" type="ns1:csvquerydocumentrequest"/> <xs:complextype name="csvquerydocumentresponse"> <xs:element maxoccurs="1" minoccurs="0" ref="ns1:csvquerydocumentresponse"/> </xs:schema> Servicio común de consulta por CSV v1.0 / 16

17 </wsdl:types> <wsdl:message name="csvquerydocument"> <wsdl:part element="tns:csvquerydocument" name="parameters"/> </wsdl:message> <wsdl:message name="csvquerydocumentresponse"> <wsdl:part element="tns:csvquerydocumentresponse" name="parameters"/> </wsdl:message> <wsdl:message name="csvquerydocumentexception"> <wsdl:part element="ns1:errorinfo" name="csvquerydocumentexception"/> </wsdl:message> <wsdl:porttype name="csvquerydocumentserviceimp"> <wsdl:operation name="csvquerydocument"> <wsdl:input message="tns:csvquerydocument"/> <wsdl:output message="tns:csvquerydocumentresponse"/> <wsdl:fault message="tns:csvquerydocumentexception" name="csvquerydocumentexception"/> </wsdl:operation> </wsdl:porttype> <wsdl:binding name="csvquerydocumentserviceimpportbinding" type="tns:csvquerydocumentserviceimp"> <soap:binding style="document" transport=" <wsdl:operation name="csvquerydocument"> <soap:operation soapaction=""/> <wsdl:input> <soap:body use="literal"/> </wsdl:input> <wsdl:output> <soap:body use="literal"/> </wsdl:output> <wsdl:fault name="csvquerydocumentexception"> <soap:fault name="csvquerydocumentexception" use="literal"/> </wsdl:fault> </wsdl:operation> </wsdl:binding> <wsdl:service name="csvquerydocumentservice"> <wsdl:port binding="tns:csvquerydocumentserviceimpportbinding" name="csvquerydocumentserviceport"> <soap:address location=" </wsdl:port> </wsdl:service> </wsdl:definitions> XSD <?xml version="1.0" encoding="utf-8"?><xs:schema xmlns:xs=" xmlns:ns1="urn:es:gob:aapp:csvbroker:webservices:querydocument:model:v1.0" attributeformdefault="unqualified" elementformdefault="unqualified" targetnamespace="urn:es:gob:aapp:csvbroker:webservices:querydocument:model:v1.0"> <xs:element name="csvquerydocumentexception" nillable="true"> <xs:complextype> <xs:element name="code" type="xs:string"/> <xs:element name="description" type="xs:string"/> Servicio común de consulta por CSV v1.0 / 17

18 </xs:element> <xs:complextype name="wscredential"> <xs:element form="unqualified" maxoccurs="1" minoccurs="0" name="idaplicacion" type="xs:string"/> <xs:element form="unqualified" maxoccurs="1" minoccurs="0" name="password" type="xs:string"/> <xs:complextype name="csvquerydocumentrequest"> <xs:element name="csv" type="xs:string"/> <xs:element name="dir3" type="xs:string"/> <xs:element name="csvquerydocumentresponse" type="ns1:csvquerydocumentresponse"/> <xs:complextype name="csvquerydocumentresponse"> <xs:element name="code" type="xs:string"/> <xs:element name="description" type="xs:string"/> <xs:element minoccurs="0" name="documentresponse" type="ns1:documentresponse"/> <xs:element minoccurs="0" name="waitresponse" type="ns1:waitresponse"/> </xs:schema> <xs:complextype name="documentresponse"> <xs:element name="content" type="xs:base64binary"/> <xs:element name="name" type="xs:string"/> <xs:element name="mime" type="xs:string"/> <xs:complextype name="waitresponse"> <xs:element name="secondstowait" type="xs:long"/> <xs:element name="errorinfo" nillable="true"/> Servicio común de consulta por CSV v1.0 / 18