Sistema Integral Multicanal de Atención al Ciudadano

Transcripción

1 Sistema Integral Multicanal de Atención al Ciudadano PAI_CONTRATO_INTEGRACION_COMUNICACION ES_v4_v004 Contrato de Integración para Servicio Web de Comunicaciones Telemáticas DIRECCIO GENERAL DE TECNOLOGIAS Versión 004 Julio de 2018

2 Índice Índice Control del documento Información general Histórico de revisiones Estado del documento Introducción Alcance Objetivos Audiencia Glosario Referencias Descripción de la integración Descripción del servicio Listado de métodos Detalle del servicio Comunicaciones_v4_ Alta de comunicación Parámetros Entrada Parámetros Salida Errores Obtención de certificado de comparecencia Parámetros Entrada Parámetros Salida Errores Obtención de certificado de no comparecencia Parámetros Entrada Parámetros Salida Errores Obtención de justificante de alta Parámetros Entrada Parámetros Salida Errores Consulta de comunicaciones Parámetros Entrada Parámetros Salida Errores Consultar estado de comunicaciones Parámetros Entrada Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 2 / 60

3 4.6.2 Parámetros Salida Errores Pase de sesión Buzón del ciudadano Parámetros Entrada Parámetros Salida Errores Pase de sesión herramienta de gestión Parámetros Entrada Parámetros Salida Errores Obtención de información del modo preferente de comunicación Parámetros Entrada Parámetros Salida Errores Tipos Comunes Códigos de Error Códigos de Error Técnicos (SoapFault) Códigos de Error Funcionales Errores que se devuelven como soap fault Compromiso de servicio Seguridad del Servicio Web BUS Instrumental Web Service Description Language Esquema con la definición de los métodos Esquema con la definición de la SOAPFault Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 3 / 60

4 1 Control del documento 1.1 Información general Título Creado por Contrato de Integración Servicio de Comunicaciones Telemáticas V4 DGTI Revisado por Lista de distribución Nombre del fichero PAI_CONTRATO_INTEGRACION_COMUNICACIONES_v4_v004.doc 1.2 Histórico de revisiones Versión Fecha Autor Observaciones 1 Abril/2017 UTE/DGTIC Versión inicial con nuevo formato de contratos 2 Enero/2018 UTE/DGTIC Se actualiza xsd de Tipos Comunes 3 Mayo/2018 UTE/DGTIC Se modifican los Tipos Comunes 4 Julio/2018 UTE/DGTIC Se modifica NOTA debajo de las URL s del servicio 1.3 Estado del documento Responsable aprobación Fecha Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 4 / 60

5 2 Introducción Este documento contiene el contrato de integración asociado al consumo del Servicios Web de Comunicaciones Telemáticas en su versión V4. El contrato de integración detalla, los aspectos relacionados con el procedimiento de integración, pudiendo exponer los mecanismos de consulta o consumo, las posibles respuestas o devolución de información, los formatos a utilizar, etc. 2.1 Alcance Este documento tiene un enfoque técnico y describe lo que hace el servicio y cómo consumir el mismo. Detalla que parámetros espera y que parámetros o excepciones de error devuelve. 2.2 Objetivos El objetivo principal del contrato de integración es permitir conocer la definición de la estructura de invocación al servicio de Comunicaciones Telemáticas. De este modo el usuario final podrá realizar el consumo del servicio web correctamente. 2.3 Audiencia Nombre y Apellidos Rol Tabla 1: Audiencia 2.4 Glosario Intermediador Término Definición Sistema informático que hace de intermediación entre el consumo directo de un webservice, que es el que ofrece en última, (a efectos del intermediador), instancia la funcionalidad, y el consumidor del servicio. Tabla 2: Glosario 2.5 Referencias Referencia Título Tabla 3: Referencias Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 5 / 60

6 3 Descripción de la integración Nombre del Servicio Tipo de Integración Modo de Funcionamiento Intermediario Proveedor del Servicio Contacto Comunicaciones_v4_00 Servicio Web N/A Plataforma Autonómica de Interoperabilidad de la GVA (PAI) DGTIC PAI Tabla 4: Datos generales de integración 3.1 Descripción del servicio El módulo de comunicaciones se integra con otras aplicaciones a través de la Plataforma Autonómica de Interoperabilidad de la GVA, en adelante PAI. La PAI permite definir un servicio indicando cuáles deben ser sus formatos XML de entrada y de salida, se encarga de securizar el acceso al servicio mediante firma digital y una vez realizado este control de acceso se encarga de comunicar el XML de entrada al módulo de comunicaciones mediante webservice. Como respuesta se obtendrá un XML que la PAI devolverá a la aplicación invocante. Es importante destacar que esta nueva versión sólo permitirá el acceso y consulta a las notificaciones generadas con los métodos de alta de esta nueva versión. Los métodos de consulta no obtendrán información de las notificaciones generadas con la versión del contrato anterior V3. Esta nueva versión incorpora cambios en el contrato y la aplicación de las buenas prácticas de la PAI, lo que deberá tenerse en cuenta por parte de los integradores al cambiar al nuevo endpoint de servicio. Para consumir adecuadamente el servicio que a continuación presentamos a través de la PAI se debe tener presente el manual de usuario para el consumo de servicios instrumentales y de verificación, que podrá encontrar en el portal de documentación de la PAI. Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 6 / 60

7 3.2 Listado de métodos Se listan los diferentes subservicios/métodos que ofrece el servicio: Alta de comunicación: Esta operación permitirá dar de alta una comunicación en el módulo de comunicaciones. Obtención de certificado de comparecencia: Esta operación permitirá obtener el certificado de comparecencia de una comunicación. Obtención de certificado de no comparecencia: Esta operación permitirá obtener el certificado de no comparecencia de una comunicación ya caducada y que se informó en el alta que se requería acuse de recibo, no habiéndose realizado el acuse de esta por parte del interesado. Obtención de justificante de alta: Esta operación permitirá obtener el justificante de alta de una comunicación. El justificante de alta se devolverá con firma PADES-LTV. Sólo recuperará justificante de comunicaciones creadas con la V4 del servicio. Consulta de comunicaciones: Esta operación permitirá realizar consultas sobre el estado de una o más comunicaciones. Sólo recuperará comunicaciones creadas con la V4 del servicio. Consultar estado de comunicaciones: Esta operación permitirá recuperar el estado de un conjunto de comunicaciones. Si no se localiza la comunicación consultada el estado en la respuesta indicará que No Existe en el modulo. Se localizará por el número de comunicación, o bien, por el par ciudadano, referencia de la comunicación. Sólo recuperará comunicaciones creadas con la V4 del servicio. Pase de sesión Buzón del ciudadano: Mediante este webservice se implementará un mecanismo de paso de sesión de una aplicación autorizada al Buzón del ciudadano permitiendo al usuario no tener que logarse de nuevo. Este mecanismo consistirá en que la aplicación autorizada invocará esta operación pasando los datos del usuario autenticado, se devolverá un ticket de acceso para redirigir el navegador del usuario a su buzón. El control de aplicaciones autorizadas se llevará a cabo por el bus de interoperabilidad mediante la firma digital de la petición. Pase de sesión herramienta de gestión: Mediante este webservice se implementará un mecanismo de paso de sesión de una aplicación autorizada a la herramienta de gestión. Este mecanismo consistirá en que la aplicación autorizada invocará esta operación pasando los datos del usuario autenticado, se devolverá un ticket de acceso para redirigir el navegador del usuario a la herramienta de gestión. El control de aplicaciones autorizadas se llevará a cabo por el bus de interoperabilidad mediante la firma digital de la petición. El control de acceso del usuario autenticado se llevará a cabo por la aplicación invocante. No se permitirá el acceso a esta herramienta si no es a través del paso de sesión. Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 7 / 60

8 Obtención de información del modo preferente de comunicación: Permite obtener la información del modo preferente de notificación asociado a una persona dada de alta en el módulo de comunicaciones. Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 8 / 60

9 4 Detalle del servicio Comunicaciones_v4_00 A continuación se detallan los datos de acceso al servicio de Comunicaciones_v4_00: Datos de Acceso al Servicio de Comunicaciones_V4_00 en el BUS Instrumental Endpoint Pre Producción Endpoint Producción Tipo de Firma admitida Respuesta Cifrada WS-Security NO Tabla 5.- Datos de acceso al servicio en el BUS Instrumental Datos de Acceso al Servicio de Comunicaciones_V4_00 en el BUS Innovación Endpoint Pre Producción Endpoint Producción Tipo de Firma admitida Respuesta Cifrada N/A NO Tabla 5.- Datos de acceso al servicio en el BUS Innovación IMPORTANTE: Los servicios publicados en el bus de Innovación son para uso exclusivo de aplicaciones de la GVA desplegadas en la infraestructura de la DGTIC. Todos los mensajes intercambiados deben firmarse y para ello es necesario disponer de un certificado digital que sea reconocido por la PAI (@firma). El tipo de transporte para las operaciones de este servicio es SOAP. Este servicio contiene las siguientes operaciones o métodos: addcomunicacion: Ver 4.1 Alta de comunicación obtenercertificacioncomparecencia: Ver 4.2 Obtención de certificado de comparecencia obtenercertificacionnocomparecencia: Ver 4.3 Obtención de certificado de no comparecencia consultajustificantealta: Ver 4.4 Obtención de justificante de alta getcomunicaciones: Ver 4.5 Consulta de comunicaciones unicaciones: Ver 4.6 Consultar estado de comunicaciones Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 9 / 60

10 getticketbuzon: Ver 4.7 Pase de sesión Buzón del ciudadano getticketgestion: Ver 4.8 Pase de sesión herramienta de gestión consultamodopreferente: Ver 4.9 Obtención de información del modo preferente de comunicación 4.1 Alta de comunicación Esta operación permitirá dar de alta una comunicación en el módulo de comunicaciones Parámetros Entrada Ubicación Nombre Tipo Etiqueta Obligatoria Campo Obligatorio Descripción addcomunicacion peticion Si Si addcomunicacion/p eticion addcomunicacion/p eticion/datosorigen addcomunicacion/p eticion/datosorigen addcomunicacion/p eticion/datosorigen addcomunicacion/p eticion/datosorigen addcomunicacion/p eticion/datosorigen addcomunicacion/p eticion/datosorigen addcomunicacion/p eticion/datosorigen addcomunicacion/p eticion datosorigen Si Si codigoentidad Si Si codigodir3 Si Si referenciaorig en organoorigen No No idioma Si Si procedimiento SIA procedimiento Representaci on datosinteresa do No Si Si Si No Si Si Si Elemento que contiene todos los datos de la petición Código entidad que genera la comunicación. Código DIR3 de la entidad que genera la comunicación Código de referencia asociado a la comunicación generado por la entidad origen. Órgano origen de la comunicación. Idioma en el que se genera la comunicación (es: castellano / va: valenciano). Los textos de asunto, cuerpo, descripción documentos, etc. deberán ser generados en este idioma. Código de procedimiento SIA asociado. Obligatorio cuando se trata de una notificación con acuse, Opcional cuando se trata de una comunicación Indicará el procedimiento asociado a la comunicación para la comprobación de la Representación Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 10 / 60

11 addcomunicacion/p eticion/datosinteres ado addcomunicacion/p eticion/datosinteres ado addcomunicacion/p eticion/datosinteres ado addcomunicacion/p eticion/datosinteres ado addcomunicacion/p eticion/datosinteres ado addcomunicacion/p eticion/datosinteres ado/datosrepresen tante addcomunicacion/p eticion/datosinteres ado/datosrepresen tante addcomunicacion/p eticion/datosinteres ado/datosrepresen tante addcomunicacion/p eticion addcomunicacion/p eticion/datosaviso addcomunicacion/p eticion/datosaviso addcomunicacion/p eticion/datosaviso addcomunicacion/p eticion addcomunicacion/p eticion/datoscomun icacion addcomunicacion/p eticion/datoscomun icacion tipo Si Si numeroidentifi cacion Si Si Indicará si el interesado es Persona Física o Persona Jurídica. Será el NIF (Persona Física) o el CIF (Persona Jurídica) nombre Si Si Nombre interesado apellidos Si Si Apellidos interesado datosreprese ntante numeroidentifi cacion No No No No Será el NIF (Persona Física) o el CIF (Persona Jurídica) nombre No No Nombre Representante apellidos No No Apellidos Representante datosaviso Si Si asunto Si Si No No SMS No No datoscomuni cacion acuse Si Si finplazo Si Si Si Si Texto que se mostrará antes de abrir la comunicación. al que se enviará el aviso. Además de este se utilizará el indicado en el perfil del ciudadano en su buzón. Número de móvil al que se enviará el SMS de aviso. Indica si la comunicación requiere la firma del acuse de recibo por parte del ciudadano. En caso de que requiera firma del acuse se indica la fecha/hora hasta cuando tiene de plazo el ciudadano para firmar el acuse. El cálculo de los días hábiles es función de la aplicación que genera la comunicación. (obligatoria para comunicación con Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 11 / 60

12 addcomunicacion/p eticion/datoscomun icacion addcomunicacion/p eticion/datoscomun icacion addcomunicacion/p eticion/datoscomun icacion/documentos addcomunicacion/p eticion/datoscomun icacion/documentos /documento addcomunicacion/p eticion/datoscomun icacion/documentos /documento addcomunicacion/p eticion/datoscomun icacion/documentos /documento cuerpo No No documentos No No documento No No nombreficher o descripcion No No contenido No No No No acuse) Texto completo a mostrar una vez se consulta la comunicación. Permite introducir un texto más descriptivo que el asunto Lista de documentos [0.. N] Nombre del fichero con su extensión Texto que se mostrará al visualizar el documento. Contenido del documento. En caso de que se envíe un documento firmado, este se incluirá con firma en formato PADES, preferiblemente PADES- LTV Parámetros Salida Ubicación Nombre Tipo Etiq. Oblig. Campo Oblig. Descripción addcomunicacionr esponse addcomunicacionr esponse/respuesta addcomunicacionr esponse/respuesta respuesta resultado comunicacione s Elemento que contiene toda la información de respuesta Indica si la petición se ha procesado correctamente. Devolverá true si la operación se ha realizado de manera correcta. False en caso contrario. En caso de error funcional o de negocio, se informará del código de error y su descripción en el apartado correspondiente del mensaje. En caso de error técnico, el servicio generará Soap Fault con un código de error específico. Se recibe una lista con las comunicaciones Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 12 / 60

13 generadas [1..N] addcomunicacionr esponse/respuesta/ comunicaciones comunicacion addcomunicacionr esponse/respuesta/ comunicaciones/co municacion numerocomun icacion Identificador de la comunicación generada addcomunicacionr esponse/respuesta/ comunicaciones/co municacion numeroidentifi cacion Identificador de la persona interesada addcomunicacionr esponse/respuesta addcomunicacionr esponse/respuesta/j ustificante addcomunicacionr esponse/respuesta addcomunicacionr esponse/respuesta/ error justificante contenido error codigoerror PDF/A con el justificante del alta de comunicación. El justificante estará firmado en PADES-LTV. Código de error de negocio addcomunicacionr esponse/respuesta/ error descripcionerr or Descripción de error de negocio Errores Errores Funcionales COD_002 COD_003 COD_004 COD_009 COD_010 COD_013 COD_018 Ejemplo de XML de entrada <soapenv:envelope xmlns:soapenv=" xmlns:urn="urn:es:gva:comunicaciones:v4:comunicacionesws:model"> <soapenv:header/> <soapenv:body> <urn:addcomunicacion> <urn:peticion> <urn:datosorigen> <urn:codigoentidad>gv</urn:codigoentidad> <urn:codigodir3>a </urn:codigodir3>  <urn:referenciaorigen>referencia:prueba:condocumento</urn:referenciaorigen>  Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 13 / 60

14 <urn:organoorigen>3.03</urn:organoorigen> <urn:idioma>es</urn:idioma> <urn:procedimientosia>210454</urn:procedimientosia>  <urn:procedimientorepresentacion>111</urn:procedimientorepresentacion> </urn:datosorigen>  <urn:datosinteresado> <urn:tipo>f</urn:tipo> <urn:numeroidentificacion> h</urn:numeroidentificacion> <urn:nombre>nombre</urn:nombre>  <urn:apellidos>apellidos</urn:apellidos>  <urn:datosrepresentante> <urn:numeroidentificacion> v</urn:numeroidentificacion> <urn:nombre>empresa</urn:nombre> </urn:datosrepresentante> </urn:datosinteresado> <urn:datosaviso> <urn:asunto>asunto</urn:asunto>  </urn:datosaviso> <urn:datoscomunicacion> <urn:acuse>true</urn:acuse>  <urn:finplazo> t17:30: :00</urn:finplazo>  <urn:cuerpo>cuerpo</urn:cuerpo>  <urn:documentos>  <urn:documento> <urn:nombrefichero>noti2.pdf</urn:nombrefichero> <urn:descripcion>resolucion</urn:descripcion> <urn:contenido>jvberi0x...</urn:contenido> </urn:documento> </urn:documentos> </urn:datoscomunicacion> </urn:peticion> </urn:addcomunicacion> </soapenv:body> </soapenv:envelope> Ejemplo de XML de salida <soapenv:envelope xmlns:soapenv=" xmlns:urn="urn:es:gva:comunicaciones:v4:comunicacionesws:model"> <soapenv:header/> <soapenv:body> <urn:addcomunicacionresponse> <urn:respuesta> <urn:resultado>true</urn:resultado>  <urn:comunicaciones>  <urn:comunicacion> <urn:numerocomunicacion>1777</urn:numerocomunicacion> <urn:numeroidentificacion> h</urn:numeroidentificacion> </urn:comunicacion> </urn:comunicaciones> <urn:justificante> <urn:contenido>jvbe...</urn:contenido> </urn:justificante> </urn:respuesta> </urn:addcomunicacionresponse> </soapenv:body> </soapenv:envelope> Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 14 / 60

15 4.2 Obtención de certificado de comparecencia Esta operación permitirá obtener un certificado de comparecencia de una comunicación. Este certificado estará firmado mediante certificado de sello por la propia aplicación. Sólo recuperará certificado de comunicaciones creadas con la V4 del servicio Parámetros Entrada Ubicación Nombre Tipo Etiqueta Obligatoria Campo Obligatorio Descripción obtenercertificacion Comparecencia obtenercertificacion Comparecencia/peti cion peticion Si Si numerocomu nicacion Si Si Elemento que contiene todos los datos de la petición Identificador de la comunicación Parámetros Salida Ubicación Nombre Tipo Etiq. Oblig. Campo Oblig. Descripción obtenercertificacion ComparecenciaRes ponse obtenercertificacion ComparecenciaRes ponse/respuesta obtenercertificacion ComparecenciaRes ponse/respuesta obtenercertificacion ComparecenciaRes ponse/respuesta obtenercertificacion ComparecenciaRes respuesta resultado fecha numeroidentifi cacion nombre Elemento que contiene toda la información de respuesta Indica si la petición se ha procesado correctamente. Devolverá true si la operación se ha realizado de manera correcta. False en caso contrario. En caso de error funcional o de negocio, se informará del código de error y su descripción en el apartado correspondiente del mensaje. En caso de error técnico, el servicio generará Soap Fault con un código de error específico. Fecha de firma del acuse de recibo NIF (Persona Física) o el CIF (Persona Jurídica) que ha realizado el acuse de la comunicación. Nombre de la persona que ha realizado el acuse de la Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 15 / 60

16 ponse/respuesta obtenercertificacion ComparecenciaRes ponse/respuesta apellidos No No comunicación. Primer y segundo apellido de la persona que ha realizado el acuse de la comunicación. obtenercertificacion ComparecenciaRes ponse/respuesta acusecompare cencia PDF/A de acuse de recibo firmado con PADES-LTV. obtenercertificacion ComparecenciaRes ponse/respuesta obtenercertificacion ComparecenciaRes ponse/respuesta/err or error codigoerror Código de error de negocio obtenercertificacion ComparecenciaRes ponse/respuesta/err or descripcionerr or Descripción de error de negocio Errores Errores Funcionales COD_006 COD_015 COD_018 COD_019 Ejemplo de XML de entrada <soapenv:envelope xmlns:soapenv=" xmlns:urn="urn:es:gva:comunicaciones:v4:comunicacionesws:model"> <soapenv:header/> <soapenv:body> <urn:obtenercertificacioncomparecencia> <urn:peticion> <urn:numerocomunicacion>1273</urn:numerocomunicacion> </urn:peticion> </urn:obtenercertificacioncomparecencia> </soapenv:body> </soapenv:envelope> Ejemplo de XML de salida <soapenv:envelope xmlns:soapenv=" xmlns:urn="urn:es:gva:comunicaciones:v4:comunicacionesws:model"> <soapenv:header/> <soapenv:body> <urn:obtenercertificacioncomparecenciaresponse> <urn:respuesta> <urn:resultado>true</urn:resultado>  <urn:datoscomparecencia> <urn:fecha> t17:30: :00</urn:fecha> <urn:numeroidentificacion> h</urn:numeroidentificacion> <urn:nombre>nombre</urn:nombre>  <urn:apellido1>apellido1 Apellido2</urn:apellido1> Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 16 / 60

17 </urn:datoscomparecencia> <urn:acusecomparecencia>jvbe...</urn:acusecomparecencia> </urn:respuesta> </urn:obtenercertificacioncomparecenciaresponse> </soapenv:body> </soapenv:envelope> 4.3 Obtención de certificado de no comparecencia Esta operación permitirá obtener el certificado de no comparecencia de una comunicación ya caducada y que se informó en el alta que se requería acuse de recibo, no habiéndose realizado el acuse de esta por parte del interesado. Sólo recuperará certificado de comunicaciones creadas con la V4 del servicio Parámetros Entrada Ubicación Nombre Tipo Etiqueta Obligatoria Campo Obligatorio Descripción obtenercertificacion NoComparecencia obtenercertificacion NoComparecencia/ peticion peticion Si Si numerocomu nicacion Si Si Elemento que contiene todos los datos de la petición Identificador de la comunicación Parámetros Salida Ubicación Nombre Tipo Etiq. Oblig. Campo Oblig. Descripción obtenercertificacion NoComparecencia Response obtenercertificacion NoComparecencia Response/respuest a obtenercertificacion NoComparecencia Response/respuest a respuesta resultado justificante Elemento que contiene toda la información de respuesta Indica si la petición se ha procesado correctamente. Devolverá true si la operación se ha realizado de manera correcta. False en caso contrario. En caso de error funcional o de negocio, se informará del código de error y su descripción en el apartado correspondiente del mensaje. En caso de error técnico, el servicio generará Soap Fault con un código de error específico. Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 17 / 60

18 obtenercertificacion NoComparecencia Response/respuest a/justificante obtenercertificacion NoComparecencia Response/respuest a obtenercertificacion NoComparecencia Response/respuest a/error obtenercertificacion NoComparecencia Response/respuest a/error contenido error codigoerror descripcionerr or PDF/A de certificado de no comparecencia firmado en PADES-LTV con sello de órgano por el propio módulo. Código de error de negocio Descripción de error de negocio Errores Errores Funcionales COD_015 COD_016 COD_018 COD_021 Ejemplo de XML de entrada <soapenv:envelope xmlns:soapenv=" xmlns:urn="urn:es:gva:comunicaciones:v4:comunicacionesws:model"> <soapenv:header/> <soapenv:body> <urn:obtenercertificacionnocomparecencia> <urn:peticion> <urn:numerocomunicacion>1273</urn:numerocomunicacion> </urn:peticion> </urn:obtenercertificacionnocomparecencia> </soapenv:body> </soapenv:envelope> Ejemplo de XML de salida <soapenv:envelope xmlns:soapenv=" xmlns:urn="urn:es:gva:comunicaciones:v4:comunicacionesws:model"> <soapenv:header/> <soapenv:body> <urn:obtenercertificacionnocomparecenciaresponse> <urn:respuesta> <urn:resultado>true</urn:resultado> <urn:justificante> <urn:contenido>jvberi0xljqk...</urn:contenido> </urn:justificante> </urn:respuesta> </urn:obtenercertificacionnocomparecenciaresponse> </soapenv:body> </soapenv:envelope> Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 18 / 60

19 4.4 Obtención de justificante de alta Esta operación permitirá obtener el justificante de alta de una comunicación. El justificante de alta se devolverá con firma PADES-LTV. Sólo recuperará justificante de comunicaciones creadas con la V4 del servicio Parámetros Entrada Ubicación Nombre Tipo Etiqueta Obligatoria Campo Obligatorio Descripción consultajustificante Alta consultajustificante Alta/peticion consultajustificante Alta/peticion consultajustificante Alta/petición/referen cia consultajustificante Alta/petición/referen cia peticion Si Si numerocomu nicacion referencia Si Si numeroidentifi cacion referenciaext erna Si Si Si Si Si Si Elemento que contiene todos los datos de la petición Identificador de la comunicación Identificador ciudadano del Referencia de la comunicación, generada por el emisor Parámetros Salida Ubicación Nombre Tipo Etiq. Oblig. Campo Oblig. Descripción consultajustificante AltaResponse consultajustificante AltaResponse/resp uesta consultajustificante AltaResponse/resp respuesta resultado numerocomun icacion Elemento que contiene toda la información de respuesta Indica si la petición se ha procesado correctamente. Devolverá true si la operación se ha realizado de manera correcta. False en caso contrario. En caso de error funcional o de negocio, se informará del código de error y su descripción en el apartado correspondiente del mensaje. En caso de error técnico, el servicio generará Soap Fault con un código de error específico. Identificador de la comunicación Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 19 / 60

20 uesta consultajustificante AltaResponse/resp uesta consultajustificante AltaResponse/resp uesta consultajustificante AltaResponse/resp uesta consultajustificante AltaResponse/resp uesta consultajustificante AltaResponse/resp uesta consultajustificante AltaResponse/resp uesta consultajustificante AltaResponse/resp uesta consultajustificante AltaResponse/resp uesta/justificante consultajustificante AltaResponse/resp uesta/justificante consultajustificante AltaResponse/resp uesta/justificante/err or consultajustificante AltaResponse/resp uesta/justificante/err or numeroidentifi cacion referenciaexter na estado fechaalta codigodir3 procedimiento SIA justificante contenido error codigoerror descripcionerr or Identificador del ciudadano No No Referencia de la comunicación, generada por el emisor Estado comunicación (Pendiente, Recibida, Rechazada/Expirada, Comunicación No Existente) Fecha en la que se dio de alta en el sistema la comunicación. Código de DIR3 del organismo asociado a la comunicación Código del procedimiento SIA asociado a la comunicación PDF/A de justificante de alta firmado con PADES- LTV Código de error de negocio Descripción de error de negocio Errores Errores COD_011 COD_012 COD_015 COD_018 COD_019 Ejemplo de XML de entrada Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 20 / 60

21 <soapenv:envelope xmlns:soapenv=" xmlns:urn="urn:es:gva:comunicaciones:v4:comunicacionesws:model"> <soapenv:header/> <soapenv:body> <urn:consultajustificantealta> <urn:peticion> <urn:comunicacion>  <urn:numerocomunicacion>1765</urn:numerocomunicacion> </urn:comunicacion> </urn:peticion> </urn:consultajustificantealta> </soapenv:body> </soapenv:envelope> Ejemplo de XML de salida <soapenv:envelope xmlns:soapenv=" xmlns:urn="urn:es:gva:comunicaciones:v4:comunicacionesws:model"> <soapenv:header/> <soapenv:body> <urn:consultajustificantealtaresponse> <urn:respuesta> <urn:resultado>true</urn:resultado>  <urn:numerocomunicacion>1765</urn:numerocomunicacion>  <urn:numeroidentificacion> v</urn:numeroidentificacion>  <urn:referenciaexterna>referencia:prueba:10</urn:referenciaexterna>  <urn:estado>pe</urn:estado>  <urn:fechaalta> t17:30: :00</urn:fechaalta>  <urn:codigodir3>a </urn:codigodir3>  <urn:procedimientosia>210454</urn:procedimientosia>  <urn:justificante> <urn:contenido>jvber...</urn:contenido> </urn:justificante> </urn:respuesta> </urn:consultajustificantealtaresponse> </soapenv:body> </soapenv:envelope> 4.5 Consulta de comunicaciones Esta operación permitirá realizar consultas sobre el estado de una o más comunicaciones. Sólo recuperará comunicaciones creadas con la V4 del servicio Parámetros Entrada Ubicación Nombre Tipo Etiqueta Obligatoria Campo Obligatorio Descripción getcomunicaciones peticion Si Si Elemento que contiene todos los datos de la petición getcomunicaciones codigoentidad Si Si Código de entidad que Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 21 / 60

22 /peticion han generado las comunicaciones. getcomunicaciones /peticion getcomunicaciones /peticion getcomunicaciones /peticion getcomunicaciones /peticion getcomunicaciones /peticion numerocomu nicacion numeroidentifi cacion fechainicio No No fechafin No No No No No No Identificador de la comunicación Identificador interesado del Fecha (de generación de la comunicación) a partir de la cuál comienza la búsqueda. Fecha (de generación de la comunicación) a partir de la cuál finaliza la búsqueda acuse No No Con o sin Acuse getcomunicaciones /peticion getcomunicaciones /peticion getcomunicaciones /peticion/paginacion getcomunicaciones /peticion/paginacion estados No No paginacion tamanyopagi na numeropagin a Se puede poner una lista de estados por los que filtrar. Filtro por estado de comunicación: PENDIENTE: pendiente de que el ciudadano la consulte RECIBIDA: comunicación recibida RECHAZADA: para una comunicación con acuse que no ha sido recibida en plazo Si se desea paginar la búsqueda En caso de que se desee paginar la búsqueda se indicará el tamaño de la página. En caso de que sólo queramos consultar el número de comunicaciones podemos realizar una consulta con una paginación con tamaño de página 0. Se indica el número de página a recuperar Parámetros Salida Ubicación Nombre Tipo Etiq. Oblig. Campo Oblig. Descripción getcomunicaciones Response respuesta Elemento que contiene toda la información de respuesta Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 22 / 60

23 getcomunicaciones Response/respuest a getcomunicaciones Response/respuest a getcomunicaciones Response/respuest a getcomunicaciones Response/respuest a/comunicaciones getcomunicaciones Response/respuest a/comunicaciones/c omunicacion getcomunicaciones Response/respuest a/comunicaciones/c omunicacion getcomunicaciones Response/respuest a/comunicaciones/c omunicacion getcomunicaciones Response/respuest a/comunicaciones/c omunicacion getcomunicaciones Response/respuest a/comunicaciones/c omunicacion getcomunicaciones Response/respuest a/comunicaciones/c omunicacion getcomunicaciones Response/respuest a/comunicaciones/c omunicacion resultado total comunicacione s comunicacion numerocomun icacion numeroidentifi cacion fechacomunic acion Indica si la petición se ha procesado correctamente. Devolverá true si la operación se ha realizado de manera correcta. False en caso contrario. En caso de error funcional o de negocio, se informará del código de error y su descripción en el apartado correspondiente del mensaje. En caso de error técnico, el servicio generará Soap Fault con un código de error específico. Indica número total de comunicaciones que cumplen el filtro. De esta forma si hay paginación sabremos el número total de elementos. Lista de comunicaciones que cumplen los criterios de búsqueda [o..n] Identificador comunicación Identificación interesado de del Fecha de generación de la comunicación asunto Asunto de la comunicación Idioma Idioma de la comunicación (es: castellano / va: valenciano). estado Estado comunicación fechaacuse Fecha de la firma del acuse (en caso de que sea una comunicación con acuse) Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 23 / 60

24 getcomunicaciones Response/respuest a/comunicaciones/c omunicacion getcomunicaciones Response/respuest a getcomunicaciones Response/respuest a/error getcomunicaciones Response/respuest a/error fechaexpiracio n error codigoerror descripcionerr or Fecha de caducidad de la notificación (en caso de que sea una comunicación con acuse) Código de error de negocio Descripción de error de negocio Errores Errores COD_004 COD_018 Ejemplo de XML de entrada <soapenv:envelope xmlns:soapenv=" xmlns:urn="urn:es:gva:comunicaciones:v4:comunicacionesws:model"> <soapenv:header/> <soapenv:body> <urn:getcomunicaciones> <urn:peticion> <urn:codigoentidad>gv</urn:codigoentidad> <urn:fechafin> t17:30: :00</urn:fechafin> <urn:paginacion> <urn:tamanyopagina>2</urn:tamanyopagina> <urn:numeropagina>1</urn:numeropagina> </urn:paginacion> </urn:peticion> </urn:getcomunicaciones> </soapenv:body> </soapenv:envelope> Ejemplo de XML de salida <soapenv:envelope xmlns:soapenv=" xmlns:urn="urn:es:gva:comunicaciones:v4:comunicacionesws:model"> <soapenv:header/> <soapenv:body> <urn:getcomunicacionesresponse> <urn:respuesta> <urn:total>1</urn:total>  <urn:comunicaciones>  <urn:comunicacion> <urn:numerocomunicacion>235</urn:numerocomunicacion> <urn:numeroidentificacion> h</urn:numeroidentificacion> <urn:fechacomunicacion> t17:30: :00</urn:fechacomunicacion> <urn:asunto>este es mi asunto</urn:asunto> <urn:idioma>es</urn:idioma> <urn:estado>re</urn:estado> Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 24 / 60

25  <urn:fechaacuse> t17:30: :00</urn:fechaacuse> </urn:comunicacion> </urn:comunicaciones> </urn:respuesta> </urn:getcomunicacionesresponse> </soapenv:body> </soapenv:envelope> 4.6 Consultar estado de comunicaciones Esta operación permitirá recuperar el estado de un conjunto de comunicaciones. Si no se localiza la comunicación consultada el estado en la respuesta indicará que No Existe en el modulo. Se localizará por el número de comunicación, o bien, por el par ciudadano, referencia de la comunicación. Sólo recuperará comunicaciones creadas con la V4 del servicio Parámetros Entrada Ubicación Nombre Tipo Etiqueta Obligatoria Campo Obligatorio Descripción unicaciones unicaciones/peticio n unicaciones/peticio n/comunicaciones unicaciones/peticio n/comunicaciones/c omunicacion unicaciones/peticio n/comunicaciones/c omunicacion unicaciones/peticio n/comunicaciones/c omunicación/refere ncia unicaciones/peticio n/comunicaciones/c omunicación/refere ncia peticion Si Si comunicacion es comunicacion Si Si numerocomu nicacion Referencia Si Si numeroidentifi cacion referenciaext erna Si Si Si Si Si Si Elemento que contiene todos los datos de la petición Lista de comunicaciones por las que se consulta [1..N] Identificador de la comunicación Identificador ciudadano del Referencia de la comunicación, generada por el emisor Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 25 / 60

26 4.6.2 Parámetros Salida Ubicación Nombre Tipo Etiq. Oblig. Campo Oblig. Descripción unicacionesrespon se unicacionesrespon se/respuesta unicacionesrespon se/respuesta unicacionesrespon se/respuesta unicacionesrespon se/respuesta/comu nicaciones unicacionesrespon se/respuesta/comu nicaciones/comunic acion unicacionesrespon se/respuesta/comu nicaciones/comunic acion unicacionesrespon se/respuesta/comu nicaciones/comunic acion unicacionesrespon se/respuesta/comu nicaciones/comunic acion unicacionesrespon respuesta resultado total comunicacione s comunicacion numerocomun icacion numeroidentifi cacion referenciaexter na estado fechaacuse Elemento que contiene toda la información de respuesta Indica si la petición se ha procesado correctamente. Devolverá true si la operación se ha realizado de manera correcta. False en caso contrario. En caso de error funcional o de negocio, se informará del código de error y su descripción en el apartado correspondiente del mensaje. En caso de error técnico, el servicio generará Soap Fault con un código de error específico. Indica número total de comunicaciones solicitadas. Se recibe una lista con las comunicaciones consultadas [1..N] Identificador de la comunicación generada Identificador de la persona interesada Referencia de la comunicación, generada por el emisor Estado comunicación (Pendiente, Recibida, Rechazada/Expirada, Comunicación No Existente) Fecha de la firma del acuse (en caso de que sea Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 26 / 60

27 se/respuesta/comu nicaciones/comunic acion unicacionesrespon se/respuesta/comu nicaciones/comunic acion unicacionesrespon se/respuesta/comu nicaciones/comunic acion unicacionesrespon se/respuesta/comu nicaciones/comunic ación/datoscompar ecencia unicacionesrespon se/respuesta/comu nicaciones/comunic ación/datoscompar ecencia unicacionesrespon se/respuesta/comu nicaciones/comunic ación/datoscompar ecencia unicacionesrespon se/respuesta/comu nicaciones/comunic ación/datoscompar ecencia unicacionesrespon se/respuesta/comu nicaciones/comunic ación/datoscompar ecencia unicacionesrespon se/respuesta/comu nicaciones/comunic ación/datoscompar ecencia unicacionesrespon se/respuesta/comu nicaciones/comunic ación unicacionesrespon se/respuesta/comu fechaexpiracio n datoscompare cencia una comunicación con acuse) o fecha de primera lectura (si no tiene acuse) Fecha límite para leer la comunicación en comunicaciones con acuse. fecha Fecha de acuse numeroidentifi cacion nombre apellidos codigodir3 procedimiento SIA modopreferent e medioselectro nicos NIF o CIF de la persona que ha hecho la comparecencia Nombre de la persona o razón social de la persona jurídica que ha hecho la comparecencia Primer y segundo apellido de la persona que ha hecho la comparecencia (personas físicas) Código de DIR3 del organismo asociado a la comunicación Indica si desea comunicación por medios Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 27 / 60

28 nicaciones/comunic ación/modoprefere nte unicacionesrespon se/respuesta/comu nicaciones/comunic ación/modoprefere nte unicacionesrespon se/respuesta unicacionesrespon se/respuesta/error Idioma error codigoerror electrónicos Indica el idioma preferente de comunicación Código de error de negocio unicacionesrespon se/respuesta/error descripcionerr or Descripción de error de negocio Errores Errores COD_018 Ejemplo de XML de entrada <soapenv:envelope xmlns:soapenv=" xmlns:urn="urn:es:gva:comunicaciones:v4:comunicacionesws:model"> <soapenv:header/> <soapenv:body> <urn:unicaciones> <urn:peticion> <urn:comunicaciones>  <urn:comunicacion>  <urn:numerocomunicacion>235</urn:numerocomunicacion> </urn:comunicacion> <urn:comunicacion> <urn:referencia> <urn:numeroidentificacion> h</urn:numeroidentificacion> <urn:referenciaexterna>mireferencia</urn:referenciaexterna> </urn:referencia> </urn:comunicacion> </urn:comunicaciones> </urn:peticion> </urn:unicaciones> </soapenv:body> </soapenv:envelope> Ejemplo de XML de salida <soapenv:envelope xmlns:soapenv=" xmlns:urn="urn:es:gva:comunicaciones:v4:comunicacionesws:model"> <soapenv:header/> <soapenv:body> <urn:unicacionesresponse> <urn:respuesta> <urn:resultado>true</urn:resultado> <urn:total>2</urn:total> Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 28 / 60

29  <urn:comunicaciones>  <urn:comunicacion> <urn:numerocomunicacion>235</urn:numerocomunicacion> <urn:numeroidentificacion> h</urn:numeroidentificacion> <urn:referenciaexterna>mireferencia2</urn:referenciaexterna> <urn:estado>pe</urn:estado> <urn:fechaexpiracion> t17:30: :00</urn:fechaexpiracion> <urn:codigodir3>a </urn:codigodir3> <urn:procedimientosia>210454</urn:procedimientosia>  <urn:modopreferente> <urn:medioselectronicos>false</urn:medioselectronicos> <urn:idioma>es</urn:idioma> </urn:modopreferente> </urn:comunicacion> <urn:comunicacion> <urn:numerocomunicacion>236</urn:numerocomunicacion> <urn:numeroidentificacion> h</urn:numeroidentificacion> <urn:referenciaexterna>mireferencia3</urn:referenciaexterna> <urn:estado>re</urn:estado>  <urn:datoscomparecencia> <urn:fecha> t17:30: :00</urn:fecha> <urn:numeroidentificacion> h</urn:numeroidentificacion> <urn:nombre>nombre</urn:nombre>  <urn:apellido1>ape1 Ape2</urn:apellido1> </urn:datoscomparecencia>  <urn:fechaexpiracion> t17:30: :00</urn:fechaexpiracion>  <urn:codigodir3>a </urn:codigodir3>  <urn:procedimientosia>210454</urn:procedimientosia>  <urn:modopreferente> <urn:medioselectronicos>true</urn:medioselectronicos> <urn:idioma>es</urn:idioma> </urn:modopreferente> </urn:comunicacion> </urn:comunicaciones> </urn:respuesta> </urn:unicacionesresponse> </soapenv:body> </soapenv:envelope> 4.7 Pase de sesión Buzón del ciudadano Mediante este webservice se implementará un mecanismo de paso de sesión de una aplicación autorizada al Buzón del ciudadano permitiendo al usuario no tener que logarse de nuevo. Este mecanismo consistirá en que la aplicación autorizada invocará esta operación pasando los datos del usuario autenticado, se devolverá un ticket de acceso para redirigir el navegador del usuario a su buzón. El control de aplicaciones autorizadas se llevará a cabo por el bus de interoperabilidad mediante la firma digital de la petición Parámetros Entrada Ubicación Nombre Tipo Etiqueta Obligatoria Campo Obligatorio Descripción Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 29 / 60

30 getticketbuzon peticion Si Si getticketbuzon/peti cion getticketbuzon/peti cion getticketbuzon/peti cion getticketbuzon/peti cion Elemento que contiene todos los datos de la petición NIF Si Si Nif ciudadano nombre No No Nombre ciudadano apellidos No No Apellidos ciudadano codigoentidad No No Código entidad de la que viene la sesión. El Buzón del ciudadano se abrirá situándose en las comunicaciones de dicha entidad, aunque se podrá navegar por el resto de comunicaciones presentes en el buzón Parámetros Salida Ubicación Nombre Tipo Etiq. Oblig. Campo Oblig. Descripción getticketbuzonres ponse getticketbuzonres ponse/respuesta getticketbuzonres ponse/respuesta getticketbuzonres ponse/respuesta getticketbuzonres ponse/respuesta/err or getticketbuzonres ponse/respuesta/err or respuesta resultado Elemento que contiene toda la información de respuesta Indica si la petición se ha procesado correctamente. Devolverá true si la operación se ha realizado de manera correcta. False en caso contrario. En caso de error funcional o de negocio, se informará del código de error y su descripción en el apartado correspondiente del mensaje. En caso de error técnico, el servicio generará Soap Fault con un código de error específico. ticket Ticket de acceso error codigoerror descripcionerr or Código de error de negocio Descripción de error de negocio Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 30 / 60

31 4.7.3 Errores Errores COD_004 COD_018 Ejemplo de XML de entrada <soapenv:envelope xmlns:soapenv=" xmlns:urn="urn:es:gva:comunicaciones:v4:comunicacionesws:model"> <soapenv:header/> <soapenv:body> <urn:getticketbuzon> <urn:peticion> <urn:nif> h</urn:nif> <urn:nombre>usuario</urn:nombre> <urn:apellidos>activo TEST</urn:apellidos> <urn:codigoentidad>gv</urn:codigoentidad> </urn:peticion> </urn:getticketbuzon> </soapenv:body> </soapenv:envelope> Ejemplo de XML de salida <soapenv:envelope xmlns:soapenv=" xmlns:urn="urn:es:gva:comunicaciones:v4:comunicacionesws:model"> <soapenv:header/> <soapenv:body> <urn:getticketbuzonresponse> <urn:respuesta> <urn:resultado>true</urn:resultado> <urn:ticket>aksd-werw-erte-sfgr</urn:ticket> </urn:respuesta> </urn:getticketbuzonresponse> </soapenv:body> </soapenv:envelope> 4.8 Pase de sesión herramienta de gestión Mediante este webservice se implementará un mecanismo de paso de sesión de una aplicación autorizada a la herramienta de gestión. Este mecanismo consistirá en que la aplicación autorizada invocará esta operación pasando los datos del usuario autenticado, se devolverá un ticket de acceso para redirigir el navegador del usuario a la herramienta de gestión. El control de aplicaciones autorizadas se llevará a cabo por el bus de interoperabilidad mediante la firma digital de la petición. El control de acceso del usuario autenticado se llevará a cabo por la aplicación invocante. No se permitirá el acceso a esta herramienta si no es a través del paso de sesión Parámetros Entrada Ubicación Nombre Tipo Etiqueta Obligatoria Campo Obligatorio Descripción getticketgestion peticion Si Si Elemento que contiene todos los datos de la Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 31 / 60

32 getticketgestion/pe ticion getticketgestion/pe ticion getticketgestion/pe ticion getticketgestion/pe ticion petición NIF Si Si Nif gestor nombre Si Si Nombre gestor apellidos Si Si Apellidos gestor codigoentidad Si Si Código entidad de la que viene la sesión. La herramienta de gestión permitirá gestionar las comunicaciones de dicha entidad Parámetros Salida Ubicación Nombre Tipo Etiq. Oblig. Campo Oblig. Descripción getticketgestionre sponse getticketgestionre sponse getticketgestionre sponse/respuesta getticketgestionre sponse/respuesta getticketgestionre sponse/respuesta/e rror getticketgestionre sponse/respuesta/e rror respuesta resultado Elemento que contiene toda la información de respuesta Indica si la petición se ha procesado correctamente. Devolverá true si la operación se ha realizado de manera correcta. False en caso contrario. En caso de error funcional o de negocio, se informará del código de error y su descripción en el apartado correspondiente del mensaje. En caso de error técnico, el servicio generará Soap Fault con un código de error específico. ticket Ticket de acceso error codigoerror descripcionerr or Código de error de negocio Descripción de error de negocio Errores Errores Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 32 / 60

33 COD_004 COD_018 Ejemplo de XML de entrada <soapenv:envelope xmlns:soapenv=" xmlns:urn="urn:es:gva:comunicaciones:v4:comunicacionesws:model"> <soapenv:header/> <soapenv:body> <urn:getticketgestion> <urn:peticion> <urn:nif> h</urn:nif> <urn:nombre>usuario</urn:nombre> <urn:apellidos>activo TEST</urn:apellidos> <urn:codigoentidad>gv</urn:codigoentidad> </urn:peticion> </urn:getticketgestion> </soapenv:body> </soapenv:envelope> Ejemplo de XML de salida <soapenv:envelope xmlns:soapenv=" xmlns:urn="urn:es:gva:comunicaciones:v4:comunicacionesws:model"> <soapenv:header/> <soapenv:body> <urn:getticketgestionresponse> <urn:respuesta> <urn:ticket>aksd-werw-erte-sfgr</urn:ticket> </urn:respuesta> </urn:getticketgestionresponse> </soapenv:body> </soapenv:envelope> 4.9 Obtención de información del modo preferente de comunicación Permite obtener la información del modo preferente de notificación asociado a una persona dada de alta en el módulo de comunicaciones Parámetros Entrada Ubicación Nombre Tipo Etiqueta Obligatoria Campo Obligatorio Descripción getticketgestion peticion Si Si getticketgestion/pe ticion numeroidentifi cacion Si Si Elemento que contiene todos los datos de la petición NIF o CIF del interesado del que se quiere obtener la información Parámetros Salida Ubicación Nombre Tipo Etiq. Campo Descripción Contrato de Integración para Servicio Web de Comunicaciones Telemáticas 33 / 60