Story Transcript
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Guía de uso de los Web Services de integración
LexNET LX8_020v12
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
FECHA
NOMBRE FORMATO VersiónComentario
27/11/2007
DOC
Versión 1.0
S.G. de Nuevas Tecnologías
14/12/2007
DOC
Versión 1.1
Modificación de WS Schema
11/01/2008
DOC
Versión 1.2
Modificación de WS Schema
24/03/2008
DOC
Versión 1.3
Modificación del servicio ObtenerCabeceras
23/04/2008
DOC
Versión 1.4
Añadido nuevo servicio web LoginServicios
21/01/08
DOC
Versión 1.5
Modificación del servicio ObtenerCabeceras
23/09/09
DOC
Versión 1.6
27/01/2010
DOC
Versión 1.7
20/04/2010
DOC
Versión 1.8
29/12/2010
DOC
Versión 1.9
31/08/2011
DOC
Versión 3.0
26/09/2011
DOC
Versión 3.0_v2
03/10/2011
DOC
Versión 3.0_v3
09/01/2012
DOC
27/01/2012
DOC
18/01/2012
DOC
26/04/2012
DOC
29/06/2012
DOC
Versión 3.0_v4 Versión 3.0_v5 Versión 3.0_v6 Versión 3.0_v7 Versión
Añadidos servicios Repartir, Asumir, ObtenerAceptados y ObtenerProcuradores. Además se ha modificado el servicio ObtenerMensaje Modificación del elemento profesional para que incluya el código de colegiado. Añadidos servicios ObtenerPendientesRepartir y ObtenerCabecerasPendientesRepartir. Además se ha modificado el servicio ObtenerCabeceras Añadidos servicios web de EnvioAcusesSGP, ObtenerAvisos. Modificación de servicios: ObtenerCabeceras, ObtenerCabecerasPendientesRepartir, ObtenerMensaje y ObtenerProcuradores. Se ha actualizado el schema de los XML de petición y respuesta. Se han añadido los servicios web ObtenerPendientesRepartirOtros, ObtenerCabecerasPendientesRepartirOtros, BuscarMensajesAuditorias, BuscarInformeAuditoria. Asimismo, se han modificado los servicios ObtenerCabeceras y ObtenerCabecerasPendientesRepartir incluyendo fechaInicio y fechaFin y el servicio ObtenerProcuradores, incluyendo el idSujeto Se modifica la descripción de los parámetros fecha,fechaInicio,fechaFin del ws ObtenerAceptados (la descripción incluida en la versión anterior era errónea) Se introducen correcciones en la descripción de los servicios y en algunas etiquetas de los mensajes de petición/respuesta Se incluye el apartado Ejemplo de uso e invocación de los Servicios Web LexNet Se añade explicación a parámetros de EnviarMensaje Se añade el servicio web ObtenerHistoricoMensaje Se añade el envio de mensajes con firma CADES Se añade explicación de formato de mensaje
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
3.0_v8 28/09/2012
DOC
01/10/2012
DOC
08/11/2012
DOC
10/12/2012
DOC
Versión 3.0_v9 Versión 3.0_v10 Versión 3.0_v11 Versión 3.0_v12
MIME/CADES y parámetro de envio cades en EnviarVerificacionLecturaGeneral Se añade al ws EnviarMensaje descripción relativa a la posibilidad de envío de copias a profesionales Se añade los ws obtenerCabecerasPendientesAsumir y ObtenerPendientesAsumir Se añade explicación adicional a ObtenerCabeceras Se añade explicación adicional ObtenerCabecerasPendientesAsumir
a
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
TABLA DE CONTENIDOS Introducción ............................................................................................... 9 Descripción de los Servicios Web .............................................................. 12 Servicio web: Login ...................................................................................12 Descripción ............................................................................................12 Definición WSDL .....................................................................................13 Mensaje SOAP de petición: .......................................................................15 Validaciones ...........................................................................................15 Mensaje SOAP de respuesta OK ................................................................16 Servicio web: LoginServicios .......................................................................16 Descripción ............................................................................................16 Definición WSDL .....................................................................................17 Mensaje SOAP de petición: .......................................................................18 Validaciones ...........................................................................................19 Mensaje SOAP de respuesta OK ................................................................19 Servicio web: Logout .................................................................................20 Descripción ............................................................................................20 Definición WSDL .....................................................................................20 Mensaje SOAP de petición: .......................................................................22 Validaciones ...........................................................................................22 Servicio web: ObtenerAvisos .......................................................................23 Descripción ............................................................................................23 Definición WSDL .....................................................................................23 Mensaje SOAP de petición: .......................................................................24
Página 1
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Validaciones ...........................................................................................25 Mensaje SOAP de respuesta OK ................................................................25 Servicio web: ObtenerDestinatarios .............................................................27 Descripción ............................................................................................27 Definición WSDL .....................................................................................27 Mensaje SOAP de petición: .......................................................................28 Validaciones ...........................................................................................30 Mensaje SOAP de respuesta OK ................................................................30 Servicio web: ObtenerTiposProcedimiento ....................................................33 Descripción ............................................................................................33 Definición WSDL .....................................................................................34 Mensaje SOAP de petición: .......................................................................35 Validaciones ...........................................................................................36 Mensaje SOAP de respuesta OK ................................................................37 Servicio web: ObtenerPendientes ................................................................38 Descripción ............................................................................................38 Definición WSDL .....................................................................................38 Mensaje SOAP de petición: .......................................................................39 Validaciones ...........................................................................................40 Mensaje SOAP de respuesta OK ................................................................40 Servicio web: ObtenerPendientesAsumir .......................................................42 Descripción ............................................................................................42 Definición WSDL .....................................................................................42 Mensaje SOAP de petición: .......................................................................43 Validaciones ...........................................................................................44
Página 2
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Mensaje SOAP de respuesta OK ................................................................44 Servicio web: ObtenerCabeceras .................................................................45 Descripción ............................................................................................45 Definición WSDL .....................................................................................46 Mensaje SOAP de petición: .......................................................................47 Validaciones ...........................................................................................49 Mensaje SOAP de respuesta OK ................................................................49 Servicio web: ObtenerMensaje ....................................................................55 Descripción ............................................................................................55 Definición WSDL .....................................................................................55 Mensaje SOAP de petición: .......................................................................57 Validaciones ...........................................................................................57 Mensaje SOAP de respuesta OK ................................................................58 Servicio web: ObtenerBloque ......................................................................63 Descripción ............................................................................................63 Definición WSDL .....................................................................................64 Mensaje SOAP de petición: .......................................................................65 Validaciones ...........................................................................................66 Mensaje SOAP de respuesta OK ................................................................67 Servicio web: ObtenerHistoricoMensaje ........................................................68 Descripción ............................................................................................68 Definición WSDL .....................................................................................68 Mensaje SOAP de petición: .......................................................................69 Validaciones ...........................................................................................70 Mensaje SOAP de respuesta OK ................................................................70
Página 3
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Servicio web: EnviarMensaje .......................................................................76 Descripción ............................................................................................76 Definición WSDL .....................................................................................76 Mensaje SOAP de petición: .......................................................................78 Validaciones ...........................................................................................82 Mensaje SOAP de respuesta OK ................................................................83 Servicio web: EnviarBloque .........................................................................84 Descripción ............................................................................................84 Definición WSDL .....................................................................................84 Mensaje SOAP de petición: .......................................................................86 Validaciones ...........................................................................................87 Mensaje SOAP de respuesta OK ................................................................87 Servicio web: EnviarVerificacionLectura ........................................................88 Descripción ............................................................................................88 Definición WSDL .....................................................................................89 Mensaje SOAP de petición: .......................................................................90 Validaciones ...........................................................................................91 Mensaje SOAP de respuesta OK ................................................................92 Servicio web: TerminarDescarga .................................................................93 Descripción ............................................................................................93 Definición WSDL .....................................................................................93 Mensaje SOAP de petición: .......................................................................94 Validaciones ...........................................................................................95 Servicio web: Repartir ................................................................................96 Descripción ............................................................................................96
Página 4
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Definición WSDL .....................................................................................96 Mensaje SOAP de petición: .......................................................................97 Validaciones ...........................................................................................98 Mensaje SOAP de respuesta OK ................................................................99 Servicio web: ObtenerAceptados ............................................................... 100 Descripción .......................................................................................... 100 Definición WSDL ................................................................................... 100 Mensaje SOAP de petición: ..................................................................... 101 Validaciones ......................................................................................... 103 Mensaje SOAP de respuesta OK .............................................................. 103 Servicio web: Asumir ............................................................................... 105 Descripción .......................................................................................... 105 Definición WSDL ................................................................................... 105 Mensaje SOAP de petición: ..................................................................... 106 Validaciones ......................................................................................... 107 Mensaje SOAP de respuesta OK .............................................................. 108 Servicio web: ObtenerProcuradores ........................................................... 114 Descripción .......................................................................................... 114 Definición WSDL ................................................................................... 114 Mensaje SOAP de petición: ..................................................................... 115 Validaciones ......................................................................................... 117 Mensaje SOAP de respuesta OK .............................................................. 117 Servicio web: ObtenerPendientesRepartir ................................................... 121 Descripción .......................................................................................... 121 Definición WSDL ................................................................................... 121
Página 5
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Mensaje SOAP de petición: ..................................................................... 122 Validaciones ......................................................................................... 123 Mensaje SOAP de respuesta OK .............................................................. 123 Servicio web: ObtenerPendientesRepartirOtros ............................................ 125 Descripción .......................................................................................... 125 Definición WSDL ................................................................................... 125 Mensaje SOAP de petición: ..................................................................... 126 Validaciones ......................................................................................... 127 Mensaje SOAP de respuesta OK .............................................................. 127 Servicio web: ObtenerCabecerasPendientesRepartir ..................................... 129 Descripción .......................................................................................... 129 Definición WSDL ................................................................................... 129 Mensaje SOAP de petición: ..................................................................... 130 Validaciones ......................................................................................... 132 Mensaje SOAP de respuesta OK .............................................................. 133 Servicio web: ObtenerCabecerasPendientesRepartirOtros ............................. 138 Descripción .......................................................................................... 138 Definición WSDL ................................................................................... 138 Mensaje SOAP de petición: ..................................................................... 140 Validaciones ......................................................................................... 141 Mensaje SOAP de respuesta OK .............................................................. 142 Servicio web: ObtenerCabecerasPendientesAsumir ...................................... 147 Descripción .......................................................................................... 147 Definición WSDL ................................................................................... 147 Mensaje SOAP de petición: ..................................................................... 149
Página 6
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Validaciones ......................................................................................... 151 Mensaje SOAP de respuesta OK .............................................................. 151 Servicio web: BuscarMensajesAuditorias..................................................... 157 Descripción .......................................................................................... 157 Definición WSDL ................................................................................... 157 Mensaje SOAP de petición: ..................................................................... 158 Validaciones ......................................................................................... 160 Mensaje SOAP de respuesta OK .............................................................. 160 Servicio web: BuscarInformeAuditoria ........................................................ 166 Descripción .......................................................................................... 166 Definición WSDL ................................................................................... 166 Mensaje SOAP de petición: ..................................................................... 167 Validaciones ......................................................................................... 168 Mensaje SOAP de respuesta OK .............................................................. 169 Servicio web: EnvioAcusesSGP .................................................................. 170 Descripción .......................................................................................... 170 Definición WSDL ................................................................................... 170 Mensaje SOAP de petición: ..................................................................... 171 Validaciones ......................................................................................... 173 Mensaje SOAP de respuesta OK .............................................................. 173 Guía de cumplimentación de las plantillas de mensaje de envío ............. 176 Mensaje formato MIME ............................................................................. 176 1.
EnviarMensaje ............................................................................ 176
2.
EnviarVerificacionLectura ............................................................. 178
Mensaje formato CADES ........................................................................... 181
Página 7
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Cabecera principal................................................................................. 182 Cabecera de fichero............................................................................... 184 Plantilla CADES devuelta por EnviarMensaje................................................ 188 Plantilla CADES devuelta por EnviarVerificacionLectura ................................. 189 Ejemplo de uso e invocación de los Servicios Web LexNet ...................... 192 Envío de mensajes ................................................................................... 192 Descarga de mensajes ............................................................................. 195 Mensaje de Error .................................................................................... 200 Descripción ............................................................................................. 200 Mensaje SOAP de respuesta ERROR: .......................................................... 200 Códigos de error devueltos por el servidor .................................................. 201
Página 8
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Introducción El objeto de este documento es describir las interfaces WebServices de la plataforma LexNET para que los desarrolladores de aplicaciones puedan integrar y utilizar los servicios ofrecidos por la misma. Una vez desarrolladas y antes de su pase a producción, estas aplicaciones habrán tenido que pasar previamente un proceso de homologación de su aplicación en el que se comprobará el funcionamiento adecuado del cliente desarrollado conforme a los requisitos del RD 84/2007 regulador del sistema LexNet. Una vez pasado el proceso de homologación, La Subdirección General de Nuevas Tecnologías de la Justicia asignará un identificador único e intransferible a la aplicación lo que permitirá su intercomunicación con LexNet por servicios web. Este documento cubre los siguientes aspectos: •
Descripción de la interfaz de Servicios web de la plataforma LexNET mediante la especificación de mensajes XML-SOAP de solicitud y respuesta.
•
XSchema general asociado al XML de los parámetros de entrada y salida de los servicios web.
•
Descripción de ejemplo uso e invocación de los servicios web LexNet para la realización de los procesos principales aportados por el sistema LexNet: envío y descarga de mensajes.
•
Descripción de los códigos de resultado devueltos por la plataforma.
La plataforma LexNET publicará los siguientes Web Services de integración con LexnET: •
De uso general: •
Login
•
Logout
•
Obtención de avisos activos en Lexnet
Página 9
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
•
•
Obtención de destinatarios válidos
•
Obtención de tipos de procedimientos
•
Obtención de mensajes pendientes
•
Obtención de cabeceras
•
Descarga de mensaje
•
Descarga de bloque
•
Indicación de fin de descarga
•
Envío de verificación de lectura
•
Envío de mensaje
•
Envío de bloque.
•
ObtenerHistoricoMensaje
De uso por parte de aplicativos del Ministerio de Justicia: •
•
LoginServicios
De uso por parte de Colegios de Procuradores: •
Obtención de cabeceras pendientes de repartir tanto dirigidos a procuradores de su Colegio como dirigidos a procuradores de otros Colegios
•
Obtención de mensajes pendientes de repartir tanto dirigidos a procuradores de su Colegio como dirigidos a procuradores de otros Colegios
•
Repartir mensajes a procuradores
•
Asumir mensajes
•
Obtener mensajes pendientes de asumir
•
Obtención de datos de procuradores
•
Obtención de mensajes aceptados
•
Busqueda de mensajes para auditoría
Página 10
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
•
Descarga de una auditoría
Todos los servicios web publicados constan de una sola operación. Todas las operaciones reciben como único parámetro de entrada un String con formato XML. Cada servicio publicado dispone de un formato de XML específico que viene definido por el XML Schema de los mensajes a los Web Services. En este schema se definen todos los mensajes de todos los web services, tanto los de petición, como los de respuesta, incluida la respuesta en caso de error (En el apartado Códigos de error devueltos por el servidor se especifican los códigos de error que devuelven los servicios web, así como su descripción).
Página 11
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Descripción de los Servicios Web En este capítulo se detallan los servicios Web que se han diseñado, sus funciones, el sentido de las mismas y sus parámetros de entrada y salida. Para facilitar la integración de las aplicaciones clientes, cada una de las operaciones que se pueden realizar en LexNET a través de servicios web, se han definido como un servicio web independiente, cada uno con una sola operación. Como se verá más adelante en la definición WSDL de los servicios web, cada uno de ellos (con su única operación) aceptan como parámetro de entrada un String, el cual representa un mensaje formateado en XML a través del cual se pasan los datos necesarios para realizar la operación que representa. Asimismo, el mensaje de respuesta que envíe el servidor LexNet será también un String formateado en XML con los datos específicos de la operación realizada o, en caso de que ocurra algún error, los datos del mismo. Como la respuesta de error es común para todos los servicios, sólo se ejemplifica un mensaje de respuesta de error al final de la descripción de cada uno de los servicios.
Servicio web: Login Descripción Esta funcionalidad permite a un usuario de una aplicación cliente de los servicios web LexNet autenticarse en el sistema. Previamente a la petición de este servicio, la aplicación deberá haber abierto una sesión SSL con LexNet utilizando el certificado digital del usuario. La implementación de este servicio web comprobará, con la información del certificado del usuario, si éste existe en LexNet cargando los datos necesarios para el establecimiento de una sesión. Cuando todo el proceso se haya realizado correctamente, el usuario estará autenticado. El servicio devolverá al cliente el identificador de sesión generado en el proceso de autenticación y el número total de mensajes pendientes de descarga por parte del usuario autenticado.
Página 12
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Figura 1 Proceso de Autenticación
Definición WSDL
Página 13
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Página 14
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Mensaje SOAP de petición: [idAplicacion] ]]>
Los elementos resaltados se enumeran a continuación: •
idAplicacion: Identificador de la aplicación que hace la petición y desde la que el usuario se ha conectado a LexNet.
Validaciones Estos son las validaciones que se aplican al servicio web: •
idAplicacion: se comprueba que el identificador de la aplicación está admitido en el entorno LexNet.
•
Certificado: se comprueba que el certificado usado por el usuario en la conexión SSL es correcto.
•
Usuario: se comprueba que el usuario del certificado está registrado en la aplicación y está habilitado para entrar al sistema.
Página 15
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
Mensaje SOAP de respuesta OK [idAplicacion] [firmaUsuario]
Página 18
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
]]>
Los elementos resaltados se enumeran a continuación: •
idAplicacion: Identificador de la aplicación que hace la petición.
•
firmaUsuario: Firma digital de un “token” cualquiera ofrecido al usuario final por la aplicación cliente. El formato de firma debe ser CMS/PKCS#7 en modo attached y debe ir codificada en base64.
Validaciones Estos son las validaciones que se aplican al servicio web: •
idAplicacion: se comprueba que el identificador de la aplicación está admitido en el entorno actual.
•
Certificado: se comprueba que es correcto el certificado usado por la aplicación conectada (certificado de servidor) en la conexión SSL.
•
Firma de usuario: se comprueba que la firma del usuario (a través del token firmado) es correcta.
•
Certificado de la firma: se comprueba que el certificado del usuario obtenido del token firmado es correcto y válido.
•
Usuario: se comprueba que el usuario extraído del certificado usado para firmar el token está dado de alta en LexNet y habilitado para entrar al sistema.
Mensaje SOAP de respuesta OK
Página 19
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
[idSesion] [idAplicacion] ]]>
Los elementos resaltados se enumeran a continuación: •
idSesion: Identificador de la sesión que se desea terminar.
•
idAplicacion: Identificador de la aplicación desde la que se hace la petición de fin de sesión.
Validaciones Este servicio web no realiza ninguna comprobación.
Página 22
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Servicio web: ObtenerAvisos Descripción Esta operación devuelve la lista de avisos activos en la aplicación Lexnet para el usuario que ha hecho Login, indicando su importancia y si se trata de un Aviso de parada del sistema. La petición a este servicio emularía el funcionamiento de la aplicación vía web cuando se presenta al usuario, en la página de inicio, la lista de avisos de importancia crítica, o al pulsar el botón “Avisos” a través del cual se listan todos los avisos activos.
Definición WSDL
Página 23
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
Mensaje SOAP de petición: [idSesion] [idAplicacion]
Página 24
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
]]>
Los elementos resaltados se enumeran a continuación: •
idSesion: Identificador de la sesión.
•
idAplicacion: Identificador de la aplicación desde la que se hace la petición.
Validaciones Estos son las validaciones que se aplican al servicio web: •
idAplicacion: se comprueba que el identificador de la aplicación está admitido en el entorno actual.
•
idSesion: se comprueba que el identificador de sesión es correcto ya que el usuario previamente lo ha debido introducir con anterioridad. Tiene una caducidad máxima de 30 minutos.
Mensaje SOAP de respuesta OK [idSesion] [idAplicacion] [nombre] [codPartidoJudicial] [tipoOrgano] ]]>
Los elementos resaltados se enumeran a continuación: •
idSesion: Identificador de la sesión.
•
idAplicacion: Identificador de la aplicación desde la que se hace la petición.
•
nombre: Nombre del órgano judicial, Colegio o profesional que se desea obtener.
•
codPartidoJudicial: Código INE del partido judicial. En caso de no aparecer en la solicitud, se utiliza el código de población al que pertenece el usuario conectado.
•
tipoOrgano: Tipo de órgano. Sólo tiene sentido cuando se buscan órganos judiciales. Los posibles valores que puede tomar este parámetro tratan de seguir la misma filosofía que la del Consejo General del Poder Judicial: o
Valor: “10-19” Indica que se solicitan órganos judiciales relativos al Tribunal
Supremo, por ejemplo:
Primera.
Página 29
Tribunal
Supremo Civil. Sala
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
o
Valor: “20-29” Indica que se solicitan órganos judiciales relativos a la Audiencia Nacional, por ejemplo: Audiencia Nacional Penal. Sección Primera.
o
Valor: “30-39” Indica que se solicitan órganos judiciales relativos al Tribunal Superior y Audiencia Provincial, por ejemplo: Audiencia Provincial Penal nº 1.
o
Valor: “40-59” Indica que se solicitan órganos judiciales de tipo Juzgados, ejemplo: Juzgado de Primera Instancia nº 1.
Validaciones Estos son las validaciones que se aplican al servicio web: •
idAplicacion: se comprueba que el identificador de la aplicación está admitido en el entorno actual.
•
idSesion: se comprueba que el identificador de sesión es correcto ya que el usuario previamente lo ha debido introducir con anterioridad. Tiene una caducidad máxima de 30 minutos.
Mensaje SOAP de respuesta OK [idSesion] [idAplicacion] [codigoPoblacion] [tipoOrgano] [numeroOrgano] [dn] [nombre] ]]>
Página 35
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Los elementos resaltados se enumeran a continuación: •
idSesion: Identificador de la sesión.
•
idAplicacion: Identificador de la aplicación desde la que se hace la petición.
•
Elemento : Indica el destinatario para el cual se obtendrán los tipos de procedimiento que pueden utilizarse en envíos a aquél. En este ejemplo, se ha utilizado como destinatarios de los tipos de procedimiento un órgano judicial, pero también podría ser una entidad o un profesional: o
Elemento : Indica el órgano judicial codigoPoblacion: 5 dígitos del código de población al que pertenece el órgano. tipoOrgano: Identificador del tipo de órgano. numeroOrgano: Numeración del órgano. dn: Identificador en Lexnet del Órgano Judicial nombre: Nombre del órgano
Validaciones Estos son las validaciones que se aplican al servicio web: •
idAplicacion: se comprueba que el identificador de la aplicación está admitido en el entorno actual.
•
idSesion: se comprueba que el identificador de sesión es correcto ya que el usuario previamente lo ha debido introducir con anterioridad. Tiene una caducidad máxima de 30 minutos.
Página 36
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
Mensaje SOAP de respuesta OK : Define un tipo de procedimiento. codigo: Código del tipo de procedimiento texto: Nombre descriptivo del tipo de procedimiento leyAntigua: boolean que indica si el tipo de procedimiento es de la ley antigua.
Servicio web: ObtenerPendientes Descripción Esta operación devuelve, para cada tipo de mensaje, el número de mensajes pendientes de descarga por parte del usuario que ha hecho Login. Los números indicados se refieren a mensajes pendientes de descarga por parte del usuario desde el cliente de servicios web.
Definición WSDL
Página 38
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
Mensaje SOAP de petición: [idSesion] [idAplicacion] ]]>
Los elementos resaltados se enumeran a continuación: •
idSesion: Identificador de la sesión.
•
idAplicacion: Identificador de la aplicación desde la que se hace la petición.
Validaciones Estos son las validaciones que se aplican al servicio web: •
idAplicacion: se comprueba que el identificador de la aplicación está admitido en el entorno actual.
•
idSesion: se comprueba que el identificador de sesión es correcto ya que el usuario previamente lo ha debido introducir con anterioridad. Tiene una caducidad máxima de 30 minutos.
Mensaje SOAP de respuesta OK [idSesion] [idAplicacion] ]]>
Página 43
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
Los elementos resaltados se enumeran a continuación: •
idSesion: Identificador de la sesión.
•
idAplicacion: Identificador de la aplicación desde la que se hace la petición.
Validaciones Estos son las validaciones que se aplican al servicio web: •
idAplicacion: se comprueba que el identificador de la aplicación está admitido en el entorno actual.
•
idSesion: se comprueba que el identificador de sesión es correcto ya que el usuario previamente lo ha debido introducir con anterioridad. Tiene una caducidad máxima de 30 minutos.
Mensaje SOAP de respuesta OK [idSesion] [idAplicacion] [tipoMensaje] [fechaExacta] [fechaInicio] [fechaFin] [soloPendientes] [maxCabeceras]
Página 47
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
]]>
Los elementos resaltados se enumeran a continuación: •
idSesion: Identificador de la sesión.
•
idAplicacion: Identificador de la aplicación desde la que se hace la petición.
•
tipoMensaje: Tipo de los mensajes para los que se solicitan las cabeceras, puede ser: notificacion, acuse, recibi, escrito, etc.
•
fechaExacta: Fecha de envío/sellado de los mensajes cuyas cabeceras se solicitan. En la solicitud de cabeceras también se puede especificar un rango de fechas en lugar de una fecha exacta.
•
fechaInicio: fecha de envío/sellado inicial de los mensajes cuyas cabeceras se solicitan. Este parámetro no es obligatorio pero debe ir asociado con fechaFin para indicar un rango de fechas de mensajes.
•
fechaFin: fecha de envío/sellado final de los mensajes cuyas cabeceras se solicitan. Este parámetro no es obligatorio pero debe ir asociado con fechaInicio para indicar un rango de fechas de mensajes.
•
soloPendientes: Valor boolean. Si es true indica que, además de los filtros anteriores, sólo se desean obtener las cabeceras de aquellos mensajes que no se hubieran descargado previamente desde un cliente de servicios web. Si es false se descargarán todas las cabeceras que cumplan con el resto de filtros sin tener en cuenta si se han descargado previamente o no (Para obtener las cabeceras de mensajes leídos a través de la interfaz web o descargados por cualquier vía, es necesario indicar el rango de fechas a través de fechaInicio y fechaFin). Este parámetro no es obligatorio, así que puede no aparecer en la solicitud, para así mantener la compatibilidad con versiones anteriores de este servicio.
Página 48
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
•
maxCabeceras: Valor numérico. Indica el número máximo de caberas a obtener como respuesta. En caso de que se especifique, en la respuesta se obtienen las primeras cabeceras indicadas que cumplan el resto de filtros especificados en la solicitud. Por ejemplo, para un usuario con 350 notificaciones pendientes de descargar, si en la solicitud de indica como tipoMensaje “notificacion”, soloPendientes a “true” y maxCabeceras 200, el servicio le devolverá las cabeceras de las primeras 200 notificaciones pendientes de descarga, ordenadas por fecha de envio ascendente, es decir, la más antigua primero. Este parámetro se introduce para evitar posibles time-out en obtener una repuesta del servidor en caso de grandes vólumenes de mensajes. Este parámetro no es obligatorio, así que
puede
no
aparecer
en
la
solicitud,
para
así
mantener
la
compatibilidad con versiones anteriores de este servicio; no obstante, si no se indica, se le asigna por defecto el valor “500”.
Validaciones Estos son las validaciones que se aplican al servicio web: •
idAplicacion: se comprueba que el identificador de la aplicación está admitido en el entorno actual.
•
idSesion: se comprueba que el identificador de sesión es correcto ya que el usuario previamente lo ha debido introducir con anterioridad. Tiene una caducidad máxima de 30 minutos.
Mensaje SOAP de respuesta OK [idLexnet1] [fechaEnvio1] ... [idLexnetN] [leidoN] [fechaUltimaDescargaN] [codigoPoblacionN] [tipoOrganoN] [numeroOrganoN] [dnN] [nombreN] [asuntoN] [codigoN] [textoN] [leyAntiguaN]
Página 51
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
[numeroProcedimientoN] [referenciaN] [idExternoN] [nombreSistemaN] [fechaEnvioN]
Los elementos resaltados se enumeran a continuación: •
Elemento
:
Es
el
contenido
de
la
respuesta
de
ObtenerCabeceras, consiste en un array de elementos . o
Elemento : Elemento que define la cabecera de un mensaje. idLexnet: Identificador del mensaje en LexNET leido: boolean que indica si el mensaje ha sido leído o no. fechaUltimaDescarga: Si el mensaje ha sido descargado con anterioridad indica la fecha de la última descarga. Elemento : Consiste en un array de elementos Elemento : Contiene la definición de un origen, puede ser un órgano judicial, una entidad o un profesional. En el caso de este ejemplo es un órgano judicial. o
Elemento
:
órgano judicial origen del mensaje
Página 52
Describe
al
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
codigoPoblacion: 5 dígitos del código de población. tipoOrgano: Identificador del tipo de órgano. numeroOrgano:
Numeración
del
órgano. dn: Identificador en Lexnet del Órgano Judicial nombre: Nombre del órgano •
Elemento : Consiste en un array de elementos o
Elemento : Contiene la definición de un destino, puede ser un órgano judicial, una entidad o un profesional. En el caso de este ejemplo es una entidad esCopia: boolean que indica si el destinatario no es el destinatario principal del mensaje. Elemento
:
Describe
al
destinatario. Elemento
:
Describe
la
entidad. o
nombre: Nombre de la entidad
o
partidoJudicial: Código INE del partido
judicial
en
el
que
se
encuentra la entidad o
tipo: Define que tipo de entidad es. Ej: Colgio de Procuradores, de Abogados, de Graduados Sociales, etc.
Página 53
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
o
dn: Identificador en Lexnet de la Entidad
Elemento : Datos del mensaje. asunto: Título del mensaje. Elemento : Describe el tipo de procedimiento al que se refiere el mensaje. o
codigo: Código del tipo de procedimiento
o
texto:
Nombre
descriptivo
del
tipo
de
procedimiento o
leyAntigua: boolean que indica si el tipo de procedimiento es de la ley antigua.
numeroProcedimiento: Número de procedimiento referencia: Referencias del mensaje; observaciones añadidas por el remitente al enviar el mensaje. Elemento
:
Contiene
información específica del sistema que hace el envío. o
idExterno: Identificador del mensaje en el sistema cliente que realizó el envío
o
nombreSistema:
Nombre
identificativo
del
sistema cliente que realizó el envío. Elemento : Contiene el NIG del procedimiento si si venía especificado en el envío del mensaje por parte del Sistema de Gestión Procesal (SGP). Elemento
:
Contiene
el
texto del detalle del acontecimiento si el SGP lo especificó en el momento del envío del mensaje. fechaEnvio: Fecha en que se realizó el envío del mensaje.
Página 54
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
En el caso de que el usuario conectado pertenezca a un rol (Ej: abogado, fiscal, etc.) para el que sea obligatorio el envío de una verificación de lectura antes de la descarga del mensaje, la petición a este servicio sin haber enviado previamente la verificación de lectura, devolvería únicamente como respuesta el identificador del mensaje en LexNET y la fecha de envío del mismo. Por tanto, para este tipo de roles, la secuencia de petición a los servicios web LexNet para la descarga de la cabecera de un mensaje o del mensaje completo sería la siguiente: primero se enviaría la verificación de lectura (petición al servicio EnviarVerificacionLectura), posteriormente se descargaría la cabecera del mensaje (petición al servicio ObtenerCabecera) o el mensaje completo (petición al servicio ObtenerMensaje).
Servicio web: ObtenerMensaje Descripción Con esta operación se solicita la descarga de los datos de un mensaje en concreto de un usuario destinatario conreto. El servidor responde con los datos de dicho mensaje: datos de cabecera, destinos, adjuntos, firmantes y el tamaño de los bloques en los que se van a particionar los archivos adjuntos al mensaje que se descargarán a través del servicio web ObtenerBloque.
Definición WSDL
Página 55
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Página 56
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
Mensaje SOAP de petición: [idSesion] [idAplicacion] [idSujeto] [idLexnet] ]]>
Los elementos resaltados se enumeran a continuación: •
idSesion: Identificador de la sesión.
•
idAplicacion: Identificador de la aplicación desde la que se hace la petición.
•
idSujeto: Identificador del sujeto para el que se desea descargar el mensaje. Es un campo obligatorio para los administradores de Colegio de procuradores
y
administradores
de
delegación
de
Colegio
de
Procuradores. •
idLexnet: Identificador en LexNET del mensaje que se desea descargar
Validaciones Estos son las validaciones que se aplican al servicio web:
Página 57
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
•
idAplicacion: se comprueba que el identificador de la aplicación está admitido en el entorno actual.
•
idSesion: se comprueba que el identificador de sesión es correcto ya que el usuario previamente lo ha debido introducir con anterioridad. Tiene una caducidad máxima de 30 minutos.
•
idSujeto:
en
el
caso
de
Administradores
de
Procuradores
y
administradores de delegación es necesario introducir el idSujeto del usuario destinatario del mensaje que se desea descargar ya que el mismo mensaje puede estar asociado a varios usuarios a la vez. •
idLexnet: se comprueba que el valor introducido es un identifcador válido para un mensaje existente en el sistema. Además, para el caso de destinatarios que requieran la firma de una verificación de lectura (recibí) previo a la descarga del mensaje, también se comprueba que se haya enviado dicho recibí previamente.
Mensaje SOAP de respuesta OK [idSesion] [idAplicacion] [idLexnet] [idAdjunto] [idBloquePedido] ]]>
Los elementos resaltados se enumeran a continuación: •
idSesion: Identificador de la sesión.
•
idAplicacion: Identificador de la aplicación desde la que se hace la petición.
•
idLexnet: Identificador en LexNET del mensaje cuyos adjuntos se están descargando.
•
idAdjunto: Identificador del adjunto que se está descargando, debe coincidir con el identificador de adjunto que envía el servidor en la respuesta a la operación ObtenerMensaje.
•
idBloquePedido: Identificador del bloque solicitado.
Validaciones Estos son las validaciones que se aplican al servicio web: •
idAplicacion: se comprueba que el identificador de la aplicación está admitido en el entorno actual.
Página 66
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
•
idSesion: se comprueba que el identificador de sesión es correcto ya que el usuario previamente lo ha debido introducir con anterioridad. Tiene una caducidad máxima de 30 minutos.
•
idLexnet: se comprueba que el valor coincide con un mensaje existente y valido.
•
idAdjunto: se comprueba que el número del adjunto a descargar es válido.
•
idBloquePedido: se comprueba que el bloque pedido es consecutivo al último pedido para el fichero adjunto que se está descargando.
Mensaje SOAP de respuesta OK [idSesion] [idAplicacion] [idSujeto] [id] ]]>
Los elementos resaltados se enumeran a continuación: •
idSesion: (Obligatorio) Identificador de la sesión.
•
idAplicacion: (Obligatorio) Identificador de la aplicación desde la que se hace la petición.
•
idSujeto: Identificador del sujeto para el que se desea descargar el histórico del mensaje. Es un campo obligatorio para los administradores de Colegio de procuradores y administradores de delegación de Colegio
Página 69
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
de
Procuradores,
y
sólo
utilizable
por
usuarios
de
este
tipo
(administradores de Colegio o de delegación de procuradores) •
id: (Obligatorio) Identificador LexNET del mensaje del que se desea el histórico. Este identificador se puede conocer a través de la petición previa al servicio ObtenerCabecerasGeneral.
Validaciones Se aplicarán las mismas restricciones que existen para la descarga de mensajes. Estos son las validaciones que se aplican al servicio web: •
idAplicacion: se comprueba que el identificador de la aplicación es está adminitdo en el entorno acutal.
•
idSesion: se comprueba que el identificador de sesión es correcto ya que el usuario previamente lo ha debido introducir con anterioridad. Tiene una caducidad máxima de 30 minutos.
•
idSujeto:
en
el
caso
de
Administradores
de
Procuradores
y
administradores de delegación es necesario introducir el idSujeto del usuario destinatario del mensaje que se desea descargar ya que el mismo mensaje puede estar asociado a varios usuarios a la vez. •
id: se comprueba que el valor introducido es un identifcador valido para un mensaje existente.
Mensaje SOAP de respuesta OK [idLexnet]
Página 70
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
[fechaAccion] [idAccion] [desAccion] [idTipoMensaje] [desTipoMensaje] [nombre] [partidoJudicial] [tipo] [idSujeto] [codigoPoblacion] [tipoOrgano] [numeroOrgano] [idSujeto] [nombre] [nif] [nombre] [apellido1] [apellido2] [email] [idSujeto] [tipo] [codigoColegiado] [nombre_entidad] [partidoJudicial] [tipo_entidad] [idSujeto_entidad] [nombre] [partidoJudicial] [tipo] [idSujeto] [codigoPoblacion] [tipoOrgano] [numeroOrgano] [idSujeto] [nombre] [nif] [nombre] [apellido1] [apellido2] [email] [idSujeto] [tipo] [codigoColegiado] [nombre_entidad] [partidoJudicial] [tipo_entidad]
Página 71
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
[idSujeto_entidad] ]]>
Los elementos resaltados se enumeran a continuación: •
id: (Obligatorio) Identificador del mensaje en LexNET
•
Elemento : (Obligatorio) Consiste en un array de elementos o
Elemento : (Obligatorio si el tag padre existe) Contiene los datos de una acción realizada. o
fechaAccion: (Obligatorio) Indica la fecha y hora de la acción.
o
idAccion: (Obligatorio) identificador Lexnet de la acción realizada
o
desAccion: (Obligatorio) descripción de la acción realizada
o
idTipoMensaje: (Obligatorio)
identificador Lexnet del tipo de
mensaje o
desTipoMensaje: (Obligatorio) descripción del tipo de mesaje
o
Elemento : (Obligatorio) Contiene la definición de un origen o emisor de la acción, puede ser un órgano judicial, una entidad o un profesional. Elemento
:
Describe
una
entidad
de
profesionales, que puede ser un colegio de abogados, de procuradores, etc. nombre:
(Obligatorio
si
el
tag
padre
existe)
Nombre de la entidad partidoJudicial: Código INE del partido judicial
Página 72
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
tipo:
(Obligatorio
si
el
tag
padre
existe)
identificador del tipo de entidad. Ver anexo I. idSujeto: (Obligatorio si el tag padre existe) Identificador único de la Entidad de LexNET Elemento : Describe un órgano judicial. codigoPoblacion: (Obligatorio si el tag padre existe) código de población. tipoOrgano: (Obligatorio si el tag padre existe) Identificador del tipo de órgano, determina la jurisdicción. numeroOrgano:
(Obligatorio
si
el
tag
padre
existe) Numeración del órgano. idSujeto: (Obligatorio si el tag padre existe) Identificador único del órgano de LexNET nombre:
(Obligatorio
si
el
tag
padre
existe)
una
persona
Nombre del órgano Elemento
:
Describe
a
colegiada Procurador, Abogado o Graduado Social. nif: (Obligatorio si el tag padre existe) NIF del profesional nombre:
(Obligatorio
si
el
tag
padre
existe)
Nombre del profesional apellido1: (Obligatorio si el tag padre existe) Primer apellido del profesional apellido2: Segundo apellido del profesional, si existe email: Correo electrónico del profesional
Página 73
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
idSujeto: (Obligatorio si el tag padre existe) Identificador único del profesional de LexNET (Obligatorio
tipo:
si
el
tag
padre
existe)
identificador del tipo de usuario. Ver anexo I. codigoColegiado:
número
de
colegiado
del
profesional dentro del colegio al que pertenece, se aplica a profesionales colegiados: procuradores, abogados, graduados sociales, etc. Elemento : Describe la entidad a la que pertenece el profesional
o
Elemento : Describe al destinatario de la acción. Elemento : Describe una entidad que puede ser una Fiscalía Abogacía del Estado, colegio de abogados, de procuradores, etc. nombre: (Obligatorio si el tag padre existe) Nombre de la entidad partidoJudicial: Código INE del partido judicial tipo: (Obligatorio si el tag padre existe) identificador del tipo de entidad. Ver anexo I. idSujeto:
(Obligatorio
si
el
tag
padre
existe)
Identificador único de la Entidad de LexNET Elemento : Describe un órgano judicial. codigoPoblacion: (Obligatorio si el tag padre existe) código de población.
Página 74
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
tipoOrgano: (Obligatorio si el tag padre existe) Identificador del tipo de órgano. numeroOrgano: (Obligatorio si el tag padre existe) Numeración del órgano. idSujeto:
(Obligatorio
si
el
tag
padre
existe)
Identificador único del órgano de LexNET nombre: (Obligatorio si el tag padre existe) Nombre del órgano Elemento : Describe a una persona colegiada Procurador, Abogado o Graduado Social nif: (Obligatorio si el tag padre existe) NIF del profesional nombre: (Obligatorio si el tag padre existe) Nombre del profesional apellido1: (Obligatorio si el tag padre existe) Primer apellido del profesional apellido2: Segundo apellido del profesional, si existe email: Correo electrónico del profesional idSujeto:
(Obligatorio
si
el
tag
padre
existe)
Identificador único del profesional de LexNET tipo: (Obligatorio si el tag padre existe) identificador del tipo de usuario. Ver anexo I. codigoColegiado:
número
de
colegiado
del
profesional dentro del colegio al que pertenece, se aplica
a
profesionales
colegiados:
procuradores,
abogados, graduados sociales, etc. Elemento : Describe la entidad a la que pertenece el profesional
Página 75
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Servicio web: EnviarMensaje Descripción Este servicio se utiliza para informar al sistema de la intención de enviar un mensaje. En la petición a este servicio web, el cliente enviará los datos del mensaje (destinatarios, título, referencia externa, nombres de los adjuntos, etc.) que posteriormente se remitirá. Tras validar los datos recibidos, el servidor LexNet devolverá una plantilla de mensaje, junto con el identificador del envío. El formato de la plantilla de mensaje devuelto por LexNet dependerá del tipo de firma utilizada por el integrador (SMIME o CADES) y que habrá sido indicado en la petición. La plantilla incluirá los datos principales del mensaje según lo enviado en la petición. El cliente de los servicios web LexNet deberá añadir a esa plantilla el contenido físico de los datos adjuntos y firmarla con la clave privada del usuario remitente. En el apartado Guía de cumplimentación de las plantillas de mensaje de envío al final de este documento, se encuentra una explicación detallada acerca de los dos formatos de plantilla posibles (MIME y CADES) devueltos por LexNet en respuesta a la petición, junto con una explicación acerca de cómo completar y firmar dichas plantillas. El mensaje resultante (plantilla enviada por LexNet completada por el cliente con datos adjuntos, firmas, etc.) será enviado por fragmentos a LexNet, utilizando la operación EnviarBloque (para lo cual se precisará el identificador del envío devuelto por EnviarMensaje).
Definición WSDL
Página 77
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
Mensaje SOAP de petición: [idSesion] [idAplicacion] [asunto] [codigo] [texto] [leyAntigua] [numeroProcedimiento] [referencia] [idExterno] [nombreSistema] [esCopia] [codigoPoblacion]
Página 78
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
[tipoOrgano] [numeroOrgano] [dn] [nombre] [nif] [nombre] [apellido1] [apellido2] [email] [idSujeto] [tipo] [codigoColegiado] [nombre_entidad] [partidoJudicial] [tipo_entidad] [idSujeto_entidad]
[idAdjunto] [nombre] [esPrincipal] [cades] ]]>
Página 79
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Los elementos resaltados se enumeran a continuación: •
idSesion: Identificador de la sesión.
•
idAplicacion: Identificador de la aplicación desde la que se hace la petición.
•
Elemento : Datos del mensaje. o
asunto: Título del mensaje.
o
Elemento : Describe el tipo de procedimiento al que se refiere el mensaje. codigo: Código del tipo de procedimiento texto: Nombre descriptivo del tipo de procedimiento leyAntigua: boolean que indica si el tipo de procedimiento es de la ley antigua.
o
numeroProcedimiento: Número de procedimiento
o
referencia: Referencias del mensaje, observaciones.
o
Elemento : Contiene información específica del sistema que hace el envío. idExterno: Identificador del mensaje en el sistema cliente que solicita el envío nombreSistema: Nombre del sistema cliente con el que se solicita el envío.
•
Elemento : Consiste en un array de elementos o
Elemento : Contiene la definición de un destino, puede ser un órgano judicial, una entidad o un profesional. En el caso de este ejemplo es un órgano judicial esCopia: boolean que indica si el destinatario no es el destinatario principal del mensaje. Elemento : Describe al destinatario.
Página 80
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
Elemento
:
Describe
al
órgano
judicial destino del mensaje o
codigoPoblacion:
5
dígitos del
código de
población. o
tipoOrgano: Identificador del tipo de órgano.
o
numeroOrgano: Numeración del órgano.
o
dn: Identificador de Lexnet del Órgano Judicial
o
nombre: Nombre del órgano
Elemento : Describe a una persona colegiada: Procurador, Abogado o Graduado Social. o
nif: NIF del profesional
o
nombre: Nombre del profesional
o
apellido1: Primer apellido del profesional
o
apellido2: Segundo apellido del profesional, si existe
o
email: Correo electrónico del profesional
o
dn: Identificador de Lexnet del profesional
o
tipo: Tipo de profesional: Procurador, abogado, abogado del Estado, etc.
o
codigo: Código del profesional en LexNET
o
codigoColegiado:
Código de colegiado del
profesional dentro del colegio al que pertenece o
Elemento : Describe la entidad a la que pertenece el profesional Elemento
:
Describe
entidad. •
Página 81
nombre: Nombre de la entidad
la
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
•
partidoJudicial: Código INE del partido judicial
•
tipo: Define que tipo de entidad es:
De
Procuradores,
Abogados,
de
de
Graduados
Sociales. •
dn: Identificador de Lexnet de la Entidad
•
Elemento : Consiste en un array de elementos o
Elemento : Describe un fichero adjunto: idAdjunto: Identificador del adjunto. (numérico entre 0 y 99) nombre: Nombre del fichero esPrincipal: boolean que indica que el adjunto es el documento principal del mensaje.
•
cades: boolean que indica si deseas realizar el envio en CADES o SMIME.
Validaciones Estos son las validaciones que se aplican al servicio web: •
idAplicacion: se comprueba que el identificador de la aplicación está admitido en el entorno actual.
•
idSesion: se comprueba que el identificador de sesión es correcto ya que el usuario previamente lo ha debido introducir con anterioridad. Tiene una caducidad máxima de 30 minutos.
•
destinos: se comprueban que todos los destinatarios son válidos para la entidad o usuario remitente logados y el tipo de mensaje enviado.
Página 82
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
•
adjuntos: se comrpueban que los adjuntos introducidos son correctos. Se comrpueba la extensión del fichero principal y anexos además del número de los mismos.
•
tipoProcedimiento: se comprueba que el procedimiento es válido para el órgano judicial interviniente en el mensaje.
•
numeroProcedimiento: se comprueba que el número de procedimiento es válido.
Mensaje SOAP de respuesta OK [idSesion] [idAplicacion] [idEnvio] [idBloqueEnviado] [esUltimo] [bytesContenido] ]]>
Los elementos resaltados se enumeran a continuación: •
idSesion: Identificador de la sesión.
•
idAplicacion: Identificador de la aplicación desde la que se hace la petición.
•
idEnvio: Identificador de envío asignado por el servidor en la respuesta a la petición de EnviarMensaje.
Página 86
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
•
idBloqueEnviado: El cliente especifica el número del bloque que está enviando. El servidor LexNet espera los bloques en orden secuencial.
•
esUltimo: boolean que le indica al servidor que se trata del último bloque del S/MIME que se está enviando
•
bytesContenido: bytes del bloque del SMIME codificado en base64.
Validaciones Estos son las validaciones que se aplican al servicio web: •
idAplicacion: se comprueba que el identificador de la aplicación está admitido en el entorno actual.
•
idSesion: se comprueba que el identificador de sesión es correcto ya que el usuario previamente lo ha debido introducir con anterioridad. Tiene una caducidad máxima de 30 minutos.
•
idEnvío: se comprueba que el identificador del envio ha sido obtenido anteriormente por el servicio ObtenerMensaje.
•
idBloqueEnviado: se comprueba que el bloque a enviar es consecutivo al último recibido correctamente.
•
bytesContenido: se comprueba que los datos del bloque están codificados correctamente en Base64 y tienen la longuitud correcta.
Mensaje SOAP de respuesta OK [idSesion] [idAplicacion] [idLexnet] [cades] ]]>
Los elementos resaltados se enumeran a continuación: •
idSesion: Identificador de la sesión.
•
idAplicacion: Identificador de la aplicación desde la que se hace la petición.
•
idLexnet: Identificador en LexNET del mensaje para el cual se quiere enviar una verificación de Lectura.
•
cades: boolean que indica si deseas realizar el envio en CADES o SMIME.
Validaciones Estos son las validaciones que se aplican al servicio web: •
idLexnet: se comprueba que el mensaje asociado a la verificación de lectura a enviar, existe y no ha sido verificado antes.
•
Remitente: se comprueba que el usuario o entidad logados tienen la funcionalidad de enviar verificaciones de lectura.
Página 91
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
Mensaje SOAP de respuesta OK [idSesion] [idAplicacion] [idLexnet] ]]>
Página 94
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Los elementos resaltados se enumeran a continuación: •
idSesion: Identificador de la sesión.
•
idAplicacion: Identificador de la aplicación desde la que se hace la petición.
•
idLexnet: Identificador en LexNET del mensaje para el cual se ha terminado la descarga de sus ficheros adjuntos.
Validaciones Este servicio no contiene ninguna validación.
Página 95
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Servicio web: Repartir Descripción Este servicio es exclusivo para usuarios con rol Administrador del Colegio de procuradores o Administrador de Delegación de Colegio de Procuradores. Este servicio reliza el reparto de aquellas notificaciones que tenga el colegio de procuradores del administrador logado en su bandeja de entrada.
Definición WSDL
Página 96
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
Mensaje SOAP de petición: [idSesion] [idAplicacion] [idLexnet] [idSujeto] ]]>
Página 97
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Los elementos resaltados se enumeran a continuación: •
idSesion: Identificador de la sesión.
•
idAplicacion: Identificador de la aplicación desde la que se hace la petición.
•
idLexNet: Identificador en LexNET del mensaje que se quiere repartir. Este parametro no es obligatorio pero en caso de introducirse, debe ir asociado con un sujeto específico receptor del mensaje (idSujeto); en el caso de que no se introduza idLexNet, se procederá al reparto de todas las notificaciones del buzón de entrada del Colegio del usuario logado.
•
idSujeto: Identificador en LexNET del sujeto al cual se quiere repartir el mensaje. Este parámetro no es obligatorio pero, en caso de aparecer, debe ir asociado con idLexNet; en el caso de que no se introduza se procederá al reparto de todas las notificaciones del buzón de entrada del Colegio del usuario logado.
Validaciones Estas son las validaciones que se aplican al servicio web: •
idAplicacion: se comprueba que el identificador de la aplicación está admitido en el entorno actual.
•
idSesion: se comprueba que el identificador de sesión es correcto ya que el usuario previamente lo ha debido introducir con anterioridad. Tiene una caducidad máxima de 30 minutos.
•
idLexNet: se comprueba que el identificador pertenece a un mensaje existente y válido y que el mensaje puede ser repartido. Sólo se valida si el campo no está vacio.
•
idSujeto: se comprueba que el identifcador de sujeto introducido existe. Sólo se valida si se ha introducido un valor de idSujeto.
Página 98
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
•
Usuario: se comprueba que el usuario que ejecuta el servicio tiene el rol de Administrador de Procuradores o de Administrador de Delegación de procuradores.
•
Colegio: se comprueba que el colegio de procuradores que desea repartir el mensaje tiene activado el reparto manual.
Mensaje SOAP de respuesta OK [idSesion] [idAplicacion]
Página 101
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
[idLexnet] [idSujeto] [fecha] [fechaInicio] [fechaFin] ]]>
Los elementos resaltados se enumeran a continuación: •
idSesion: Identificador de la sesión.
•
idAplicacion: Identificador de la aplicación desde la que se hace la petición.
•
idLexNet: Identificador en LexNET del mensaje para el cual se quiere obtener
la
fecha
de
recogida/aceptación.
Este
parámetro
no
es
obligatorio pero debe ir asociado con idSujeto; en el caso de que no se introduzca se procede a buscar los mensajes por el rango de fechas. •
idSujeto: Identificador en LexNET del sujeto para el cual se quiere obtener
la
fecha
de
aceptación/recogida.
Este
parámetro
no
es
obligatorio pero debe ir asociado con idLexNet; en el caso de que no se introduzca se procede a buscar los mensajes por el rango de fechas. •
fecha: fecha de aceptación de los mensajes que se desean obtener. Este parámetro no es obligatorio; en el caso de que no se introduzca se procede a buscar los mensajes por el rango de fechas de inicio/fin o por idLexNet/idSujeto.
•
fechaInicio: fecha de aceptación de inicio de los mensajes que se desean obtener. Este parámetro no es obligatorio pero debe ir asociado con fechaFin; en el caso de que no se introduzca se procede a buscar los mensajes por idLexNet/idSujeto.
Página 102
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
•
fechaFin: fecha de aceptación de fin de los mensajes que se desean obtener. Este parámetro no es obligatorio pero debe ir asociado con fechaInicio; en el caso de que no se introduzca se procede a buscar los mensajes por idLexNet/idSujeto.
Validaciones Estos son las validaciones que se aplican al servicio web: •
idAplicacion: se comprueba que el identificador de la aplicación está admitido en el entorno actual.
•
idSesion: se comprueba que el identificador de sesión es correcto ya que el usuario previamente lo ha debido introducir con anterioridad. Tiene una caducidad máxima de 30 minutos.
•
fechaInicio – fechaFin: se comprueba que la fecha de fin es posterior a la fecha de inicio en la búsqueda de mensajes aceptados/recogidos. Solo se valida si no se ha introducido el campo fechaExacta.
Mensaje SOAP de respuesta OK
Página 106
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
[idSesion] [idAplicacion] [idLexnet] [idSujeto] ]]>
Los elementos resaltados se enumeran a continuación: •
idSesion: Identificador de la sesión.
•
idAplicacion: Identificador de la aplicación desde la que se hace la petición.
•
idLexnet: Identificador en LexNET del mensaje que se desea asumir.
•
idSujeto: Identificador del sujeto para el que se desea aumir el mensaje.
Validaciones Estos son las validaciones que se aplican al servicio web: •
idAplicacion: se comprueba que el identificador de la aplicación está admitido en el entorno actual.
•
idSesion: se comprueba que el identificador de sesión es correcto ya que el usuario previamente lo ha debido introducir con anterioridad. Tiene una caducidad máxima de 30 minutos.
•
idLexNet: se comprueba que el identificador pertenece a un mensaje existente y válido. Además se comprueba que el mensaje puede ser asumido.
•
idSujeto: se comprueba que el identificador de sujeto existe
Página 107
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
•
Usuario: se comprueba que el usuario que ejecuta el servicio tiene el rol de Administrador de Procuradores o de Administrador de Delegación de procuradores.
Mensaje SOAP de respuesta OK [idSesion] [idAplicacion] [nif] [idSujeto] [codigoColegiado] [codigoColegio] ]]>
Los elementos resaltados se enumeran a continuación: •
idSesion: Identificador de la sesión.
•
idAplicacion: Identificador de la aplicación desde la que se hace la petición.
•
nif: NIF del procurador para el que se desean conocer sus datos en Lexnet. Elemento opcional que sólo se rellenará si la petición es para obtener los datos de un procurador en específico.
•
idSujeto: identificador en Lexnet del procurador para el que se desean conocer sus datos en Lexnet. Elemento opcional que sólo se rellanará si la petición es para obtener los datos de un procurador en específico.
•
datosColegiado: Elemento opcional que sólo se rellanará si la petición es para obtener los datos de un único procurador, indicando el código de colegiado y el código del Colegio al que pertenece(sólo necesario si el procurador solicitado pertenece a un colegio distinto al que pertenece el administrador de colegio logado):
Página 116
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
o
codigoColegiado: Número de colegiado en el Colegio al que pertenece del procurador para el que se quieren obtener los datos. Si es un procurador de un Colegio distinto al del administrador logado, hay que rellenar además codigoColegio.
o
codigoColegio: Código del Colegio al que pertenece el procurador para el que se desean obtener los datos. Sólo es necesario rellenarlo para obtener los datos de procuradores de Colegios distintos a aquél al que pertenece el administrador logado.
Nota: En una petición para obtener los datos de un único procurador, bien sea de su Colegio o no, si se rellena el parámetro “nif” y el parámetro “códigoColegiado” se devolverán aquellos procuradores que cumplan
la
siguiente
condición:
nifProcurador=nifParametro
OR
codigoColegiadoProcurador=codigoColegiadoParametro, por lo que el servicio web puede devolver más de un procurador.
Validaciones Estos son las validaciones que se aplican al servicio web: •
idAplicacion: se comprueba que el identificador de la aplicación está admitido en el entorno actual.
•
idSesion: se comprueba que el identificador de sesión es correcto ya que el usuario previamente lo ha debido introducir con anterioridad. Tiene una caducidad máxima de 30 minutos.
•
Usuario: se comprueba que el usuario que ejecuta el servicio tiene el rol de Administrador de Procuradores o de Administrador de Delegación de procuradores.
Mensaje SOAP de respuesta OK
Página 117
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
[idSesion] [idAplicacion] ]]>
Página 122
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Los elementos resaltados se enumeran a continuación: •
idSesion: Identificador de la sesión.
•
idAplicacion: Identificador de la aplicación desde la que se hace la petición.
Validaciones Estos son las validaciones que se aplican al servicio web: •
idAplicacion: se comprueba que el identificador de la aplicación está admitido en el entorno actual.
•
idSesion: se comprueba que el identificador de sesión es correcto ya que el usuario previamente lo ha debido introducir con anterioridad. Tiene una caducidad máxima de 30 minutos.
•
Usuario: se comprueba que el usuario que ejecuta el servicio tiene el rol de Administrador de Procuradores o de Administrador de Delegación de procuradores.
•
Colegio: se comprueba que el Colegio de Procuradores al que pertenece el administrador logado tiene activado el reparto manual.
Mensaje SOAP de respuesta OK
Página 123
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
[numPendientes] [tipoMensaje]
Los elementos resaltados se enumeran a continuación: •
Elemento
:
Es
el
contenido
de
la
respuesta
de
ObtenerPendientesRepartir que consiste en un array de elementos . Para este servicio web se ha reutilizado la estructura utilizada en la respuesta del servicio web ObtenerPendientes, aunque en la actualidad, el único tipo de mensaje que se reparte en el Colegio de Procuradores son las notificacioesn, con lo cual la respuesta solo constará de un elemento . Elemento : Elemento que define un subtotal de mensajes pendientes de repartir compuesto por el tipo de mensaje y el total de mensajes pendientes de repartir para ese tipo de mensaje. numPendientes: total de mensajes pendientes de repartir a procuradores del mismo Colegio que el administrador logado. tipoMensaje: Para el caso del servicio ObtenerPendientesRepartir el tipo de mensaje será siempre “notificacion” ya que, en la actualidad, es el único tipo de mensaje que se reparte en el colegio de procuradores.
Página 124
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Servicio web: ObtenerPendientesRepartirOtros Descripción Este servicio sólo es válido para usuario con roles de administrador de Colegio de Procuradores o de administrador de delegación de Colegio de procuradores de Colegios que tengan activado el reparto manual. Este servicio permite al cliente de los servicios web LexNet obtener el número de notificaciones dirigidas a procuradores colegiados en Colegios distintos al Colegio del administrador logado, pendientes de repartir.
Definición WSDL
Página 125
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Mensaje SOAP de petición: [idSesion] [idAplicacion] ]]>
Página 126
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Los elementos resaltados se enumeran a continuación: •
idSesion: Identificador de la sesión.
•
idAplicacion: Identificador de la aplicación desde la que se hace la petición.
Validaciones Estos son las validaciones que se aplican al servicio web: •
idAplicacion: se comprueba que el identificador de la aplicación está admitido en el entorno actual.
•
idSesion: se comprueba que el identificador de sesión es correcto ya que el usuario previamente lo ha debido introducir con anterioridad. Tiene una caducidad máxima de 30 minutos.
•
Usuario: se comprueba que el usuario que ejecuta el servicio tiene el rol de Administrador de Procuradores o de Administrador de Delegación de procuradores.
•
Colegio: se comprueba que el colegio de Procuradores tiene activado el reparto manual.
Mensaje SOAP de respuesta OK
Página 127
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
[numPendientes] [tipoMensaje]
Los elementos resaltados se enumeran a continuación:
•
Elemento
:
Es
el
contenido
de
la
respuesta
de
ObtenerPendientesRepartirOtros; consiste en un array de elementos . Para este servicio web se ha reutilizado la estructura utilizada en la respuesta del servicio web ObtenerPendientes, aunque el la actualidad, el único tipo de mensaje que se reparte en el Colegio de Procuradores son las notificaciones, con lo cual la respuesta solo constará de un elemento . Elemento : Elemento que define un subtotal de mensajes pendientes de repartir a procuradores de otro Colegio. Está compuesto por el tipo de mensaje y el total de mensajes pendientes de repartir para ese tipo de mensaje. numPendientes: total de mensajes pendientes de repartir a procuradores colegiados en un Colegio distinto al del administrador logado. tipoMensaje:
Para
el
caso
del
servicio
ObtenerPendientesRepartirOtros el tipo de mensaje será siempre “notificacion” ya que, en la actualidad, es el único tipo de mensaje que se reparte en el colegio de procuradores.
Página 128
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Servicio web: ObtenerCabecerasPendientesRepartir Descripción Este servicio sólo es válido para usuarios con roles de administrador de Colegio de Procuradores o de administrador de delegación de Colegio de procuradores de Colegios que tengan activado el reparto manual. Este servicio permite al cliente de servicios web LexNet obtener las cabeceras de las notificaciones pendientes de repartir a procuradores pertenecientes al mismo Colegio que el administrador logado. El servidor LexNet devuelve una lista con las cabeceras de las notificaciones pendientes de repartir a procuradores del mismo Colegio que el administrador logado, que cumplan unas condiciones: fecha exacta y rango de fechas. Los parámetros “tipo de mensaje” y solo mensajes pendientes de descarga se mantienen para
la compatibilidad con el mensaje de solicitud del servicio
ObtenerCabeceras.
Definición WSDL
Página 129
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
name="ObtenerCabecerasPendientesRepartirServiceSoap"
Mensaje SOAP de petición: [idSesion] [idAplicacion] [tipoMensaje] [fechaExacta] [fechaInicio] [fechaFin] [soloPendientes] [maxCabeceras] ]]>
Los elementos resaltados se enumeran a continuación: •
idSesion: Identificador de la sesión.
•
idAplicacion: Identificador de la aplicación desde la que se hace la petición.
•
tipoMensaje: Se mantiene por compatibilidad con el xml de solicitud del servicio ObtenerCabeceras, pero para este servicio web sólo se tienen en cuenta las notificaciones, ya que son el único tipo de mensaje que se puede repartir.
•
fechaExacta: Fecha de envío de los mensajes cuyas cabeceras se solicitan. En la solicitud de cabeceras también se puede especificar un rango de fechas (a través de fechaInicio y fechaFin) en lugar de una fecha exacta.
•
fechaInicio: Fecha de inicio de los mensajes cuyas cabeceras se solicitan.
Página 131
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
•
fechaFin: Fecha de fin de los mensajes cuyas cabeceras se solicitan.
•
soloPendientes: Valor boolean. Se mantiene por compatibilidad con el xml de solicitud del servicio ObtenerCabeceras, pero para este servicio web no se tiene en cuenta.
•
maxCabeceras: Valor numérico. Indica el número máximo de caberas a obtener como respuesta. En caso de que se especifique, en la respuesta se obtienen las primeras “maxCabeceras” cabeceras que cumplan el resto de condiciones especificadas en la solicitud. Por ejemplo, para un usuario
con
350
notificaciones
pendientes
de
repartir,
si
en
maxCabeceras se especifica 200, el servicio le devolverá las cabeceras de las primeras 200 notificaciones pendientes de repartir, ordenadas por fecha de envio ascendente, es decir, la más antigua primero. Este parámetro se introduce para evitar posibles time-out a la hora de obtener una repuesta del servidor para grandes vólumenes de mensajes. Este parámetro no es obligatorio, así que puede no aparecer en la solicitud, para así mantener la compatibilidad con versiones anteriores de este servicio; no obstante, si no se indica se le asigna por defecto el valor “500”.
Validaciones Estos son las validaciones que se aplican al servicio web: •
idAplicacion: se comprueba que el identificador de la aplicación está admitido en el entorno actual.
•
idSesion: se comprueba que el identificador de sesión es correcto ya que el usuario previamente lo ha debido introducir con anterioridad. Tiene una caducidad máxima de 30 minutos.
•
Usuario: se comprueba que el usuario que ejecuta el servicio tiene el rol de Administrador de Procuradores o de Administrador de Delegación de procuradores.
•
Colegio: se comprueba que el colegio de Procuradores tiene activado el reparto manual.
Página 132
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
Mensaje SOAP de respuesta OK [idSesion] [idAplicacion] [tipoMensaje] [fechaExacta] [fechaInicio] [fechaFin] [soloPendientes] [maxCabeceras] ]]>
Los elementos resaltados se enumeran a continuación: •
idSesion: Identificador de la sesión.
•
idAplicacion: Identificador de la aplicación desde la que se hace la petición.
•
tipoMensaje: Se mantiene por compatibilidad con el xml de solicitud del servicio ObtenerCabeceras, pero para este servicio web solo se tienen en cuenta las notificaciones, ya que son el único tipo de mensaje que se puede repartir.
Página 140
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
•
fechaExacta: Fecha de envío los mensajes cuyas cabeceras se solicitan. En la solicitud de cabeceras también se puede especificar un rango de fechas (a través de fechaInicio y fechaFin) en lugar de una fecha exacta.
•
fechaInicio: Fecha de envío inicial de los mensajes cuyas cabeceras se solicitan.
•
fechaFin: Fecha de envío final de los mensajes cuyas cabeceras se solicitan.
•
soloPendientes: Valor boolean. Se mantiene por compatibilidad con el xml de solicitud del servicio ObtenerCabeceras, pero para este servicio web no se tiene en cuenta.
•
maxCabeceras: Valor numérico. Indica el número máximo de caberas a obtener como respuesta. En caso de que se especifique, en la respuesta se obtienen las primeras “maxCabeceras” cabeceras que cumplan el resto de condiciones especificadas en la solicitud. Por ejemplo, para un usuario con 350 notificaciones pendientes de repartir a procuradores de otros Colegio, si en maxCabeceras especifica 200, el servicio le devolverá cabeceras de las primeras 200 notificaciones pendientes de repartir a procuradores
de
otros
Colegios,
ordenadas
por
fecha
de
envio
ascendente, es decir, la más antigua primero. Este parámetro se introduce para evitar posibles time-out en obtener una repuesta del servidor para grandes vólumenes de mensajes. Este parámetro no es obligatorio, así que puede no aparecer en la solicitud, para así mantener la compatibilidad con versiones anteriores de este servicio; no obstante, si no se indica se le asigna por defecto el valor “500”.
Validaciones Estos son las validaciones que se aplican al servicio web: •
idAplicacion: se comprueba que el identificador de la aplicación está admitido en el entorno actual.
Página 141
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
•
idSesion: se comprueba que el identificador de sesión es correcto ya que el usuario previamente lo ha debido introducir con anterioridad. Tiene una caducidad máxima de 30 minutos.
•
Usuario: se comprueba que el usuario que ejecuta el servicio tiene el rol de Administrador de Procuradores o de Administrador de Delegación de procuradores.
•
Colegio: se comprueba que el Colegio de Procuradores del administrador logado tiene activado el reparto manual.
Mensaje SOAP de respuesta OK [idSesion] [idAplicacion] [soloPendientes] [fechaExacta] [fechaInicio] [fechaFin] [idLexnet] [idSujeto] [maxCabeceras] ]]>
Los elementos resaltados se enumeran a continuación: •
idSesion: Identificador de la sesión.
•
idAplicacion: Identificador de la aplicación desde la que se hace la petición.
•
fechaExacta: Fecha de envío de los mensajes cuyas cabeceras se solicitan. En la solicitud de cabeceras también se puede especificar un rango de fechas (a través de fechaInicio y fechaFin) en lugar de una fecha exacta.
Página 149
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
•
fechaInicio: Fecha de inicio de los mensajes cuyas cabeceras se solicitan.
•
fechaFin: Fecha de fin de los mensajes cuyas cabeceras se solicitan.
•
soloPendientes: Valor boolean. Si es true indica que, además de los filtros anteriores, sólo se desean obtener las cabeceras de aquellos mensajes que no se hubieran descargado previamente desde un cliente de servicios web. Si es false se descargarán todas las cabeceras que cumplan con el resto de filtros sin tener en cuenta si se han descargado previamente o no (Para obtener las cabeceras de mensajes leídos a través de la interfaz web o descargados por cualquier vía, es necesario indicar el rango de fechas a través de fechaInicio y fechaFin). Este parámetro no es obligatorio.
•
idLexnet (opcional): Identificador de la notificación sobre la cual se solicita su cabecera.
•
idSujeto (opcional): Identificador del sujeto lexnet destinatario de la notificación (procurador).
•
maxCabeceras: Valor numérico. Indica el número máximo de caberas a obtener como respuesta. En caso de que se especifique, en la respuesta se obtienen las primeras “maxCabeceras” cabeceras que cumplan el resto de condiciones especificadas en la solicitud. Por ejemplo, para un usuario
con
350
notificaciones
pendientes
de
asumir,
si
en
maxCabeceras se especifica 200, el servicio le devolverá las cabeceras de las primeras 200 notificaciones pendientes de asumir, ordenadas por fecha de envio ascendente, es decir, la más antigua primero. Este parámetro se introduce para evitar posibles time-out a la hora de obtener una repuesta del servidor para grandes vólumenes de mensajes. Este parámetro no es obligatorio, así que puede no aparecer en la solicitud, para así mantener la compatibilidad con versiones anteriores de este servicio; no obstante, si no se indica se le asigna por defecto el valor “500”.
Página 150
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
Validaciones Estos son las validaciones que se aplican al servicio web: •
idAplicacion: se comprueba que el identificador de la aplicación está admitido en el entorno actual.
•
idSesion: se comprueba que el identificador de sesión es correcto ya que el usuario previamente lo ha debido introducir con anterioridad. Tiene una caducidad máxima de 30 minutos.
•
Usuario: se comprueba que el usuario que ejecuta el servicio tiene el rol de Administrador de Procuradores o de Administrador de Delegación de procuradores.
•
idLexnet: Si está relleno, se comprobará que está asociado al colegio o delegación del administrador logado.
•
idSujeto: Si está relleno, se comprobará que el procurador existe y está asociado está asociado al colegio o delegación del administrador logado.
Mensaje SOAP de respuesta OK [idSesion] [idAplicacion] [fechaExacta] [fechaInicio]
Página 158
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
[fechaFin] [idSujeto] [maxCabeceras] ]]>
Los elementos resaltados se enumeran a continuación: •
idSesion: Identificador de la sesión.
•
idAplicacion: Identificador de la aplicación desde la que se hace la petición.
•
fechaExacta: Fecha de los mensajes auditados. En la solicitud de cabeceras también se puede especificar un rango de fechas en lugar de una fecha exacta.
•
fechaInicio: Fecha de inicio de los mensajes auditados.
•
fechaFin: Fecha de fin de los mensajes auditados.
•
idSujeto: Identificador de sujeto para el que se quieren buscar los mensajes auditados.
•
maxCabeceras: Valor numérico. Indica el número máximo de caberas a obtener como respuesta. En caso de que se especifique en la respuesta se obtienen las primeras “maxCabeceras” cabeceras que cumplan el resto de condiciones especificados en la solicitud. Por ejemplo, para un usuario que hubiera recibido 350 notificaciones en un rango de fechas, si se auditaran en ese rango de fechas y se indicara maxCabeceras 200, el servicio le devolverá cabeceras de las primeras 200 notificaciones auditadas, ordenadas por fecha de envio ascendente, es decir, la más antigua primero. Este parámetro se introduce para evitar posibles timeout en obtener una repuesta del servidor para grandes vólumenes de mensajes. Este parámetro no es obligatorio, así que puede no aparecer
Página 159
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
en la solicitud, para así mantener la compatibilidad con versiones anteriores de este servicio; no obstante si no se indica se le asigna por defecto el valor “500”.
Validaciones Estos son las validaciones que se aplican al servicio web: •
idAplicacion: se comprueba que el identificador de la aplicación está admitido en el entorno actual.
•
idSesion: se comprueba que el identificador de sesión es correcto ya que el usuario previamente lo ha debido introducir con anterioridad. Tiene una caducidad máxima de 30 minutos.
Mensaje SOAP de respuesta OK [idSesion] [idAplicacion] [idLexnet] [idSujeto]
Página 167
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
]]>
Los elementos resaltados se enumeran a continuación: •
idSesion: Identificador de la sesión.
•
idAplicacion: Identificador de la aplicación desde la que se hace la petición.
•
idLexNet: Identificador en LexNet del mensaje para el que se desea obtener un informe de auditoría.
•
idSujeto: Identificador en LexNet del procurador para cuyo mensaje se está solicitando un informe de auditoría.
Validaciones Estas son las validaciones que se aplican al servicio web: •
idAplicacion: se comprueba que el identificador de la aplicación está admitido en el entorno actual.
•
idSesion: se comprueba que el identificador de sesión es correcto ya que el usuario previamente lo ha debido introducir con anterioridad. Tiene una caducidad máxima de 30 minutos.
•
Usuario: se comprueba que el usuario que ejecuta el servicio tiene el rol de Administrador de Procuradores o de Administrador de Delegación de procuradores.
•
idSujeto: se comprueba que el usuario cuyo mensaje se está auditando existe en el sistema y pertenece al Colegio de Procuradores que está realizando la petición.
•
idLexnet: se comprueba que el mensaje auditado existe, es válido y está asociado al procurador cuyo mensaje se está auditando.
Página 168
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
Mensaje SOAP de respuesta OK [idSesion] [idAplicacion]
Página 171
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
[idMensaje] [tipoAcuse] [fechaDevolucion] [motivo] ... [idMensajeN] [tipoAcuseN] [fechaDevolucionN] [motivoN] ]]>
Los elementos resaltados se enumeran a continuación: •
idSesion: Identificador de la sesión.
•
idAplicacion: Identificador de la aplicación desde la que se hace la petición.
•
acuses: Contiene la lista de elementos acuse que se desean enviar. o
acuse: Elemento que contiene los datos del acuse: idMensaje: Identificador del mensaje Lexnet para el que se desea enviar un acuse. tipoAcuse: Indica el tipo de acuse que se envía. Puede tener uno de estos valores: ACA (para acuses de cancelación) o ARD (para acuses de aceptación en destino). Sólo en el caso de los acuses de cancelación, es decir, tipoAcuse=ACA, se deberán completar los dos campos siguientes:
Página 172
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
fechaDevolucion: Fecha en la que se canceló el mensaje. motivo: Motivo por el que se cancela el mensaje.
Validaciones Estos son las validaciones que se aplican al servicio web: •
idAplicacion: se comprueba que el identificador de la aplicación está admitido en el entorno actual.
•
idSesion: se comprueba que el identificador de sesión es correcto ya que el usuario previamente lo ha debido introducir con anterioridad. Tiene una caducidad máxima de 30 minutos.
•
Usuario: se comprueba que el usuario que ejecuta el servicio pertenece a un órgano judicial.
Mensaje SOAP de respuesta OK Esta plantilla contiene los siguientes documentos: •
Un archivo de tipo test/xml (lexnet_datos.xml): este archivo contiene información general del envío que se va a realizar. Este archivo habrá sido rellenado por LexNet en base a la información contenida en la petición a EnviarMensaje
•
Un archivo de tipo text/plain: texto principal incluido por LexNet en el mensaje MIME en base a la información contenida en la petición a EnviarMensaje
El cliente de los servicios web LexNet deberá añadir a esa plantilla MIME el contenido físico de los datos adjuntos, a continuación de los documentos explicados en el párrafo anterior y en el siguiente orden: •
documento principal. Este documento habrá sido firmado por el usuario remitente con firma PKCS#7 modo detached lo que generará el siguiente documento que deberá adjuntarse también a la plantilla MIME
•
firma del documento principal (en formato PKCS#7)
•
resto de documentos adjuntos.
Página 177
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
A continuación, el cliente deberá firmar el mensaje MIME resultado (plantilla MIME + documentos adjuntados por el integrador) con la clave privada del usuario remitente, conformando un mensaje SMIME. De esta forma, la estructura del mensaje SMIME obtenido debería ser similar al que se muestra en la siguiente figura:
Figura 3 Mensaje SMIME preparado para el envío
Este mensaje SMIME será enviado por fragmentos a LexNet, utilizando la operación EnviarBloque (para lo cual se precisará el identificador del envío que había sido devuelto por EnviarMensaje junto con la plantilla MIME).
2. EnviarVerificacionLectura La
plantilla
MIME
devuelta
por
LexNet
en
respuesta
a
la
petición
a
EnviarVerificacionLectura contiene un formato similar al que se muestra en la siguiente figura. Esta plantilla contiene los siguientes documentos: •
Un archivo de tipo test/xml (lexnet_datos.xml): este archivo contiene información general del recibí que se va a enviar. Este archivo habrá sido
Página 178
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
rellenado por LexNet en base a la información contenida en la petición a EnviarVerificacionLectura. •
Un archivo de tipo text/plain (Recibi.rtf): texto del Recibí incluido por LexNet en el mensaje MIME en base a la información contenida en la petición a EnviarVerificacionLectura
•
Un archivo de tipo text/plain: texto principal incluido por LexNet en el mensaje MIME en base a la información contenida en la petición a EnviarVerificacionLectura
Figura 4 Formato plantilla MIME – respuesta EnviarVerificacionLectura
El cliente de los servicios web LexNet deberá firmar el archivo Recibi.rtf devuelto por LexNet dentro de la plantilla, usando la clave privada del usuario remitente con firma PKCS#7 modo dettached. Esa firma deberá adjuntarse a la plantilla anterior. A continuación, el cliente deberá firmar el mensaje MIME resultado con la clave privada del usuario remitente, conformando un mensaje SMIME. De esta forma, la estructura del mensaje SMIME del recibí que se enviará a LexNet será el siguiente:
Página 179
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Figura 5 Mensaje SMIME de recibí preparado para el envío
Este mensaje SMIME será enviado por fragmentos a LexNet, utilizando la operación EnviarBloque (para lo cual se precisará el identificador del envío que había sido devuelto por EnviarVerificacionLectura junto con la plantilla MIME).
Página 180
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Mensaje formato CADES La petición a los servicios web EnviarMensaje/EnviarVerificacionLectura produce como respuesta una plantilla de mensaje en formato CADES (binario) que deberá ser completada por el integrador para su posterior envío a LexNet mediante el servicio web EnviarBloque. El mensaje CADES (binario) final que se enviará a LexNet tendrá una estructura como la que se muestra en la siguiente figura.
Mensaje CADES Cabecera principal
Cabecera xml LexNet
Fichero xml Cabecera doc principal
Doc principal Cabecera adjunto 1
Adjunto 1 Cabecera adjunto 2
Adjunto 2 . . . Cabecera adjunto n
Página 181
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Adjunto n Figura 6 Estructura de mensaje CADES
Tal y como se muestra en la Figura, este mensaje estará compuesto por los siguientes elementos: •
Una cabecera principal: esta cabecera contendrá información general sobre la estructura del mensaje CADES completo y la firma del mensaje completo
•
Un par cabecera/documento por cada fichero del mensaje. Los ficheros que contendrá el mensaje serán: o
Un documento XML (obligatorio): contendrá la información general del mensaje y será devuelto por LexNet
o
El documento principal de envío (obligatorio): que deberá ser adjuntado por el integrador. En caso de que el documento no sea binario, deberá ser transformado a base 64 antes de añadirlo al mensaje CADES
o
De 0 a n documentos adjuntos (opcional): que deberán ser adjuntados por el integrador. En caso de que el documento no sea binario, deberá ser transformado a base 64 antes de añadirlo al mensaje CADES
En los siguientes apartados se detalla la estructura de la cabecera principal y de las cabeceras de los ficheros.
Cabecera principal La cabecera principal contendrá la información general del fichero CADES de envío. Esta cabecerá estará formada por un conjunto de 26+n bytes distribuidos tal y como se muestra en la siguiente figura:
Cabecera principal
Página 182
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Byte 0
Firma_cabecera
4
Version_cades
6
Sin_uso
8
Longitud_cades
12
Num_ficheros
14
Fecha_mod
22
Longitud_firma
26
Firma_cades
. . 26+n
Figura 7 Estructura cabecera principal CADES
Página 183
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
La siguiente tabla detalla la información contenida en cada uno de esos bytes e indica los campos que deberían ser completados por el integrador respecto a los incluidos en la plantilla devuelta inicialmente por LexNet: Cabecera Principal Offset Nº Bytes
Campo
Formato
Descripcion
4
Firma identificativa de la cabera principal Version de formato Version_cades Signed short de plantilla CADES Byte de proposito Sin_uso Signed short general (para uso futuro) Longitud del fichero Longitud_cades Signed integer cades total sin firma Numero de ficheros (minimo 2: XML Num_ficheros Signed short devuelto por lexnet + documento principal) Fecha de última modificación(número de milisegundos Fecha_mod Signed long desde el 1 de Enero de 1970 a las 00:00:00) Longitud_firma Signed integer Longitud de la firma
n
Firma_cades
0
4
4
2
6
2
8
4
12
2
14
8
22 26
Firma_cabecera Binario
Binario
Firma binaria CADES
Incluido para la Valor inicial Rellenar por integrador firma Si
0x4C580304 No
Si
1
No
Si
0
No
Si
0
Si
Si
1
Si
Si
fecha
No
Si
0
Si
No
Ninguno
Si
Cabecera de fichero La cabecera de cada uno de los ficheros que se incluirán en el mensaje CADES (cabeceras del xml devuelto por LexNet, del documento principal y de los adjuntos) estará formada por un conjunto de 20+r+n bytes distribuidos tal y como se muestra en la siguiente figura:
Cabecera fichero
Página 184
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Byte 0
Firma_cabecera_fichero
4
Numero_fichero
6
Tipo_fichero
8
Formato_fichero
10
Longitud_fichero
14
Longitud_nombre_fichero
16
Longitud_firma_fichero
20
Nombre del fichero
20+r
Longitud_firma_fichero
20+r+s Figura 8 Cabecera fichero
Página 185
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
La siguiente tabla detalla la información contenida en cada uno de esos bytes:
Cabecera del fichero adjunto Offset Bytes
Campo
Formato
Descripcion
Incluido para la firma
0
4
Firma_cabecera_fichero
Binario
Identificador de la cabecera el fichero
Si
4
2
Numero_fichero
Signed short
Numero del fichero
Si
6
2
Tipo_fichero
Signed short
Tipo de fichero adjunto
Si
8
2
Formato_fichero
Signed short
Formato del Fichero Adjunto Si
10
4
Longitud_fichero
Signed long
14
2
16
4
20
r
20 + r s
Longitud del fichero adjunto Longitud del nombre del Longitud_nombre_fichero Signed short fichero adjunto Longitud de la firma del Longitud_firma_fichero Signed long fichero adjunto Nombre_fichero String (ISO 8859-1) Nombre del fichero adjunto firma del fichero (en caso de ir firmado será la firma Firma_fichero Binario CADES del hash SHA-1 del fichero)
Página 186
Si Si Si si No
Valor 0x4C580708 1..n
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
A continuación se detallan los valores posibles para los campos numero_fichero, formato_fichero y tipo_fichero: •
Numero_fichero
Los ficheros que se enviarán en el mensaje CADES serán: el fichero xml devuelto por lexNet, un documento principal y de 0 a n documentos adjuntos. La cabecera de cada uno de esos ficheros podrá tener uno de los siguientes valores en el campo numero_fichero de su cabecera:
Fichero Fichero xml Doc principal Doc adjunto 1
Valor del campo numero_fichero de su cabecera 1 2 3
Doc adjunto n
3+(n-1)
•
Formato_fichero
Valor 1 2
•
Formato_fichero Descripcion Fichero binario Fichero texto (base 64)
Tipo_fichero
Tipo_fichero Valor 1 2 3 5
Tipo Fichero XML LexNet Acuse de recibo Documento principal Documento anexo
En los apartados anteriores se ha explicado la estructura completa de un mensaje CADES que se enviaría a LexNet a través de EnviarBloque, basado en la plantilla
Página 187
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
devuelta
tras
la
petición
a
los
servicios
web
EnviarMensaje
y
EnviarVerificacionLectura. A continuación se detalla la estructura de la plantilla que deberá ser completada por el integrador para conseguir la estructura descrita en los párrafos anteriores
Plantilla CADES devuelta por EnviarMensaje La plantilla CADES devuelta por EnviarMensaje tiene la siguiente estructura: •
La cabecera principal del mensaje CADES.
•
La cabecera del fichero xml devuelto por LexNet
•
El fichero xml generado por LexNet
Plantilla CADES Cabecera principal sin firma
Cabecera xml LexNet
Fichero xml A partir de esta plantilla el integrador deberá dar los siguientes pasos para obtener el mensaje CADES con el formato y estructura final explicado en los apartados anteriores y que será enviado a LexNet mediante EnviarBloque:
Página 188
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
1. Añadir a continuación del fichero xml incluido en la plantilla, la cabecera de cada uno de los ficheros (principal y adjuntos) y los propios ficheros. En el caso del documento principal, cuya firma es obligatoria, para cumplimentar la cabecera del mismo, el integrador habrá tenido que firmar previamente en CADES-BES el hash SHA-1 de dicho fichero. Asimismo, en caso necesario, el integrador, podrá incluir la firma de cada uno de los ficheros adjuntos en su cabecera correspondiente. 2. Modificar el campo num_ficheros de la cabecera principal. LexNet devuelve inicialmente el valor 1 (correspondiente al fichero xml devuelto en la plantilla). El integrador tendrá que modificar este valor con el nº de total de ficheros que enviará (fichero xml+documento principal +0..n documentos adjuntos). Por tanto, el valor de este campo será como mínimo 2 (fichero xml + documento principal obligatorio) 3. Calcular la longitud del mensaje CADES sin la firma y modificar la información del campo longitud_cades de la cabecera principal 4. Firmar en CADES-BES el hash SHA-1 del mensaje CADES compuesto por el integrador 5. Modificar la información del campo longitud_firma (inicialmente LexNet devuelve un valor 0 en la plantilla) 6. Añadir al campo firma_cades de la cabecera principal, la firma obtenida en el paso 3.
Plantilla
CADES
devuelta
por
EnviarVerificacionLectura La plantilla CADES devuelta en respuesta a EnviarVerificacionLectura tiene la siguiente estructura: •
La cabecera principal del mensaje CADES de verificación de lectura.
•
La cabecera del fichero xml devuelto por LexNet
Página 189
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
•
El fichero xml generado por LexNet
•
La cabecera del fichero correspondiente a la verificación de lectura (Recibi.rtf)
•
El fichero Recibi.rtf
Plantilla Recibí CADES Cabecera principal sin firma
Cabecera xml LexNet
Fichero xml Cabecera Recibí LexNet
Fichero Recibi.rtf A partir de esta plantilla el integrador deberá dar los siguientes pasos para obtener el mensaje CADES de verificación de lectura con el formato final que será enviado a LexNet: 1. Firmar el fichero Recibi.rtf devuelto por LexNet El integrador deberá decodificar de base 64 el fichero Recibi.rtf devuelto en la plantilla anterior. A continuación, el integrador deberá firmar en CADESBES el hash SHA-1 de dicho fichero decodificado. 2. Adjuntar la firma obtenida al campo Firma_fichero de la cabecera del fichero Recibi.rtf devuelto por LexNet 3. Modificar el campo longitud_firma_fichero de la cabecera del fichero Recibi.rtf devuelto por LexNet en la plantilla
Página 190
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
4. Calcular la longitud del mensaje CADES sin la firma y modificar la información del campo longitud_cades de la cabecera principal 5. Firmar en CADES-BES el hash SHA-1 del mensaje CADES compuesto por el integrador 6. Modificar la información del campo longitud_firma (inicialmente LexNet devuelve un valor 0 en la plantilla) 7. Añadir al campo firma_cades de la cabecera principal, la firma obtenida en el paso 3.
Página 191
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Ejemplo de uso e invocación de los Servicios Web LexNet El uso de los principales servicios web de LexNet requiere la invocación de los mismos en un orden determinado. En los siguientes apartados se detalla el proceso de invocación para los procesos más importantes aportados por LexNet: •
Envío de mensajes
•
Descarga de mensajes
Envío de mensajes El envío de un mensaje a través de LexNet requiere un proceso consistente en los siguientes cinco pasos:
Figura 9 Proceso envío mensajes
Página 192
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
•
[T1]En primer lugar se realizará un proceso de Autenticación del usuario, en caso de que no se hubiera realizado previamente. Para ello, la aplicación habrá establecido con LexNet una sesión SSL utilizando el certificado digital del usuario. A continuación se realizará una petición al servicio web Login
•
[T2] A continuación se iniciaría el proceso de envío del mensaje. Esto conlleva la realización de peticiones a los servicios web LexNet y tareas que se detallan a continuación:
Figura 10 [T2] Envío de mensaje: detalle de peticiones a los ws LexNet
o
[T2x] Si la aplicación no había invocado previamente al servicio ObtenerTiposProcedimiento,
podría
Página 193
realizarlo
para
conocer
los
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
posibles tipos de procedimento que podrá enviar como asunto de su mensaje. Se recomienda realizar esta llamada de forma ocasional debido a la carga de datos de este servicio web y a que se trata de una información con pocos cambios a lo largo del tiempo. o
[T2y] Si la aplicación no había invocado previamente al servicio ObtenerDestinatarios, podría realizarlo para conocer los datos de identificación de los posibles destinatarios de su mensaje. Se recomienda realizar esta llamada de forma ocasional debido a la carga de datos de este servicio web y a que se trata de una información con pocos cambios a lo largo del tiempo.
o
[T21]
La
aplicación
realizará
una
petición
al
servicio
web
EnviarMensaje donde detallará los datos previamente solicitados al usuario:
destinatario
del
mensaje,
tipo/nº
de
procedimiento,
adjuntos, etc. o
[T22] En respuesta a esta petición, LexNet proporcionará una plantilla de mensaje MIME.
o
[T23] La aplicación deberá cumplimentar la plantilla MIME obtenida en el
paso anterior. Para
ello, deberá
anexar a la plantilla
proporcionada la siguiente información: Documento principal firmado con el certificado digital del usuario remitente en formato PKCS#7 detached. Documentos adjuntos que el usuario desee enviar (si alguno). Una vez completada la plantilla MIME, la aplicación deberá firmarla con el certificado digital del usuario remitente, generando un documento SMIME que será el mensaje que se remitirá a LexNet. o
[T24..T24+n] A continuación, el mensaje SMIME será enviado a LexNet dividido en n bloques con n llamadas sucesivas al servicio web EnviarBloque.
o
[T25..T25+n]
En
respuesta
a
cada
EnviarBloque, LexNet proporcionará
Página 194
una
de
las
peticiones
a
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
o
[T26] Una vez obtenidos todos los bloques, LexNet realizará un proceso de sellado de tiempo sobre el mensaje y de firma por parte de LexNet, creando el mensaje final que será enviado al destinatario
o
[T27] LexNet proporcionará como respuesta al último bloque el identificador del acuse del envío realizado así como la fecha de sellado del mismo. Este identificador posibilitará la descarga del acuse, en caso deseado.
•
[T3] A continuación, en caso de que se desee descargar el acuse, el proceso de descarga será similar al proceso de descarga de un mensaje, tal y como se explica en los tiempos [T25] a [T29] del siguiente apartado (Descarga de mensajes).
•
[T4] La aplicación finalizaría su sesión con LexNet haciendo una invocación al servicio de LogOut.
Descarga de mensajes La descarga de un mensaje recibido a través de LexNet requiere un proceso consistente en los siguientes tres pasos:
Página 195
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Figura 11 Proceso de descarga de mensajes
•
[T1]En primer lugar se realizará un proceso de Autenticación del usuario, en caso de que ya no se hubiera realizado previamente. Para ello, la aplicación habrá establecido con LexNet una sesión SSL utilizando el certificado digital del usuario. A continuación se realizará una petición al servicio web Login
•
[T2] A continuación se iniciaría el proceso de descarga del mensaje. Esto conlleva la realización de peticiones a los servicios web LexNet y tareas que se detallan a continuación:
Página 196
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
Figura 12 [T2] Descarga de mensaje: detalle de peticiones a los ws LexNet
o
[T21] En primer lugar, la aplicación realizará una llamada a ObtenerPendientes para conocer los mensajes recibidos nuevos que todavía no se hubiera descargado
o
[T22] En respuesta a la petición anterior, LexNet indicará el nº de mensajes
cuyo
destinatario
es
el
usuario
logado
que
están
pendientes de descarga o
[T23] La aplicación podrá solicitar la descarga de la cabecera de los mensajes deseados. Ej: los mensajes pendientes de descarga
Página 197
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
únicamente o cualquiera que cumpla una serie de condiciones (fecha de envío, etc.) o
[T24] En respuesta, LexNet proporcionará la cabecera de los mensajes solicitados (que cumplen las condiciones indicadas en la petición anterior y cuyo destinatario es el usuario logado).
o
[T25] A continuación, la aplicación podrá solicitar la descarga de un mensaje
en
específico
cuyo
identificador
habrá
sido
obtenido
previamente (Ej: a través ObtenerCabeceras). Para ello, hará una solicitud al servicio web ObtenerMensaje. Nota: en el caso de aquellos usuarios que requieran la firma de recibí previa a la descarga de su mensaje (Ej: abogados), LexNet requerirá, previa a la solicitud de ObtenerMensaje la invocación de un conjunto de servicios web que permitirían el envío del recibí. En este caso, ver la descripción del servicio web EnviarVerificacionLectura. o
[T26] En respuesta, LexNet proporcionará todos los datos del mensaje así como los identificadores de los documentos principal y adjuntos asociados al mensaje, lo que posibilitará su descarga subsiguiente.
o
[T27..T27+n] La aplicación podrá solicictar la descarga en bloques de los documentos principal y adjuntos cuyos identificadores fueron obtenidos en el paso anterior. Para ello, se realizará sucesivas llamadas al servicio web ObtenerBloque.
o
[T28..T28+n] LexNet proporcionará los bloques de los documentos solicitados.
o
[T29] Una vez, descargados todos los bloques del documento principal y de todos los adjuntos, la aplicación realizará una solicitud al servicio web TerminarDescarga, para indicarle a LexNet la finalización del proceso de descarga del mensaje completo.
•
[T3] La aplicación finalizará su sesión con LexNet haciendo una invocación al servicio de LogOut.
Página 198
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración LexNET
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE LA JUSTICIA
Página 199
DIRECCIÓN GENERAL DE RELACIONES CON LA ADMINISTRACIÓN DE JUSTICIA
Guía de uso de los Web Services de integración
SUBDIRECCIÓN GENERAL DE LAS NUEVAS TECNOLOGIAS DE
LexNET
LA JUSTICIA
Mensaje de Error Descripción Se dedica este apartado al mensaje de respuesta de error ya que es único para todos los servicios. Además, como se podrá apreciar en las definiciones WSDL, ninguno de los servicios web define un mensaje “default” en sus operaciones, esto es debido a que en caso de error se utiliza el mismo mensaje de salida. Es por esto que las aplicaciones clientes, al recibir una respuesta de cualquiera de los servicios web, deberán preguntar si el mensaje es de error o de respuesta real a la operación invocada. El mensaje de error incluye información sobre el momento en que ocurre el error, códigos definidos (para más información sobre los códigos de error consulte Códigos de error devueltos por el servidor), un mensaje explicativo y el módulo en el que ocurre. En el ejemplo que se muestra a continuación se ha escenificado el siguiente error: se solicita la operación ObtenerMensaje por parte de un usuario que requiere el envío de una verificación de lectura previo a la petición de este servicio web. El servicio ObtenerMensaje devolvería un mensaje de error, causado por el hecho de que el usuario necesitaba enviar una verificación de lectura antes de descargar el mensaje.
Mensaje SOAP de respuesta ERROR: