SERVICIO DE PLATINO. v1.0

Transcripción

1 Interoperabilidad de los servicios telemáticos de la Administración Pública de la CAC Página 1 de 71 SERVICIO NOTIFIC@ DE PLATINO v1.0 Documento : Ubicación en eroom: PLA-DOC-FIN-V 1.0. Servicio.pdf Preparado por Revisado por Aprobado por Oficina Técnica de Platino D. Gral. de Telecomunicaciones y Nuevas Tecnologías D. Gral. de Telecomunicaciones y Nuevas Tecnologías Fecha: 28/11/2017 Fecha: 28/11/2017 Fecha: 28/11/2017

2 Página 2 de 71 ÍNDICE 1 INTRODUCCIÓN REQUISITOS PREVIOS VERSIÓN DEL SERVICIO OPERACIONES DEL SERVICIO PARA ORGANISMOS altaenvio() Entrada... 7 Notas Aclaratorias Salida infoenvio() Entrada Salida consultaestado() Entrada Salida consultadatadoenvio() Entrada Salida consultacertificaciónenvio() Entrada Salida consultacies() Entrada Servicio

3 Página 3 de Salida OPERACIONES DEL SERVICIO PARA SEDES getenvios() Entrada Salida getenvios2() Entrada Salida getenviosagrupados() Entrada Salida getenviosagrupados2() Entrada Salida infoenvio() Entrada Salida infoenvio2() Entrada Salida certificacionsede() Entrada Servicio

4 Página 4 de Salida getcertificacion() Entrada Salida comunicacionsede() Entrada Salida...64 Códigos de Respuesta para Organismos y Sedes Estado de un envío...70 Servicio

5 Página 5 de 71 1 INTRODUCCIÓN El Servicio, dentro del marco de la Plataforma de Interoperabilidad del Gobierno de Canarias, a través de la implementación de un servicio horizontal que podrá ser utilizado por backoffices y sedes, permite la remisión/recepción de Notificaciones y Comunicaciones vía Carpeta Ciudadana y Dirección Electrónica Habilitada. Este documento describe los Servicios Web que el Servicio pone a disposición de los consumidores para el uso automatizado e integración de las aplicaciones con el servicio. El servicio Notific@ expone 2 endpoints para el consumo de los Organismos emisores y el de las Sedes. Servicio

6 Página 6 de 71 2 REQUISITOS PREVIOS Para poder hacer uso del servicio de Notific@ es necesario que previamente se cumpla con los requisitos de alta en Platino: disponer de un identificador único API_KEY y que el certificado de consumo de la aplicación esté autorizado en la Base de Datos de Autorización de Platino a consumir la plantilla Notifica. A continuación se detallan los pasos a seguir: 1) El organismo emisor deberá remitir la clave pública del Certificado de Identidad(certificado de una entidad de confianza reconocida) a la Oficina Técnica de Platino para proceder a la generación de la API_KEY correspondiente. 2) Se deberá abrir incidencia a Cibercentro para el alta del certificado de consumo de la aplicación en la Base de datos de Autorización de Platino, solicitando la asignación de la plantilla de Notifica a dicho Consumidor. 3) La Oficina Técnica de Platino proporcionara al organismo emisor el API_KEY generado por el Ministerio (MinHap). 3 VERSIÓN DEL SERVICIO Este documento corresponde a la versión del servicio Para consultar la información más detallada de los cambios del servicio ver Servicio

7 Página 7 de 71 4 OPERACIONES DEL SERVICIO PARA ORGANISMOS La ruta del wsdl de organismos se expone en la siguiente ruta: Las operaciones que se ofrecen son las de creación, consulta y monitorización de la entrega de una notificación. Incluye los siguientes métodos: Parámetros altaenvio() infoenvio() consultaestado() consultadatadoenvi o() consultacertificacion Envio() consultacies() Descripción Método que permite el alta de un envío. Método para consultar la información detallada de un envío específico. Método que permite la consulta del Estado de un envío. Método que permite la consulta del Datado de un envío. Método que permite la consulta de la certificación de un envío. Método que permite consultar a los CIEs disponibles para un organismo emisor. 4.1 altaenvio() El método altaenvio() permite el envío de los datos necesarios para el alta de un envío: comunicación o notificación Entrada Parámetros Tipo Descripción organismo_emisor::codigo_dir 3 Obligatorio. Código correspondiente al DIR3. organismo_emisor::nombre Opcional. Nombre de la Entidad Emisora. Servicio

8 Página 8 de 71 organismo_pagador_correos:: codigo_dir3 organismo_pagador_correos:: numero_contrato_correos organismo_pagador_correos:: codigo_cliente_facturacion_cor reos organismo_pagador_correos:: fecha_vigencia organismo_pagador_cie:: codigo_dir3 organismo_pagador_cie:: fecha_vigencia DateTime String DateTime Campo aún válido pero deprecado. Sólo aplica al envío postal a través del Operador Postal Correos. Campo Opcional. Código DIR3 del organismo que realizará el pago del servicio de entrega postal. No se recomienda su uso, y utilizar el orden de preferencia según se ha establecido en la Aplicación Web, modificable a través del campo cie de domicilio. Campo aún válido pero deprecado. Sólo aplica al envío postal a través del Operador Postal Correos. Campo Opcional. Número de contrato del organismo pagador con el operador postal. No se recomienda su uso, y utilizar el orden de preferencia según se ha establecido en la Aplicación Web, modificable a través del campo cie de domicilio. Campo aún válido pero deprecado. Sólo aplica al envío postal a través del Operador Postal Correos. Campo Opcional. Código cliente del organismo pagador para la facturación con el operador postal. No se recomienda su uso, y utilizar el orden de preferencia según se ha establecido en la Aplicación Web, modificable a través del campo cie de domicilio. Campo aún válido pero deprecado. Sólo aplica al envío postal a través del Operador Postal Correos. Campo Opcional. Fecha fin del contrato con el operador postal. Si está caducado no se puede tramitar el alta del servicio en Notific@. No se recomienda su uso, y utilizar e orden de preferencia según se ha establecido en la Aplicación Web, modificable a través del campo cie de domicilio. Campo aún válido pero deprecado. Sólo aplica al envío postal a través del CIE de la AEAT. Campo Opcional. Código DIR3 del organismo que realizará el pago de costes de impresión y ensobrado. No se recomienda su uso, y utilizar e orden de preferencia según se ha establecido en la Aplicación Web, modificable a través del campo cie de domicilio. Campo aún válido pero deprecado a través del CIE de la AEAT. Sólo aplica al envío postal. Campo Opcional. Fecha del fin del contrato con el Centro de Impresión y Ensobrado. Si está caducado no se Servicio

9 Página 9 de 71 puede tramitar el alta del servicio en Notific@. No se recomienda su uso, y utilizar e orden de preferencia según se ha establecido en la Aplicación Web, modificable a través del campo cie de domicilio. documento::contenido Obligatorio. Contenido del documento de la notificación codificado en base64. Puede ser un archivo ZIP o PDF documento::hash_sha1 Obligatorio. Codificación base64 del sha1 del contenido binario del documento. documento::normalizado Obligatorio. En caso de que el documento reserve en la primera página el espacio en blanco necesario para introducir la ventanilla del sobre (NCC, titular, destinatario, domicilio) se debe rellenar con SI. En caso contrario debe rellenarse con NO y el CIE adjuntará una página adicional con la ventana para el ensobrado, incrementando el coste del servicio por la página impresa y por el peso adicional del servicio postal. documento::generar_csv Obligatorio. En caso de que desee que Notific@ genere un CSV y que el documento esté firmado digitalmente se debe introducir SI, caso contrario debe introducir NO. El CSV se introducirá en el pie del documento con la información de los firmantes para la consulta por parte del receptor de la notificación. tipo_envio Obligatorio. Tipo de envío a dar de alta. Los valores válidos para el elemento pueden ser notificación o comunicación. fecha_envio_programado DateTime Opcional. Fecha para realizar un envío programado. Concepto Obligatorio. Concepto del envío que se realiza. Máximo 50 caracteres. destinatarios::item:: referencia_emisor Obligatorio y único dentro de cada organismo. Referencia interna del Emisor del envío. No pueden existir dos envíos con la misma referencia para un mismo organismo. Máximo 20 caracteres. destinatarios::item::titular:: Número de teléfono. Se prevé que se realizarán Servicio

10 Página 10 de 71 telefono avisos vía SMS del envío de la notificación/comunicación y de su disponibilidad en Carpeta Ciudadana. destinatarios::ítem::titular:: (Ver nota más abajo) para realizar el aviso vía correo electrónico del envío de la notificación/comunicación cuando se realiza un envío exclusivo a Carpeta Ciudadana. destinatarios::ítem::titular:: nif Obligatorio para envíos a Sedes Electrónicas y Carpeta Ciudadana. Debe ser el NIF/CIF/NIE del titular del envío. destinatarios::ítem::titular:: nombre destinatarios::ítem::titular:: apellidos Destinatarios::ítem::destinatari o:: telefono destinatarios::ítem::destinatario :: destinatarios::ítem::destinatario :: nif Destinatarios::ítem::destinatari o::nombre destinatarios:: ítem::destinatario::apellidos Obligatorio. Debe rellenarse con el nombre o la razón social del titular del envío. La longitud máxima de la concatenación de los campos nombre y apellidos será de 125 caracteres. Opcional. Debe rellenarse con los apellidos del titular del envío. Puede no usarse y poner los apellidos en el mismo campo del nombre. Número de teléfono. Se prevé que se realizarán avisos vía SMS del envío de la notificación/comunicación y de su disponibilidad en Carpeta Ciudadana. (Ver nota más abajo) para realizar el aviso vía correo electrónico del envío de la notificación/comunicación cuando se realiza un envío exclusivo a Carpeta Ciudadana. Obligatorio para envíos a Sedes Electrónicas y Carpeta Ciudadana. Debe ser el NIF/CIF/NIE del destinatario del envío. Obligatorio. Debe rellenarse con el nombre o la razón social del destinatario del envío. La longitud máxima de la concatenación de los campos nombre y apellidos será de 125 caracteres. Obligatorio si es un envío a una persona física. Debe rellenarse con los apellidos del destinatario del envío. Servicio

11 Página 11 de 71 destinatarios::tipo_domicilio Opcional. Obligatorio para envíos postales. Tipo de domicilio del destinatario, puede ser fiscal o concreto. En caso de que sea concreto deben rellenarse los campos de domicilio. destinatarios::domicilio Compuesto Obligatorio para envíos postales. Debe rellenarse el campo tipo_domicilio_concreto, que puede ser nacional, extranjero, sin_normalizar o apartado_correos. Si no se dispone de Código Postal, como sucede en algunos países, se colocará el valor Dependiendo del tipo de domicilio cambian los campos obligatorios dentro de domicilio. Nacional: tipo_via: Se corresponde con los siguientes tipos: 'ALMDA' => 'ALAMEDA', 'CALLE' => 'CALLE', 'CAMNO' => 'CAMINO', 'CARR' => 'CARRER', 'CTRA' => 'CARRETERA', 'GTA' => 'GLORIETA', 'KALEA' => 'KALEA', 'PSJ' => 'PASAJE', 'PASEO' => 'PASEO', 'PLAÇA' => 'PLAÇA', 'PLAZA' => 'PLAZA', 'RAMBL' => 'RAMBLA', 'RONDA' => 'RONDA', 'RÚA' => 'RÚA', 'SECT' => 'SECTOR', 'TRAV' => 'TRAVESÍA', 'URB' => 'URBANIZACIÓN', 'AVDA' => 'AVENIDA', 'AVGDA' => 'AVINGUDA', 'BAR' => 'BARRIO', 'CJA' => 'CALLEJA', 'CAMÍ' => 'CAMÍ', Servicio

12 Página 12 de 71 'CAMPO' => 'CAMPO', 'CRA' => 'CARRERA', 'CSTA' => 'CUESTA', 'EDIF' => 'EDIFICIO', 'EPTZA' => 'ENPARANTZA', 'ESTR' => 'ESTRADA', 'JARD' => 'JARDINES', 'JARDI' => 'JARDINS', 'PRQUE' => 'PARQUE', 'PSG' => 'PASSEIG', 'PRAZA' => 'PRAZA', 'PLZA' => 'PLAZUELA', 'PLCTA' => 'PLACETA', 'POBL' => 'POBLADO', 'VIA' => 'VIA', 'TRAVS' => 'TRAVESSERA', 'PASTG' => 'PASSATGE', 'BVR' => 'BULEVAR', 'POLIG' => 'POLÍGONO', 'OTROS' => 'OTROS', nombre_via: Máximo 50 caracteres. Tipo_numeracion: Con los siguientes valores posibles: 'num', 'pkm', 's/n', 'apc' numero_casa o punto_kilometrico (solo uno de los dos). Máximo 5 caracteres poblacion: Máximo 30 caracteres municipio: :codigo_ine codigo_postal. Máximo 10 caracteres, aunque en España se usan 5. provincia::codigo_p rovincia (código INE) pais::codigo_iso3166. Extranjero: nombre_via: Máximo 50 caracteres pais::codigo_iso3166 codigo_postal: Máximo 10 caracteres población Máximo 30 caracteres Servicio

13 Página 13 de 71 Apartado de Correos: apartado_correos: Máximo 10 caracteres provincia::codigo_p rovincia municipio::codigo_ine codigo_postal. Máximo 10 caracteres. población. Máximo 30 caracteres Sin Normalizar: codigo_postal Pais::codigo_iso3166 Máximo 50 caracteres. linea_2: Máximo 50 caracteres. destinatarios::domicilio::cie integer Opcional. En caso que se quiera alterar el CIE al que irá dirigido, de modo que el envío que se está dando de alta no siga el orden de preferencia que se estableció en la Aplicación Web, se puede emplear el campo CIE de domicilio estableciendo el identificador que devuelve el método consultacies. destinatarios::servicio Obligatorio. Tipo de servicio de envío a realizar, puede ser urgente o normal. Válido para la DEH y para el CIE, otorgando prioridad en la cola de envíos. En el caso del envío postal no afecta la entrega, es decir, la entrega se realiza en los plazos normales. destinatarios::direccion_electro nica ::obligado destinatarios::direccion_electro nica ::nif destinatarios::direccion_electro nica::codigo_procedimiento booleano Obligatorio para envíos a la DEH (Ver nota más abajo). Indica si la notificación por DEH es con obligatoriedad del titular que la recibe o no. Los valores aceptados son true o false. En caso de que sea obligado y el titular no disponga de Buzón DEH se le creará uno automáticamente. En caso de no ser obligado se debe realizar la consulta del censo de suscritos. Obligatorio para envíos a la DEH (Ver nota más abajo). NIF del titular del buzón DEH que va a recibir la notificación. Obligatorio para envíos a la DEH NO OBLIGADOS (Ver nota más abajo). Código de procedimiento en la DEH al que el NIF debe estar suscrito. Servicio

14 Página 14 de 71 destinatarios::opciones_emisio n ::retardo_postal_deh destinatarios::opciones_emisio n ::caducidad int Indica el número de días naturales que estará disponible una notificación en la Sede Electrónica y/o Carpeta Ciudadana para que pueda ser notificada por comparecencia antes de ponerse a disposición del ciudadano por otras vías. Una vez pasen esos días, el envío pasará a ser realizado a través de la DEH o el CIE. En el caso de que el valor sea 0, pasa directamente a la DEH o al CIE para la posterior entrega postal, permaneciendo en todo caso disponible en la Sede Electrónica y/o Carpeta Ciudadana. Opcional (Ver nota más abajo). Fecha en la cual, a última hora del día, una notificación pasa a estado rehusado. Aplica a los envíos que se depositan en Carpeta y/o sede electrónica y a los que van a la DEH. Cuando no sea obligatorio establecer fecha de caducidad y un envío se ponga a disposición a través de la DEH, se considerará un plazo por defecto de 10 días conforme a la Ley. El formato correcto de la fecha es YYYYMM-DD. procedimiento::codigo_sia Opcional, pero obligatorio para las notificaciones. Para las comunicaciones no aplica. Código de procedimiento SIA (Sistema de Información Administrativa). procedimiento::descripcion_sia Opcional. Descripción del SIA (Sistema de Información Administrativa). Notas Aclaratorias Envío únicamente a Capeta/Sede electrónica Si desea que el envío esté disponible únicamente en la Carpeta Ciudadana y, en su caso, sede electrónica, para evitar que el destinatario sea notificado a través de la DEH o por la Vía Postal, los valores de los campos: destinatarios::tipo_domicilio, destinatarios::domicilio y destinatarios::dirección_electrónica deben ser nulos Servicio

15 Página 15 de 71 y el campo destinatarios::opciones_emision::caducidad pasaría a ser obligatorio. Envío DEH voluntario + Carpeta Ciudadana / Sede electrónica De la misma manera el campo caducidad también es obligatorio cuando un envío se configura como DEH con el campo obligado a false + Carpeta Ciudadana, ya que en caso que el ciudadano no esté suscrito el envío acabará únicamente en Carpeta Ciudadana. Uso de la fecha de caducidad cuando se está integrando una sede electrónica Con respecto a la caducidad, en caso que se esté integrando una sede electrónica del organismo, y que se desee que ésta gestione la caducidad de las notificaciones en lugar de Notific@, se deberá establecer un periodo de caducidad superior al manejado por la sede, de modo que se produzca la caducidad primero en la sede y se informe inmediatamente a Notific@ del cambio de estado del envío. Envíos a través de la DEH cuando el titular es distinto que el destinatario Cuando se desea enviar una notificación o comunicación a través de la DEH con titular diferente del destinatario (o, lo que es lo mismo, autorizado según el vocabulario de la DEH), se deben rellenar los campos de la siguiente manera: destinatarios::ítem::titular::nif coincidirá con destinatarios::direccion_electronica::nif destinatarios::ítem::destinatario::nif contendrá el NIF del destinatario (autorizado) Importancia de consignar el campo Estadísticamente se ha confirmado que la tasa de comparecencia de notificaciones por medios electrónicos es muy superior cuando se consigna el campo . Esto es especialmente importante cuando los destinatarios están obligados a recibir notificaciones electrónicas. Es deseable que el Organismo Emisor rellene el campo a partir de la información contenida en un registro de contactos. Ejemplo de Entrada <soapenv:envelope xmlns:soapenv=" Servicio

16 Página 16 de 71 xmlns:org=" <soapenv:header> <api_key>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</api_key> </soapenv:header> <soapenv:body> <org:altaenvio> <envio_type> <!--You may enter the following 9 items in any order--> <organismo_emisor> <!--You may enter the following 2 items in any order--> <codigo_dir3>a </codigo_dir3> <nombre>comunidad Autónoma de Canarias</nombre> </organismo_emisor> <documento> <!--You may enter the following 4 items in any order--> <contenido>jvberi0xljzyhlcy1fuykgl1n0cnvjdfryzwvsb290idq2idagu...</contenido> <hash_sha1>k5g/vxjltvdjvhaad4cncbu5kvy=</hash_sha1> <normalizado>no</normalizado> <generar_csv>no</generar_csv> </documento> <tipo_envio>notificacion</tipo_envio> <concepto>nueva prueba desde WS</concepto> <destinatarios> <!--Zero or more repetitions:--> <item> <!--You may enter the following 8 items in any order--> <referencia_emisor/> <titular> <!--You may enter the following 5 items in any order--> <telefono> </telefono> < > ejemplo@gmail.com</ > <nif> h</nif> <nombre>antonio</nombre> <apellidos>lopez PEREZ</apellidos> </titular> <destinatario> Servicio

17 Página 17 de 71 <!--You may enter the following 5 items in any order--> <telefono> </telefono> < > ejemplo@gmail.com</ > <nif> h</nif> <nombre>antonio</nombre> <apellidos>lopez PEREZ</apellidos> </destinatario> <servicio>normal</servicio> <opciones_emision> <!--You may enter the following 2 items in any order--> <retardo_postal_deh>10</retardo_postal_deh> <caducidad> </caducidad> </opciones_emision> </item> </destinatarios> <procedimiento> <!--You may enter the following 2 items in any order--> <codigo_sia>200620</codigo_sia> <descripcion_sia>consulta Bibliotecas Públicas</descripcion_sia> </procedimiento> </envio_type> </org:altaenvio> </soapenv:body> </soapenv:envelope> Salida Parámetros Tipo Descripción identificadores::item:: identificador identificadores::item:: referencia_emisor ID que se proporciona al dar el alta y que se deberá usar posteriormente para referenciar dicho envío Referencia interna del Emisor del envío. No pueden existir dos envíos con la misma referencia para un mismo organismo. identificadores::item:: nif_titular NIF/CIF/NIE del titular del envío. Servicio

18 Página 18 de 71 codigo_csv Opcional. Código de Seguridad y Verificación generado en el alta del envío. codigo_respuesta Código de tres dígitos asociado al resultado. descripcion_respuesta Descripción de la operación. * Los valores devueltos en los campos codigo_respuesta y descripción_respuesta se pueden consultar al final de este documento. Ejemplo de Salida <soap:envelope xmlns:soap=" <soap:body> <ns1:altaenvioresponse xmlns:ns1=" <return> <identificadores> <item> <identificador>4a01a39f210f4</identificador> <referencia_emisor>2a01a39ed8cf6</referencia_emisor> <nif_titular> h</nif_titular> </item> </identificadores> <codigo_csv xsi:nil="true" xmlns:xsi=" <codigo_respuesta>000</codigo_respuesta> <descripcion_respuesta>ok</descripcion_respuesta> </return> </ns1:altaenvioresponse> </soap:body> </soap:envelope> 4.2 infoenvio() El método infoenvio() permite la consulta y el detalle de un envío. Servicio

19 Página 19 de Entrada Parámetros Tipo Descripción envio_destinatario Obligatorio. Identificador del envío devuelto en la respuesta de altaenvio(). Ejemplo de Entrada <soapenv:envelope xmlns:soapenv=" xmlns:org=" <soapenv:header> <api_key>xxxxxxxxxxxxxxxxxxxxx</api_key> </soapenv:header> <soapenv:body> <org:infoenvio> <info_envio> <envio_destinatario>59ef387279b91</envio_destinatario> </info_envio> </org:infoenvio> </soapenv:body> </soapenv:envelope> Salida Parámetros Tipo Descripción organismo_emisor::codigo_dir3 Obligatorio. Código correspondiente al DIR3. organismo_emisor::nombre Opcional. Nombre de la Entidad Emisora. organismo_pagador_correos:: codigo_dir Sólo se muestra para envíos postales cuando el dato fue consignado en el Método altaenvio(). Código DIR3 del organismo que realizará el pago del servicio de entrega postal. organismo_pagador_correos:: Sólo se muestra para envíos postales cuando el Servicio

20 Página 20 de 71 numero_contrato_correos dato fue consignado en el Método altaenvio() Número de contrato del organismo pagador con el operador postal. organismo_pagador_correos:: codigo_cliente_facturacion_correos Sólo se muestra para envíos postales cuando el dato fue consignado en el Método altaenvio(). Código cliente del organismo pagador para la facturación con el operador postal. organismo_pagador_correos:: fecha_vigencia datetime Sólo se muestra para envíos postales cuando el dato fue consignado en el Método altaenvio(). Fecha fin del contrato con el operador postal. organismo_pagador_cie:: codigo_dir3 Sólo se muestra para envíos postales cuando el dato fue consignado en el Método altaenvio(). Código DIR3 del organismo que realizará el pago de costes de impresión y ensobrado organismo_pagador_cie:: fecha_vigencia datetime Sólo se muestra para envíos postales cuando el dato fue consignado en el Método altaenvio(). Fecha del fin del contrato con el Centro de Impresión y Ensobrado. documento::contenido Obligatorio. Contenido del documento de la notificación codificado en base64. documento::hash_sha1 Obligatorio. Codificación base64 del sha1 del contenido binario del documento. documento::normalizado Obligatorio. En caso de que el documento reserve en la primera página el espacio en blanco necesario para introducir la ventanilla del sobre (NCC, titular, destinatario, domicilio) se debe rellenar con SI. En caso contrario debe rellenarse con NO y el CIE adjuntará una página adicional con la ventana para el ensobrado, incrementando el coste del servicio por la página impresa y por el peso adicional del servicio postal. documento::generar_csv Obligatorio. En caso de que desee que Notific@ genere un CSV y que el documento esté firmado digitalmente se debe introducir SI, caso contrario debe introducir NO. El CSV se introducirá en el pie del documento con la información de los firmantes para la consulta por parte del receptor de la Servicio

21 Página 21 de 71 notificación. tipo_envio Obligatorio. Tipo de envío a dar de alta. Los valores válidos para el elemento pueden ser notificación o comunicación. fecha_envio_programado datetime Opcional. Fecha para realizar un envío programado. concepto Obligatorio. Concepto del envío que se realiza. destinatarios::item::referencia_emis or Obligatorio y único dentro de cada organismo. Referencia interna del Emisor del envío. No pueden existir dos envíos con la misma referencia para un mismo organismo. destinatarios::item::titular::telefono Número de teléfono. Se prevé que se realizarán avisos vía SMS del envío de la notificación/comunicación y de su disponibilidad en Carpeta Ciudadana. destinatarios:: ítem::titular:: para realizar el aviso vía correo electrónico del envío de la notificación/comunicación cuando se realiza un envío exclusivo a Carpeta Ciudadana destinatarios:: ítem::titular::nif Obligatorio para envíos a Sedes Electrónicas y Carpeta Ciudadana. Debe ser el NIF/CIF/NIE del titular del envío. destinatarios::ítem::titular::nombre Obligatorio. Debe rellenarse con el nombre o la razón social del titular del envío destinatarios:: ítem::titular::apellidos destinatarios::ítem::destinatario:: telefono Destinatarios::ítem::destinatario:: Obligatorio si es un envío a una persona física. Debe rellenarse con los Apellidos del titular del envío. Número de teléfono. Se prevé que se realizarán avisos vía SMS del envío de la notificación/comunicación y de su disponibilidad en Carpeta Ciudadana. para realizar el aviso vía correo electrónico del envío de la notificación/comunicación cuando se realiza un envío exclusivo a Carpeta Ciudadana. Servicio

22 Página 22 de 71 destinatarios:: ítem::destinatario::nif Obligatorio para envíos a Sedes Electrónicas y Carpeta Ciudadana. Debe ser el NIF/CIF/NIE del titular del envío destinatarios:: ítem::destinatario::nombre destinatarios:: ítem::destinatario::apellidos Obligatorio. Debe rellenarse con el nombre o la razón social del titular del envío. Obligatorio si es un envío a una persona física. Debe rellenarse con los apellidos del titular del envío. destinatarios::tipo_domicilio Opcional aunque obligatorio para envíos postales. Tipo de domicilio del destinatario, puede ser fiscal o concreto. En caso de que sea concreto deben rellenarse los campos de domicilio. destinatarios::domicilio Compue sto Obligatorio para envíos postales. Mostrará información conforme se introdujo al dar de alta el envío. destinatarios::servicio Obligatorio. Tipo de servicio de envío a realizar, puede ser urgente o normal. destinatarios::direccion_electronica ::obligado destinatarios::direccion_electronica ::nif boolean Obligatorio para envíos a la DEH. Indica si la notificación por DEH es con obligatoriedad del titular que la recibe o no. Los valores aceptados son true o false. En caso de que sea obligado y el titular no disponga de Buzón DEH se le creará uno automáticamente. En caso de no ser obligado se debe realizar la consulta del censo de suscritos. Obligatorio para envíos a la DEH. NIF del titular del buzón DEH que va a recibir la notificación. destinatarios::direccion_electronica ::codigo_procedimiento Obligatorio para envíos a la DEH NO OBLIGADOS. Código de procedimiento en la DEH al que el NIF debe estar suscrito. destinatarios::opciones_emision ::retardo_postal_deh int Indica el número de días naturales que estará disponible una notificación en la Sede Electrónica y/o Carpeta Ciudadana para que pueda ser notificada por comparecencia antes de ponerse a disposición del ciudadano por otras vías, de acuerdo a la configuración que se estableció al dar de alta el envío. Servicio

23 Página 23 de 71 destinatarios::opciones_emision ::caducidad Opcional. Fecha en la cual, a primera hora del día, una notificación pasa a estado rehusado a última hora del día. El formato correcto de la fecha es YYYY-MM-DD. procedimiento::codigo_sia Opcional. Código de procedimiento SIA (Sistema de Información Administrativa). procedimiento::descripcion_sia Opcional. Descripción del SIA (Sistema de Información Administrativa). certificada boolean Obligatorio. Indica si la notificación ha llegado a su estado final. Los valores aceptados son true o false. Nótese que para las notificaciones un valor de true indica que hay certificación pero ésta puede ser positiva o negativa. Para las comunicaciones este valor siempre es false. codigo_respuesta Obligatorio. Código de tres dígitos asociado al resultado. descripción_respuesta Obligatorio. Descripción de la operación. * Los valores devueltos en los campos codigo_respuesta y descripción_respuesta se pueden consultar al final de este documento. Ejemplo de Salida <soap:envelope xmlns:soap=" <soap:body> <ns1:infoenvioresponse xmlns:ns1=" <return> <infoenvio> <organismo_emisor> <codigo_dir3>a </codigo_dir3> <nombre>comunidad Autónoma de Canarias</nombre> </organismo_emisor> <organismo_pagador_correos xsi:nil="true" xmlns:xsi=" Servicio

24 Página 24 de 71 <organismo_pagador_cie xsi:nil="true" xmlns:xsi=" <documento> <contenido>jvberi0xljunciw1tbw1dqoxidagb2jqdqo8pc9uexbll0...</contenido> <hash_sha1>xo0uve2l8hnvnmr2wdqi/ipgwjc=</hash_sha1> <normalizado>no</normalizado> <generar_csv>no</generar_csv> </documento> <tipo_envio>notificacion</tipo_envio> <fecha_envio_programado xsi:nil="true" xmlns:xsi=" <concepto>notificacion</concepto> <destinatarios> <item> <referencia_emisor>59ef387279b91</referencia_emisor> <titular> <telefono xsi:nil="true" xmlns:xsi=" < xsi:nil="true" xmlns:xsi=" <nif> h</nif> <nombre>antonio</nombre> <apellidos>lopez Perez</apellidos> </titular> <destinatario> <telefono xsi:nil="true" xmlns:xsi=" < xsi:nil="true" xmlns:xsi=" <nif xsi:nil="true" xmlns:xsi=" <nombre/> <apellidos xsi:nil="true" xmlns:xsi=" </destinatario> <tipo_domicilio xsi:nil="true" xmlns:xsi=" <domicilio xsi:nil="true" xmlns:xsi=" Servicio

25 Página 25 de 71 instance"/> <servicio>normal</servicio> <direccion_electronica xsi:nil="true" xmlns:xsi=" <opciones_emision xsi:nil="true" xmlns:xsi=" </item> </destinatarios> <procedimiento> <codigo_sia>201378</codigo_sia> <descripcion_sia>consulta de notas y faltas de asistencia</descripcion_sia> </procedimiento> </infoenvio> <certificada>true</certificada> <codigo_respuesta>000</codigo_respuesta> <descripcion_respuesta>ok</descripcion_respuesta> </return> </ns1:infoenvioresponse> </soap:body> </soap:envelope> 4.3 consultaestado() El método infoenvio() permite consultar el estado de un envío Entrada Parámetros Tipo Descripción identificador_envio Obligatorio. Identificador del envío devuelto en la respuesta de altaenvio(). Servicio

26 Página 26 de 71 Ejemplo de Entrada <soapenv:envelope xmlns:soapenv=" xmlns:org=" <soapenv:header/> <soapenv:body> <org:consultaestado> <identificador_envio>59ef387279b91</identificador_envio> </org:consultaestado> </soapenv:body> </soapenv:envelope> Salida Parámetros Tipo Descripción estado:: identificador_envio Obligatorio. Identificador del envío devuelto en la respuesta de altaenvio() estado:: estado Obligatorio. Estado del envío. identificador_envio::nif_titular Obligatorio. Estado del envío. estado::ncc_id_externo Opcional. NCC. Número de seguimiento de correos. codigo_respuesta Obligatorio. Código de tres dígitos asociado al resultado. descripcion_respuesta Obligatorio. Descripción de la operación. * Los valores devueltos en los campos codigo_respuesta y descripción_respuesta se pueden consultar al final de este documento. Ejemplo de Salida <soap:envelope xmlns:soap=" <soap:body> <ns1:consultaestadoresponse Servicio

27 Página 27 de 71 xmlns:ns1=" <return> <estado> <identificador_envio>59ef387279b91</identificador_envio> <estado>notificada</estado> <ncc_id_externo xsi:nil="true" xmlns:xsi=" </estado> <codigo_respuesta>000</codigo_respuesta> <descripcion_respuesta>ok</descripcion_respuesta> </return> </ns1:consultaestadoresponse> </soap:body> </soap:envelope> 4.4 consultadatadoenvio() El método consultadatadoenvio() permite consultar el Datado de un envío Entrada Parámetros Tipo Descripción estado:: identificador_envio Obligatorio. Identificador del envío devuelto en la respuesta de altaenvio() Ejemplo de Entrada <soapenv:envelope xmlns:soapenv=" xmlns:org=" <soapenv:header/> <soapenv:body> <org:consultadatadoenvio> <identificador_envio>59f1dbe626ed9</identificador_envio> Servicio

28 Página 28 de 71 </org:consultadatadoenvio> </soapenv:body> </soapenv:envelope> Salida Parámetros Tipo Descripción identificador_envio:: identificador Obligatorio. Identificador del envío devuelto en la respuesta de altaenvio() identificador_envio:: referencia_emisor Obligatorio. Referencia interna del Emisor del envío. No pueden existir dos envíos con la misma referencia para un mismo organismo. identificador_envio:: nif_titular Opcional. El NIF/CIF/NIE del titular del envío. datado::item::estado Opcional. Estado del Datado. Es un array o lista con todo el historial de estados. datado::item::descripción Opcional. Descripción del estado. datado::item::fecha Opcional. Fecha del datado. estado_actual Estado Actual o último estado del array o lista con todo el historial de estados. descripción_estado_actual Obligatorio. Descripción del estado actual. fecha_actualizacion DateTime Obligatorio. Fecha de actualización. ncc_id_externo Opcional. NCC. codigo_respuesta Obligatorio. Código de tres dígitos asociado al resultado. descripcion_respuesta Obligatorio. Descripción de la operación. * Los valores devueltos en los campos codigo_respuesta y descripción_respuesta se pueden consultar al final de este documento. Servicio

29 Página 29 de 71 Ejemplo de Salida <soap:envelope xmlns:soap=" <soap:body> <ns1:consultadatadoenvioresponse xmlns:ns1=" <return> <datado> <identificador_envio> <identificador>59db5afc93e9f</identificador> <referencia_emisor> </referencia_emisor> <nif_titular> h</nif_titular> </identificador_envio> <datado> <item> <estado>pendiente_sede</estado> <descripcion>pendiente de comparecencia</descripcion> <fecha> t13:18:20+02:00</fecha> </item> <item> <estado>rehusada</estado> <descripcion>rehusada</descripcion> <fecha> t00:00:14+02:00</fecha> </item> </datado> <estado_actual>rehusada</estado_actual> <descripcion_estado_actual>rehusada</descripcion_estado_actual> <fecha_actualizacion> T00:00:14+02:00</fecha_actualizacion> <ncc_id_externo xsi:nil="true" xmlns:xsi=" </datado> <codigo_respuesta>000</codigo_respuesta> <descripcion_respuesta>ok</descripcion_respuesta> </return> </ns1:consultadatadoenvioresponse> Servicio

30 Página 30 de 71 </soap:body> </soap:envelope> 4.5 consultacertificaciónenvio() El método consultacertificaciónenvio() permite la consulta de la Certificación de un envío. Parámetros Tipo Descripción estado:: identificador_envio Obligatorio. Identificador del envío devuelto en la respuesta de altaenvio() Entrada Ejemplo de Entrada <soapenv:envelope xmlns:soapenv=" xmlns:org=" <soapenv:header/> <soapenv:body> <org:consultacertificacionenvio> <identificador_envio>59f ad</identificador_envio> </org:consultacertificacionenvio> </soapenv:body> </soapenv:envelope> Salida Parámetros Tipo Descripción certificación::identificador_envio:: identificador certificación::identificador_envio:: referencia_emisor Obligatorio. ID que se proporciona al dar de alta un envío. Obligatorio. Referencia interna del Emisor del envío. No pueden existir dos envíos con la misma Servicio

31 Página 31 de 71 certificación::identificador_envio:: nif_titular referencia para un mismo organismo. Opcional. El NIF/CIF/NIE del titular del envío. certificación::pdf_certificado Opcional. Contenido del Certificado en PDF y en base 64. Es excluyente con el siguiente campo, si está en PDF no se devuelve en XML. certificación::xml_certificado Opcional. Contenido del Certificado en XML. Es excluyente con el anterior campo, si está en XML no se devuelve en PDF. certificación::certificación Obligatorio. Tipo de acuse o sobre. Nótese que para envíos postales el acuse es una notificación positiva y el sobre es una notificación negativa (por ejemplo, rehusada). Para otros medios se usa el acuse independientemente del resultado. certificación::fecha_actualizacion DateTime Obligatorio. Fecha en la que llega el acuse. certificación::ncc_id_externo Opcional. NCC. codigo_respuesta Obligatorio. Código de tres dígitos asociado al resultado. descripcion_respuesta Obligatorio. Descripción de la operación. * Los valores devueltos en los campos codigo_respuesta y descripción_respuesta se pueden consultar al final de este documento. Ejemplo de Salida <soap:envelope xmlns:soap=" <soap:body> <ns1:consultacertificacionenvioresponse xmlns:ns1=" <return> <certificacion> <identificador_envio> <identificador>59f ad</identificador> Servicio

32 Página 32 de 71 <referencia_emisor>a </referencia_emisor> <nif_titular> h</nif_titular> </identificador_envio> <pdf_certificado>jvberi0xljqkjcokw7zdtsofcjigmcbvymokpdwvtgvuz9gbgf0zurly29k... </pdf_certificado> <xml_certificado xsi:nil="true" xmlns:xsi=" <certificacion>acuse</certificacion> <fecha_actualizacion> T09:50:12+02:00</fecha_actualizacion> <ncc_id_externo>59f ad</ncc_id_externo> </certificacion> <codigo_respuesta>000</codigo_respuesta> <descripcion_respuesta>ok</descripcion_respuesta> </return> </ns1:consultacertificacionenvioresponse> </soap:body> </soap:envelope> 4.6 consultacies() El método consultacies() permite consultar a los CIEs (Centros de Impresión y Ensobrado) disponibles para un organismo emisor Entrada Parámetros Tipo Descripción organismo_emisor Obligatorio. Código DIR3 del Organismo. Ejemplo de Entrada <soapenv:envelope xmlns:soapenv=" xmlns:org=" Servicio

33 Página 33 de 71 <soapenv:header> <api_key>xxxxxxxxxxxxxxxxxxxx</api_key> </soapenv:header> <soapenv:body> <org:consultacies> <consulta_cies> <organismo_emisor>a </organismo_emisor> </consulta_cies> </org:consultacies> </soapenv:body> </soapenv:envelope> Salida Parámetros Tipo Descripción cies::id integer Obligatorio. Identificador del CIE. cies::centro_impresion Obligatorio. Nombre del CIE. cies::fecha_vigencia Date Obligatorio. Fecha de vigencia (hasta) del contrato. cies:: codigo_unidad_relacionada Obligatorio. Código DIR3 del Organismo. cies:: nombre_unidad_relacionada Obligatorio. Nombre del Organismo cies::orden integer Obligatorio. Orden de preferencia del CIE. En caso que varios CIEs tengan el mismo orden, seleccionará el CIE entre ellos en función de criterios como la capacidad del CIE o el reparto de cargas de trabajo. codigo_respuesta Obligatorio. Código de tres dígitos asociado al resultado. descripcion_respuesta Obligatorio. Descripción de la operación Servicio

34 Página 34 de 71 * Los valores devueltos en los campos codigo_respuesta y descripción_respuesta se pueden consultar al final de este documento. Ejemplo de Salida <soap:envelope xmlns:soap=" <soap:body> <ns1:consultaciesresponse xmlns:ns1=" <return> <cies/> <codigo_respuesta>000</codigo_respuesta> <descripcion_respuesta>ok</descripcion_respuesta> </return> </ns1:consultaciesresponse> </soap:body> </soap:envelope> 5 OPERACIONES DEL SERVICIO PARA SEDES La ruta del wsdl de sedes se expone en la siguiente ruta: Las operaciones que ofrece permiten la consulta y monitorización de la entrega de una notificación. Incluye los siguientes métodos: Parámetros getenvios() getenvios2() getenviosagrupados() getenviosagrupados2() Descripción Método que devuelve todos los identificadores de los envíos dependiendo de las opciones introducidas. Método similar a getenvios() pero que además dispone de opciones para considerar quién es el titular, el destinatario o la existencia de apoderamientos. También permite filtrar entre notificaciones y comunicaciones. Método que devuelve la cantidad de envíos asociados a un criterio señalado. Método que devuelve la cantidad de envíos asociados a un criterio Servicio

35 Página 35 de 71 señalado de forma más detallada. infoenvio() infoenvio2() certificacionsede() getcertificacion() comunicacionsede() Método para consultar la información detallada de un envío específico. Método para consultar la información detallada de un envío específico, con menos detallte que el método anterior. Método para el envío de la certificación de la notificación desde la Sede hacia la aplicación Método que devuelve la certificación del envío solicitado. Método para indicar que una comunicación ha sido leída en sede electrónica y por tanto, en su caso, no es necesario enviarla por papel o DEH. 5.1 getenvios() El método getenvios() permite obtener los envíos de un destinatario Entrada Parámetros Tipo Descripción nif Obligatorio. Indica el NIF/CIF de titular del que se quieren obtener las notificaciones que tiene el sistema. estado Opcional. Filtro por estado en el que se encuentra la notificación: Notificada, Rehusada o Pendiente. organismos_emisor Opcional. Filtro por el organismo que ha remitido la notificación, debe introducirse el código DIR3 del organismo. Si no se consigna se devolverán todos los envíos del NIF/CIF indicado que estén asociados al API_KEY independientemente del Organismo Emisor. codigo_sia Opcional. Filtro por el código del procedimiento al que hace referencia la notificación. Servicio

36 Página 36 de 71 fecha_desde datetime Opcional. Filtro por la fecha desde la que se quieren recuperar las notificaciones, debe introducirse en formato AAAA-MM-DD y en caso de no rellenarse se tomarán desde el fecha_hasta datetime Opcional. Filtro por la fecha hasta la que se quieren recuperar las notificaciones, debe introducirse en formato AAAA-MM-DD y en caso de no rellenarse se tomará el día actual Ejemplo de Entrada <soapenv:envelope xmlns:soapenv=" xmlns:sed=" <soapenv:header> <api_key>xxxxxxxxxxxxxxxxxxxx</api_key> </soapenv:header> <soapenv:body> <sed:getenvios> <get_envios> <nif> h</nif> <organismo_remisor>a </organismo_remisor> <fecha_desde> t08:00:00</fecha_desde> <fecha_hasta> t08:00:00</fecha_hasta> </get_envios> </sed:getenvios> </soapenv:body> </soapenv:envelope> Salida Parámetros Tipo Descripción envio_destinatario Identificador del envío devuelto en la respuesta de altaenvio() estado Estado del envío: Notificada, Rehusada o Servicio

37 Página 37 de 71 Pendiente. concepto Concepto del envío. organismo_emisor Código DIR3 del organismo que ha remitido el envío. fecha_notificacion datetime Fecha en la que ha sido dada de alta en el envío (independientemente de que sea una notificación o comunicación). fecha_actualizacion datetime Fecha del último cambio vinculo Indica si el envío ha sido recuperado porque el NIF/CIF indicado es el del titular o el del destinatario. tipo_envio Notificación o comunicación canal_envio A partir del último datado * Los valores devueltos en los campos codigo_respuesta y descripción_respuesta se pueden consultar al final de este documento. Ejemplo de Salida <soap:envelope xmlns:soap=" <soap:body> <ns1:getenviosresponse xmlns:ns1=" <return> <resultadogetenvios> <item> <envio_destinatario>5a0559aa62a0a</envio_destinatario> <estado>pendiente</estado> <concepto>notificacion prueba de Notific de la CAC</concepto> <organismo_remisor>a </organismo_remisor> <fecha_notificacion> t08:47:54+01:00</fecha_notificacion> <fecha_actualizacion> t08:47:54+01:00 </fecha_actualizacion> Servicio

38 Página 38 de 71 <vinculo>titular</vinculo> <tipo_envio>notificacion</tipo_envio> <canal_envio xsi:nil="true" xmlns:xsi=" /> </item> </resultadogetenvios> <codigo_respuesta>000</codigo_respuesta> <descripcion_respuesta>ok</descripcion_respuesta> </return> </ns1:getenviosresponse> </soap:body> </soap:envelope> 5.2 getenvios2() El método getenvios2() permite obtener los envíos de un destinatario. Permite distinguir en la búsqueda entre titular, destinatario o apoderado. También permite filtrar entre notificaciones y comunicaciones Entrada Parámetros Tipo Descripción nif Obligatorio. Indica el NIF/CIF de titular del que se quieren obtener las notificaciones que tiene el sistema. nif_representante Opcional. Indica el NIF/CIF del destinatario. estado Opcional. Filtro por estado en el que se encuentra la notificación: Notificada, Rehusada o Pendiente. organismos_emisor Opcional. Filtro por el organismo que ha remitido la notificación, debe introducirse el código DIR3 del organismo. Si no se consigna se devolverán todos los envíos del NIF/CIF indicado que estén asociados al API_KEY independientemente del Servicio

39 Página 39 de 71 Organismo Emisor. codigo_sia Opcional. Filtro por el código del procedimiento al que hace referencia la notificación. fecha_desde datetime Opcional. Filtro por la fecha desde la que se quieren recuperar las notificaciones, debe introducirse en formato AAAA-MM-DD y en caso de no rellenarse se tomarán desde el fecha_hasta datetime Opcional. Filtro por la fecha hasta la que se quieren recuperar las notificaciones, debe introducirse en formato AAAA-MM-DD y en caso de no rellenarse se tomará el día actual tipo_envio Opcional. Debe valer 1 si se desea obtener únicamente las comunicaciones 2 para obtener únicamente las notificaciones rea boolean Opcional. Por defecto false. Indica que el Organismo Emisor ha comprobado que existen derechos de representación en el registro electrónico de apoderamientos que corresponda, y que el resultado de dicha consulta es positivo. En la siguiente tabla se explica, mediante ejemplo, el funcionamiento de los parámetros nif, nif_representante y rea: Nif Nif_representante Rea Comportamiento H Vacío N/A Devuelve todos los envíos para los que sea titular H Vacío H N/A Devuelve todos los envíos para los que sea destinatario H H T F Devuelve todos los envíos para los que sea titular H y destinatario T, es decir, que se cumplan ambas condiciones H T T Devuelve todos los envíos para los que sea titular H (se ignora el dato nif_representante). Servicio

40 Página 40 de 71 ATENCIÓN: Aunque tanto nif, como nif_representante, son parámetros opcionales se debe consignar al menos uno de ellos. Ejemplo de Entrada <soapenv:envelope xmlns:soapenv=" xmlns:sed=" <soapenv:header> <api_key>xxxxxxxxxxxxxxxxxxxx</api_key> </soapenv:header> <soapenv:body> <sed:getenvios2> <get_envios2> <nif> h</nif> <organismo_remisor>a </organismo_remisor> <fecha_desde> t08:00:00</fecha_desde> <fecha_hasta> t08:00:00</fecha_hasta> <rea>false</rea> </get_envios2> </sed:getenvios2> </soapenv:body> </soapenv:envelope> Salida Parámetros Tipo Descripción envio_destinatario Identificador del envío devuelto en la respuesta de altaenvio() estado Estado del envío: Notificada, Rehusada o Pendiente. concepto Concepto del envío. organismo_emisor Código DIR3 del organismo que ha remitido el Servicio

41 Página 41 de 71 envío. fecha_creacion datetime Fecha en la que ha sido dado de alta en el envío. fecha_actualizacion datetime Fecha del último cambio vinculo Indica si el envío ha sido recuperado porque el NIF/CIF indicado es el del titular o el del destinatario. tipo_envio Notificación o comunicación canal_envio A partir del último datado. * Los valores devueltos en los campos código_respuesta y descripción_respuesta se pueden consultar al final de este documento. ATENCION: El campo de respuesta haymasresultados indica que no se han recuperado todos los resultados existentes en la base de datos de Notific@, sino que únicamente se han recuperado los 1000 resultados con fecha de alta más reciente. Si los envíos que se quieren encontrar no están entre los recuperados se deberán usar opciones de filtrado. Ejemplo de Salida <soap:envelope xmlns:soap=" <soap:body> <ns1:getenvios2response xmlns:ns1=" <return> <resultadogetenvios2> <item> <envio_destinatario xsi:nil="true" xmlns:xsi=" <estado xsi:nil="true" xmlns:xsi=" <concepto xsi:nil="true" xmlns:xsi=" <organismo_remisor xsi:nil="true" xmlns:xsi=" Servicio