Administración Local Soluciones

Transcripción

1 SISTEMA INTEGRADO DE GESTIÓN DE EXPEDIENTES MODULAR (SIGM) DESCRIPCIÓN Y CÓDIGO DE SERVICIOS WEB SIGM SIGM v3 Administración Local Soluciones

2 Control de versiones Versión Fecha aprobación Cambio producido Autor Versión inicial IECISA Actualización para SIGEM v1.9. Se amplía la información sobre los servicios Web Actualización para SIGEM DOS. Se aumentan los contenidos de la información de los servicios Web se incluyen ejemplos de utilización del servicio de Consulta web de datos del Expediente. Se eliminan los wsdl y se incorporan al nuevo documento: SGM_2009_11_Descriptores (wsdl) de los Servicios Web SIGEM.doc Modificado el Descriptor del Registro Presencial para añadir operación de comprobación de tipo de asunto. IECISA IECISA IECISA Actualización para SIGM v3.0. IECISA

3 ÍNDICE 1 INTRODUCCIÓN VISIÓN GENERAL DEL SISTEMA FINALIDAD DEL DOCUMENTO DEFINICIONES Y ABREVIATURAS LISTADO DE SERVICIOS WEB DE SIGM DESCRIPCIÓN DE LOS SERVICIOS WEB DE SIGEM SERVICIO WEB DE AUTENTICACIÓN DE USUARIOS Métodos autenticarusuario obtenerusuario eliminarusuario buscarusuarios actualizarusuario crearusuario Clases Códigos de error SERVICIO WEB DE CONFIGURACIÓN DEL CATÁLOGO DE TRÁMITES Métodos addprocedure getprocedure query deleteprocedure updateprocedure isdocumentreferenced addproceduredocument deleteproceduredocument getdocument adddocument deletedocument updatedocument getdocuments getproceduredocuments getproceduredocument updateproceduredocument getprocedures getdocumentfromcode getaddressee addaddressee deleteaddressee updateaddressee getaddressees gethook addhook deletehook updatehook gethooks gethooksbytype gethooktype addhooktype... 34

4 deletehooktype updatehooktype gethooktypes getauthhooks addauthhooks deleteauthhooks updateauthhooks getauthhook Clases Códigos de error SERVICIO WEB DE CONSULTA DE EXPEDIENTES Métodos consultarexpedientesnif consultarexpedientes obtenerurlaportacionexpedientes obtenerurlnotificacionexpedientes obtenerurlpagotasas obtenerdetalle obtenerhistoricoexpediente obtenerhitoestado btenerficheroshito obtenerficheroshitos nuevoexpediente eliminarexpediente nuevointeresado eliminarinteresado eliminarinteresadoexpediente establecerhitoactual eliminarhitoactual nuevohitohistorico eliminarhitohistorico cargardocumento recogerdocumento busquedaexpedientes anexarficheroshitoactual existennotificaciones existensubsanaciones existenpagos recogernotificaciones altasolicitudsubsanacion obtenersubsanacioneshitoactual obtenersubsanacioneshito altasolicitudpago obtenerpagoshitoactual obtenerpagoshito altanotificacion obtenernotificioneshitoactual obtenernotificioneshito Códigos de error SERVICIO WEB DE VALIDACIÓN DE CERTIFICADOS Métodos crearhash validarhash validarcertificado Clases Códigos de error SERVICIO WEB DE FIRMA DIGITAL... 53

5 3.5.1 Métodos firmar validarfirma getcertinfo registrarfirma Clases Códigos de error SERVICIO WEB DE NOTIFICACIONES Métodos actualizaestados actualizaestado recuperadocumento detallenotificacion detallenotificacionbynotiid consultarnotificaciones obtenerestado obtenerestadobd altanotificacion Clases Códigos de error SERVICIO WEB DE PAGO ELECTRÓNICO Métodos altaliquidacion baja Liquidación modificarliquidacion buscarliquidaciones obtenerdatostasa buscartasas obtenerdocumentopago realizarpago detallepago Clases Códigos de error SERVICIO WEB DE PUBLICACIÓN Métodos getlistahitos gethito addhito updatehito deletehito reactivatehito getlistareglas getregla addregla updateregla deleteregla getlistaerrores geterror Códigos de error SERVICIO WEB DEL REPOSITORIO DE DOCUMENTOS DE TRAMITACIÓN Métodos recuperardocumento retrievedocumentinfo guardardocumento guardardocumentoguid eliminardocumento... 87

6 obtenerhash almacenardocumentos almacenardocumentotemporal eliminardocumentotemporal obtenerdocumentostemporales obtenerdocumentostemporalescaducados Clases Códigos de error SERVICIO WEB DEL REGISTRO PRESENCIAL Métodos createfolder updatefolder findfolder importfolder getinputfolderfornumber getoutputfolderfornumber getdocumentfolder getinputdistribution getoutputdistribution acceptdistribution rejectdistribution changeinputdistribution changeoutputdistribution adddocument getinterestedoutputregister getinterestedinputregister getinputregister getoutputregister existmattertypeinoffice Clases Códigos de error SERVICIO WEB DEL REGISTRO TELEMÁTICO Métodos crearpeticionregistro establecerdocumentossubsanacion registrar registrartelematicoandiniciarexpediente deshacerregistro obtenernumeroregistro eliminardocumentostemporales query obtenerregistro obtenerdocumentosregistro obtenerdatosdocumentosregistro obtenerjustificanteregistro obtenerpeticionregistro obtenerregistrosconsolidados obtenerregistrosparamostrar tienedocumentos obtenercontenidodocumento obtenerdocumento establecerestadoregistro obtenerdocumentoregistro insertardocumentoregistro actualizardocumentoregistro eliminardocumentoregistro Clases

7 Códigos de error SERVICIO WEB DE SESIÓN DE USUARIOS Métodos loginexternaluser logincertificate logincertificateauth Logout crearsesion borrarsesion limpiarsesiones limpiarsesionestimeout obtenersesion getinfousuario getidmetodoautenticacion getmetodoautenticacion Códigos de error SERVICIO WEB DE TERCEROS Métodos getelectronicaddress getpostaladdress lookup lookup lookup lookup lookupbyid lookupbyid lookupbyid lookupdefaultelectronicaddress lookupdefaultpostaladdress lookupelectronicaddresses lookuppostaladdresses Códigos de error SERVICIO WEB DE GESTIÓN DE EXPEDIENTES Métodos getprocedimientosportipo getprocedimientos getprocedimiento getfichero getinfofichero getinfoocupacion eliminaficheros getidsexpedientes getexpedientes getexpediente iniciarexpediente iniciarexpediente anexardocsexpediente cambiarestadoadministrativo moverexpedienteafase busquedaavanzada establecerdatosregistroentidad obtenerregistroentidad obtenerregistrosentidad Códigos de error SERVICIO WEB DE CONSULTA DE DOCUMENTOS DE GESTIÓN DE EXPEDIENTES POR CSV 133

8 Métodos existedocumento getcontenidodocumento SERVICIO WEB DE MENSAJES CORTOS Métodos sendsms sendsms getsmsstatus sendcertsms getcertsmssignaturestatus getcertsmssignaturexml getcertsmssignaturedocument sendmail Clases Códigos de error SERVICIO WEB DE ANTIVIRUS Métodos comprobarfichero comprobarfichero SERVICIO WEB DE NOTARIADO PARA SIGNO Métodos calculoliquidacion pagoliquidacion SERVICIO WEB DE TRANSFERENCIA DE EXPEDIENTES A ARCHIVO Métodos transferirexpedienteelectronicocondocumentos SERVICIO WEB DEL CLIENTE LIGERO DE INTERMEDIACIÓN Métodos consultaprocedimientobynif Clases SERVICIO WEB DE CATASTRO Métodos validarreferenciacatastral consultarcatastro Clases Códigos de error SERVICIO WEB DE GESTIÓN DE SESIONES DE ADMINISTRACIÓN Métodos nuevasesion nuevasesionentidad validarsesion validarsesionentidad caducarsesion caducarsesionentidad obtenersesion obtenersesionentidad modificardatossesion Clases Códigos de error SERVICIO WEB DE GESTIÓN DE SESIONES DE GESTIÓN Métodos nuevasesion validarsesion caducarsesion obtenersesion

9 modificardatossesion Clases Códigos de error SERVICIO WEB DE CALENDARIO DE TRÁMITES Métodos obtenercalendario nuevocalendario actualizarcalendario eliminarcalendario obtenerdiacalendario nuevodiacalendario actualizardiacalendario eliminardiacalendario obtenerdiascalendario proximolaborable Clases Códigos de error SERVICIO WEB DE CERTIFICACIÓN Métodos generarcertificacionpagos altacertificacion eliminarcertificacion obtenercertificacion Clases Códigos de error SERVICIO WEB DE ENTIDADES Métodos nuevaentidad eliminarentidad actualizarentidad obtenerentidad buscarentidades obtenerentidades obteneridentificadorentidad Clases Códigos de error SERVICIO WEB DE ESTRUCTURA ORGANIZATIVA Métodos getusuariosdepartamento getusuarioporid getusuariopornombre getusuarioporidcertificado getusuariosaplicacion getusuariosgrupo getdepartamentosporpadre getgrupos getdepartamentos getgrupo getdepartamento creararchivador creararchivador editardepartamentocompleto editarusuario eliminararchivador getlistas getusuarios

10 getusuariosasociation getusuariosyaasociados getusuariosaplicacionpordepartamento creargrupoldap getgrupoldap crearusuarioldap getusuarioldapbyguid getusuarioldapbyfullname getusuarioldapporidcertificado getusuariosldap getusuarioldap getusuariosldapyaasociados editarusuarioldap eliminarusuarioldap getusuarioldapbasicbyid getdepartamentolite getgrupoldapbyid getusuariosldapaplicacion getusuariosldapaplicacionpordepartamento Clases Códigos de error SERVICIO WEB DE GEOLOCALIZACIÓN Métodos verplanoporcoordenadas verplanoporreferenciacatastral verplanoporidvia verplanoporidnumeropolicia verplanospublicados validarvia validarportal obtenerportal validardireccionpostal validardireccionpostalcompleta obtenerprovincias obtenermunicipios obtenertiposdevia Clases Códigos de error SERVICIO WEB DE POBLACIÓN PARA REGISTRO TELEMÁTICO Métodos buscartercero buscarterceroporentidad Clases SERVICIO WEB DE GESTIÓN DE CSV Métodos generarcsv getinfodocumentobycsv getdocumentobycsv deleteinfodocumento existecontenidodocumento getcontenidodocumento existecontenidodocumento writedocumento Clases SERVICIO WEB DE CONSULTA DE DOCUMENTOS DE REGISTRO TELEMATICO POR CVS Métodos

11 existedocumento getcontenidodocumento ANEXO I: EJEMPLOS DE USO DEL SERVICIO WEB DE CONSULTA DE EXPEDIENTES LLAMADAS AL SERVICIO WEB consultarexpedientesnif consultarexpedientes obtenerurlaportacionexpedientes obtenerurlnotificacionexpedientes obtenerurlpagotasas obtenerdetalle obtenerhistoricoexpediente obtenerhitoestado obtenerficheroshito obtenerficheroshitos nuevoexpediente eliminarexpediente nuevointeresado eliminarinteresado eliminarinteresadoexpediente establecerhitoactual eliminarhitoactual nuevohitohistorico eliminarhitohistorico cargardocumento recogerdocumento busquedaexpedientes anexarficheroshitoactual existennotificaciones existensubsanaciones existenpagos recogernotificaciones altasolicitudsubsanacion obtenersubsanacioneshitoactual obtenersubsanacioneshito altasolicitudpago obtenerpagoshitoactual obtenerpagoshito altanotificacion obtenernotificacioneshitoactual obtenernotificioneshito CLASES UTILIZADAS

12 1 Introducción 1.1 Visión general del sistema AL SIGM es la plataforma de Tramitación Electrónica del MINETUR, solución integral para la tramitación electrónica de los procedimientos administrativos, que fomenta la interoperabilidad entre administraciones mediante su adaptación a estándares de comunicación así como la reutilización de recursos e información pública. 1.2 Finalidad del documento El objeto de este documento es describir los diferentes Servicios Web disponibles en AL SIGM. El documento comienza con la enumeración de los Servicios Web, y continúa mostrando una descripción detallada de cada uno de ellos. Finalmente se incluye un amplio ejemplo de utilización del servicio de Consulta Web del Expediente. 1.3 Definiciones y Abreviaturas A continuación se expone una tabla con los diferentes acrónimos y abreviaturas utilizados a lo largo del documento, con su correspondiente definición. Acrónimo / Abreviatura MINETUR IECISA SIGM AL Definición Ministerio de Industria, Energía y Turismo Informática El Corte Inglés S.A. Sistema Integrado de Gestión de Expedientes Modular Administración Local AL SIGM v3 Descripción y código Servicios Web SIGEM 12

13 2 Listado de Servicios Web de SIGM Los Servicios Web disponibles en AL SIGM son los siguientes: 1. Autenticación de usuarios (SIGEM_AutenticacionWS) 2. Configuración del catálogo de trámites (SIGEM_CatalogoTramitesWS) 3. Consulta de expedientes (SIGEM_ConsultaWS) 4. Validación de certificados (SIGEM_CriptoValidacionWS) 5. Firma digital (SIGEM_FirmaDigitalWS) 6. Notificaciones (SIGEM_NotificacionWS) 7. Pago electrónico (SIGEM_PagoElectronicoWS) 8. Publicación (SIGEM_PublicadorWS) 9. Repositorio de documentos de tramitación (SIGEM_RdeWS) 10. Registro presencial (SIGEM_RegistroPresencialWS) 11. Registro telemático (SIGEM_RegistroTelematicoWS) 12. Sesión de usuarios (SIGEM_SesionUsuariosWS) 13. Terceros (SIGEM_TercerosWS) 14. Gestión de expedientes (SIGEM_TramitacionWS) 15. Consulta de Documentos de Gestión de Expedientes por CSV (SIGEM_TramitacionWS) 16. Mensajes Cortos (SIGEM_MensajesCortosWS) 17. Antivirus (SIGEM_AntivirusWS) 18. Notariado para SIGNO (SIGEM_SignoWS) 19. Transferencia de Expedientes a Archivo (incluido en SIGEM_ArchivoWeb) 20. Servicio de Consulta sobre el Cliente Ligero de la Plataforma de Intermediación de Datos (SIGEM_ServicioIntermediacionClienteLigeroWS) 21. Catastro (SIGEM_CatastroWS) 22. Gestión de Sesiones de Administración (SIGEM_AdministracionSesionesAdmWS) 23. Gestión de Sesiones de Gestión (SIGEM_AdministracionSesionesBackOfficeWS) 24. Calendario de Trámites (SIGEM_CalendarioWS) 25. Certificación (SIGEM_CertificacionWS) 26. Entidades (SIGEM_EntidadesWS) 27. Estructura Organizativa (SIGEM_EstructuraOrganizativaWS) 28. Geolocalización (SIGEM_GeoLocalizacionWS) 29. Población para Registro Telemático (SIGEM_RegistroTelematicoDefaultTercerosConnectorWS) 30. Gestión de CSV (SIGEM_GestionCSVWS) 31. Consulta de Documentos de Registro Telemático por CSV (SIGEM_RegistroTelematicoWS) AL SIGM v3 Descripción y código Servicios Web SIGEM 13

14 3 Descripción de los Servicios Web de SIGEM 3.1 Servicio Web de Autenticación de Usuarios Este servicio proporciona al sistema SIGEM la funcionalidad para la gestión de usuarios externos (ciudadanos) e internos que tendrán acceso a las aplicaciones de tramitación electrónica mediante autenticación con usuario/contraseña. La política de acceso a las aplicaciones de tramitación electrónica se especifica mediante ficheros de propiedades, ubicados dentro de las propias aplicaciones, que permiten la definición del acceso mediante certificado digital, usuario/contraseña o ambos, por lo que estos usuarios no necesitarán tener un certificado digital para poder acceder a las funcionalidades que les ofrece SIGEM. Dichos servicios de gestión se despliegan como un servicio Web independiente basado en la implementación Axis. El servicio de distribuye como una aplicación Web dentro de un archivo war: SIGEM_AutenticacionUsuariosWS Métodos autenticarusuario Método autenticarusuario Método que autentica el usuario que se pasa como parámetro y obtiene todos los datos de dicho usuario. Parámetros Usuario Entidad Nombre y contraseña de usuario Código de entidad Retorno User Datos del usuario public Usuario autenticarusuario(usuario user, Entidad entidad) Valida el usuario y contraseña encriptada que se pasan como parámetros y recoge los datos del usuario autenticado user (Usuario). Objeto con la información de la persona que se ha autenticado en el sistema. Los datos a consignar en el objeto son: user. Código de usuario password. Contraseña de usuario entidad (Entidad) Objeto el código de entidad Los datos del usuario: Usuario. Objeto con la información de la persona y la información del estado de la operación: id. Identificación del usuario (NIF, NIE...) name. Nombre del usuario AL SIGM v3 Descripción y código Servicios Web SIGEM 14

15 lastname. Apellidos del usuario returncode. Código de estado de la operación returnerror. Código de error en caso de producirse obtenerusuario Método obtenerusuario Método que recupera los datos de un usuario Parámetros Usuario Entidad Nombre de usuario Código de entidad Retorno User Datos del usuario public Usuario obtenerusuario(usuario user, Entidad entidad) Recupera la información de en usuario a partir de su código de usuario. user (Usuario). Los datos a consignar en el objeto son: user. Código de usuario entidad (Entidad) Objeto el código de entidad Los datos del usuario: Usuario. Objeto con la información de la persona y el estado de la operación eliminarusuario Método eliminarusuario Elimina la información de un usuario Parámetros Usuario Entidad Usuario de acceso Código de entidad Retorno RetornoServicio Información del resultado de la operación public RetornoServicio eliminarusuario(usuario user, Entidad entidad) Elimina un usuario. user (Usuario). Los datos a consignar en el objeto son: user. Código de usuario entidad (Entidad) Objeto el código de entidad RetornoServicio. Objeto con el estado de la operación AL SIGM v3 Descripción y código Servicios Web SIGEM 15

16 buscarusuarios Método buscarusuarios Devuelve una lista de usuarios que cumplen el criterio de búsqueda que llega como parámetro Parámetros CriterioBusquedaUsuario Entidad Criterio de búsqueda Código de entidad Retorno ListaUsuarios Array de DatosUsuario public ListaUsuarios buscarusuarios(criteriobusquedausuario criteria, Entidad entidad) Devuelve un listado de usuarios encontrados con el criterio de búsqueda que se pasa como parámetro. criteria (CriterioBusquedaUsuario). Objeto que contiene el criterio de búsqueda entidad (Entidad) Objeto el código de entidad Los datos del usuario: ListaUsuarios. Listado de objetos User con los datos de los usuarios encontrados actualizarusuario Método actualizarusuario Actualiza los datos de un usuario Parámetros Usuario Entidad Datos del usuario Código de entidad Retorno RetornoServicio Información del resultado de la operación public RetornoServicio actualizarusuario(usuario user, Entidad entidad) Actualiza los datos de un usuario. user (Usuario). Objetos con los datos a actualizar del usuario. Los datos mínimos a consignar en el objeto son: user. Código de usuario entidad (Entidad) Objeto el código de entidad Los datos del usuario: RetornoServicio. Objeto con el estado de la operación AL SIGM v3 Descripción y código Servicios Web SIGEM 16

17 crearusuario Método crearusuario Método que da de alta en el sistema un nuevo usuario Parámetros Usuario Entidad Datos de usuario Código de entidad Retorno RetornoServicio Información del resultado de la operación public RetornoServicio crearusuario(usuario user, Entidad entidad) Crea un nuevo usuario con los datos suministrados. user (Usuario). Objeto que contiene todos los datos del nuevo usuario a crear. entidad (Entidad) Objeto el código de entidad Los datos del usuario: RetornoServicio. Objeto con el estado de la operación Clases RetornoServicio. Objeto con la información del estado de la operación returncode. Código de estado de la operación (OK, ERROR, error desconocido) errorcode. Código de error en caso de producirse ListaUsuarios. Listado de usuarios user[] Array de objetos Usuario Usuario. Objeto con la información del usuario user. Código de usuario password. Contraseña de usuario id. Identificación del usuario (NIF, NIE...) name. Nombre del usuario lastname. Apellidos del usuario Entidad. Datos de la entidad identificador. Código de identificación de la entidad CriterioBusquedaUsuario. Cadena con los campos del objeto usuario (Usuario) user, password,id,name,lastname Códigos de error =Error inesperado =Error: al acceder a la base de datos =Error: nombre/usuario no válido AL SIGM v3 Descripción y código Servicios Web SIGEM 17

18 =Error: al crear el usuario =Error: al eliminar el usuario =Error: al recuperar la información del usuario =Error: al actualizar la información del usuario =Error: al realizar búsqueda de usuarios AL SIGM v3 Descripción y código Servicios Web SIGEM 18

19 3.2 Servicio Web de Configuración del Catálogo de Trámites Este servicio proporciona al sistema SIGEM funcionalidad para la gestión de los tipos de solicitudes de Registro Telemático disponibles, así como sus políticas de seguridad (autenticación y firma), documentos necesarios para la tramitación, etc. El servicio se despliega como un servicio web independiente basado en la implementación Axis. El servicio de distribuye como una aplicación web dentro de un archivo war: SIGEM_CatalogoTramitesWS.war Métodos addprocedure Método addprocedure Método que da de alta un trámite Parámetros Tramite Entidad Datos del trámite Código de entidad Retorno RetornoServicio public RetornoServicio addprocedure(tramite procedure, Entidad entidad) Crea un nuevo trámite de registro electrónico. procedure (Tramite). Objeto que contiene todos los datos del trámite a crear entidad (Entidad). Objeto que contiene el código de entidad con la que se está trabajando El estado de la operación: RetornoServicio. Objeto con el estado de la operación getprocedure Método getprocedure Método que obtiene un trámite Parámetros RetornoLogico Identificador del trámite Determina si deben cargarse tipos de documentos asociados al trámite Entidad Código de entidad Retorno Tramite Datos del trámite AL SIGM v3 Descripción y código Servicios Web SIGEM 19

20 public Tramite getprocedure( procedureid, RetornoLogico loaddocuments, Entidad entidad) Recupera los datos de un trámite. procedureid. Cadena de texto alfanumérico con el identificador del trámite a recuperar loaddocuments (RetornoLogico). Objeto de valor booleano que identifica si debe devolverse la información de los documentos asociados al trámite entidad (Entidad). Objeto que contiene el código de entidad Los datos del trámite: Tramite. Objeto con los datos del trámite recuperado query Método query Método que realiza un consulta sobre los trámites Parámetros TramiteConsulta Entidad Parámetros de la consulta Código de entidad Retorno Tramites Trámites obtenidos en la consulta a partir de los parámetros definidos public Tramites query(tramiteconsulta query, Entidad entidad) Recupera el listado de trámites que cumplen la condición que se pasa como parámetro. query (TramiteConsulta). Objeto con los datos de la búsqueda entidad (Entidad). Objeto que contiene el código de entidad Los datos de los trámites que coinciden con el criterio de búsqueda: Tramites. Listado de objeto Tramite recuperados deleteprocedure Método deleteprocedure Método que elimina un trámite Parámetros Entidad Identificador del trámite Código de entidad Retorno RetornoServicio AL SIGM v3 Descripción y código Servicios Web SIGEM 20

21 public RetornoServicio deleteprocedure( procedureid, Entidad entidad) Elimina un trámite del catálogo y los datos asociados al mismo procedureid. Cadena de texto alfanumérico con el identificador del trámite a eliminar entidad (Entidad). Objeto que contiene el código de entidad El estado de la operación: RetornoServicio. Objeto con el estado de la operación updateprocedure Método updateprocedure Método que actualiza la información de un trámite Parámetros Tramite Entidad Datos actualizados del trámite Código de entidad Retorno RetornoServicio public RetornoServicio updateprocedure(tramite procedure, Entidad entidad) Actualiza los datos de un trámite. procedure (Tramite). Objeto con los datos a actualizar entidad (Entidad). Objeto que contiene el código de entidad El estado de la operación: RetornoServicio. Objeto con el estado de la operación isdocumentreferenced Método isdocumentreferenced Método que informa si un tipo de documento está asociado a algún trámite Parámetros Entidad Identificador de documento Código de entidad Retorno RetornoLogico true si está asociado el documento a algún trámite, false si no lo está public RetornoLogico isdocumentreferenced( documentid, Entidad entidad) AL SIGM v3 Descripción y código Servicios Web SIGEM 21

22 Informa si el tipo de documento cuyo identificador se pasa como parámetro está asociado con algún trámite. documentid. Cadena alfanumérica con el identificador de tipo de documento entidad (Entidad). Objeto que contiene el código de entidad Si un tipo de documento está asociado o no: RetornoLogico. Objeto de valor booleano que identifica si el documento se encuentra asociado a algún trámite o no addproceduredocument Método addproceduredocument Método que da de alta la asociación entre un trámite y un tipo documento Parámetros DocumentoTramite Entidad Datos de la asociación a dar de alta Código de entidad Retorno RetornoServicio public RetornoServicio addproceduredocument(documentotramite proceduredocument, Entidad entidad) Asocia un tipo de documento a un trámite y crea la información de la relación. proceduredocument (DocumentoTramite). Objeto con los datos de la asociación del tipo de documento y trámite entidad (Entidad). Objeto que contiene el código de entidad El estado de la operación: RetornoServicio. Objeto con el estado de la operación deleteproceduredocument Método deleteproceduredocument Método que elimina la sociación entre un trámite y un tipo de documento Parámetros DocumentoTramite Entidad Datos de la asociación a eliminar Código de entidad Retorno RetornoServicio public RetornoServicio deleteproceduredocument(documentotramite proceduredocument, Entidad entidad) AL SIGM v3 Descripción y código Servicios Web SIGEM 22

23 Elimina la asociación entre un tipo de documento y un trámite. proceduredocument (DocumentoTramite). Objeto con los datos de la asociación del tipo de documento y trámite entidad (Entidad). Objeto que contiene el código de entidad El estado de la operación: RetornoServicio. Objeto con el estado de la operación AL SIGM v3 Descripción y código Servicios Web SIGEM 23

24 getdocument Método getdocument Método que obtiene un tipo de documento Parámetros Entidad Identiicador del documento Código de entidad Retorno Documento Datos del tipo de documento public Documento getdocument( documentid, Entidad entidad) Recupera la información de un tipo de documento. documentid. Cadena de texto alfanumérico con el identificador de tipo de documento a recuperar entidad (Entidad). Objeto que contiene el código de entidad Información de tipo de documento: Documento. Objeto con los datos del tipo de documento recuperado adddocument Método adddocument Método que da de alta un tipo de documento Parámetros Documento Entidad Datos del documento a dar de alta Código de entidad Retorno RetornoServicio public RetornoServicio adddocument(documento document, Entidad entidad) Añade un tipo de documento al catálogo. document (Documento). Objeto con toda la información del tipo de documento a crear entidad (Entidad). Objeto que contiene el código de entidad El estado de la operación: RetornoServicio. Objeto con el estado de la operación AL SIGM v3 Descripción y código Servicios Web SIGEM 24

25 deletedocument Método deletedocument Método que elimina un documento Parámetros Entidad Identificador del documento Código de entidad Retorno RetornoServicio public RetornoServicio deletedocument( documentid, Entidad entidad) Elimina un tipo de documento del catálogo. documentid. Cadena alfanumérica con el identificador de tipo de documento a eliminar entidad (Entidad). Objeto que contiene el código de entidad El estado de la operación: RetornoServicio. Objeto con el estado de la operación updatedocument Método updatedocument Método que actualiza los datos de un tipo de documento Parámetros Documento Entidad Datos actualizados del documento Código de entidad Retorno RetornoServicio public RetornoServicio updatedocument(documento document, Entidad entidad) Actualiza los datos de un tipo de documento. document (Documento). Objeto con la información del tipo de documento a actualizar entidad (Entidad). Objeto que contiene el código de entidad El estado de la operación: RetornoServicio. Objeto con el estado de la operación getdocuments AL SIGM v3 Descripción y código Servicios Web SIGEM 25

26 Método getdocuments Métodos que obtiene los tipos de documentos dados de alta Parámetros Entidad Código de entidad Retorno Documentos Documentos dados de alta en el sistema public Documentos getdocuments(entidad entidad) Recupera todo el listado de tipos de documento del catálogo. entidad (Entidad). Objeto que contiene el código de entidad El listado de los documentos del catálogo: Documentos. Array de objetos con la información de los tipos de documentos getproceduredocuments Método getproceduredocuments Método que obtiene todos los tipos de documento asociados a un trámite Parámetros Entidad Identificador del trámite Código de entidad Retorno Documentos Documentos asociados a un trámite public Documentos getproceduredocuments( procedureid, Entidad entidad) Recupera el listado de documentos asociados a un trámite. procedureid. Cadena alfanumérica con el identificador del trámite entidad (Entidad). Objeto que contiene el código de entidad El listado de los documentos: Documentos. Array de objetos con la información de los tipos de documentos getproceduredocument Método getproceduredocument Método que obtiene los datos de la asociación de un trámite con un tipo de documento Parámetros Entidad Identificador del trámite Identificador del documento Código de entidad Retorno DocumentoTramite de la asociación de un documento a un AL SIGM v3 Descripción y código Servicios Web SIGEM 26

27 trámite public DocumentoTramite getproceduredocument( procedureid, documentid, Entidad entidad) Recupera la información de relación de un tipo de documento con un trámite. procedureid. Cadena alfanumérica con el identificador del trámite documentid. Cadena alfanumérica con el identificador del tipo de documento entidad (Entidad). Objeto que contiene el código de entidad Los datos de relación: DocumentoTramite. Objeto con toda la información que relaciona un tipo de documento y un trámite updateproceduredocument Método updateproceduredocument Método que actualiza la asociación entre un trámite y un tipo de documento Parámetros DocumentoTramite Entidad Datos actualizados de la asociación Código de entidad Retorno RetornoServicio public RetornoServicio updateproceduredocument(documentotramite proceduredocument, Entidad entidad) Actualiza la información de relación de un tipo de documento y un trámite. proceduredocument (DocumentoTramite). Objeto con la información que se desea actualizar de la relación de tipo de documento y trámite entidad (Entidad). Objeto que contiene el código de entidad El estado de la operación: RetornoServicio. Objeto con el estado de la operación getprocedures Método getprocedures Método que obtiene la lista de trámites dados de alta en el sistema Parámetros Entidad Código de entidad AL SIGM v3 Descripción y código Servicios Web SIGEM 27

28 Retorno Tramites Lista de trámites public Tramites getprocedures(entidad entidad) Recupera el listado de todos los trámites del catálogo. entidad (Entidad). Objeto que contiene el código de entidad Los datos de los trámites dados de alta en el catálogo: Tramites. Listado de objetos Tramite recuperados getdocumentfromcode Método getdocumentfromcode Método que obtiene un documento a partir del código de documento (código único que asocia un trámite con un tipo de documento Parámetros Emtidad Código de documento Código de entidad Retorno Documento Datos del documento public Documento getdocumentfromcode ( code, Entidad entidad) Obtiene un documento a partir del código de documento (código único que asocia un trámite con un tipo de documento. code. Cadena alfanumérica con el código único de documento entidad (Entidad). Objeto que contiene el código de entidad Información de tipo de documento: Documento. Objeto con los datos del tipo de documento recuperado getaddressee Método getaddressee Método que obtiene un órgano destinatario Parámetros Entidad Identificador del órgano destinatario Código de entidad Retorno OrganoDestinatario Datos del órgano destinatario public OrganoDestinatario getaddressee( addresseeid, Entidad entidad) AL SIGM v3 Descripción y código Servicios Web SIGEM 28

29 Recupera la información de un órgano destinatario. addresseeid. Cadena alfanumérica con el identificador de órgano destinatario entidad (Entidad). Objeto que contiene el código de entidad Información de tipo de documento: OrganoDestinatario. Objeto con los datos del órgano destinatario addaddressee Método addaddressee Método que da de alta un órgano destinatario Parámetros OrganoDestinatario Entidad Datos del órgano destinatario Código de entidad Retorno RetornoServicio public RetornoServicio addaddressee(organodestinatario addressee, Entidad entidad) Añade al catálogo una nueva oficina destinataria. addressee (OrganoDestinatario). Objeto con los datos del órgano destinatario entidad (Entidad). Objeto que contiene el código de entidad El estado de la operación: RetornoServicio. Objeto con el estado de la operación deleteaddressee Método deleteaddressee Método que elimina un órgano destinatario Parámetros Entidad Identificador del órgano destinatario Código de entidad Retorno RetornoServicio public RetornoServicio deleteaddressee( addresseeid, Entidad entidad) Elimina del catálogo una oficina destinataria. AL SIGM v3 Descripción y código Servicios Web SIGEM 29

30 addresseeid. Cadena alfanumérica con el identificador de órgano destinatario entidad (Entidad). Objeto que contiene el código de entidad El estado de la operación: RetornoServicio. Objeto con el estado de la operación updateaddressee Método updateaddressee Método que actualiza un órgano destinatario Parámetros OrganoDestinatario Datos actualizados del órgano destinatario Entidad Código de entidad Retorno RetornoServicio public RetornoServicio updateaddressee(organodestinatario addressee, Entidad entidad) Actualiza los datos de una oficina destinataria. addressee (OrganoDestinatario). Objeto con los datos del órgano destinatario entidad (Entidad). Objeto que contiene el código de entidad El estado de la operación: RetornoServicio. Objeto con el estado de la operación getaddressees Método getaddressees Método que obtiene una lista de órrganos destinatarios Parámetros Entidad Código de entidad Retorno OrganosDestinatarios Lista de órganos destinatarios public OrganosDestinatarios getaddressees(entidad entidad) Obtiene los datos de los órganos destinatarios dados de alta en el catálogo. entidad (Entidad). Objeto que contiene el código de entidad AL SIGM v3 Descripción y código Servicios Web SIGEM 30

31 Información de tipo de documento: OrganosDestinatarios. Listado de objetos todos los datos de los órganos destinatarios gethook Método gethook Método que obtiene un conector Parámetros Entidad Identiicador de conector Código de entidad Retorno Conector Datos del conector public Conector gethook( hookid, Entidad entidad) Obtiene los datos de un conector. hookid. Cadena alfanumérica con el identificador del conector entidad (Entidad). Objeto que contiene el código de entidad Información de implementación de seguridad: Conector. Objeto con los datos del conector de implementación de seguridad addhook Método addhook Método que da de alta un conector Parámetros Conector Entidad Datos del conector Código de entidad Retorno RetornoServicio public RetornoServicio addhook(conector hook, Entidad entidad) Añade un nuevo conector al catálogo. hook (Conector). Objeto con los datos del conector a añadir en el catálogo entidad (Entidad). Objeto que contiene el código de entidad El estado de la operación: RetornoServicio. Objeto con el estado de la operación deletehook Método deletehook Método que elimina un conector AL SIGM v3 Descripción y código Servicios Web SIGEM 31

32 Parámetros Entidad Retorno RetornoServicio Identificador de conector Código de entidad public RetornoServicio deletehook( hookid, Entidad entidad) Elimina un conector del catálogo. hookid. Cadena alfanumérica con el identificador del conector entidad (Entidad). Objeto que contiene el código de entidad El estado de la operación: RetornoServicio. Objeto con el estado de la operación updatehook Método updatehook Método que actualiza un conector Parámetros Conector Entidad Datos actualizados del conector Código de entidad Retorno RetornoServicio public RetornoServicio updatehook(conector hook, Entidad entidad) Actualiza los datos de un conector del catálogo. hook (Conector). Objeto con los datos a actualizar del conector entidad (Entidad). Objeto que contiene el código de entidad El estado de la operación: RetornoServicio. Objeto con el estado de la operación gethooks Método gethooks Método que obtiene una lista de conectores Parámetros Entidad Código de entidad Retorno Conectores Lista de conectores public Conectores gethooks(entidad entidad) Recupera la información de los conectores de seguridad existentes en el catálogo. AL SIGM v3 Descripción y código Servicios Web SIGEM 32

33 entidad (Entidad). Objeto que contiene el código de entidad Listado de conectores existentes: Conectores. Listado de objetos con la información de los conectores dados de alta gethooksbytype Método gethooksbytype Método que obtiene una lista de conectores de un tipo determinado Parámetros Entidad Identificador de tipo de conector Código de entidad Retorno Conectores Lista de conectores del tipo especificado public Conectores gethooksbytype( hooktype, Entidad entidad) Recupera la información de los conectores del tipo de implementación indicado existentes en el catálogo. hooktype. Cadena alfanumérica con el identificador de tipo de conector entidad (Entidad). Objeto que contiene el código de entidad Listado de conectores existentes: Conectores. Listado de objetos con la información de los conectores existentes del tipo definido gethooktype Método gethooktype Método que obtiene un tipo de conector Parámetros Entidad Identificador del tipo de conector Código de entidad Retorno TipoConector Datos del tipo de conector public TipoConector gethooktype( typeid, Entidad entidad) Recupera la información de un tipo de implementación de seguridad typeid. Cadena alfanumérica con el identificador de tipo de conector entidad (Entidad). Objeto que contiene el código de entidad AL SIGM v3 Descripción y código Servicios Web SIGEM 33

34 Listado de conectores existentes: TipoConector. Información del tipo de conector addhooktype Método addhooktype Método que da de alta un tipo de conector Parámetros TipoConector Entidad Datos del tipo de conector Código de entidad Retorno RetornoServicio public RetornoServicio addhooktype(tipoconector hooktype, Entidad entidad) Añade un nuevo tipo de implementación de seguridad al catálogo hooktype (TipoConector). Objeto con los datos del tipo de conector a añadir en el catálogo entidad (Entidad). Objeto que contiene el código de entidad El estado de la operación: RetornoServicio. Objeto con el estado de la operación deletehooktype Método deletehooktype Método que elimina un tipo de conector Parámetros Entidad Identificador del tipo de conector Código de entidad Retorno RetornoServicio public RetornoServicio deletehooktype( typeid, Entidad entidad) Elimina un tipo de implementación de seguridad al catálogo typeid. Cadena alfanumérica con el identificador de tipo de conector entidad (Entidad). Objeto que contiene el código de entidad El estado de la operación: RetornoServicio. Objeto con el estado de la operación AL SIGM v3 Descripción y código Servicios Web SIGEM 34

35 updatehooktype Método updatehooktype Método que actualiza un tipode conector Parámetros TipoConector Entidad Datos actualizados del tipo de conector Código de entidad Retorno RetornoServicio public RetornoServicio updatehooktype(tipoconector hooktype, Entidad entidad) Actualiza los datos de un tipo de implementación de seguridad al catálogo hooktype (TipoConector). Objeto con los datos del tipo de conector a actualizar entidad (Entidad). Objeto que contiene el código de entidad El estado de la operación: RetornoServicio. Objeto con el estado de la operación gethooktypes Método gethooktypes Método que obtiene una lista de tipos de conectores Parámetros Entidad Código de entidad Retorno TiposConectores Lista de tipos de conectores dados de alta en el sistema public TiposConectores gethooktypes(entidad entidad) Devuelve un listado con los tipos de conectores existentes en el catálogo de una entidad entidad (Entidad). Objeto que contiene el código de entidad Listado de tipos de conector: TiposConectores. Array de objetos de tipo de conector existentes getauthhooks Método getauthhooks Método que obtiene los conectores de autenticación asociados a un trámite AL SIGM v3 Descripción y código Servicios Web SIGEM 35

36 Parámetros Entidad Identificador del trámite Código de entidad Retorno ConectoresAutenticacion Datos de los conectores de autenticación asociados a un trámite public ConectoresAutenticacion getauthhooks( tramiteid, Entidad entidad) Devuelve un listado con los conectores de tipos de autenticación válidos para un trámite electrónico. tramiteid. Cadena alfanumérica con un identificador de trámite entidad (Entidad). Objeto que contiene el código de entidad Listado de conectores de autenticación: ConectoresAutenticacion. Array de objetos conector de autenticación addauthhooks Método addauthhooks Método que da de alta la asociación de un conector de autenticación a un trámite Parámetros ConectorAutenticacion Entidad Datos del conector de autenticación Código de entidad Retorno RetornoServicio public RetornoServicio addauthhooks(conectorautenticacion authhook, Entidad entidad) Añade una implementación de autenticación para un trámite. authhook (ConectorAutenticacion). Objeto con la relación conector de seguridad de autenticación-trámite entidad (Entidad). Objeto que contiene el código de entidad El estado de la operación: RetornoServicio. Objeto con el estado de la operación deleteauthhooks Método deleteauthhooks Método que elimina la asociación de un conector de autenticación con un trámite AL SIGM v3 Descripción y código Servicios Web SIGEM 36

37 Parámetros Entidad Retorno RetornoServicio Identificador del trámite Identificador del conector Código de entidad public RetornoServicio deleteauthhooks( tramiteid, conectorid, Entidad entidad) Elimina la relación de implementación de seguridad para un trámite electrónico. tramiteid. Cadena alfanumérica con el identificador de trámite conectorid. Cadena alfanumérica con el identificador de conector entidad (Entidad). Objeto que contiene el código de entidad El estado de la operación: RetornoServicio. Objeto con el estado de la operación updateauthhooks Método updateauthhooks Método que actualiza la asociación entre un conector de autenticación y un trámite Parámetros ConectorAutenticacion Retorno Entidad RetornoServicio Datos actualizados de la asociación Identificador del conector que se quiere modificar antes de la modificación Código de entidad public RetornoServicio updateauthhooks(conectorautenticacion conectorautenticacion, oldhookid, Entidad entidad) Actualiza la relación de implementación de seguridad para un trámite electrónico. conectorautenticacion (ConectorAutenticacion). Objeto con la relación conector de seguridad de autenticación-trámite oldhookid. Cadena alfanumérica con el identificador de conector a actualizar entidad (Entidad). Objeto que contiene el código de entidad El estado de la operación: RetornoServicio. Objeto con el estado de la operación AL SIGM v3 Descripción y código Servicios Web SIGEM 37

38 getauthhook Método getauthhook Método que obtiene un conector de autenticación Parámetros Entidad Identificador del trámite Identificador del conector Código de entidad Retorno ConectorAutenticacion Datos del conector de autenticación public ConectorAutenticacion getauthhook( tramiteid, conectorid, Entidad entidad) Devuelve la información de la implementación de seguridad para un trámite. tramiteid. Cadena alfanumérica con el identificador de trámite conectorid. Cadena alfanumérica con el identificador de conector entidad (Entidad). Objeto que contiene el código de entidad El estado de la operación: ConectorAutenticacion. Objeto con la información de la implementación de autenticación asociada al trámite Clases RetornoServicio. Objeto con la información del estado de la operación. returncode. Código de estado de la operación realizada (OK, ERROR, error desconocido) errorcode. Código de error en caso de producirse Tramite. Objeto con la información funcional de tipo de solicitud de registro electrónico. id. Clave primaria del trámite topic. Código de asunto del trámite description. Descripción de asunto del trámite addressee. Código de oficina destinataria limitdocs. Si está limitado el número de documentos a aportar por el ciudadano a los definidos en el trámite o puede aportar más documentos. Cadena true/false firma: Si el ciudadano debe firmar la solicitud. Cadena true/false documents (Documentos). Listado de objetos tipo de documento asociados al trámite oficina. Código de oficina de tramitación electrónica idprocedimiento. Código de procedimiento administrativo en caso de iniciar expediente automáticamente. RetornoLogico. Contiene una cadena con valor booleano. valor. Cadena true/false AL SIGM v3 Descripción y código Servicios Web SIGEM 38

39 TramiteConsulta. Objeto con los parámetros de trámite por los que se puede realizar búsquedas. id. Identificador de trámite topic. Código de asunto del trámite addressee. Código de oficina destinataria Tramites. Listado de objetos de tipo trámite. Tramite[] Array de objetos trámite Entidad. Datos de la entidad identificador. Código de identificación de la entidad DocumentoTramite. Información de asociación de un tipo de documento a un trámite. procedureid. Identificador del trámite documentid. Identificador de tipo de documento code. Código descriptivo único de identificación de la relación entre trámite y tipo de documento mandatory. Cadena true/false que indica si el documento debe ser aportado obligatoriamente al realizar el apunte de registro Documento. Información de tipo de documento. id. Identificador de tipo de documento description. Descripción de tipo de documento extension. Extensión permitida para el tipo de documento signaturehook. Identificador de conector de validación de firma validationhook. Identificador de conector de validación de contenido Documentos. Listado de documentos de formato extendido para que puedan ser incluidos en un procedimiento. documentos (DocumentoExtendido[]). Array de objetos documento extendido con toda la información de los documentos. DocumentoExtendido. Extensión al objeto documento que incluye información de vinculación con los trámites. id. Identificador de tipo de documento description. Descripción de tipo de documento extension. Extensión permitida para el tipo de documento signaturehook. Identificador de conector de validación de firma validationhook. Identificador de conector de validación de contenido code. Código único de relación del tipo documento con el trámite mandatory. Cadena booleana que indica si el documento es obligatorio para el trámite DocumentoTramite. Información de relación entre un tipo de documento y un trámite. procedureid. Identificador de trámite. documentid. Identificador de tipo de documento code. Código único de relación del tipo documento con el trámite mandatory. Cadena booleana que indica si el documento es obligatorio para el trámite AL SIGM v3 Descripción y código Servicios Web SIGEM 39

40 OrganoDestinatario. Descripción de las oficinas destinatarias de registros electrónicos. id. Identificador de oficina description. Breve descripción identificativa de oficina OrganosDestinatarios. Listado de organos destinatarios. organosdestinatarios (OrganoDestinatario[]). Array de objetos órgano destinatario con la información de las oficinas Conector. Información del conector de implementación de seguridad. id. Identificador de conector description. Descripción de la implementación type. Tipo de conector, esto es, que tipo de seguridad implementa (verificación, firma...) Conectores. Listado de conectores de implementación de seguridad. conectores (Conector[]). Array de objetos conector TipoConector. Información descriptiva de tipos de implementaciones de seguridad diponibles en el catálogo id. Identificador de tipo de conector description. Descripción de tipo de implementación TiposConectores. Listado de tipos de conectores de seguridad. tiposconectores (TipoConector[]). Array de objetos de tipo conector ConectorAutenticacion. Información relacional de la implementación/es de seguridad que utiliza un trámite. tramiteid. Identificador de trámite conectorid. Identificador de conector de seguridad ConectoresAutenticacion. Listado de objetos conector de autenticación. conectorautenticacion (ConectorAutenticacion[]). Array de objetos con los datos de seguridad de los trámites del catálogo Códigos de error =Error: en la base de datos del catálogo de trámites =Error: al acceder a la base de datos =Error: el identificador de trámite no es válido =Error: el identificador de documento no es válido =Error: al crear el documento =Error: al eliminar el documento =Error: al recuperar la información del documento =Error: al actualizar la información del documento =Error: al crear el trámite =Error: al eliminar el trámite =Error: al recuperar la información del trámite =Error: al actualizar la información del trámite =Error: el documento está siendo utilizado en algún trámite. Debe eliminarlo en primer lugar de dicho trámite AL SIGM v3 Descripción y código Servicios Web SIGEM 40

41 =Error: al recuperar la lista de trámites =Error: al recuperar la lista de documentos =Error: al recuperar un documento del trámite =Error: el identificador del trámite o del documento no es válido =Error: al crear un documento del trámite =Error: al eliminar un documento del trámite =Error: al actualizar un documento del trámite =Error: al recuperar el órgano destinatario =Error: el identificador del órgano destinatario no es válido =Error: al crear un órgano destinatario =Error: al actualizar un órgano destinatario =Error: al recuperar la lista de órganos destinatarios =Error: el órgano destinatario está en uso =Error: al eliminar un órgano destinatario =Error: al recuperar un conector =Error: el identificador del conector no es válido =Error: al crear un conector =Error: el actualizar un conector =Error: al eliminar un conector =Error: al recuperar la lista de conectores =Error: al recuperar un tipo de conector =Error: el identificador del tipo de conector no es válido =Error: al crear un tipo de conector =Error: el actualizar un tipo de conector =Error: al eliminar un tipo de conector =Error: al recuperar la lista de tipos de conectores =Error: Al crear un conector de autenticación =Error: El identificador del conector de autenticación no es válido =Error: Al actualizar un conector de autenticación =Error: Al eliminar un conector de autenticación =Error: Al recuperar la lista de conectores de autenticación =Error: Al recuperar un conector de autenticación. AL SIGM v3 Descripción y código Servicios Web SIGEM 41

42 3.3 Servicio Web de Consulta de Expedientes Este servicio proporciona al sistema SIGEM la funcionalidad la publicación de hitos, avisos y documentos generados, durante la tramitación de los expedientes, para su consulta por parte de los interesados desde la aplicación web de consulta. El servicio se despliega como un servicio web independiente. El servicio web se basa en la implementación Axis. El servicio de distribuye como una aplicación web dentro de un archivo war: SIGEM_ConsultaWS.war. Para más detalle sobre el uso de este servicio web, consulte el anexo Ejemplos del uso del Servicio Web de Consulta de Expedientes en este manual Métodos consultarexpedientesnif Método consultarexpedientesnif Método que obtiene los expedientes pertenecientes a un usuario Parámetros CriterioBusquedaExpedientes Entidad Documento de identidad del usuario Identificador de entidad Retorno Expedientes Lista de expedientes del usuario dados de alta en el sistema consultarexpedientes Método consultarexpedientes Método que realiza un búsqueda de expedientes a partir de determinados parámetros de búsqueda Parámetros CriterioBusquedaExpedientes Entidad Parámetros de búsqueda Código de identificación de entidad Retorno Expedientes Lista de expedientes resultantes de la búsqueda obtenerurlaportacionexpedientes Método obtenerurlaportacionexpedientes Método que obtiene la url del enlace de aportación de documentos (subsanación) Parámetros Entidad Código de identificación de entidad Retorno Url URL del enlace de subsanación AL SIGM v3 Descripción y código Servicios Web SIGEM 42

43 obtenerurlnotificacionexpedientes Método obtenerurlnotificacionexpedientes Método que obtiene la url del enlace de notificación Parámetros Entidad Código de identificación de entidad Retorno Url URL del enlace de notificación obtenerurlpagotasas Método obtenerurlpagotasas Método que obtiene la url del enlace de pago de tasas Parámetros Entidad Código de identificación de entidad Retorno Url URL del enlace de pago de tasas obtenerdetalle Método obtenerdetalle Método que obtiene los datos detallados de un expediente Parámetros Expediente Entidad Identificador de expediente Código de identificación de entidad Retorno Expediente Datos del expediente obtenerhistoricoexpediente Método obtenerhistoricoexpediente Método que obtiene el histórico de hitos de un expediente Parámetros Expediente Entidad Identificador de expediente Código de identificación de entidad Retorno HitosExpediente Listado de hitos históricos obtenerhitoestado Método obtenerhitoestado Método que obtiene le hito actual de un expediente Parámetros Expediente Entidad Identificador de expediente Código de identificación de entidad Retorno HitoExpediente Datos del hito actual del expediente btenerficheroshito Método obtenerficheroshito Método que obtiene los ficheros AL SIGM v3 Descripción y código Servicios Web SIGEM 43

44 asociados a un hito Parámetros HitoExpediente Entidad Identificador de hito Código de identificación de entidad Retorno FicherosHito Listado de ficheros asociados al hito obtenerficheroshitos Método obtenerficheroshitos Método que obtiene los ficheros asociados a un listado de hitos Parámetros HitosExpediente Listado de hitos de los que obtener sus ficheros Entidad Código de identificación de entidad Retorno FicherosHitos Listado de ficheros asociados a los hitos nuevoexpediente Método nuevoexpediente Método que da de alta un expediente Parámetros Expediente Interesado Datos del expediente Datos del interesado (si es null no se asocia al expediente un interesado) Entidad Código de identificación de entidad Retorno RetornoServicio eliminarexpediente Método eliminarexpediente Método que elimina un expediente Parámetros Expediente Entidad Datos del expediente a eliminar Código de identificación de entidad Retorno RetornoServicio nuevointeresado Método nuevointeresado Método que da de alta un interesado Parámetros Interesado Entidad Datos del interesado Código de identificación de entidad Retorno RetornoServicio eliminarinteresado Método eliminarinteresado Método que elimina un interesado Parámetros Interesado Datos del interesado Retorno RetornoServicio AL SIGM v3 Descripción y código Servicios Web SIGEM 44

45 eliminarinteresadoexpediente Método eliminarinteresadoexpediente Método que elimina el interesado de un expediente Parámetros Identificador de expediente Retorno RetornoServicio establecerhitoactual Método establecerhitoactual Método que establece un nuevo hito actual para un expediente Parámetros HitoExpediente FicherosHito Historico Datos del hito a establecer como actual Ficheros asociados al hito Determina si se deben pasar el hito al histórico Retorno RetornoServicio eliminarhitoactual Método eliminarhitoactual Método que elimina el hito actual de un expediente Parámetros Expediente Identificador de expediente Retorno RetornoServicio nuevohitohistorico Método nuevohitohistorico Método que da de alta un hito histórico para un expediente Parámetros HitoExpediente Datos del hito histórico Retorno RetornoServicio eliminarhitohistorico Método eliminarhitohistorico Método que elimina el listado de hitos históricos para un expediente Parámetros HitoExpediente Identificador del expediente Retorno RetornoServicio cargardocumento AL SIGM v3 Descripción y código Servicios Web SIGEM 45

46 Método cargardocumento Método que carga un documento Parámetros InfoDocumento Identificador del documento Retorno InfoDocumento Ruta del documento recogerdocumento Método recogerdocumento Método que carga un documento Parámetros InfoDocumento Identificador del documento Retorno InfoDocumento Datos del documento busquedaexpedientes Método busquedaexpedientes Método que busca expedientes determinado por unos parámetros Parámetros CriterioBusquedaExpedientes Parámetros de búsqueda Retorno Expedientes Lista de expedientes anexarficheroshitoactual Método anexarficheroshitoactual Método que anexa ficheros al hito actual Parámetros FicherosHito Lista de ficheros a anexar Retorno RetornoServicio existennotificaciones Método existennotificaciones Método que comprueba si existen notificaciones para un expediente Parámetros Expediente Identificador del expediente Retorno RetornoLogico true si existen notificaciones, false si no existensubsanaciones Método existensubsanaciones Método que comprueba si existen subsanaciones para un expediente Parámetros Expediente Identificador del expediente Retorno RetornoLogico true si existen subsanaciones, false si no AL SIGM v3 Descripción y código Servicios Web SIGEM 46

47 existenpagos Método existenpagos Método que comprueba si existen pagos pendientes para un expediente Parámetros Expediente Identificador del expediente Retorno RetornoLogico true si existen pagos pendiente, false si no recogernotificaciones Método recogernotificaciones Método que utiliza el servicio de notificaciones de SIGEM para conocer si el expediente tiene alguna notificación en curso. Parámetros Expediente Datos de expediente Retorno NotificacionesPendientes Listado de notificaciones pendientes altasolicitudsubsanacion Método altasolicitudsubsanacion Método que da de alta y asocia al hito actual un nueva solicitud de subsanación. Se utiliza desde la tramitación de expedientes para publicar en la consulta de expedientes del ciudadano la necesidad de aportar nueva documentación al expediente. La publicación de esta solicitud de subsanación suele ir acompañada de una notificación previa. Parámetros Subsanacion Objeto que encapsula los datos de la subsanación Retorno RetornoServicio obtenersubsanacioneshitoactual Método obtenersubsanacioneshitoactual Método que devuelve una lista de objetos Subsanación que estén asociados al hito actual del expediente Parámetros Expediente Datos del expediente Retorno Subsanaciones ArrayList con la lista de objetos Subsanación obtenersubsanacioneshito AL SIGM v3 Descripción y código Servicios Web SIGEM 47

48 Método obtenersubsanacioneshito Método que devuelve una lista de objetos Subsanación que estén asociados al hito actual del expediente Parámetros HitoExpediente Identificador del hito del que se quiere recuperar la lista de solicitudes de subsanación Retorno Subsanaciones ArrayList con la lista de objetos Subsanación altasolicitudpago Método altasolicitudpago Método que da de alta y asocia al hito actual del procedimiento un solicitud de realización de pago y aportación de documentación al expediente Parámetros Pago Objeto con los datos del pago Retorno RetornoServicio obtenerpagoshitoactual Método obtenerpagoshitoactual Método que devuelve una lista de objetos Pago asociados al hito actual del expediente Parámetros Expediente Datos del expediente Retorno Pagos ArrayList con la lista de Pagos obtenerpagoshito Método obtenerpagoshito Método que devuelve una lista de objetos Pago asociados al hito que llega como parámetro Parámetros HitoExpediente Identificador del hito del que se quiere recuperar la lista de solicitudes de pagos Retorno Pagos ArrayList con la lista de Pagos altanotificacion Método altanotificacion Método que da de alta y asocia al hito actual la información referente a una notificación en curso en el sistema de notificaciones de SIGEM. Este método es usado desde la tramitación para publicar que se ha realizado una notificación. Previa a su publicación la notificación se ha dado de alta en el AL SIGM v3 Descripción y código Servicios Web SIGEM 48

49 Parámetros Notificacion Retorno RetornoServicio servicio de notificaciones y el identificador devuelto por este sistema se pasa como atributo de la clase Notificacion Datos de la notificación para su publicación obtenernotificioneshitoactual Método obtenernotificioneshitoactual Devuelve una lista de objetos Notificacion con los datos publicados de las notificaciones en curso para el hito actual Parámetros Expediente Datos del expediente Retorno Notificaciones ArrayList con la lista de Notificaciones obtenernotificioneshito Método obtenernotificioneshito Devuelve una lista de objetos Notificacion con los datos publicados de las notificaciones en curso para cuyo identificador se pasa como parámetro Parámetros HitoExpediente Identificador del hito del que se quiere recuperar la lista de solicitudes de notificaciones Retorno Notificaciones ArrayList con la lista de Notificaciones Códigos de error =Error: en la obtención de todos los valores =Error: al insertar los valores =Error: al añadir valor =Error: al borrar valores =Error: al cerrar la conexión =Error: identificador no válido =Error: al cargar el expediente =Error: al cargar los expedientes del interesado =El NIF del interesado no es válido =El código de expediente no es válido =No se puede cargar el expediente {0} =El identificador del hito es incorrecto =Imposible cargar los hitos de un expediente =Imposible cargar interesado de un expediente =Imposible cargar expedientes de un interesado =Certificado X509 no encontrado =Imposible cargar los ficheros del hito con identificador {0} AL SIGM v3 Descripción y código Servicios Web SIGEM 49

50 =Formato de fecha incorrecto =Imposible cargar el hito de estado del expediente =Imposible insertar un fichero de un hito =Imposible eliminar un fichero de un hito =Imposible insertar un expediente =Imposible eliminar un expediente =Imposible insertar un hito de estado =Imposible eliminar un hito de estado =Imposible insertar un hito en el histórico =Imposible eliminar un hito en el histórico =Imposible insertar un interesado =Imposible eliminar un interesado AL SIGM v3 Descripción y código Servicios Web SIGEM 50

51 3.4 Servicio Web de Validación de Certificados Este servicio proporciona al sistema SIGEM la funcionalidad de validación de certificados y huellas digitales. El servicio se despliega como un servicio web independiente. El servicio web se basa en la implementación Axis. El servicio de distribuye como una aplicación web dentro de un archivo war: SIGEM_CriptoValidacionWS.war Métodos crearhash Método crearhash Método que obtiene el resumen de un documento Parámetros Contenido Contendido del documento Retorno Hash Resumen validarhash Método validarhash Método que valida el resumen de un documento Parámetros Contenido Contenido del documento Contenido Valor del resumen a validar Retorno ResultadoValidacionHash true si el resumen es correcto, false si no lo es validarcertificado Método validarcertificado Método que valida un certificado Parámetros Contenido Contenido del certificado Retorno ResultadoValidacionCertificado Datos del resultado de la validación AL SIGM v3 Descripción y código Servicios Web SIGEM 51

52 3.4.2 Clases Contenido Campo Tipo Descripción contenidob64 Contenido del documento en base64 Hash Campo Tipo Descripción hash Hash del documento ResultadoValidacionHash Campo Tipo Descripción resultadovalidacion true si el resumen es correcto, false si no lo es ResultadoValidacionCertificado Campo Tipo Descripción resultadovalidacion true si el resumen es correcto, false si no lo es mensajevalidacion Mensaje asociado al resultado de la validación certificado Información asociada al certificado a validar Códigos de error =Error inesperado AL SIGM v3 Descripción y código Servicios Web SIGEM 52

53 3.5 Servicio Web de Firma Digital Este servicio proporciona al sistema SIGEM la funcionalidad de firma digital y validación de firmas. El servicio se despliega como un servicio web independiente. El servicio web se basa en la implementación Axis. El servicio de distribuye como una aplicación web dentro de un archivo war: SIGEM_FirmaDigitalWS.war Métodos firmar Método firmar Método que firma un conjunto de datos Parámetros pbab64source Datos a firmar Retorno Datos firmados validarfirma Método validarfirma Método que valida la firma de datos Parámetros pbab64sourcesigned signedcontentb64 Firma a validar Datos firmados Retorno ResultadoValidacionFirma Datos del resultado de la validación getcertinfo Método getcertinfo Método para obtener la información de un certificado Parámetros Retorno CertificadoX509Info Contenido de información del certificado registrarfirma Método registrarfirma La operación de firma por parte de un ciudadano consta de dos fases: Fase1: El ciudadano mediante su propio certificado y el applet de firma realiza la firma de la solicitud a presentar. Fase 2: La solicitud firmada es enviada a SIGEM que finaliza la operación AL SIGM v3 Descripción y código Servicios Web SIGEM 53

54 Parámetros signaturevalue signcertificatevalue invocando al método de registrarfirma Firma realizada por el applet de firma Certificado del usuario con el que se ha realizado la firma Hash del documento firma hash Retorno Identificador de la transacción AL SIGM v3 Descripción y código Servicios Web SIGEM 54

55 3.5.2 Clases ResultadoValidacionFirma Campo Tipo Descripción documentos InfoDocumentoTemporal[] Arraya de documentos CertificadoX509Info Campo Tipo Descripción cert X509Certificate Objeto X509 con el contenido del certificado privkey PrivateKey Objeto PrivateKey con la clave privada del almacén de claves (si procede) certstore CertStore Objeto CertStore con el Almacén de certificados/claves públicas certs Certificate[] Vector de objetos Certificate con los certificados que componen la cadena de certificados del certificado a validar Códigos de error =Error inesperado AL SIGM v3 Descripción y código Servicios Web SIGEM 55

56 3.6 Servicio Web de Notificaciones Este servicio proporciona al sistema SIGEM la funcionalidad para la gestión de las notificaciones creadas desde la tramitación de expedientes. El servicio se despliega como un servicio web independiente. El servicio web se basa en la implementación Axis. El servicio de distribuye como una aplicación web dentro de un archivo war: SIGEM_NotificacionWS.war Métodos actualizaestados Método actualizaestados Método que obtiene todas las notificaciones pendientes de SIGEM y sincroniza su estado con los estados de esas notificaciones en Sisnot. Parámetros Entidad Código de la entidad Retorno RetornoServicio public RetornoServicio actualizaestados(entidad entidad) Sincroniza los estados de todas las notificaciones en SIGEM, con los estados de esas notificaciones en Sisnot. entidad (Entidad) Objeto con el código de entidad El resultado de la llamada al servicio web: RetornoServicio. Objeto con la información de error de las llamadas a los Servicios Web: returncode. Cadena corta asociada al error errorcode. Número con el código del error actualizaestado Método actualizaestado Método que actualiza el estado de las notificaciones Parámetros numexp Número de expediente estado Nuevo estado de la notificación factualización Nueva Fecha de actualización nifdest NIF destinatario AL SIGM v3 Descripción y código Servicios Web SIGEM 56

57 Retorno Entidad RetornoServicio Código de la entidad public RetornoServicio actualizaestado( numexp, Integer estado, Date factualizacion, nifdest, Entidad enti) Actualiza en la tabla sgmntinfo_notificacion de SIGEM, la notificación identificada por los campos nifdest y numexp, con el nuevo estado y la fecha de actualización recibidas como parámetro. numexp Número de expediente estado (Integer) identificador con el nuevo estado factualizacion La nueva fecha de actualización de estado. nifdest NIF del destinatario de la notificación. entidad (Entidad) Objeto con el código de entidad El resultado de la llamada al servicio web: RetornoServicio. Objeto con la información de error de las llamadas a los Servicios Web: returncode. Cadena corta asociada al error errorcode. Número con el código del error recuperadocumento Método recuperadocumento Método que recupera un documento a partir de unos parámetros de búsqueda Parámetros CriterioBusquedaDocumentos Parámetros de búsqueda Entidad Código de la entidad Retorno InfoDocumento Datos del documento public InfoDocumento recuperadocumento(criteriobusquedadocumentos cri, Entidad enti) Realiza una consulta en la BD de SIGEM (tabla sgmntinfo_documento ) para obtener un documento asociado a una notificación. Devuelve el documento resultante de la consulta. cri (CriterioBusquedaDocumentos) Objeto con los criterios a utilizar en la consulta de la búsqueda codigonoti. Código de la notificación (ncc) codigodoc. Código del documento expediente. Expediente del documento de la notificación. nifdestinatario. El NIF del destinatario de la documento de la notificación. Enti (Entidad) Objeto con el código de entidad AL SIGM v3 Descripción y código Servicios Web SIGEM 57

58 La información correspondiente al documento buscado: InfoDocumento. Hereda de RetornoServicio. Objeto con la información del documento: content. El contenido del documento extensión. La extensión del documento guid. ID del documento mimetype. El MIME del documento detallenotificacion Método detallenotificacion Método que devuelve el detalle de una notificación Parámetros IdentificadorNotificacion Identificador de la notificación Entidad Código de la entidad Retorno Notificacion Datos de la notificación public Notificacion detallenotificacion (IdentificadorNotificacion idem, Entidad ent) Realiza una consulta a la BD de SIGEM, consultando las tablas sgmntinfo_documento y sgmntinfo_notificacion, y devuelve una estructura con los detalles de la notificación resultante de la búsqueda. idem (IdentificacionNotificacion) Objeto con un solo campo (codigodenotificación) utilizada cuando el servicio web llamado sólo necesita el código de la notificación a buscar. (Máximo 13 caracteres) codigodenotificacion. Código de la notificación (ncc) Enti (Entidad) Objeto con el código de entidad La información correspondiente al documento buscado: Notificacion. Hereda de RetornoServicio. Objeto con la información de la notificación: apellidosdest. Apellidos del destinatario de la notificación codigopostal. Código postal del destinatario escaleradirección. Campo escalera de la dirección postal del destinatario municipio. Municipio del destinatario nifdest. NIF del destinatario nombredest. Nombre del destinatario numerodireccion. Campo Número en la dirección del destinatario pisodireccion. Campo piso en la dirección del destinatario provincia. Provincia del destinatario puertadirección Campo puerta en la dirección del destinatario telefono. Teléfono del destinatario viadireccion. Campo vía en la dirección del destinatario asunto. Asunto de la notificación AL SIGM v3 Descripción y código Servicios Web SIGEM 58

59 codigonoti. Código de la notificación (ncc) correodest. DEU del destinatario de la notificación descripcionestado. Descripción asociada al estado actual de la notificación. estado. Estado actual de la notificación. fechaactualiestado. Fecha de última actualización del estado fechaentrega. Fecha de entrega de la notificación (formato AAAA-MM- DD) idioma. Idioma de la notificación numeroexpediente. Número de expediente de la notificación (máx. 20 caracteres) numeroregistro. Número de registro de la notificación (opcional, máx.. 8 caracteres) organismo. Organismo emisor de la notificación procedimiento. Procedimiento al que va dirigida la notificación (máx. 20 caracteres) texto. Texto de la notificación (adicional a los documentos) tipo. Tipo de la notificación ( A y B ) tipocorrespondencia. Tipos de correspondencia de notificación definidos en Sisnot. usuario. Id del usuario al que va dirigida la notificación (máx. 17 caracteres). documentos. Arraya con el contenido de los distintos documentos de la notificación guid. Arraya con los idus de los documentos extensión. Arraya con las extensiones de los documentos nombredocumentos. Arraya con los nombres de los documentos detallenotificacionbynotiid Método detallenotificacion Método que devuelve el detalle de una notificación Parámetros Identificador de la notificación Entidad Código de la entidad Retorno Notificacion Datos de la notificación public Notificacion detallenotificacion ( notiid, Entidad ent) Realiza una consulta a la BD de SIGEM, consultando las tablas sgmntinfo_documento y sgmntinfo_notificacion, y devuelve una estructura con los detalles de la notificación resultante de la búsqueda. notiid () Código de la notificación a buscar. (Máximo 13 caracteres) Enti (Entidad) Objeto con el código de entidad Un objeto Notificacion con la información correspondiente al documento buscado. AL SIGM v3 Descripción y código Servicios Web SIGEM 59

60 consultarnotificaciones Método consultarnotificaciones Método que devuelve una lista de notificaciones a partir de unos parámetros de búsqueda Parámetros CriterioBusquedaNotificaciones Parámetros de búsqueda Entidad Código de la entidad Retorno Notificaciones Lista de notificaciones public Notificaciones consultarnotificaciones (CriterioBusquedaNotificaciones cri, Entidad entidad) Busca en la BD de SIGEM, consultando las tablas sgmntinfo_documento y sgmntinfo_notificacion, las notificaciones que cumplen unas determinadas condiciones. Devuelve una estructura con todas las devueltas por la búsqueda. cri (CriterioBusquedaNotificaciones) Objeto la información a utilizar en la búsqueda de notificaciones. estado. Estado de la notificación. fechadesde. Fecha de inicio de la búsqueda. fechahasta. Fecha de fin de la búsqueda. nif. NIF del destinatario de la documentación. notificación. Código de la notificación (ncc). Enti (Entidad) Objeto con el código de entidad Una lista con las notificaciones que cumplen los criterios de búsqueda: Notificaciones. Hereda de RetornoServicio. Objeto con la información de la notificaciones encontradas: notificaciones. Lista de las notificaciones obtenerestado Método obtenerestado Método que obtiene el estado de una notificación consultando con Sisnot Parámetros Notificación Identificador de la notificación Entidad Código de la entidad Retorno EstadoNotificacion Estado de la notificación public EstadoNotificacion obtenerestado(notificacion not, Entidad ent) Llama al Servicio Web de Sisnot correspondiente para obtener el estado de una notificación, pasando como parámetro su Id. Se obtienen los datos de la tabla sisnot.sn_notificaciones de la BD de Sisnot. AL SIGM v3 Descripción y código Servicios Web SIGEM 60

61 not (Notificacion) Objeto la información a utilizar en la búsqueda Enti (Entidad) Objeto con el código de entidad La información del estado devuelto por la búsqueda: EstadoNotificacion. Hereda de RetornoServicio. Objeto con la información del estado de la notificación: error. Código del error durante la consulta. estado. Estado de la notificación (tabla de estado del SNTS) fecha. Fecha del último cambio de estado de la notificación. motivorechazo. Mensaje de error al enviar la notificación, si fue rechazada obtenerestadobd Método obtenerestadobd Obtiene la correspondencia entre un estado en SIGEM y el correspondiente en Sisnot. Parámetros idestado Identificador de la notificación Entidad Código de la entidad Retorno EstadoNotificacionBD Estado de la notificación public EstadoNotificacionBD obtenerestadobd(integer idestado, Entidad ent) Los valores de los identificadores del estado en SIGEM, pueden ser diferentes a los del SNTS. Por este motivo existe en SIGEM una tabla donde están registradas las correspondencias. Este Servicio Web devuelve la estructura que define la correspondencia correspondiente al estado identificado por el idestado que recibe como parámetro (Tabla sgmntinfo_estado_noti ). idestado identificador del estado del SIGEM a buscar Enti (Entidad) Objeto con el código de entidad La información del estado devuelto por la búsqueda: EstadoNotificacionBD. Hereda de RetornoServicio. Objeto con la información del estado de la notificación en la BD de SIGEM: descripción. Descripción de la notificación. Id. ID de la notificación en Sisnot. idsisnot. ID de la notificación en SIGEM altanotificacion Método altanotificacion Método que da de alta una notificación Parámetros Notificación Datos de la notificación AL SIGM v3 Descripción y código Servicios Web SIGEM 61

62 Entidad Código de la entidad Retorno IdentificadorNotificacion Identificador de la notificación public IdentificadorNotificacion altanotificacion(notificacion not, Entidad ent) Crea una notificación en Sisnot y en SIGEM. not (Notificacion) Objeto la información de la notificación a crear Enti (Entidad) Objeto con el código de entidad La información del estado devuelto por la búsqueda: IdentificadorNotificacion. Hereda de RetornoServicio. Objeto con un solo campo (codigodenotificación) codigodenotificacion. Código de la notificación (ncc) creada en Sisnot Clases Entidad Campo Tipo Descripción identificador Código de identificación de la entidad RetornoServicio Campo Tipo returncode errorcode Descripción Cadena corta asociada al error Número con el código del error CriterioBusquedaDocumentos Campo Tipo Descripción codigonoti Código de la notificación (ncc) codigodoc Código del documento expediente Expediente del documento de la notificación nifdestinatario El NIF del destinatario de la documento de la notificación InfoDocumentos Campo Tipo Descripción AL SIGM v3 Descripción y código Servicios Web SIGEM 62

63 content El contenido del documento extensión La extensión del documento guid ID del documento mimetype El MIME del documento IdentificadorNotificacion Campo Tipo Descripción codigodenotificacion Código de la notificación (ncc) Notificacion Campo Tipo Descripción apellidosdest Apellidos del destinatario de la notificación codigopostal Código postal del destinatario escaleradirección Campo escalera de la dirección postal del destinatario municipio Municipio del destinatario nifdest NIF del destinatario nombredest Nombre del destinatario numerodireccion Campo Número en la dirección del destinatario pisodireccion Campo piso en la dirección del destinatario provincia Provincia del destinatario puertadirección Campo puerta en la dirección del destinatario telefono Teléfono del destinatario viadireccion Campo vía en la dirección del destinatario asunto Asunto de la notificación codigonoti Código de la notificación (ncc) AL SIGM v3 Descripción y código Servicios Web SIGEM 63

64 correodest DEU del destinatario de la notificación descripcionestado Descripción asociada al estado actual de la notificación estado Estado actual de la notificación fechaactualiestado Fecha de última actualización del estado fechaentrega Fecha de entrega de la notificación (formato AAAA-MM-DD) idioma Idioma de la notificación numeroexpediente numeroregistro Número de expediente de la notificación (máx. 20 caracteres) Número de registro de la notificación (opcional, máx.. 8 caracteres) organismo Organismo emisor de la notificación procedimiento texto Procedimiento al que va dirigida la notificación (máx. 20 caracteres) Texto de la notificación (adicional a los documentos) tipo Tipo de la notificación ( A y B ) tipocorrespondencia usuario documentos Tipos de correspondencia de notificación definidos en Sisnot Id del usuario al que va dirigida la notificación (máx.. 17 caracteres) Arraya con el contenido de los distintos documentos de la notificación guid Arraya con los idus de los documentos extensión Arraya con las extensiones de los documentos nombredocumentos Arraya con los nombres de los documentos CriterioBusquedaNotificaciones Campo Tipo Descripción estado Estado de la notificación fechadesde Date Fecha de inicio de la búsqueda AL SIGM v3 Descripción y código Servicios Web SIGEM 64

65 fechahasta Date Fecha de fin de la búsqueda nif NIF del destinatario de la documentación notificación Código de la notificación (ncc) Notificaciones Campo Tipo Descripción notificaciones Notificacion[] Lista de objetos Notificación EstadoNotificacion Campo Tipo Descripción error Código del error durante la consulta estado fecha Date motivorechazo Estado de la notificación (tabla de estado del SNTS) Fecha del último cambio de estado de la notificación. Mensaje de error al enviar la notificación, si fue rechazada EstadoNotificacionBD Campo Tipo Descripción descripción Descripción de la notificación id ID de la notificación en Sisnot idsisnot ID de la notificación en SIGEM Códigos de error =Error: en la obtención de todos los valores =Error: al obtener la extensión del documento =Error: al insertar los valores =Error: tipo de mime no encontrado =Error: al obtener el tipo de mime =Error: tipo de mime no encontrado para la extensión {0} =Error: al obtener el tipo de mime para la extensión {0} =Error: al añadir valor =Error: al borrar valores =Error: identificador no encontrado AL SIGM v3 Descripción y código Servicios Web SIGEM 65

66 =Error: al obtener documento por identificador =Error: al cerrar la conexión =Error: identificador no válido =Error: al obtener documento =Se ha producido un error al almacenar el documento =Se ha producido un error al almacenar los documentos =Se ha producido un error al recuperar el documento =Se ha producido un error al eliminar el documento =Se ha producido un error al obtener el hash del documento =Se ha producido un error en el manejo de ficheros (fichero no encontrado) =Se ha producido un error ya que varios ficheros cumplen un criterio único =No se puede actualizar el estado en base de datos =El identificador único del documento no es válido =El servicio al que llama no responde =La conexión al servicio ha fallado =Fallo inesperado al llamar al servicio =Los datos en la llamada al servicio no son correctos =Los datos tienen un formato incorrecto =Los datos han producido un error inesperado en el acceso a base de datos =Los datos proporcionados resultan insuficientes para poder completar el proceso =Error al buscar los estados de las notificaciones =Error al actualizar los estados de las notificaciones AL SIGM v3 Descripción y código Servicios Web SIGEM 66

67 3.7 Servicio Web de Pago Electrónico Este servicio proporciona al sistema SIGEM la funcionalidad para la gestión de los pagos públicos y liquidaciones realizados por los ciudadanos, a través de la aplicación web de pago. Este servicio de pago, utiliza la funcionalidad del SPT, Servicio de Pago Telemático de red.es. El servicio se despliega como un servicio web independiente. El servicio web se basa en la implementación Axis. El servicio de distribuye como una aplicación web dentro de un archivo war: SIGEM_PagoElectronicoWS.war Métodos altaliquidacion Método altaliquidacion Método que da de alta una liquidación Parámetros Liquidacion Datos de la liquidación Entidad Código de la entidad Retorno Liquidacion Datos de la liquidación public Liquidacion altaliquidacion(liquidacion liq, Entidad ent) Crea en el sistema una liquidación, a partir de los datos recibidos como parámetros. Se da de alta en la tabla sgm_pe_liquidaciones. Se devuelve el objeto con los datos de la liquidación creada, incluyendo la tasa asociada. liq (Liquidacion) Objeto con la información a utilizar en el alta Enti (Entidad) Objeto con el código de entidad Liquidacion. Objeto de tipo Liquidacion, con la información de la liquidación creada referencia. Identificador de la liquidación/pago en el cuaderno. identidademisora. Identificador de la entidad emisora. (6 dígitos). idtasa. Identificador de la tasa asociada con la liquidación. ejercicio. Cadena de 4 dígitos con el año del ejercicio de la liquidación. vencimiento. Cadena con la fecha de finalización del plazo de pago, con formato AAAMMDD. discriminante. Identificador propio de algunos tipos de liquidaciones, para los períodos. En el caso de las autoliquidaciones, no se usa. remesa. Identificador propio de algunos tipos de liquidaciones. En el caso de las autoliquidaciones, no se usa. AL SIGM v3 Descripción y código Servicios Web SIGEM 67

68 importe. Cadena con el importe, de la liquidación a usar en el cuaderno. 12 dígitos, rellenar ceros izquierda y sin decimales (multiplicado por 100) nif. Identificador del titular de la liquidación. nrc. Identificador del pago realizado. Contiene el número de referencia. Se rellena al realizar el pago. estado. Cadena de dos dígitos para identificar el estado de la liquidación. 00 Pendiente y 01 Pagado tasa. Objeto con los datos asociados a la liquidación nombre. Nombre completo del titular de la liquidación datos Específicos. Campo libre de la autoliquidación a rellenar por el titular. inicio Periodo. Inicio del periodo incluido en la liquidación. No se usa en el caso de las autoliquidaciones. fin Periodo. Inicio del periodo incluido en la liquidación. No se usa en el caso de las autoliquidaciones. solicitud. XML de la solicitud asociada con la liquidación. fecha Pago. Fecha de pago de la liquidación baja Liquidación Método bajaliquidacion Método que da de baja una liquidación Parámetros Liquidacion Datos de la liquidación Entidad Código de la entidad Retorno RetornoServicio Resultado de la operación public RetornoServicio bajaliquidacion(liquidacion liq, Entidad ent) Elimina del sistema una liquidación, identificada a partir del identificador de la referencia, obtenido a partir del objeto Liquidación recibido por parámetros. Se elimina de la tabla sgm_pe_liquidaciones. Se devuelve un objeto con el resultado de la operación, junto con el código y el mensaje asociado en caso de error. liq (Liquidacion) Objeto con la información a utilizar en la operación de baja Enti (Entidad) Objeto con el código de entidad El resultado de la llamada al servicio web: RetornoServicio. Objeto con la información de error de las llamadas a los Servicios Web: returncode. Cadena corta asociada al error errorcode. Número con el código del error modificarliquidacion Método modificarliquidacion Método que actualiza una liquidación Parámetros Liquidacion Datos actualizados de la liquidación Entidad Código de la entidad AL SIGM v3 Descripción y código Servicios Web SIGEM 68

69 Retorno RetornoServicio Datos de retorno del servicio AL SIGM v3 Descripción y código Servicios Web SIGEM 69

70 public Liquidacion modificarliquidacion(liquidacion liq, Entidad ent) Modifica una liquidación en el sistema, a partir de los datos recibidos como parámetros. Se devuelve el objeto con los datos de la liquidación modificada. liq (Liquidacion) Objeto con la información a utilizar en la modificación Enti (Entidad) Objeto con el código de entidad Liquidacion. Objeto de tipo Liquidacion, con la información de la liquidación modificada buscarliquidaciones Método buscarliquidaciones Método que obtiene una lista de liquidaciones a partir de unos parámetros de búsqueda Parámetros CriterioBusquedaLiquidacion Parámetros de búsqueda Entidad Código de la entidad Retorno ListaLiquidaciones Lista de liquidaciones public ListaLiquidaciones buscarliquidaciones(criteriobusquedaliquidacion cri, Entidad ent) Realiza una búsqueda de liquidaciones en el sistema, utilizando los criterios recibidos por parámetro. Se devuelve un objeto con un vector de objetos Liquidacion que cumplen con los criterios de la consulta. cri (CriterioBusquedaLiquidacion) Objeto con los criterios de la búsqueda referencia. Identificador de la liquidación/pago en el cuaderno. identidademisora. Identificador de la entidad emisora. (6 dígitos). idtasa. Identificador de la tasa asociada con la liquidación. ejercicio. Cadena de 4 dígitos con el año del ejercicio de la liquidación. vencimiento. Cadena con la fecha de finalización del plazo de pago, con formato AAAMMDD. nif. Identificador del titular de la liquidación. nrc. Identificador del pago realizado. Contiene el número de referencia. Se rellena al realizar el pago. estado. Cadena de dos dígitos para identificar el estado de la liquidación. 00 Pendiente y 01 Pagado ent (Entidad) Objeto con el código de entidad Un objeto de tipo ListaLiquidaciones, con objetos Liquidación con el resultado de la búsqueda: AL SIGM v3 Descripción y código Servicios Web SIGEM 70

71 obtenerdatostasa Método obtenerdatostasa Método que obtiene detalle de un pago Parámetros Tasa Datos de la tasa: Identificador de la tasa y de la entidad emisora Entidad Código de la entidad Retorno Tasa Datos de la tasa public Tasa obtenerdatostasa(tasa tasa, Entidad ent) Obtiene la tasa a partir del código e identificador de la entidad emisora contenidos en el objeto tasa, recibido como parámetro. Se obtiene de la tabla sgm_pe_tasas. Se devuelve el objeto con los datos de la tasa, si existe. tasa (Tasa) Objeto con la información a utilizar en el alta enti (Entidad) Objeto con el código de entidad Tasa. Objeto de tipo Tasa, con la información de la tasa encontrada código. Identificador de la tasa identidademisora. Identificador de la entidad emisora. (6 dígitos). nombre. Nombre de la tasa. tipo. Identificador alfanumérico para diferencia los diferentes tipos de liquidaciones del Cuaderno 60. AL2 Modalidad 2, AL1 Modalidad 1 y AL3 Modalidad 3 (Autoliquidaciones). modelo. Identificador del modelo, utilizado exclusivamente en las autoliquidaciones, definido en el cuaderno 60. datos Específicos. Fragmento de XML asociados con la tasa de pago. captura. Identificador de captura, utilizado exclusivamente en las autoliquidaciones, definido en el cuaderno buscartasas Método buscartasas Método que obtiene una lista de tasas a partir de unos parámetros de búsqueda Parámetros CriterioBusquedaTasa Parámetros de búsqueda Entidad Código de la entidad Retorno ListaTasas Lista de tasas public ListaTasas buscartasas(criteriobusquedatasa cri, Entidad ent) Realiza una búsqueda de tasas en el sistema, utilizando los criterios recibidos por parámetro. Se devuelve un objeto con un vector de objetos Tasa que cumplen con los criterios de la consulta. AL SIGM v3 Descripción y código Servicios Web SIGEM 71

72 cri (CriterioBusquedaTasa) Objeto con los criterios de la búsqueda tipo. Identificador con el tipo de la tasa a buscar. enti (Entidad) Objeto con el código de entidad Un objeto de tipo ListaTasas, con objetos Tasa con el resultado de la búsqueda obtenerdocumentopago Método obtenerdocumentopago Método que obtiene el documento asociado a un pago Parámetros Pago Datos del pago Entidad Código de la entidad Retorno DocumentoPago Datos del documento public DocumentoPago obtenerdocumentopago(pago pago, Entidad ent) Obtiene un objeto DocumentoPago con el XML con los datos del pago, a partir de los datos del pago y código de la entidad, recibido como parámetro. pago (Pago) Objeto con la información del pago identidademisora. Cadena de 6 dígitos con el identificador de la entidad emisora idtasa. Identificador de la tasa importe. Cadena de 12 dígitos con el importe, sin decimales (multiplicado por 100) y con ceros por la izquierda. nif. NIF del titular del pago idioma. Idioma del pago. fecha. Fecha del pago realizado. hora. Hora del pago realizado. entidadbancaria. Cadena correspondiente a la entidad bancaria para el pago, en caso se usar como medio de pago la domiciliación bancaria. mediopago. Identificador del medio de pago a usar. ccc. Número de cuenta bancaria a usar en el pago, en caso se usar como medio de pago la domiciliación bancaria. numerotarjetacredito. Número de tarjeta a usar en el pago, en caso se usar como medio de pago el pago con tarjeta. fechacaducidadtarjetacredito. Fecha de caducidad de la tarjeta a usar en el pago. referencia. Identificador del pago. nrc. Identificador del pago realizado estado. Estado del pago. tasa. Objeto con los datos de la tasa asociada al pago. liquidación. Objeto con los datos de la liquidación asociada al pago. ejercicio. Cadena de 4 dígitos con el año del pago. remesa. Identificador propio de algunos tipos de liquidaciones. En el caso de las autoliquidaciones, no se usa. AL SIGM v3 Descripción y código Servicios Web SIGEM 72

73 acreditación. Campo específico para la modalidad 3 del cuaderno 60 asociado al pago. fechadevengo. Fecha devengo para la modalidad 3 del cuaderno 60 asociado al pago. informacionespecifica. Datos específicos asociados al pago. expediente: Identificador del expediente asociado con el pago. enti (Entidad) Objeto con el código de entidad. Un objeto de tipo DocumentoPago, con el XML con los datos del pago realizarpago Método realizarpago Método que realiza un pago Parámetros Pago Datos del pago Entidad Código de la entidad Retorno Pago Datos del pago realizado public Pago realizarpago(pago pago, Entidad ent) Realiza el pago utilizando el conector configurado en el sistema, utilizando los datos recibidos como parámetros. Devuelve un objeto Pago con los datos del pago realizado.. pago (Pago) Objeto con la información del pago enti (Entidad) Objeto con el código de entidad Un objeto de tipo Pago, con los datos del pago realizado detallepago Método detallepago Método que obtiene el detalle de un pago Parámetros Pago Identificador del pago Entidad Código de la entidad Retorno Pago Datos del pago public Pago detallepago(pago pago, Entidad ent) Realiza una búsqueda de pagos en el sistema, a partir de la referencia del pago, recibida en el objeto Pago en los parámetros recibidos. Se devuelve un objeto Pago con el resultado de la consulta. pago (Pago) Objeto con la información del pago enti (Entidad) Objeto con el código de entidad AL SIGM v3 Descripción y código Servicios Web SIGEM 73

74 Un objeto de tipo Pago, con los datos del pago Clases Entidad Campo Tipo Descripción identificador Código de identificación de la entidad Liquidacion Campo Tipo Descripción referencia Identificador de la liquidación/pago en el cuaderno identidademisora Identificador de la entidad emisora. (6 dígitos) idtasa ejercicio vencimiento discriminante remesa importe Identificador de la tasa asociada con la liquidación Cadena de 4 dígitos con el año del ejercicio de la liquidación Cadena con la fecha de finalización del plazo de pago, con formato AAAMMDD Identificador propio de algunos tipos de liquidaciones, para los períodos. En el caso de las autoliquidaciones, no se usa. Identificador propio de algunos tipos de liquidaciones. En el caso de las autoliquidaciones, no se usa Cadena con el importe, de la liquidación a usar en el cuaderno. 12 dígitos, rellenar ceros izquierda y sin decimales (multiplicado por 100) nif Identificador del titular de la liquidación nrc estado Identificador del pago realizado. Contiene el número de referencia. Se rellena al realizar el pago Cadena de dos dígitos para identificar el estado de la liquidación. 00 Pendiente y 01 Pagado tasa Tasa Objeto con los datos asociados a la liquidación nombre Nombre completo del titular de la liquidación AL SIGM v3 Descripción y código Servicios Web SIGEM 74

75 datos Específicos inicio Periodo fin Periodo Campo libre de la autoliquidación a rellenar por el titular Inicio del periodo incluido en la liquidación. No se usa en el caso de las autoliquidaciones Inicio del periodo incluido en la liquidación. No se usa en el caso de las autoliquidaciones solicitud XML de la solicitud asociada con la liquidación fecha Pago Date Fecha de pago de la liquidación RetornoServicio Campo Tipo Descripción returncode Cadena corta asociada al error errorcode Número con el código del error CriterioBusquedaLiquidacion Campo Tipo Descripción referencia identidademisora idtasa ejercicio vencimiento Identificador de la liquidación/pago en el cuaderno. Identificador de la entidad emisora. (6 dígitos). Identificador de la tasa asociada con la liquidación Cadena de 4 dígitos con el año del ejercicio de la liquidación Cadena con la fecha de finalización del plazo de pago, con formato AAAMMDD nif Identificador del titular de la liquidación nrc estado Identificador del pago realizado. Contiene el número de referencia. Se rellena al realizar el pago Cadena de dos dígitos para identificar el estado de la liquidación. 00 Pendiente y 01 Pagado Tasa Campo Tipo Descripción código Identificador de la tasa AL SIGM v3 Descripción y código Servicios Web SIGEM 75

76 identidademisora Identificador de la entidad emisora. (6 dígitos). nombre Nombre de la tasa tipo modelo datos Específicos captura Identificador alfanumérico para diferencia los diferentes tipos de liquidaciones del Cuaderno 60. AL2 Modalidad 2, AL1 Modalidad 1 y AL3 Modalidad 3 (Autoliquidaciones) Identificador del modelo, utilizado exclusivamente en las autoliquidaciones, definido en el cuaderno 60 Fragmento de XML asociados con la tasa de pago Identificador de captura, utilizado exclusivamente en las autoliquidaciones, definido en el cuaderno 60 CriterioBusquedaTasa Campo Tipo Descripción tipo Identificador con el tipo de la tasa a buscar Pago Campo Tipo Descripción identidademisora Cadena de 6 dígitos con el identificador de la entidad emisora idtasa Identificador de la tasa importe Cadena de 12 dígitos con el importe, sin decimales (multiplicado por 100) y con ceros por la izquierda nif NIF del titular del pago idioma Idioma del pago fecha Fecha del pago realizado hora Hora del pago realizado entidadbancaria Cadena correspondiente a la entidad bancaria para el pago, en caso se usar como medio de pago la domiciliación bancaria mediopago Identificador del medio de pago a usar AL SIGM v3 Descripción y código Servicios Web SIGEM 76

77 ccc Número de cuenta bancaria a usar en el pago, en caso se usar como medio de pago la domiciliación bancaria AL SIGM v3 Descripción y código Servicios Web SIGEM 77

78 numerotarjetacredito fechacaducidad- TarjetaCredito Número de tarjeta a usar en el pago, en caso se usar como medio de pago el pago con tarjeta Fecha de caducidad de la tarjeta a usar en el pago referencia Identificador del pago nrc Identificador del pago realizado estado Estado del pago tasa liquidación Tasa Liquidacion Objeto con los datos de la tasa asociada al pago Objeto con los datos de la liquidación asociada al pago ejercicio Cadena de 4 dígitos con el año del pago remesa acreditación fechadevengo Identificador propio de algunos tipos de liquidaciones. En el caso de las autoliquidaciones, no se usa Campo específico para la modalidad 3 del cuaderno 60 asociado al pago Fecha devengo para la modalidad 3 del cuaderno 60 asociado al pago informacionespecifica Datos específicos asociados al pago expediente Identificador del expediente asociado con el pago DocumentoPago Campo Tipo Descripción documentopago Fragmento XML con los datos del pago Códigos de error =Error inesperado =Error: Parámetros incorrectos =Error: Tipo de pago no permitido =Error: Obteniendo número de secuencia =Error: Realizando pago =Error: Guardando datos del pago =Error: Error invocando servicio de pago externo =Error: Error consultando pagos AL SIGM v3 Descripción y código Servicios Web SIGEM 78

79 =Error: alta de pago =Error: Validando datos de entrada: Datos de la liquidación nulos =Error: Obteniendo datos de la liquidación =Error: Actualizando datos de la liquidación =Error: Creando datos de la liquidación =Error: Eliminando datos de la liquidación =Error: Creando tasa =Error: Recuperando datos de tasa =Error: Actualizando datos de tasa =Error: Eliminando tasa =Error: No existe una liquidación asociada a ese número de referencia =Error: Liquidación ya satisfecha =Error: Parámetros incorrectos en alta de pago =Error: Generando número de referencia para liquidación AL1_ =Error: Generando número de referencia para liquidación AL =Error: Parámetros incorrectos en eliminación de liquidación =Error: Parámetros incorrectos en modificación de liquidación =Error: El conector no soporta realizar pagos usando autoliquidaciones (Cuaderno 60 Modalidad 3) =Error: El conector no soporta realizar pagos usando el Cuaderno =Error inesperado =Operación finalizada OK =Número de justificante o importe erróneo o ausente =Modelo o tipo de operación no soportado =Solicitud anulada =El certificado firmante no está autorizado para realizar el pago por personas ajenas =El representante del certificado firmante no está autorizado para realizar el pago por personas ajenas =El certificado firmante no está para pagar y presentar este modelo =El certificado firmante no está autorizado para realizar este pago por convenio =La entidad emisora de esta tarjeta no admite este tipo de servicio =Concepto o modelo erróneo =Falta concepto o modelo =Ejercicio fiscal erróneo =Falta ejercicio fiscal =Período erróneo =Falta período =Tipo de moneda erróneo (distinto de P o E) =NIF/CIF incorrecto para este modelo =Falta tipo de moneda =Importe ingreso erróneo =Falta importe ingreso =NIF contribuyente erróneo =Falta NIF del contribuyente =NIF del primer representante erróneo =Falta NIF del representante =Sobre NIF del representante =Falta nombre del contribuyente =Falta nombre del representante AL SIGM v3 Descripción y código Servicios Web SIGEM 79

80 =Sobra nombre del representante =Código de administración erróneo =Falta código administración =Anagrama erróneo =Falta anagrama =Sobra anagrama =Importe total y parcial no cuadra =Falta importe total =Sobra importe total =Opción fraccionamiento errónea =Falta opción fraccionamiento =C.C.C. (Código Cuenta Cliente) erróneo =Falta C.C.C. (Código Cuenta Cliente) =Importe redenominación erróneo =Falta importe redenominación =Tipo de operación erróneo =Falta tipo de operación =Tipo de petición erróneo (distinto de 01 o 02) =Falta tipo de petición =Tipo de autoliquidación erróneo (distinto de I o D) =Falta tipo de autoliquidación =NIF del segundo representante erróneo =Concepto o modelo no permitidos =Ejercicio fiscal no permitido =Período no permitido =Ingreso no fraccionable por estar fuera del periodo voluntario =Ingreso fuera de periodo =Movimiento distinto de 01 y =NIF certificado distinto a NIF tecleado =NIF primer certificado distinto a NIF tecleado =NIF segundo certificado distinto a NIF tecleado =El horario del servicio es desde las 2:00 h hasta las 23:00 h diariamente =Fecha de presentación fuera de plazo =Importe total de la deuda erróneo =Autoridad certificador errónea =Certificado caducado =Certificado revocado =Presentador no autorizado en nombre de terceras personas =Ha firmado 2 veces con el mismo representante =Período impositivo concluido o erróneo =Fecha de conclusión del período impositivo errónea =Error de formato en los datos de la petición =Petición duplicada. Utilice la opción de consulta =No existe cargo con los datos consultados =C.C.C. cancelado =C.C.C. bloqueado (judicialmente) =C.C.C. con saldo no disponible =C.C.C. con saldo insuficiente =C.C.C. cuenta no es de ahorro a la vista =C.C.C. inexistente =C.C.C. inoperante =NIF del contribuyente no titular de la cuenta AL SIGM v3 Descripción y código Servicios Web SIGEM 80

81 =NIF del representante no apoderado de la cuenta =Contribuyente no persona jurídica (e informa representante) =Falta segundo NIF por ser cuenta conjunta =El segundo NIF no corresponde a titular de la cuenta =MAX erróneo =No hay suficientes apoderados =Esta entidad no atiende la solicitud de cargo por esta vía en este rango horario =Error específico de Entidad Colaboradora =Contribuyente no identificado =Fecha validez/caducidad de la tarjeta excedida =No está autorizado a realizar el pago por personas ajenas =Número de tarjeta no válido, erróneo o ausente =El titular del certificado con que se ha firmado no es titular de la tarjeta =Se ha excedido el límite de la operación =Tipo de tarjeta no soportado =Sólo se aceptan tarjetas emitidas por la propia entidad =Error técnico =NRC no existe =NIF no existe =NRC ya constituido. Inténtelo por consulta =NRC no preconstituido. Inténtelo por consulta =NRC ya existe =NRC no disponible para devolución =NRC ya liberado =Incoherencia de datos =NRC de operación ya existe =NRC no disponible para devolución =Imposible cobro, NRC ya cobrado =Dígito de control erróneo =Carácter de control erróneo =Error en el modelo de operación =Error en el código del Banco de España =Error de validación =Error: en la obtención de todos los valores =Error: al obtener la extensión del documento =Error: al insertar los valores =Error: error obteniendo valor actual de la secuencia =Error: obteniendo siguiente número de secuencia =Error: imposible crear más números de secuencia, máximo alcanzado =Error: al obtener el tipo de mime para la extensión {0} =Error: al añadir valor =Error: al borrar valores =Error: identificador no encontrado =Error: al obtener documento por identificador =Error: al cerrar la conexión =Error: identificador no válido =Error: al obtener documento =Error: transacción de base de datos requerida =Error: ejecutando sentencia de consulta =Se ha producido un error al almacenar el documento =Se ha producido un error al almacenar los documentos AL SIGM v3 Descripción y código Servicios Web SIGEM 81

82 =Se ha producido un error al recuperar el documento =Se ha producido un error al eliminar el documento =Se ha producido un error al obtener el hash del documento =Se ha producido un error en el manejo de ficheros (fichero no encontrado) =El identificador único del documento no es válido AL SIGM v3 Descripción y código Servicios Web SIGEM 82

83 3.8 Servicio Web de Publicación Este servicio proporciona al sistema SIGEM la funcionalidad de gestión de la información de publicación de expedientes. El servicio se despliega como un servicio web independiente. El servicio web se basa en la implementación Axis. El servicio de distribuye como una aplicación web dentro de un archivo war: SIGEM_PublicadorWS.war Métodos getlistahitos Método getlistahitos Obtiene la lista de hitos Parámetros Identificador de la entidad Retorno ListaHitos Lista de hitos gethito Método gethito Obtiene la información del hito Parámetros int int Identificador de la entidad Identificador del hito Identificador de la aplicación Identificador del sistema Retorno Hito Información del hito addhito Método addhito Crea un hito Parámetros Hito Identificador de la entidad Información del hito Retorno Hito Información del hito creado updatehito Método updatehito Actualiza la información del hito Parámetros Hito Identificador de la entidad Información del hito Retorno Hito Información del hito actualizado AL SIGM v3 Descripción y código Servicios Web SIGEM 83

84 deletehito Método deletehito Elimina la información del hito Parámetros int int Identificador de la entidad Identificador del hito Identificador de la aplicación Identificador del sistema Retorno Booleano True si se ha eliminado el hito reactivatehito Método reactivatehito Reactiva un hito erróneo Parámetros int int Identificador de la entidad Identificador del hito Identificador de la aplicación Identificador del sistema Retorno Hito Información del hito reactivado getlistareglas Método getlistareglas Obtiene la lista de reglas de publicación Parámetros Identificador de la entidad Retorno ListaReglas Lista de reglas de publicación getregla Método getregla Obtiene la información de la regla de publicación Parámetros int Identificador de la entidad Identificador de la regla Retorno Regla Información de la regla addregla Método addregla Crea una regla de publicación Parámetros Regla Identificador de la entidad Información de la regla Retorno Regla Información de la regla creada updateregla AL SIGM v3 Descripción y código Servicios Web SIGEM 84

85 Método updateregla Actualiza la información de una regla de publicación Parámetros Regla Identificador de la entidad Información de la regla Retorno Regla Información de la regla actualizada deleteregla Método deleteregla Elimina la información de la regla de publicación Parámetros int Identificador de la entidad Identificador de la regla Retorno Booleano True si se ha eliminado la regla getlistaerrores Método getlistaerrores Obtiene la lista de los errores Parámetros Identificador de la entidad Retorno ListaErrores Lista de errores geterror Método geterror Obtiene la información del error. Parámetros int int Identificador de la entidad Identificador del hito Identificador de la aplicación Identificador del sistema Retorno Error Información del error Códigos de error =Error inesperado en el módulo de publicación =Parámetros incorrectos AL SIGM v3 Descripción y código Servicios Web SIGEM 85

86 3.9 Servicio Web del Repositorio de Documentos de Tramitación Este servicio proporciona al sistema SIGEM la funcionalidad para la gestión de la documentación generada durante la tramitación electrónica. El servicio se despliega como un servicio web independiente. El servicio web se basa en la implementación Axis. El servicio se distribuye como una aplicación web dentro de un archivo war: SIGEM_RdeWS.war Métodos recuperardocumento Método recuperardocumento Recupera la información del documento cuyo GUID es el pasado como parámetro Parámetros InfoDocumento Entidad Datos del documento a recuperar Identificación de la entidad Retorno InfoDocumento Objeto que contiene el documento (en binario), la extensión y el tipo MIME asociado a esa extensión (en caso de estar definida) retrievedocumentinfo Método retrievedocumentinfo Recupera la información del documento cuyo GUID es el pasado como parámetro Parámetros InfoDocumento Entidad Datos del documento a recuperar Identificación de la entidad Retorno ContenedorDocumento Objeto que contiene el documento (en binario), la extensión y el tipo MIME asociado a esa extensión (en caso de estar definida) guardardocumento Método guardardocumento Almacena un documento Parámetros InfoDocumento Datos del documento a almacenar. Obligatorio el contenido y la extensión Entidad Identificación de la entidad Retorno InfoDocumento Datos del documento almacenado AL SIGM v3 Descripción y código Servicios Web SIGEM 86

87 guardardocumentoguid Método guardardocumentoguid Actualiza el documento de GUID pasado por parámetro Parámetros InfoDocumento Datos del documento a almacenar. Obligatorio el GUIS Entidad Identificación de la entidad Retorno InfoDocumento Datos del documento almacenado eliminardocumento Método eliminardocumento Elimina un documento del RDE Parámetros InfoDocumento Datos del documento a eliminar. Obligatorio el GUID Entidad Identificación de la entidad Retorno RetornoServicio Valores de retorno del servicio obtenerhash Método obtenerhash Obtiene el hash del documento cuyo guid es el pasado como parámetro Parámetros InfoDocumento Datos del documento sobre el que obtener el hash. Entidad Identificación de la entidad Retorno InfoDocumento Datos del documento (Hash del documento) almacenardocumentos Método almacenardocumentos Almacena los documentos y devuelve sus GUIDs y sus hashes Parámetros InfoDocumentos Documentos a almacenar. Únicamente se pasan con información los campos correspondientes a la ruta y a la extensión del documento Entidad Identificación de la entidad Retorno RetornoServicio Valores de retorno del servicio almacenardocumentotemporal Método almacenardocumentotemporal Almacena un documento temporal Parámetros InfoDocumentoTemporal Datos del documento temporal. Obligatorio el GUID del documento AL SIGM v3 Descripción y código Servicios Web SIGEM 87

88 Entidad Identificación de la entidad Retorno RetornoServicio Valores de retorno del servicio eliminardocumentotemporal Método eliminardocumentotemporal Entidad Parámetros InfoDocumentoTemporal Elimina los documentos temporales del RDE asociados a un identificador de sesión o a un número de registro Identificación de la entidad Datos de los documentos temporales a eliminar. Obligatorio el número de registro (o su correspondiente identificador de sesión) Retorno RetornoServicio Valores de retorno del servicio obtenerdocumentostemporales Método obtenerdocumentostemporales Obtiene los documentos temporales asociados a un identificador de sesión o a un número de registro Parámetros InfoDocumentoTemporal Datos de los documentos temporales a obtener. Obligatorio el número de registro (o su correspondiente identificador de sesión) Entidad Identificación de la entidad Retorno InfoDocumentosTemporales Documentos temporales asociados a un número de registro (o su correspondiente identificador de sesión) obtenerdocumentostemporalescaducados Método obtenerdocumentostemporalescaducados Obtiene los documentos temporales caducados Parámetros CriterioBusquedaDocs Entidad Parámetros de búsqueda Identificación de la entidad Retorno InfoDocumentosTemporales Documentos temporales caducados Clases InfoDocumentos Campo Tipo Descripción AL SIGM v3 Descripción y código Servicios Web SIGEM 88

89 documentos InfoDocumento[] Arraya de documentos InfoDocumento Campo Tipo Descripción guid Identificador del documento. (Opcional) contenidob64 Contenido en base 64 extension Extensión del documento mimetype MimeType del documento hash Hash del documento sessionid Identificador de la sesión para la que se creó el documento timestamp Hora en la que se creó el documento InfoDocumentosTemporales Campo Tipo Descripción documentos InfoDocumentoTemporal[] Arraya de documentos RetornoServicio Campo Tipo Descripción errorcode Código de error. returncode Código de retorno. OK: Operación realizada con éxito ERROR: Se ha producido un error en la operación CriterioBusquedaDocs Campo timeout Tipo Descripción Timeout ContenedorDocumento Campo guid Tipo Descripción Identificador del documento AL SIGM v3 Descripción y código Servicios Web SIGEM 89

90 contentb64 Binario del documento en Base 64 hash Hash del documento extension Extensión en minúsculas del documento timestamp Hora en la que se creó el documento contentsize Tamaño en bytes del documento Códigos de error =Error: en la obtención de todos los valores =Error: al obtener la extensión del documento =Error: al insertar los valores =Error: tipo de mime no encontrado =Error: al obtener el tipo de mime =Error: tipo de mime no encontrado para la extensión {0} =Error: al obtener el tipo de mime para la extensión {0} =Error: al añadir valor =Error: al borrar valores =Error: identificador no encontrado =Error: al obtener documento por identificador =Error: al cerrar la conexión =Error: identificador no válido =Error: al obtener documento =Se ha producido un error al almacenar el documento =Se ha producido un error al almacenar los documentos =Se ha producido un error al recuperar el documento =Se ha producido un error al eliminar el documento =Se ha producido un error al obtener el hash del documento =Se ha producido un error en el manejo de ficheros (fichero no encontrado) =El identificador único del documento no es válido AL SIGM v3 Descripción y código Servicios Web SIGEM 90

91 3.10 Servicio Web del Registro Presencial Este servicio proporciona al sistema SIGEM la funcionalidad que ofrece la aplicación de registro presencial. El servicio se despliega como un servicio web independiente. El servicio web se basa en la implementación Axis. El servicio de distribuye como una aplicación web dentro de un archivo war: SIGEM_RegistroPresencialWS.war Métodos createfolder Método createfolder Método para crear un nuevo registro. Parámetros UserInfo Usuario que se conecta (obligatorio). PersonInfo[] Interesados (no obligatorio). Fólder Información necesaria para crear el registro (identificador de libro, datos de los campos con los que se va a crear el registro y opcionalmente los documentos anexos). Es obligatorio. Entidad Entidad o ayuntamiento al que se realiza la petición Retorno RegisterInfo Información del registro creado (número de registro,...). public RegisterInfo createfolder(userinfo user, PersonInfo[] inter, Folder folder, Entidad entidad) Crea un nuevo registro con los datos suministrados. user (UserInfo). Usuario con el que se realiza la petición. inter (PersonInfo[]). Interesados (opcional). folder (Folder) Información necesaria para crear el registro. entidad (Entidad) Ayuntamiento sobre el que se realiza la petición. Los datos del registro: RegisterInfo. Información del registro creado updatefolder Método updatefolder Método para actualizar un registro. AL SIGM v3 Descripción y código Servicios Web SIGEM 91

92 Parámetros UserInfo PersonInfo[] Folder Entidad Usuario que se conecta (obligatorio). Interesados que se desean actualizar (no obligatorio). Información que se desea actualizar e identificativa del registro (identificador de libro, datos de los campos actualizar y opcionalmente los documentos anexos). Es obligatorio. Entidad o ayuntamiento al que se realiza la petición Retorno RegisterInfo Información del registro creado (número de registro,...). public RegisterInfo updatefolder(userinfo user, PersonInfo[] inter, Folder folder, Entidad entidad) Actualiza un registro con los datos suministrados. user (UserInfo). Usuario con el que se realiza la petición. inter (PersonInfo[]). Interesados (opcional). folder (Folder) Información necesaria para actualizar el registro. entidad (Entidad) Ayuntamiento sobre el que se realiza la petición. Los datos del registro: RegisterInfo. Información del registro actualizado findfolder Método findfolder Método para buscar registros. Parámetros UserInfo Usuario que se conecta (obligatorio). FolderSearchCriteria Criterios de búsqueda e información identificativa del registro. Es obligatorio Entidad Entidad o ayuntamiento al que se realiza la petición Retorno RegistersInfo Listado de los registros que coinciden con los criterios de búsqueda introducidos. public RegistersInfo findfolder(userinfo user, FolderSearchCriteria folderquery, Entidad entidad) Busca los registros que concuerdan con los criterios de búsqueda suministrados user (UserInfo). Usuario con el que se realiza la petición. folderquery (FolderSearchCriteria) Información necesaria para crear el registro. entidad (Entidad) Ayuntamiento sobre el que se realiza la petición. AL SIGM v3 Descripción y código Servicios Web SIGEM 92

93 Los datos del registro: RegistersInfo. Información de los registros encontrados importfolder Método importfolder Método para importar un registro. Parámetros UserInfo Usuario que se conecta (obligatorio). PersonInfo[] Interesados (no obligatorio). Fólder Información del registro a importar registro (identificador de libro, datos de los campos con los que se va a crear el registro y opcionalmente los documentos anexos). Es obligatorio. Entidad Entidad o ayuntamiento al que se realiza la petición Retorno RegisterInfo Información del registro importado (número de registro,...). public RegisterInfo importfolder(userinfo user, PersonInfo[] inter, Folder folder, Entidad entidad) Importa un registro con los datos suministrados. user (UserInfo). Usuario con el que se realiza la petición. inter (PersonInfo[]). Interesados (opcional). folder (Folder) Información necesaria para crear el registro. entidad (Entidad) Ayuntamiento sobre el que se realiza la petición. Los datos del registro: RegisterInfo. Información del registro importado getinputfolderfornumber Método getinputfolderfornumber Método para consultar un registro de entrada Parámetros UserInfo Usuario que se conecta (obligatorio). Fólder Información necesaria para consultar el registro (número de registro a consultar). Es obligatorio. Entidad Entidad o ayuntamiento al que se realiza la petición Retorno Fields Datos del registro. AL SIGM v3 Descripción y código Servicios Web SIGEM 93

94 public Fields getinputfolderfornumber(userinfo user, Folder folder, Entidad entidad) Consulta los metadatos de un registro de entrada con los filtros suministrados. user (UserInfo). Usuario con el que se realiza la petición. folder (Folder) Información necesaria para consultar el registro (número de registro a consultar). entidad (Entidad) Ayuntamiento sobre el que se realiza la petición. Los metadatos del registro: RegisterInfo. Información del registro creado getoutputfolderfornumber Método getoutputfolderfornumber Método para consultar un registro de salida Parámetros UserInfo Usuario que se conecta (obligatorio). Fólder Información necesaria para consultar el registro (número de registro a consultar). Es obligatorio. Entidad Entidad o ayuntamiento al que se realiza la petición Retorno Fields Datos del registro. public Fields getoutputfolderfornumber(userinfo user, Folder folder, Entidad entidad) Consulta los metadatos de un registro de salida con los filtros suministrados. user (UserInfo). Usuario con el que se realiza la petición. folder (Folder) Información necesaria para consultar el registro (número de registro a consultar). entidad (Entidad) Ayuntamiento sobre el que se realiza la petición. Los metadatos del registro: RegisterInfo. Información del registro creado getdocumentfolder Método getdocumentfolder Método para obtener un documento anexo a un registro determinado. Parámetros UserInfo Usuario que se conecta (obligatorio). Document Información necesaria para obtener el documento anexo (identificadores de libro, registro, documento y página). AL SIGM v3 Descripción y código Servicios Web SIGEM 94

95 Es obligatorio. Entidad Entidad o ayuntamiento al que se realiza la petición Retorno Document Información del documento y su contenido. public Document getdocumentfolder(userinfo user, Document document, Entidad entidad) Obtiene el contenido de un documento. user (UserInfo). Usuario con el que se realiza la petición. document (Document) Información necesaria para obtener el documento anexo (identificadores de libro, registro, documento y página). entidad (Entidad) Ayuntamiento sobre el que se realiza la petición. Document. Información del documento y su contenido getinputdistribution Método getinputdistribution Método para recupera el contenido de la bandeja de entrada asociada a un usuario. Parámetros UserInfo Usuario que se conecta (obligatorio). DistributionSearchCriteria Criterio de búsqueda índice del primer registro a obtener y número máximo de registros a obtener desde el offset anterior. Entidad Entidad o ayuntamiento al que se realiza la petición Retorno DistributionsInfo Lista de distribución de entrada. public DistributionsInfo getinputdistribution(userinfo user, DistributionSearchCriteria search, Entidad entidad). Método para recuperar el contenido de la bandeja de entrada asociada a un usuario. user (UserInfo). Usuario con el que se realiza la petición. search (DistributionSearchCriteria) Criterio de búsqueda, índice del primer registro a obtener y número máximo de registros a obtener. entidad (Entidad) Ayuntamiento sobre el que se realiza la petición. DistributionsInfo. Lista de distribución de entrada. AL SIGM v3 Descripción y código Servicios Web SIGEM 95

96 getoutputdistribution Método getoutputdistribution Método para recupera el contenido de la bandeja de salida asociada a un usuario. Parámetros UserInfo Usuario que se conecta (obligatorio). DistributionSearchCriteria Criterio de búsqueda índice del primer registro a obtener y número máximo de registros a obtener desde el offset anterior. Entidad Entidad o ayuntamiento al que se realiza la petición Retorno DistributionsInfo Lista de distribución de entrada. public DistributionsInfo getoutputdistribution(userinfo user, DistributionSearchCriteria search, Entidad entidad). Método para recuperar el contenido de la bandeja de salida asociada a un usuario. user (UserInfo). Usuario con el que se realiza la petición. search (DistributionSearchCriteria) Criterio de búsqueda, índice del primer registro a obtener y número máximo de registros a obtener. entidad (Entidad) Ayuntamiento sobre el que se realiza la petición. DistributionsInfo. Lista de distribución de salida acceptdistribution Método acceptdistribution Método que realiza la operación de aceptar un registro de la bandeja de entrada de un usuario. Parámetros UserInfo Usuario que se conecta (obligatorio). Fólder Información necesaria para realizar tal operación (identificador de libro y número de registro a aceptar). Es obligatorio. Entidad Entidad o ayuntamiento al que se realiza la petición Retorno RetornoServicio K si la operación se ha realizado con exito o una excepción si no es así. public RetornoServicio acceptdistribution(userinfo user, Folder folder, Entidad entidad) Método que realiza la operación de aceptar un registro de la bandeja de entrada de un usuario. user (UserInfo). Usuario con el que se realiza la petición. AL SIGM v3 Descripción y código Servicios Web SIGEM 96

97 folder (Folder) Información necesaria para realizar la operación (identificador de libro y número de registro). entidad (Entidad) Ayuntamiento sobre el que se realiza la petición. OK si la operación se ha realizado con éxito o una excepción si no es así. RetornoServicio rejectdistribution Método rejectdistribution Método que realiza la operación de rechazar un registro de la bandeja de entrada de un usuario. Parámetros UserInfo Usuario que se conecta (obligatorio). Folder información necesaria para realizar tal operación (número de registro a rechazar). DistributionOptions Motivo del rechazo. Entidad Entidad o ayuntamiento al que se realiza la petición Retorno RetornoServicio OK si la operación se ha realizado con exito o una excepción si no es así. public RetornoServicio rejectdistribution (User info user, Folder folder, DistributionOptions options, Entidad entidad) Método que realiza la operación de rechazar un registro de la bandeja de entrada de un usuario. user (UserInfo). Usuario con el que se realiza la petición. folder (Folder) Información necesaria para realizar la operación (número de registro). options (DistributionOptions) Motivo del rechazo. entidad (Entidad) Ayuntamiento sobre el que se realiza la petición. OK si la operación se ha realizado con éxito o una excepción si no es así. RetornoServicio changeinputdistribution Método changeinputdistribution Método que realiza la operación de redistribuir un registro de la bandeja de entrada de un usuario, modificando el destino. Parámetros UserInfo Usuario que se conecta (obligatorio). Folder Información necesaria para realizar tal operación (número de registro a redistribuir) AL SIGM v3 Descripción y código Servicios Web SIGEM 97

98 DistributionOptions Código del nuevo destino. Entidad Entidad o ayuntamiento al que se realiza la petición Retorno RetornoServicio OK si la operación se ha realizado con exito o una excepción si no es así. public RetornoServicio changeinputdistribution(userinfo user, Folder folder, DistributionOptions options, Entidad entidad) Método que realiza la operación de redistribuir un registro de la bandeja de entrada de un usuario, modificando el destino. user (UserInfo). Usuario con el que se realiza la petición. folder (Folder) Información necesaria para realizar la operación (número de registro). options (DistributionOptions) Código del nuevo destino. entidad (Entidad) Ayuntamiento sobre el que se realiza la petición. OK si la operación se ha realizado con éxito o una excepción si no es así. RetornoServicio changeoutputdistribution Método changeoutputdistribution Método que realiza la operación de redistribuir un registro de la bandeja de salida de un usuario, modificando el destino Parámetros UserInfo Usuario que se conecta (obligatorio). Folder Información necesaria para realizar tal operación (número de registro a redistribuir) DistributionOptions Código del nuevo destino. Entidad Entidad o ayuntamiento al que se realiza la petición Retorno RetornoServicio OK si la operación se ha realizado con exito o una excepción si no es así. public RetornoServicio changeoutputdistribution(userinfo user, Folder folder, DistributionOptions options, Entidad entidad) Método que realiza la operación de redistribuir un registro de la bandeja de salida de un usuario, modificando el destino. user (UserInfo). Usuario con el que se realiza la petición. folder (Folder) Información necesaria para realizar la operación (número de registro). AL SIGM v3 Descripción y código Servicios Web SIGEM 98

99 options (DistributionOptions) Código del nuevo destino. entidad (Entidad) Ayuntamiento sobre el que se realiza la petición. OK si la operación se ha realizado con éxito o una excepción si no es así. RetornoServicio adddocument Método adddocument Método para adjuntar documentos a un registro. Parámetros UserInfo Usuario que se conecta (obligatorio). Folder Información identificativa del registro, asi como los documentos a adjuntar. Entidad Entidad o ayuntamiento al que se realiza la petición Retorno RetornoServicio OK si la operación se ha realizado con exito o una excepción si no es así. public RetornoServicio createfolder(userinfo user, Folder folder, Entidad entidad) Adjunta documentos a un registro existente user (UserInfo). Usuario con el que se realiza la petición. folder (Folder) Información necesaria para adjuntar documentos entidad (Entidad) Ayuntamiento sobre el que se realiza la petición. OK si la operación se ha realizado con éxito o una excepción si no es así. RetornoServicio getinterestedoutputregister Método getinterestedoutputregister Método para obtener los interesados asociados a un registro de salida. Parámetros UserInfo Usuario que se conecta (obligatorio). Fólder Información identificativa del registro Entidad Entidad o ayuntamiento al que se realiza la petición Retorno RetornoServicio Datos de interesados. public RetornoServicio getinterestedoutputregister(userinfo user, Folder folder, Entidad entidad) Retorno los interesados asociados a un registro de salida. AL SIGM v3 Descripción y código Servicios Web SIGEM 99

100 user (UserInfo). Usuario con el que se realiza la petición. folder (Folder) Información identificativa del registro entidad (Entidad) Ayuntamiento sobre el que se realiza la petición. Datos del registro: RetornoServicio. Información del registro getinterestedinputregister Método getinterestedinputregister Método para obtener los interesados asociados a un registro de entrada. Parámetros UserInfo Usuario que se conecta (obligatorio). Folder Información identificativa del registro Entidad Entidad o ayuntamiento al que se realiza la petición Retorno RetornoServicio Datos de interesados. public RetornoServicio getinterestedinputregister(userinfo user, Folder folder, Entidad entidad) Retorno los interesados asociados a un registro de entrada. user (UserInfo). Usuario con el que se realiza la petición. folder (Folder) Información identificativa del registro entidad (Entidad) Ayuntamiento sobre el que se realiza la petición. Datos del registro: RetornoServicio. Información del registro getinputregister Método getinputregister Método para obtener los datos de un registro de entrada (incluyendo interesados). Parámetros UserInfo Usuario que se conecta (obligatorio). Fólder Información identificativa del registro Entidad Entidad o ayuntamiento al que se realiza la petición Retorno RetornoServicio Datos de registro de entrada. public FolderWithPersonInfo getinputregister(userinfo user, Folder folder, Entidad entidad) Retorno información de un registro de entrada junto con los interesados asociados. AL SIGM v3 Descripción y código Servicios Web SIGEM 100

101 user (UserInfo). Usuario con el que se realiza la petición. folder (Folder) Información identificativa del registro entidad (Entidad) Ayuntamiento sobre el que se realiza la petición. Datos del registro: FolderWithPersonInfo. Información del registro getoutputregister Método getoutputregister Método para obtener los datos de un registro de salida (incluyendo interesados). Parámetros UserInfo Usuario que se conecta (obligatorio). Folder Información identificativa del registro Entidad Entidad o ayuntamiento al que se realiza la petición Retorno RetornoServicio Datos de registro de entrada. public FolderWithPersonInfo getoutputregister(userinfo user, Folder folder, Entidad entidad) Retorno información de un registro de salida junto con los interesados asociados. user (UserInfo). Usuario con el que se realiza la petición. folder (Folder) Información identificativa del registro entidad (Entidad) Ayuntamiento sobre el que se realiza la petición. Datos del registro: FolderWithPersonInfo. Información del registro existmattertypeinoffice Método existmattertypeinoffice Método para obtener los datos de un registro de salida (incluyendo interesados). Parámetros UserInfo Usuario que se conecta (obligatorio). mattertypecode Código del tipo de asunto (obligatorio) officecode Código de oficina (obligatorio) Entidad Entidad o ayuntamiento al que se realiza la petición Retorno RetornoServicio Datos de registro de entrada. public RetornoServicio existmattertypeinoffice (UserInfo user, mattertypecode, officecode, Entidad entidad) AL SIGM v3 Descripción y código Servicios Web SIGEM 101

102 Comprueba si un tipo de asunto está disponible para una oficina. user (UserInfo). Usuario con el que se realiza la petición. mattertypecode (). Código de asunto officecode (). Código de oficina. entidad (Entidad) Ayuntamiento sobre el que se realiza la petición. Datos del registro: RetornoServicio. Información del estado de la operación. ReturnCode=OK. Si está disponible el tipo de asunto para la oficina Clases BookId. Almacena el identificador del libro de Registro bookid. identificador del libro de registro RetornoServicio. Objeto con la información del estado de la operación returncode. Código de estado de la operación (OK, ERROR, error desconocido) errorcode. Código de error en caso de producirse DistributionInfo. Objeto con la información de una distribución. dtrid. Identificador del registro distribuido. bookid. Identificador del libro de registro. booktype. Tipo del libro de registro. 1-Entrada, 2-Salida. bookname. Nombre del libro de registro. folderid. Identificador del registro. distributiondate. Fecha en la que se generó la distribución. sendertype. Tipo de origen de la distribución: 1-Usuario, 2-Departamento, 3-Grupo. senderid. Identificador del origen de la distribución. Su significado depende del valor de sendertype. sendername. Código y nombre del origen de la distribución. destinationtype. Tipo de destino de la distribución. 1-Usuario, 2- Departamento, 3-Grupo. destinationid. Identificador del destino de la distribución. Su significado depende del valor de destinationtype. destinationname. Código y nombre del destino de la distribución. state. Estado actual de la distribución. 1-Pendiente, 2-Aceptado, 3- Archivado, 4-Rechazado, 5-Redistribuido. statedescription. Descripción del estado de la distribución. statedate. Fecha en la que se llegó al estado actual. Message. Mensaje que acompaña a la distribución. user. Nombre del usuario. registernumber. Número de registro. registerdate. Fecha del registro. registerdestinationname. Nombre del destino del registro. AL SIGM v3 Descripción y código Servicios Web SIGEM 102

103 registermattertypename. Descripción del tipo de asunto del registro. registermatter. Tipo de asunto del registro. DistributionOptions. Clase que almacena valores, su significado depende del contexto. Al rechazar una distribución será el motivo del rechazo y al cambiar el destino de esta será el nuevo destino. code. Almacena el código del nuevo destino. remarks. Almacena el motivo del rechazo. DistributionSearchCriteria. Criterio de búsqueda, índice del primer registro a obtener y número máximo de registros que devolver. state. Estado de la distribución. 1-Pendiente, 2-Aceptado, 3-Archivado, 4- Rechazado, 5-Redistribuido. firstrow. Primera fila a devolver. maxresults. Número máximo de resultados a devolver. DistributionsInfo. Objeto que almacena objetos de tipo DistributionInfo. distributions. Array de objetos de tipo DistributionInfo. Document. Tipo particular de documento (Un documento formado por una página que almacena un fichero). documentname. Nombre del documento (valor lógico). filename. Nombre del fichero (valor físico). pagename. Nombre de la página (valor lógico). documentcontentb64. Contenido físico del documento en base 64. extension. Extensión del fichero. folder. Objeto de tipo Folder con información sobre el registro donde se encuentra el documento. docid. Identificador del documento. pageid. Identificador de la página. Documents. Objeto que almacena objetos de tipo Document. documents. Array de objetos de tipo Document. DocumentsWithPage. Tipo general de documento. Un documento almacena muchas páginas y cada una de ellas un fichero. documentname. Nombre del documento. bookid. Identificador del libro de registro. folderid. Identificador del registro. docid. Identificador del documento. pages. Array de objetos Page. FieldInfo. Objeto que almacena uno de los datos de un registro. fieldid. Identificador del dato. 1-Número de registro, 2-Fecha del registro, 3-Usuario, 4- Fecha de trabajo, 5-Oficina de registro, 6-Estado, 7-Origen, 8-Destino, 9-Remitentes, 10-Nº de registro original, 11-Tipo de registro original, 12-Fecha de registro original, 13-Registro original, 14-Tipo de transporte, 15-Número de transporte, 16-Tipo de asunto, 17-Resumen, 18- Comentario, 19-Referencia del expediente. value. Valor del campo FieldInfoSearchCriteria. Objeto que almacena uno de los criterios de búsqueda. AL SIGM v3 Descripción y código Servicios Web SIGEM 103

104 fieldid. Identificador del dato. 1-Número de registro, 2-Fecha del registro, 3-Usuario, 4- Fecha de trabajo, 5-Oficina de registro, 6-Estado, 7-Origen, 8-Destino, 9-Remitentes, 10-Nº de registro original, 11-Tipo de registro original, 12-Fecha de registro original, 13-Registro original, 14-Tipo de transporte, 15-Número de transporte, 16-Tipo de asunto, 17-Resumen, 18- Comentario, 19-Referencia del expediente. value: valor del dato operator: operador de búsqueda. =, >, <, >=, <=, = Fields. Objeto que almacena objetos de tipo FieldInfo. fields. Array de objetos de tipo FieldInfo. FieldsSearchCriteria. Objeto que almacena objetos de tipo FieldInfoSearchCriteria. fields. Array de objetos de tipo FieldInfoSearchCriteria. Folder. Información completa de un registro. folderid. Identificador del registro. foldernumber. Número de registro. fields. Objeto Fields con los datos del registro. bookid. Identificador del libro de registro. docwithpage. Array de objetos DocumentsWithPage. documents. Objeto Documents FolderSearchCriteria. Criterios de busqueda de registros. folderid. Identificador del registro. foldernumber. Número de registro. bookid. Identificador del libro de registro. fields. Objeto FieldsSearchCriteria con los datos de búsqueda Page. Objeto que almacena un fichero e información sobre el mismo. pagename. Nombre de la página. folderid. Identificador del registro al que pertenece esta página. docid. Identificador del documento al que pertenece esta página. pageid. Identificador de la página. fileid. Identificador del fichero que está almacenado en esta página. volidid. Identificador del volumen en el que se encuentra el fichero. Los ficheros se depositan en repositorios (normalmente un FTP), estos se dividen en volúmenes. loc. Ruta de acceso al fichero dentro de su volumen. PersonInfo. Objeto que almacena datos de interesados en un registro. personid. Identificador del interesado. (0 si no está normalizado) personname. Nombre del interesado. domid. Identificador del domicilio. RegisterInfo. Información sobre un registro. folderid. Identificador de un registro. bookid. Identificador del libro de registro. number. Número de registro. date. Fecha del registro. AL SIGM v3 Descripción y código Servicios Web SIGEM 104

105 username. Usuario que efectúa el registro. workdate. Fecha de la última operación con el registro. state. Estado del registro. office. Oficina de registro. officename. Nombre de la oficina de registro. RegistersInfo. Objeto que almacena objetos de tipo RegisterInfo. registers. Array de objetos de tipo RegisterInfo. UserInfo. Información del usuario que realiza la petición. locale. Idioma del usuario. password. Contraseña del usuario. username. Login del Usuario Entidad. Ayuntamiento sobre el que se realiza la petición. identificador. Código del ayuntamiento. nombre. Nombre del ayuntamiento. FolderWithPersonInfo. Información completa de un registro junto con los interesados. Folder. persons. Interesados Códigos de error =Error inesperado =Error: El nuevo código propuesto no es válido =Error: El tipo de distribución solicitado no esta soportado =Error: El libro asociado para la creación automática de registros no esta abierto =Error: El libro asociado para la creación automática de registros no es de salida =Error: Resulta imposible recuperar los libros solicitados =Error: Resulta imposible abrir el libro =Error: Resulta imposible obtener la fecha del servidor de base de datos =Error: Resulta imposible obtener la información de identificación del usuario =Error: Resulta imposible cerrar el libro =Error: Resulta imposible generar el formato para =Error: El libro no esta abierto por este usuario =Error: Este libro no se puede abrir. No tiene definido formatos =Error: No se puede ejecutar la consulta =Error: No se pueden recuperar los documentos del libro =Error: El registro seleccionado está bloqueado por otro usuario =Error: No se puede cerrar la carpeta =Error: No se puede recuperar el historial de distribución =Error: No se puede recuperar la lista de registros asociados =Error: No se pueden guardar los campos persistentes =Error: No se pueden cargar los campos persistentes =Error: No se pueden guardar los documentos originales =Error: Código de tipo de procedimiento no válido. AL SIGM v3 Descripción y código Servicios Web SIGEM 105

106 =Error: No se puede recuperar la lista de documentos originales =Error: No se puede incluir esta persona física =Error: No se puede incluir esta persona jurídica =Error: No se puede modificar esta persona física =Error: No se puede modificar esta persona jurídica =Error: Imposible recuperar este fichero. El fichero no existe o no esta disponible =Error: No se permite el acceso al documento seleccionado debido a que se ha producido una alteración de su contenido original =Error: No se puede almacenar el fichero =Error: No se puede recuperar la información de interesados =Error: No se pueden recuperar las direcciones =Error: No se pueden recuperar los domicilios =Error: No se puede recuperar la información adicional del tipo de asunto =Error: No se puede recuperar el detalle del archivo =Error: Dimensiones de página no permitidas =Error: La consulta no se encuentra abierta =Error: Esta consulta ya se encuentra abierta =Error: El registro solicitado no se encuentra entre los límites de la consulta =Error: No se puede crear esta carpeta =Error: Numeración no soportada para la versión web de invesicres =Error: No se puede modificar esta carpeta =Error: No se pueden salvar los ficheros compulsados =Error: No se puede realizar los cambios en la distribución =Error: Valor no válido =Error: El registro seleccionado está bloqueado por otro usuario =La propiedad [{0}] tiene un valor no válido =Valor no válido =El nombre de usuario debe ser menor de 32 caracteres =La contraseña de usuario debe ser menor de 64 caracteres =El nombre de la página debe ser menor de 32 caracteres =El nombre de la página debe tener extensión =Se ha producido un error en el acceso a la base de datos =Este usuario no se encuentra definido en el sistema =La contraseña del usuario no es válida =Este usuario se encuentra bloqueado =Este usuario ha sido bloqueado =Imposible cerrar la sesión =Este usuario no tiene definidos permisos en invesdoc =Este usuario no tiene definidos permisos en invesicres =No se puede recuperar la oficina del usuario =La sesión del usuario ha caducado o no existe =Los campos marcados no son correctos =Campo no soportado por la validación =No se pueden recuperar las listas de validación =No se pueden recuperar las ciudades de una provincia =No se pueden recuperar los interesados =No se pueden recuperar las provincias =o se pueden recuperar las direcciones de una persona =Resulta imposible obtener la distribución =No se puede aceptar la distribución de los registros solicitados. AL SIGM v3 Descripción y código Servicios Web SIGEM 106

107 =El estado de la distribución ya ha sido cambiado. Actualice el contenido de la bandeja =El nuevo destino no tiene lista de distribución =No se puede rechazar la distribución de los registros solicitados =No se puede archivar la distribución de los registros solicitados =Tipo de distribución no soportada =El registro seleccionado está bloqueado por otro usuario =No posee permiso de registro sobre ningún libro de registro de entrada. AL SIGM v3 Descripción y código Servicios Web SIGEM 107

108 3.11 Servicio Web del Registro Telemático Este servicio proporciona al sistema SIGEM, la funcionalidad que ofrece la aplicación de registro telemático de SIGEM. El servicio se despliega como un servicio web independiente. El servicio web se basa en la implementación Axis. El servicio de distribuye como una aplicación web dentro de un archivo war: SIGEM_RegistroTelematicoWS.war Métodos crearpeticionregistro Este método genera una petición de registro, es decir, nos genera el XML de la petición de registro Método crearpeticionregistro Método que genera una petición de registro Parámetros Identificador de sesión * este Identificador lo obtenemos llamando a algunos de los métodos de login del servicio web SIGEM_SesionUsuarioWS RegistroPeticion Datos de la solicitud Idioma de la solicitud Organismo al que se le realiza la solicitud Número de expediente asociado (si es subsanación). Null en caso contrario Entidad Entidad o ayuntamiento al que se realiza la petición Retorno B64 Estructura XML con la petición de registro en Base establecerdocumentossubsanacion Establece los documentos subsanados por el ciudadano Método establecerdocumentossubsanacion Método que establece los documentos adjuntados a una solicitud de subsanación Parámetros Identificador de sesión * este Identificador lo obtenemos llamando a algunos de los métodos de login del servicio web SIGEM_SesionUsuarioWS AL SIGM v3 Descripción y código Servicios Web SIGEM 108

109 Documentos Lista de documentos definidos para el trámite en el que se está presentando la subsanación PeticionDocumentos Información de los documentos subsanados por el ciudadano Entidad Entidad o ayuntamiento al que se realiza la petición Retorno RetornoCadena XML con los datos correspondiente a los ficheros anexados registrar Método que registra una solicitud Método registrar Método que registra una solicitud Parámetros Identificador de sesión * Este identificador lo obtendremos llamando a alguno de los métodos de login del módulo de autenticación. B64 Datos de la solicitud a registrar, obtenidos a través del método crearpeticionregistro XML con los datos específicos Idioma de la solicitud. Por ejemplo: es Número de oficina. En el caso de SIGEM estándar es el 999, código de la oficina de Registro Telemático. Ruta de la plantilla usada para la generación del justificante. El servicio web ha de tener acceso a esta ruta Ruta hacia el certificado usado para firmar el justificante. El servicio web ha de tener acceso a esta ruta Entidad Entidad o ayuntamiento al que se realiza la petición Retorno B64 XML de registro de la solicitud registrartelematicoandiniciarexpediente Este método genera una petición de registro, es decir, nos genera el XML de la petición de registro, y nos inicia un expediente para tramitarlo Método registrartelematicoandiniciarexpe diente Parámetros B64 Método que registra una solicitud e inicia un expediente para tramitarlo. Identificador de sesión. * Este identificador lo obtendremos llamando a alguno de los métodos de login del módulo de autenticación. Datos de la solicitud a registrar, que nos ha devuelto el método AL SIGM v3 Descripción y código Servicios Web SIGEM 109

110 crearpeticionregistro Datos específicos Idioma de la solicitud Número de oficina, en el caso de SIGEM estándar es el 999, código de la oficina de Registro Telemático. Ruta del justificante del registro que se usará como plantilla Ruta del certificado del servidor Tramite a iniciar. Identificador que tiene asociado en el catálogo de trámites, el trámite (registro) que estamos realizando. Entidad Entidad o ayuntamiento al que se realiza la petición Retorno B64 Registro de la solicitud, XML de la solicitud de registro con numero, fecha y hora de registro modificados deshacerregistro Método que elimina un registro si se produce un error. Método deshacerregistro Elimina un registro en caso de producirse algún error al iniciar expediente Parámetros Identificador de sesión * Este identificador lo obtendremos llamando a alguno de los métodos de login del módulo de autenticación Número de registro Entidad Entidad o ayuntamiento al que se realiza la petición Retorno sin retorno obtenernumeroregistro Método que obtiene un nuevo número de registro Método obtenernumeroregistro Método que obtiene un nuevo número de registro (secuencial) Parámetros Entidad Entidad o ayuntamiento al que se realiza la petición Retorno RetornoCadena Número de registro eliminardocumentostemporales Método que elimina los documentos temporales asociados a una solicitud AL SIGM v3 Descripción y código Servicios Web SIGEM 110

111 Método eliminardocumentostemporales Método que elimina los documentos temporales asociados a una solicitud Parámetros Identificador de sesión * Este identificador lo obtendremos llamando a alguno de los métodos de login del módulo de autenticación Número de registro Entidad Entidad o ayuntamiento al que se realiza la petición Retorno RetornoServicio query Método que realiza una búsqueda de registro a partir de determinados parámetros Método query Método que realiza una búsqueda de registro a partir de determinados parámetros Parámetros Identificador de sesión * Este identificador lo obtendremos llamando a alguno de los métodos de login del módulo de autenticación RegistroConsulta Criterios de búsqueda Entidad Entidad o ayuntamiento al que se realiza la petición Retorno Registros Lista de registros resultado de la búsqueda obtenerregistro Método que obtiene un registro Método obtenerregistro Método que obtiene un registro Parámetros Identificador de sesión * Este identificador lo obtendremos llamando a alguno de los métodos de login del módulo de autenticación Número de registro a obtener Entidad Entidad o ayuntamiento al que se realiza la petición Retorno Registro Datos del registro obtenerdocumentosregistro Método que obtiene la información de los documentos asociados a un registro (anexos, solicitud, justificante) AL SIGM v3 Descripción y código Servicios Web SIGEM 111

112 Método obtenerdocumentosregistro Método que obtiene información de los documentos asociados a un registro (anexos, solicitud, justificante) Parámetros Número de registro Entidad Entidad o ayuntamiento al que se realiza la petición Retorno RegistroDocumentos Información de los documentos asociados a un registro obtenerdatosdocumentosregistro Método que obtiene los documentos asociados a un registro (anexos, solicitud, justificante) Método obtenerdatosdocumentosregistro Método que obtiene los documentos asociados a un registro (anexos, solicitud, justificante) Parámetros Número de registro Entidad Entidad o ayuntamiento al que se realiza la petición Retorno ContenedorDocumentos Documentos asociados a un registro obtenerjustificanteregistro Método que obtiene el justificante de registro Método obtenerjustificanteregistro Método que obtiene el justificante de registro Parámetros Identificador de sesión * Este identificador lo obtendremos llamando a alguno de los métodos de login del módulo de autenticación Número de registro Entidad Entidad o ayuntamiento al que se realiza la petición Retorno B64 Justificante obtenerpeticionregistro Método obtenerpeticionregistro Método que obtiene la solicitud de registro Parámetros Número de registro Entidad Entidad o ayuntamiento al que se realiza la petición Retorno B64 Solicitud de registro AL SIGM v3 Descripción y código Servicios Web SIGEM 112

113 obtenerregistrosconsolidados Método que obtiene los registros consolidados Método obtenerregistrosconsolidados Método que obtiene los registros consolidados Parámetros Entidad Entidad o ayuntamiento al que se realiza la petición Retorno Registros Registros consolidados obtenerregistrosparamostrar Método que obtiene los registros a mostrar a un usuario Método obtenerregistrosparamostrar Método que obtiene los registros a mostrar a un usuario Parámetros RegistroConsulta Criterios de búsqueda Entidad Entidad o ayuntamiento al que se realiza la petición Retorno Registros Registros a mostrar tienedocumentos Método que comprueba si existen documentos anexos a un registro Método tienedocumentos Método que comprueba si existen documentos anexos a un registro Parámetros Número de registro Entidad Entidad o ayuntamiento al que se realiza la petición Retorno RetornoLogico Verdadero si existen documentos anexos a un registro obtenercontenidodocumento Método que obtiene el contenido de un documento asociado a un registro Método obtenercontenidodocumento Método que obtiene el contenido de un documento asociado a un registro Parámetros Identificador de sesión * Este identificador lo obtendremos llamando a alguno de los métodos de login del módulo de autenticación Número de registro Código de documento Entidad Entidad o ayuntamiento al que se AL SIGM v3 Descripción y código Servicios Web SIGEM 113

114 realiza la petición Retorno ByteArrayB64 Contenido del Documento obtenerdocumento Método que obtiene el contenido de un documento asociado a un registro Método obtenerdocumento Método que obtiene el contenido de un documento asociado a un registro Parámetros Número de registro Código de documento Entidad Entidad o ayuntamiento al que se realiza la petición Retorno B64 Contenido del Documento establecerestadoregistro Método que actualiza el estado de un registro Método establecerestadoregistro Método que actualiza el estado de un registro Parámetros Número de registro Nuevo estado para el registro Entidad Entidad o ayuntamiento al que se realiza la petición Retorno RetornoServicio Datos de retorno obtenerdocumentoregistro Método que obtiene la asociación entre un registro y un documento Método obtenerdocumentoregistro Método que obtiene la asociación entre un registro y un documento Parámetros Identificador de sesión * Este identificador lo obtendremos llamando a alguno de los métodos de login del módulo de autenticación Número de registro Código de documento Entidad Entidad o ayuntamiento al que se realiza la petición Retorno RegistroDocumento Datos de la asociación del documento con el registro AL SIGM v3 Descripción y código Servicios Web SIGEM 114

115 insertardocumentoregistro Método que da de alta la asociación entre un registro y un documento Método insertardocumentoregistro Método que da de alta la asociación entre un registro y un documento Parámetros RegistroDocumento Datos de la asociación Entidad Entidad o ayuntamiento al que se realiza la petición Retorno RegistroDocumento Datos de la asociación actualizardocumentoregistro Método que actualiza la asociación entre un registro y un documento Método actualizardocumentoregistro Método que actualiza la asociación entre un registro y un documento Parámetros RegistroDocumento Datos de la asociación Entidad Entidad o ayuntamiento al que se realiza la petición Retorno RetornoServicio Datos de retorno eliminardocumentoregistro Método que elimina la asociación entre un registro y sus documentos Método eliminardocumentoregistro Método que elimina la asociación entre un registro y sus documentos Parámetros Número de registro Entidad Entidad o ayuntamiento al que se realiza la petición Retorno RetornoServicio Datos de retorno Clases Entidad Campo Tipo Descripción Identificador Código de identificación de la entidad RegistroDocumentos Campo Tipo Descripción AL SIGM v3 Descripción y código Servicios Web SIGEM 115

116 registrydocuments ArrayList Lista de documentos RegistroDocumento Campo Tipo Descripción registrynumber Número de registro code Código de documento dentro del catálogo de trámites guid Identificador del documento Registro Campo Tipo Descripción registrynumber Numero de registro registrydate Fecha effectivedate Fecha efectiva de presentación senderid Identificación del ciudadano name Nombre topic Objeto del registro addressee Organismo destinatario status senderidtype Estado. 0:No Consolidado 1:Consolidado 3:Error 0: Otro 1: Dni addtionalinfo XML que recoge los datos específicos oficina Código de oficina numeroexpediente Número de expediente al que está asociado el registro RegistroConsulta AL SIGM v3 Descripción y código Servicios Web SIGEM 116

117 Campo Tipo Descripción registrynumber Número de registro oprregistrynumber firstregistrydate Operador. Por defecto a 0. O: Sin operador 1: Mayor que 2: Mayor o igual que 3: Menor que 4: Menor o igual que 5: Que contenga 6: Igual a Fecha inicial del rango de búsqueda lastregistrydate Fecha final del rango de búsqueda senderid Identificador del ciudadano topic Objeto del registro addressee Organismo destinatario status Estado. RegistroPeticion Campo Tipo Descripción addressee Órgano destinatario o Unidad Administrativa a la que va dirigida la petición documents PeticionDocumentos Documentos Anexos a la solicitud. del solicitante folderid procedureid Identificador que tiene asociado en el catálogo de trámites, el trámite (registro) que estamos realizando. senderidtype specificdata Xml correspondiente al bloque de Datos Específicos de nuestra solicitud. Documentos Campo Tipo Descripción documentos ArrayList Lista de objetos DocumentoExtendido AL SIGM v3 Descripción y código Servicios Web SIGEM 117

118 DocumentoExtendido Campo Tipo Descripción id code mandatory description extension PeticionDocumento Campo Tipo Descripción code Código del documento extension Extensión del documento filename location Nombre de fichero Ruta física del documento. Esta ruta ha de ser accesible por el servicio Web. PeticionDocumentos Campo Tipo documents ArrayList Descripción Documentos Todos los objetos extienden del objeto RetornoServicio: RetornoServicio Campo Tipo Descripción errorcode Código de error. returncode Código de retorno. OK: Operación realizada con éxito ERROR: Se ha producido un error en la operación Códigos de error =Error inesperado AL SIGM v3 Descripción y código Servicios Web SIGEM 118

119 =Error: No se ha podido crear la solicitud de registro =Error: Error en la base de datos de registro =Error: La información suministrada no es válida =Error: Hay virus en el documento =Error: Se requiere el documento =Error: Se han anexado más documentos de los requeridos =Error: Ha excedido el tamaño máximo permitido en el documento =Error: Es una extensión no soportada para el documento =Error: No se ha podido efectuar la operación de registro =Error: No se ha podido generar un número de registro =Error: La tabla de números de registro no ha sido inicializada =Error: No se ha podido generar la evidencia forense =Error: El número de registro no existe =Error: No se han podido eliminar los documentos temporales =Error: No se ha podido recuperar el justificante de registro =Error: No se ha podido recuperar la información del registro =Error: Error de configuración =Error: Error en la gestión de los documentos =Error: Error en la gestión de los documentos =Error: La firma no es correcta en el documento =Error: El formato del documento no es correcto =Error: El formato de la solicitud de registro no es correcto =Error: La solicitud de registro no está firmada correctamente =Error: El contenido del justificante de registro no es correcto =Error: El justificante de registro no está firmado correctamente =Error: No se ha podido obtener la información del documento =Error: No se ha podido recuperar el contenido del documento =Error: No se ha podido verificar la integridad del registro =Error: No se ha podido verificar la integridad del registro =Error: No es válido el documento cuyo código es {0} =Error: No existe ningún registro que coincida con los parámetros de la búsqueda =Error: No se ha podido actualizar el estado de un registro consolidado =Error: No se ha podido transformar documento para impresión =Error: No se ha podido obtener un documento de un registro =Error: El número de registro o el código de documento no es válido =Error: No se ha podido añadir un nuevo documento de registro =Error: No se ha podido actualizar un documento de registro =Error: No se han podido actualizar los documentos de un registro =Error: El número de registro no es válido =Error: No se han podido eliminar los documentos de un registro =Error: No se han podido obtener todos los documentos de un registro =Error: No se ha podido deshacer correctamente el registro realizado =Error: No se ha podido iniciar un expediente asociado al registro. AL SIGM v3 Descripción y código Servicios Web SIGEM 119

120 3.12 Servicio Web de Sesión de Usuarios Este servicio proporciona al sistema SIGEM la funcionalidad para la gestión de las sesiones de usuario de portal abiertas en las aplicaciones de tramitación electrónica. El servicio se despliega como un servicio web independiente. El servicio web se basa en la implementación Axis. El servicio de distribuye como una aplicación web dentro de un archivo war: SIGEM_SesionUsuarioWS.war Métodos loginexternaluser Método loginexternaluser Permite al usuario acceder al sistema si posee las credenciales adecuadas. En este caso, la información debe ser previamente recuperada de la validación de los datos de usuario contra un aplicativo externo Parámetros LoginExternalUser Datos del usuario (identificador de sesión actual, nombre, apellidos, e identificador de usuario) Retorno IdentificadorSesion Identificador de sesión logincertificate Método logincertificate Permite al usuario acceder al sistema si posee las credenciales adecuadas. En este caso debe poseer un certificado Además su certificado no debe estar revocado. Parámetros LoginCertificado Datos del login (identificador del procedimiento y el certificado presentado o credencial) Retorno IdentificadorSesion Identificador de sesión logincertificateauth Método logincertificateauth Permite al usuario acceder al sistema si posee las credenciales adecuadas. En este caso debe poseer un certificado Además su certificado no debe estar revocado. Parámetros LoginCertificadoAutoridad Datos del login (identificador de AL SIGM v3 Descripción y código Servicios Web SIGEM 120

121 autenticación y el certificado presentado o credencial) Retorno IdentificadorSesion Identificador de sesión Logout Método logout Desconecta a un usuario del sistema Parámetros IdentificadorSesion Identificador de sesión Retorno ReotnoServicio crearsesion Método crearsesion Crea una nueva sesión de usuario en el sistema. Esta sesión de usuario es compartida por las aplicaciones de tramitación de SIGEM Parámetros SesionUsuario Datos de la sesión de usuario Retorno RetornoServicio borrarsesion Método borrarsesion Elimina una sesión de usuario del sistema. El usuario estará "deslogado" de todas las aplicaciones de tramitación de SIGEM Parámetros SesionUsuario Datos de la sesión de usuario Retorno RetornoServicio limpiarsesiones Método limpiarsesiones Elimina del sistema todas las sesiones de usuario que hayan sobrepasado el tiempo máximo de existencia definido por configuración Parámetros Retorno RetornoServicio limpiarsesionestimeout Método limpiarsesionestimeout Elimina del sistema todas las sesiones de usuario que hayan sobrepasado el tiempo máximo que llega como parámetro AL SIGM v3 Descripción y código Servicios Web SIGEM 121

122 Parámetros LimpiarSesiones Retorno RetornoServicio Intervalo de tiempo hasta el momento actual máximo para mantener sesiones obtenersesion Método obtenersesion Obtiene todos los datos de la sesión de usuario Parámetros Identificador de la sesión de usuario Retorno SesionUsuario Datos de la sesión de usuario getinfousuario Método getinfousuario Obtiene la información personal del usuario que inició la sesión en el sistema Parámetros IdentificadorSesion Identificador de la sesión de usuario Retorno InfoUsuario Información personal del usuario getidmetodoautenticacion Método getidmetodoautenticacion Obtiene el identificador del método de autenticación utilizado para iniciar la sesión en el sistema Parámetros IdentificadorSesion Identificador de la sesión de usuario Retorno MetodoAutenticacion Identificador del método de autenticación utilizado al crear la sesión getmetodoautenticacion Método getmetodoautenticacion Obtiene la información del método de autenticación utilizado para iniciar la sesión Parámetros IdentificadorSesion Identificador de la sesión de usuario Retorno MetodoAutenticacion Objeto con la información sobre el método de autenticación Códigos de error =Error: En la base de datos de sesiones. AL SIGM v3 Descripción y código Servicios Web SIGEM 122

123 =Error: Al crear la sesión =Error: Al eliminar la sesión =Error: Al recuperar información de la sesión =Error: Al generar el hash =Error: Al firmar =Error: La sesión no existe =Error: No se ha podido leer el certificado =Error: Al cifrar datos =Error: Al descifrar datos =Error: No se ha podido obtener la información de autenticación =Error: No se ha podido acceder al sistema =Error: Las credenciales de acceso no son válidas =Error: No se ha podido desconectar del sistema =Error: No se puede recuperar la información de autenticación del usuario en esta sesión =Error: De configuración =Error: En el registro de acción en el log =Error: Al verificar firma =Error: Al verificar documento =Error: No se puede acceder al componente de autenticación y firma =Error: No se puede acceder al componente de sesión =Error: No se puede acceder al componente de criptografía =Error: No se puede recuperar el documento sin la firma =Error: En el servicio de validación de CATCert =Error: Del sistema de validación (InternalError, UnrecognizedToken) =Error: En el formato de la petición (RequestError) =Error: Al crear un conector de autenticación =Error: El identificador del conector de autenticación no es válido =Error: Al actualizar un conector de autenticación =Error: Al eliminar un conector de autenticación =Error: Al recuperar la lista de conectores de autenticación =Error: Al recuperar un conector de autenticación =Error: Error de autenticación =Error: Error de seguridad. AL SIGM v3 Descripción y código Servicios Web SIGEM 123

124 3.13 Servicio Web de Terceros Este servicio proporciona al sistema SIGEM la funcionalidad para la gestión de Terceros. El servicio se despliega como un servicio web independiente. El servicio web se basa en la implementación Axis. El servicio de distribuye como una aplicación web dentro de un archivo war: SIGEM_TercerosWS.war Métodos getelectronicaddress public DireccionElectronica getelectronicaddress( entityid, id) Obtiene una dirección electrónica según su identificador entityid - Identificador de la entidad administrativa. id - identificador de dirección electrónica Retorno: dirección electrónica getpostaladdress public DireccionPostal getpostaladdress( entityid, id) Obtiene una dirección postal según su identificador entityid - Identificador de la entidad administrativa. id - identificador de dirección postal Retorno: dirección postal lookup public List lookup( entityid, code) Obtiene una lista de terceros en función del código de identificación. entityid - Identificador de la entidad administrativa. code - Código de identificación del tercero Retornos: Lista de terceros (Tercero) AL SIGM v3 Descripción y código Servicios Web SIGEM 124

125 lookup public List lookup( entityid, code, boolean defaultvalues) Obtiene una lista de terceros en función del código de identificación, indicando si se han de cargar sólo las direcciones marcadas como preferentes. entityid - Identificador de la entidad administrativa. code - Código de identificación del tercero defaultvalues- Indica si se han de devolver sólo las direcciones marcadas como preferentes Retornos: Lista de terceros (Tercero) lookup public List lookup( entityid, name, surname1, surname2) Obtiene una lista de terceros en función del nombre y dos apellidos. entityid - Identificador de la entidad administrativa. name - Nombre del tercero surname1 Primer apellido del tercero surname2 - Segundo apellido del tercero Retornos: Lista de terceros (Tercero) lookup public List lookup( entityid, name, surname1, surname2, boolean onlydefaultvalues) Obtiene una lista de terceros en función del nombre y dos apellidos, indicando si se han de cargar sólo las direcciones marcadas como preferentes. entityid - Identificador de la entidad administrativa. name - Nombre del tercero surname1 Primer apellido del tercero surname2 - Segundo apellido del tercero onlydefaultvalues - Indica si se han de devolver sólo las direcciones marcadas como preferentes Retornos: Lista de terceros (Tercero) AL SIGM v3 Descripción y código Servicios Web SIGEM 125

126 lookupbyid public Tercero lookupbyid( entityid, id) Obtiene un tercero a partir de su identificador interno. entityid - Identificador de la entidad administrativa. id - Identificador interno del tercero. Retornos: Información del tercero lookupbyid public Tercero lookupbyid(entityid, id, onlydefaultvalues) Obtiene un tercero a partir de su identificador, indicándole si deben recuperarse las direcciones marcadas como preferentes. entityid - Identificador de la entidad administrativa. id - identificador del tercero. onlydefaultvalues - Indica si se cargan solamente las direcciones asociadas por defecto. Retornos: Información del tercero con sus direcciones por defecto si así se indica lookupbyid public Tercero lookupbyid( entityid, id, postaladdressid, electronicaddressid) Obtiene un tercero a partir de su identificador interno. entityid - Identificador de la entidad administrativa. id - identificador del tercero. postaladdressid - Identificador de la dirección postal. electronicaddressid - Identificador de la dirección postal. Retornos: Información del tercero lookupdefaultelectronicaddress public DireccionElectronica lookupdefaultelectronicaddress( entityid, id) Obtiene la dirección electrónica por defecto para un tercero entityid - Identificador de la entidad administrativa. AL SIGM v3 Descripción y código Servicios Web SIGEM 126

127 id - identificador de tercero Retornos: dirección electrónica lookupdefaultpostaladdress public DireccionPostal lookupdefaultpostaladdress( entityid, id) Obtiene la dirección postal por defecto para un tercero entityid - Identificador de la entidad administrativa. id - identificador de tercero Retornos: dirección postal por defecto lookupelectronicaddresses public DireccionElectronica[] lookupelectronicaddresses( entityid, id) Obtiene una colección de todas las direcciones electrónicas para un tercero entityid - Identificador de la entidad administrativa. id - identificador de tercero Retornos: colección de direcciones electrónicas lookuppostaladdresses public DireccionPostal[] lookuppostaladdresses( entityid, id) Obtiene una colección de todas las direcciones postales para un tercero entityid - Identificador de la entidad administrativa. id - identificador de tercero Retornos: lista de direcciones de postales relacionadas con un tercero Códigos de error =Error inesperado. AL SIGM v3 Descripción y código Servicios Web SIGEM 127

128 3.14 Servicio Web de Gestión de Expedientes Este servicio proporciona al sistema SIGEM la funcionalidad para la gestión de Expedientes. El servicio se despliega como un servicio web independiente. El servicio web se basa en la implementación Axis. El servicio de distribuye como una aplicación web dentro de un archivo war: SIGEM_TramitacionWS.war Métodos getprocedimientosportipo Método getprocedimientosportipo Recupera la lista de procedimientos del tipo que se indica, con su información básica Parámetros int Retorno Identificador de entidad (organismo). Tipo de procedimiento. Valores posible: 1 - Todos 2 - Procedimientos automatizados 3 - Procedimientos no automatizados Nombre del procedimiento de información de procedimientos getprocedimientos Método getprocedimientos Recupera la lista de procedimientos cuyos identificadores se incluyen en el parámetro idprocs Parámetros [] Identificador de entidad (organismo). Lista de identificadores de procedimientos Retorno ListaInfoBProcedimientos Lista de información de procedimientos getprocedimiento Método getprocedimiento Recupera la información de un procedimiento cuyo identificador único es pasado como parámetro Parámetros Identificador de entidad (organismo). Identificador de procedimiento Retorno Procedimiento Información del procedimiento AL SIGM v3 Descripción y código Servicios Web SIGEM 128

129 getfichero Método getfichero Obtiene el contenido del documento Parámetros Identificador de entidad (organismo). GUID del documento Retorno Binario Contenido del documento getinfofichero Método getinfofichero Obtiene la información de origen e integridad del documento Parámetros Identificador de entidad (organismo). GUID del documento Retorno InfoFichero Información del documento getinfoocupacion Método getinfoocupacion Obtiene la información de ocupación del repositorio Parámetros Identificador de entidad (organismo). Retorno InfoOcupacion Información de ocupación eliminaficheros Método eliminaficheros Elimina los documentos determinados por los GUIDs Parámetros [] Identificador de entidad (organismo). Lista de GUIDs de los documentos Retorno RetornoServicio getidsexpedientes Método getidsexpedientes Recupera los identificadores de los expedientes, del procedimiento identificado por el identificador del procedimiento, que hayan finalizado en el rango de fechas comprendido entre la fecha inicial y la fecha final ordenados por lo que indique el parámetro de tipo de ordenación Parámetros Date Date Identificador de entidad (organismo). Identificador del procedimiento Fecha de inicio Fecha de fin AL SIGM v3 Descripción y código Servicios Web SIGEM 129

130 int Tipo de ordenación. Valores posible: 1 - Número de expediente 2 - Fecha finalización Retorno ListaIdentificadores Lista de identificadores de expedientes getexpedientes Método getexpedientes Recupera la lista de expedientes cuyos identificadores son pasados como parámetro Parámetros [] Identificador de entidad (organismo). Identificadores de expedientes Retorno ListaInfoBExpedientes Lista de expedientes getexpediente Método getexpediente Recupera la información de un expediente cuyo identificador único es pasado como parámetro Parámetros Identificador de entidad (organismo). Identificador del expediente Retorno Expediente Información de un expediente iniciarexpediente Método iniciarexpediente Crear un expediente Parámetros DatosComunesExpediente DocumentoExpediente[] Identificador de entidad (organismo). Datos comunes para todos los expedientes XML con los datos específicos del expediente Lista de documentos asociados al expediente Retorno Booleano Cierto si el expediente se ha creado correctamente iniciarexpediente Método iniciarexpediente Crear un expediente Parámetros DatosComunesExpediente Identificador de entidad (organismo). Datos comunes para todos los expedientes. XML con los datos específicos del expediente. DocumentoExpediente[] Lista de documentos asociados al AL SIGM v3 Descripción y código Servicios Web SIGEM 130

131 expediente. Sistema externo desde el que se da inicio al expediente. Retorno Número de expediente iniciado anexardocsexpediente Método anexardocsexpediente Añade documentos al trámite de un expediente Parámetros Date DocumentoExpediente[] Identificador de entidad (organismo). Número de expediente. Número de registro de entrada. Fecha de registro de entrada. Lista de documentos asociados al expediente. Retorno Booleano Cierto si los documentos se han creado correctamente cambiarestadoadministrativo Método cambiarestadoadministrativo Permite cambiar el estado administrativo de un expediente Parámetros Identificador de entidad (organismo). Número de expediente. Nuevo estado administrativo. Retorno Bolean Cierto si todo ha ido bien moverexpedienteafase Método moverexpedienteafase Mueve un expediente de fase, siempre y cuando se cumplan las condiciones para poder ser movido (sin trámites abiertos, etc.) Parámetros Identificador de entidad (organismo). Número de expediente Identificador de la fase destino en el catálogo de fases. Retorno Bolean Cierto si todo ha ido bien busquedaavanzada Método busquedaavanzada Realiza búsquedas sobre las entidades de tramitación haciendo uso de un formulario de búsqueda avanzada existente AL SIGM v3 Descripción y código Servicios Web SIGEM 131

132 Parámetros int Identificador de entidad (organismo). Nombre de grupo a usar para permisos sobre formulario de búsqueda y para responsabilidades en la búsqueda. Nombre del formulario de búsqueda a utilizar. XML con criterios de búsqueda. Dominio de búsqueda (todos los expedientes/según responsabilidad). Retorno Resultados obtenidos establecerdatosregistroentidad Método establecerdatosregistroentidad Inserta/actualiza los datos de un registro de una entidad de tramitación. Parámetros Identificador de entidad (organismo). Nombre de entidad de tramitación. Número de expediente. XML con los datos del registro a insertar/actualizar. Retorno int Identificador del registro insertado/actualizado obtenerregistroentidad Método obtenerregistroentidad Retorna los datos de un registro de una entidad de tramitación para un expediente Parámetros int Identificador de entidad (organismo). Nombre de entidad de tramitación. Número de expediente. Identificador del registro. Retorno Datos del registro a obtener obtenerregistrosentidad Método obtenerregistrosentidad Retorna todos los registro de una entidad de tramitación para un expediente Parámetros Identificador de entidad (organismo). Nombre de entidad de tramitación. Número de expediente. Retorno Datos de los registros. AL SIGM v3 Descripción y código Servicios Web SIGEM 132

133 Códigos de error =Error inesperado Servicio Web de Consulta de documentos de Gestión de Expedientes por CSV Este servicio proporciona al sistema SIGEM la funcionalidad para descargar los documentos de la Gestión de Expedientes a partir del CSV. El servicio se despliega como un servicio web independiente. El servicio web se basa en la implementación Axis. El servicio de distribuye como una aplicación web dentro de un archivo war: SIGEM_TramitacionWS.war Métodos existedocumento Método existedocumento Comprueba si el contenido del documento está disponible. Parámetros CSV del documento. Identificador de entidad (organismo). Retorno Boolean True si existe el documento, false en caso contrario getcontenidodocumento Método getcontenidodocumento Recupera el contenido del documento. Parámetros CSV del documento. Identificador de entidad (organismo). Retorno base64binary Contenido del documento. AL SIGM v3 Descripción y código Servicios Web SIGEM 133

134 3.16 Servicio Web de Mensajes Cortos Este servicio proporciona al sistema SIGEM la funcionalidad para en envío de sms certificados o no y s. El servicio se despliega como un servicio web independiente. El servicio web se basa en la implementación Axis. El servicio de distribuye como una aplicación web dentro de un archivo war: SIGEM_MensajesCortosWS.war Métodos sendsms Método sendsms Envía un mensaje SMS. Retorna el identificador del envío. Parámetros Usuario del servicio Clave del usuario Remitente del mensaje Destinatario del mensaje Texto a enviar Retorno Identificador del envío, con el siguiente formato mtid:dst donde mtid es un identificador único generado por la aplicación y dst el número de destino. public sendsms( user, pwd, src, dst, txt) Envía un mensaje SMS. user - Usuario del conector. pwd - Clave del usuario del conector. src - Remitente del mensaje dst - Destinatario del mensaje en formato internacional. txt - Texto a enviar. Retorno: Identificador del mensaje enviado sendsms Método sendsms Envía un mensaje SMS a cada uno de los destinatarios. Retorna un array de s con los identificadores del envío. Parámetros Usuario del servicio Clave del usuario Remitente del mensaje AL SIGM v3 Descripción y código Servicios Web SIGEM 134

135 [] Array de destinatarios del mensaje Texto a enviar Retorno [] Array con los identificadores de envío. public [] sendsms( user, pwd, src, [] dst, txt) Envía un mensaje SMS. user - Usuario del conector. pwd - Clave del usuario del conector. src - Remitente del mensaje dst - Destinatarios del mensaje en formato internacional. txt - Texto a enviar. Retorno: Identificadores de los mensajes enviados getsmsstatus Método getsmsstatus Obtiene el estado de un mensaje SMS enviado Parámetros Usuario del servicio Clave del usuario Identificador del sms enviado Retorno int Código identificativo del estado: 1 Nuevo 2Pendiente 3Enviado 4Fallido 5Pendiente envío al destinatario 6Fallido 7Inválido 8Cancelado 9Programado public int getsmsstatus( user, pwd, id) Obtiene el estado de un mensaje SMS enviado. user - Usuario del conector. pwd - Clave del usuario del conector. id - Identificador del SMS enviado. Retorno: Estado del mensaje sendcertsms AL SIGM v3 Descripción y código Servicios Web SIGEM 135

136 Método sendcertsms Envía un sms certificado Parámetros Usuario del servicio Clave del usuario Remitente del mensaje Destinatario Texto a enviar Lenguaje Retorno Identificador del envío, con el siguiente formato mtid:dst donde mtid es un identificador único generado por la aplicación y dst el número de destino. public sendcertsms( user, pwd, src, dst, txt, lang) Envía un mensaje SMS certificado. user - Usuario del conector. pwd - Clave del usuario del conector. src - Remitente del mensaje dst - Destinatarios del mensaje en formato internacional. txt - Texto a enviar. lang - Lenguaje del resguardo del mensaje. Retorno: Identificador del mensaje certificado getcertsmssignaturestatus Método getcertsmssignaturestatus Obtiene el estado del proceso de firma del resguardo del envío de un SMS Parámetros Usuario del servicio Clave del usuario Identificador del sms certificado Retorno int Código identificativo del estado: 1El servidor de firma electrónica se esta inicializando o el servicio del tercero no esta temporalmente disponible por algún motivo. Fichero pendiente de generación. 2Generando el contenido y cursando la petición de firma electrónica del contenido. Fichero pendiente de generación. 3 Incrustando la firma en el fichero PDF. Fichero pendiente de generación. 4Notificando al usuario a través del correo electrónico. Fichero no disponible todavía. AL SIGM v3 Descripción y código Servicios Web SIGEM 136

137 5Proceso de firma finalizado. Fichero temporalmente disponible en el repositorio. -1Error 50Proceso de firma finalizado. Fichero disponible en el repositorio 51Proceso de firma finalizado. Fichero no disponible en el repositorio. public int getcertsmssignaturestatus( user, pwd, id) Obtiene el estado del proceso de firma del resguardo del envío de un SMS certificado. user - Usuario del conector. pwd - Clave del usuario del conector. id - Identificador del SMS certificado. Retorno: Estado del proceso de firma getcertsmssignaturexml Método getcertsmssignaturexml Obtiene el resguardo del envío de un SMS certificado en formato XML Parámetros Usuario del servicio Clave del usuario Identificador del sms certificado Retorno Xml con el resguardo. public getcertsmssignaturexml( user, pwd, id) Obtiene el resguardo del envío de un SMS certificado en formato XML. user - Usuario del conector. pwd - Clave del usuario del conector. id - Identificador del SMS certificado. Retorno: XML con el resguardo getcertsmssignaturedocument Método getcertsmssignaturedocument Obtiene el resguardo del envío de un SMS certificado en formato binario. Parámetros Usuario del servicio AL SIGM v3 Descripción y código Servicios Web SIGEM 137

138 Clave del usuario Identificador del sms certificado Retorno Byte[] Array de bytes que representa el resguardo del sms certificado. public byte[] getcertsmssignaturedocument( user, pwd, id) Obtiene el resguardo del envío de un SMS certificado en formato binario. user - Usuario del conector. pwd - Clave del usuario del conector. id - Identificador del SMS certificado. Retorno: Binario con el resguardo sendmail Método getcertsmssignaturedocument Obtiene el resguardo del envío de un SMS certificado en formato binario. Parámetros Usuario del servicio Clave del usuario Identificador del sms certificado Retorno Byte[] Array de bytes que representa el resguardo del sms certificado. public void sendmail( from, [] to, [] cc, [] bcc, subject, content, Attachment[] attachments) Envía un correo electrónico. from - Dirección de correo electrónico del remitente. to - Dirección de correo electrónico del destinatario. cc - Dirección de correo electrónico de destinatarios en copia. bcc - Dirección de correo electrónico de destinatarios en copia oculta. subject - Asunto del mensaje. content - Contenido del mensaje. attachments - Array de objetos Attachment con el nombre del fichero adjunto y el contenido en binario. Attachment Clases filename - Nombre del fichero adjunto. content - Contenido del fichero adjunto. AL SIGM v3 Descripción y código Servicios Web SIGEM 138

139 Códigos de error =Error inesperado. AL SIGM v3 Descripción y código Servicios Web SIGEM 139

140 3.17 Servicio Web de Antivirus Este servicio proporciona al sistema SIGEM la funcionalidad para comprobar si un fichero tiene virus. El servicio se despliega como un servicio web independiente. El servicio web se basa en la implementación Axis. El servicio de distribuye como una aplicación web dentro de un archivo war: SIGEM_AntivirusWS.war Métodos comprobarfichero Método comprobarfichero Método que comprueba si el contenido de un fichero contiene virus Parámetros byte[] Contenido del fichero a comprobar Retorno Boolean True en caso de no tener virus, false en caso contrario AntivirusException public boolean comprobarfichero(byte[] fichero, boolean borrar) Método que comprueba si el contenido de un fichero contiene virus fichero. Contenido del fichero a analizar. borrar. True en caso de no tener virus, false en caso contrario comprobarfichero Método comprobarfichero Método que comprueba si un fichero contiene virus Parámetros Ruta del fichero a comprobar Retorno Boolean True en caso de no tener virus, false en caso contrario AntivirusException public boolean comprobarfichero( rutafichero, boolean borrar) Método que comprueba si un fichero contiene virus rutafichero. Ruta del fichero a analizar. borrar. True en caso de no tener virus, false en caso contrario AL SIGM v3 Descripción y código Servicios Web SIGEM 140

141 3.18 Servicio Web de Notariado para Signo Proporciona servicios a la aplicación externa Signo, durante la notaria. Ofrece operaciones de cálculo y pago de plusvalía, que deben ser personalizadas para cada entidad a través de la implementación del conector correspondiente. El servicio se despliega como un servicio web independiente. El servicio web se basa en la implementación Spring-WS. El servicio de distribuye como una aplicación web dentro de un archivo war: SIGEM_SignoWS.war Métodos calculoliquidacion Método calculoliquidacion Método que calcula el importe de una plusvalía Parámetros REQUESTType Tipo definido en el xsd suministrado desde ANCERT. Contiene los datos de la plusvalía. Mensaje XML de la petición Retorno REPLYType Tipo definido en el xsd suministrado desde ANCERT. Contiene los datos de la respuesta incluyendo el importe de la plusvalía y el resultado de la operación Exception public REPLYType calculoliquidacion(requesttype fichero, borrar) Método que calcula el importe de una pluvalia requet. Contenido de la plusvalia. REPLYType. Objeto con el resultado del calculo de la plusvalia pagoliquidacion Método pagoliquidacion Método que comprueba el importe de la plusvalía, y realiza el pago, creando la solicitud y dando de alta el expediente asociado. Parámetros REQUESTType Tipo definido en el xsd suministrado desde ANCERT. Contiene los datos de la plusvalía. Mensaje XML de la petición Retorno REPLYType Tipo definido en el xsd suministrado desde ANCERT. Contiene los datos de la respuesta incluyendo el importe de AL SIGM v3 Descripción y código Servicios Web SIGEM 141

142 Exception la plusvalía y el resultado de la operación public REPLYType pagoliquidacion( rutafichero, boolean borrar) Método que comprueba el importe de la plusvalía, y realiza el pago, creando la solicitud y dando de alta el expediente asociado. requet. Contenido de la plusvalía. REPLYType. Objeto con el resultado del pago de la plusvalía AL SIGM v3 Descripción y código Servicios Web SIGEM 142

143 3.19 Servicio Web de Transferencia de Expedientes a Archivo Este servicio proporciona al sistema SIGEM la funcionalidad para la transferencia de Expedientes al archivo. El servicio web se basa en la implementación Axis. El servicio de distribuye dentro de la aplicación web de archivo: SIGEM_ArchivoWeb.war Métodos transferirexpedienteelectronicocondocumentos Método transferirexpedienteelectronicocon Documentos Parámetros codigotramitador nombretramitador int anioexpediente codigoprocedimiento byte[] contenidoxml int verificarunicidad Permite transferir un expediente con sus documentos electrónicos Cadena que contiene el código del sistema tramitador. Cadena que contiene el nombre del sistema tramitador. Entero que contiene el año del expediente Cadena que contiene el código del procedimiento Array de bytes, que contiene el fichero XML de contenido del expediente. La definición del XML se detalla en el anexo 3.1 del Documento SETSI_AL SIGM_Diseño técnico módulo Archivo Entero que contiene el valor del parámetro verificar unicidad. Los valores posibles son: 0 (No verifica) 1 (Por nº de expediente no nulo) 2 (Por nº de expediente + título 3 (Por nº de expediente + título + fecha inicial) 4 (Por nº de expediente + título + fecha inicial + fecha final) usuario Cadena que contiene el identificador del usuario. AL SIGM v3 Descripción y código Servicios Web SIGEM 143

144 password Cadena que contiene el password del usuario. Puede ser texto o estar encriptado en base64. entidad Cadena que contiene el identificador de la entidad. Retorno Boolean Si todo el proceso fue correcto, se devuelve true. Si se produce algún error, devolverá una excepción con el código y texto descriptivo del error. Si se ha producido alguna excepción durante el proceso de transferencia public boolean transferirexpedienteelectronicocondocumentos( codigotramitador, nombretramitador, int anioexpediente, codigoprocedimiento, byte[] contenidoxml, int verificarunicidad, usuario, password, entidad) throws Exception; Excepciones: A continuación se detallan los códigos de errores que puede retornar el servicio web. Error Definición 0000 Error no controlado al realizar la operación 0001 Error al realizar la autenticación del usuario 0002 El usuario no tiene permisos para ejecutar la operación 0003 Tipo de elemento padre es incorrecto 0004 El elemento padre de la serie no está vigente 0005 El elemento padre de la serie no existe 0006 Error con el sistema de estructura organizativa 0007 La operación no está disponible 0008 Error al procesar el fichero de contenido xml 0009 Falta información obligatoria para ejecutar el servicio web AL SIGM v3 Descripción y código Servicios Web SIGEM 144

145 0010 Longitud del campo incorrecta 0011 No existe el productor en el sistema de organización 0012 El campo dato no existe 0013 El campo tabla no existe 0014 El campo fila no existe 0015 Fecha incorrecta 0016 Existe un campo sin valor en el atributo etiqueta 0017 Error al crear el descriptor 0018 El campo binario del documento electrónico no está definido 0019 Error al procesar el fichero binario del documento electrónico 0020 Si el origen de almacenamiento del documento, no es un repositorio, es necesaria la información para almacenarlo en uno 0021 Error al almacenar el fichero en el repositorio 0022 Error al almacenar el fichero en el repositorio 0023 Error en la configuración general. Para más información revisar los ficheros de logs de la aplicación 0024 Error al obtener el identificador documento interno 0025 El repositorio documental no está configurado 0026 No existe el repositorio documental electrónico 0027 El repositorio de almacenamiento del documento no es un ECM válido 0028 No se ha definido el identificador del repositorio donde se almacenarán AL SIGM v3 Descripción y código Servicios Web SIGEM 145

146 el documento 0029 Error al validar la unidad documental en el cuadro 0030 Tipo de Sistema Externo no soportado 0031 No existe ningún órgano externo con ese código 0032 No existe ningún órgano externo con ese identificador 0033 Ya existe una unidad documental en la relación de entrega 0034 Error al obtener el documento origen AL SIGM v3 Descripción y código Servicios Web SIGEM 146

147 3.20 Servicio Web del Cliente Ligero de Intermediación Proporciona el conjunto de servicios de intermediación disponibles para un usuario, en función de su identificador fiscal (NIF) y del código de procedimiento del cliente ligero Métodos consultaprocedimientobynif Método consultaprocedimientobynif Método que recupera los servicios de intermediación que puede usar un usuario en función del código de procedimiento del Cliente Ligero y el Identificador fiscal del usuario Parámetros niffuncionario codigoprocedimiento Identificador fiscal del usuario Código de procedimiento Retorno Servicio[] Conjunto de servicios disponibles public Servicio[] consultaprocedimientobynif ( niffuncionario, codigoprocedimiento) Recupera los servicios de intermediación disponibles para el usuario cuyo identificador fiscal coincida con el pasado como parámetro en niffuncionario. niffuncionario (). Identificador fiscal del usuario. codigoprocedimiento (). Código de procedimiento en el Cliente Ligero que sirve de agrupación de servicios. Datos de los servicios disponibles para el usuario: Servicio. Objeto con la información de un servicio de intermediación. Servicio Clases codcertificado Código del servicio coreemisorcertificado Código del organismo que oferta el servicio descripción Descripción del servicio AL SIGM v3 Descripción y código Servicios Web SIGEM 147

148 3.21 Servicio Web de Catastro Este servicio proporciona al sistema SIGEM la funcionalidad de validar una referencia catastral y consultar las parcelas del catastro. El servicio se despliega como un servicio web independiente. El servicio web se basa en la implementación Axis. El servicio de distribuye como una aplicación web dentro de un archivo war: SIGEM_CatastroWS.war Métodos validarreferenciacatastral Método validarreferenciacastastral Método que ovalida una referencia catastral Parámetros referenciacatastral Referecia catastral a validar Retorno RetornoLogico public RetornoLogico validarrefenciacatastral(retornocadena referenciacatastral) Comprueba si la referencia catastral recibida como parámetro, está dada de alta en el sistema. referenciacatastral (RetornoCadena) Objeto con la cadena de la referencia catastral El resultado de la llamada al servicio web: RetornoLogico. Objeto un valor booleano con el resultado de la validación (true/false): consultarcatastro Método consultarcatastro Método de consulta del catastro para obtener las parcelas asociadas con una referencia catastral Parámetros referenciacatastral Referencia catastral Retorno Parcelas Lista de parcelas del resultado public Parcelas consultarcatastro(retornocadena referenciacatastral) Recupera los datos de las parcelas asociadas con la referencia catastral, que recibe como parámetro. AL SIGM v3 Descripción y código Servicios Web SIGEM 148

149 referenciacatastral (RetornoCadena) Objeto con la cadena de la referencia catastral El resultado de la llamada al servicio web: Parcelas. Objeto con un vector con los objetos Parcela correspondientes a esa referencia catastral. Estos objetos tienen los siguientes campos: dirección (Localizacion): datos de la localización de la parcela. lstbienesinmuebles (BienesInmuebles): Lista de bienes inmuebles de la parcela. refcatastral (): Código de la referencia catastral de esa parcela. superficie (Double): Número de metros cuadrados de superficie, correspondiente a esa parcela superficiecostruida (Double): Número de metros cuadrados de superficie construida, correspondiente a esa parcela Clases Entidad Campo Tipo Descripción Identificador Código de identificación de la entidad RetornoLogico Campo Tipo valor boolean Descripción Valor booleano. RetornoCadena Campo Tipo Descripción cadena Valor de la cadena Parcelas Campo Tipo Descripción parcelas Parcela[] Vector de objetos Parcela Parcela Campo Tipo Descripción direccion Localizacion Datos de la dirección de la parcela AL SIGM v3 Descripción y código Servicios Web SIGEM 149

150 lstbienesinmuebles BienesInmuebles Lista de bienes inmuebles refcatastral Referencia catastral superficie Double superficieconstruida Double Número de metros cuadrados de la superficie de la parcela Número de metros cuadrados de la superficie construida en la parcela Localizacion Campo Tipo Descripción bloque Bloque de la dirección. codigopostal Integer Código postal de la dirección. kilometro Double Número de kilometro nombremunicipio Nombre del municipio. nombreprovincia Nombre de la provincia. nombrevia Nombre de la vía primernumero Integer Primer número de la dirección primeraletra Primera letra de la dirección segundaletra Segundo número de la dirección segundonumero Integer Segunda letra de la dirección BienesInmuebles Campo Tipo Descripción bienesinmuebles BienInmueble[] Vector de objetos BienInmueble AL SIGM v3 Descripción y código Servicios Web SIGEM 150

151 BienInmueble Campo Tipo Descripción clasebieninmueble Clase del bien inmueble claseuso Clase de uso direccionlocalizacion Localizacion Dirección de localización lstconstrucciones Construcciones Lista construcciones lstcultivos Cultivos Lista de cultivos referencia_catastral Referencia catastral superficie Double Metros cuadrados de superficie Construcciones Campo Tipo Descripción construcciones Construccion[] Vector de objetos Construccion Construccion Campo Tipo Descripción codigouso Código del uso escalera Strin Código de escalera identificador Identificador de la construcción planta Planta de la construcción puerta Puerta de la construcción superficietotal Double Numero de metros cuadrados de la superficie total construida. Cultivos Campo Tipo cultivos Cultivo[] Descripción Vector de objeto Cultivo AL SIGM v3 Descripción y código Servicios Web SIGEM 151

152 Cultivo Campo Tipo Descripción calificacion Calificación del cultivo denominacion Denominación del cultivo identificador Identificador del cultivo intensidadproductiva Integer Intensidad productiva del cultivo superficie Double Metros cuadrados de cultivo Todos los objetos extienden del objeto RetornoServicio: RetornoServicio Campo Tipo Descripción errorcode Código de error. returncode Código de retorno. OK: Operación realizada con éxito ERROR: Se ha producido un error en la operación Códigos de error =Error inesperado en la aplicación =Error al validar el número de referencia catastral =Error al consultar el catastro. AL SIGM v3 Descripción y código Servicios Web SIGEM 152

153 3.22 Servicio Web de Gestión de Sesiones de Administración Este servicio proporciona al sistema SIGEM la funcionalidad para la gestión de las sesiones de los usuarios de las aplicaciones de administración El servicio se despliega como un servicio web independiente. El servicio web se basa en la implementación Axis. El servicio de distribuye como una aplicación web dentro de un archivo war: SIGEM_AdministracionSesionesAdmWS.war Métodos nuevasesion Método nuevasesion Método que crea una nueva sesión de administración en el sistema. Parámetros usuario Identificador del usuario tipousuario Tipo del usuario Retorno Identificador de la sesión creada public nuevasesion( usuario,int tipousuario) Realiza el alta de una nueva sesión de administración en el sistema, a partir de los datos recibidos como parámetros. usuario(): Identificador del usuario tipousuario (int): Tipo del usuario. El resultado de la llamada al servicio web:. El identificador de la nueva sesión creada. Null en caso de error nuevasesionentidad Método nuevasesionentidad Método que añade a una clave el identificador de la entidad Parámetros key Clave identidad Identificador de la interfaz Retorno Cadena final con la entidad public nuevasesionentidad( key, identidad) Recupera la clave que recibe como parámetro, tras anexarle el identificador de la entidad que también recibe como parámetro. AL SIGM v3 Descripción y código Servicios Web SIGEM 153

154 key (): Cadena inicial de la clave identidad (): Identificador de la entidad. El resultado de la llamada al servicio web:. El identificador de clave tras anexarle la entidad. Null en caso de error validarsesion Método validarsesion Método que comprueba si una sesión es valida actualmente o no, en todas las entidades. Parámetros key Identificador de la sesión a validar. Retorno boolean El resultado de la validación public boolean validarsesion( key) Realiza la validación de una sesión de la aplicación de administración de entidades, cuyo identificador se pasa como parámetro. key (): Identificador de la sesión a validar. El resultado de la llamada al servicio web: boolean. Un valor booleano (true/false) con el resultado de la validación validarsesionentidad Método validarsesionentidad Método que comprueba si una clave de sesión es valida actualmente en una aplicación. Parámetros key_entidad Clave de sesión con la entidad idaplicacion Identificador de la aplicación Retorno boolean El resultado de la validación public boolean validarsesionentidad( key_entidad, idaplicacion) Comprueba si una clave de sesión es válida actualmente en una aplicación de administración, a partir de los datos que recibe como parámetros key_entidad (): Clave de sesión que incluye el identificador de la entidad idaplicacion: Identificador de la aplicación AL SIGM v3 Descripción y código Servicios Web SIGEM 154

155 El resultado de la llamada al servicio web: boolean. Un valor booleano (true/false) con el resultado de la validación caducarsesion Método caducarsesion Método que caduca una sesión en el sistema. Parámetros key Clave de la sesión a caducar Retorno void public void caducarsesion( key) Realiza las operaciones para caducar la sesión de la aplicación de administración de entidades, identificada por el parámetro que recibe. key (): Clave de la sesión a caducar caducarsesionentidad Método caducarsesionentidad Método que caduca una sesión en el sistema. Parámetros key_entidad Clave de la sesión con la entidad Retorno void public void caducarsesionentidad( key_entidad) Realiza las operaciones para caducar la sesión de una aplicación de administración, identificada por el parámetro que recibe. key_entidad (): Clave de sesión que incluye el identificador de la entidad obtenersesion Método obtenersesion Método que obtiene una sesión a partir de su identificador. Parámetros key Identificador de la sesión Retorno Sesion Datos de la sesión devuelta public Sesion obtenersesion( key) Recupera los datos asociados con una sesión de la aplicación de administración de entidades, partir del identificador de la sesión que recibe como parámetro. AL SIGM v3 Descripción y código Servicios Web SIGEM 155

156 key (): Identificador de la sesión El resultado de la llamada al servicio web: Sesion. Objeto con los datos de la sesión obtenersesionentidad Método obtenersesionentidad Método que obtiene una sesión a partir de su identificador. Parámetros key_entidad Clave de la sesión con la entidad Retorno Sesion Datos de la sesión devuelta public Sesion obtenersesionentidad( key_entidad) Recupera los datos asociados con una sesión de una aplicación de administración, partir del identificador de la sesión que recibe como parámetro. key_entidad (): Clave de sesión que incluye el identificador de la entidad El resultado de la llamada al servicio web: Sesion. Objeto con los datos de la sesión modificardatossesion Método modificardatossesion Método que modifica los datos de una sesión. Parámetros key Identificador de la sesión datosespecificos Nuevos datos específicos para la sesión Retorno boolean Resultado de la operación public boolean modificardatossesion( key, datosespecificos) Modifica los datos de una sesión, a partir de los datos recibidos por parámetro. key (): Identificador de la sesión a modificar datosespecificos (): Nuevos datos específicos El resultado de la llamada al servicio web: boolean. Valor booleano (true/false) con el resultado de la operación. AL SIGM v3 Descripción y código Servicios Web SIGEM 156

157 Clases Sesion Campo Tipo Descripción usuario Usuario de la sesión idsesion Identificador de la sesión identidad Identificador de la entidad datosespecificos Datos específicos en la entidad tipousuario int Tipo de usuario 1 Administrador 2 Interno Códigos de error =Error inesperado. AL SIGM v3 Descripción y código Servicios Web SIGEM 157

158 3.23 Servicio Web de Gestión de Sesiones de Gestión Este servicio proporciona al sistema SIGEM la funcionalidad para la gestión de las sesiones de los usuarios de las aplicaciones de BackOffice. El servicio se despliega como un servicio web independiente. El servicio web se basa en la implementación Axis. El servicio de distribuye como una aplicación web dentro de un archivo war: SIGEM_AdministracionSesionesBackOfficeWS.war Métodos nuevasesion Método nuevasesion Método que crea una nueva sesión de administración en el sistema. Parámetros usuario Identificador del usuario identidad Tipo del usuario Retorno Identificador de la sesión creada public nuevasesion( usuario,int tipousuario) Realiza el alta de una nueva sesión de administración en el sistema, a partir de los datos recibidos como parámetros. usuario(): Identificador del usuario identidad (): Tipo del usuario El resultado de la llamada al servicio web:. El identificador de la nueva sesión creada. Null en caso de error validarsesion Método validarsesion Método que comprueba si una sesión es valida actualmente o no, en todas las entidades. Parámetros key Identificador de la sesion Retorno boolean El resultado de la validación public boolean validarsesion( key) Realiza la validación de una sesión, cuyo identificador se pasa como parámetro. key (): Identificador de la sesión a validar AL SIGM v3 Descripción y código Servicios Web SIGEM 158

159 El resultado de la llamada al servicio web: boolean. Un valor booleano (true/false) con el resultado de la validación caducarsesion Método caducarsesion Método que caduca una sesión en el sistema. Parámetros key Clave de la sesión a caducar Retorno void public void caducarsesion( key) Realiza las operaciones para caducar la sesión, identificada por el parámetro que recibe. key (): Clave de la sesión a caducar obtenersesion Método obtenersesion Método que obtiene una sesión a partir de su identificador. Parámetros key Identificador de la sesión Retorno Sesion Datos de la sesión devuelta public Sesion obtenersesion( key) Recupera los datos asociados con una sesión, partir del identificador de la sesión que recibe como parámetro. key (): Identificador de la sesión El resultado de la llamada al servicio web: Sesion. Objeto con los datos de la sesión. AL SIGM v3 Descripción y código Servicios Web SIGEM 159

160 modificardatossesion Método modificardatossesion Método que modifica los datos de una sesión. Parámetros key Identificador de la sesión datosespecificos Nuevos datos específicos para la sesión Retorno boolean Resultado de la operación public boolean modificardatossesion( key, datosespecificos) Modifica los datos de una sesión, a partir de los datos recibidos por parámetro. key (): Identificador de la sesión a modificar datosespecificos (): Nuevos datos específicos El resultado de la llamada al servicio web: boolean. Valor booleano (true/false) con el resultado de la operación Clases Sesion Campo Tipo Descripción usuario Usuario de la sesión idsesion Identificador de la sesión identidad Identificador de la entidad datosespecificos Datos específicos de la sesión Códigos de error =Error inesperado. AL SIGM v3 Descripción y código Servicios Web SIGEM 160

161 3.24 Servicio Web de Calendario de Trámites Este servicio proporciona al sistema SIGEM la funcionalidad de gestión y consulta de calendarios, junto con sus días laborables. El servicio se despliega como un servicio web independiente. El servicio web se basa en la implementación Axis. El servicio de distribuye como una aplicación web dentro de un archivo war: SIGEM_CalendarioWS.war Métodos obtenercalendario Método obtenercalendario Método que obtiene el calendario correspondiente a una determinada entidad Parámetros entidad Identificador de la entidad Retorno Calendario El calendario correspondiente a esa entidad public Calendario obtenercalendario(entidad entidad) Devuleve el calendario correspondiente a una determinada entidad. entidad(entidad): Objeto con el identificador de la entidad El resultado de la llamada al servicio web: Calendario. Objeto con los datos del calendario actual, para esa entidad nuevocalendario Método nuevocalendario Método para dar de alta un nuevo calendario para una entidad Parámetros calendario Datos del nuevo calendario. Entidad Identificador de la entidad Retorno RetornoServicio Resultado de la operación. public RetornoServicio nuevocalendario(calendario calendario, Entidad entidad) Crea un nuevo calendario en el sistema, a partir de los datos recibidos como parámetros. AL SIGM v3 Descripción y código Servicios Web SIGEM 161

162 calendario (Calendario): Objeto calendario con los datos del nuevo calendario entidad (Entidad): Objeto con el identificador de la entidad, sobre la que se va a dar de alta el nuevo calendario. El resultado de la llamada al servicio web: RetornoServicio. Información del estado de la operación. errorcode: Código del error. 0 si todo fue correcto. returncode: Descripción asociada al error actualizarcalendario Método nuevocalendario Método para modificar el calendario de una entidad Parámetros calendario Datos del nuevo calendario. Entidad Identificador de la entidad Retorno RetornoServicio Resultado de la operación. public RetornoServicio actualizarcalendario(calendario calendario, Entidad entidad) Modifica el calendario de una entidad, a partir de los datos recibidos como parámetros. calendario (Calendario): Objeto calendario con los nuevos datos del calendario entidad (Entidad): Objeto con el identificador de la entidad, cuyo calendario se va a modificar. El resultado de la llamada al servicio web: RetornoServicio. Información del estado de la operación. errorcode: Código del error. 0 si todo fue correcto. returncode: Descripción asociada al error eliminarcalendario Método nuevocalendario Método para eliminar el calendario de una entidad Parámetros borrardias Bandera para indicar si deben de borrar también los días asociados. Entidad Identificador de la entidad Retorno RetornoServicio Resultado de la operación. public RetornoServicio eliminarcalendario(boolean borrardias, Entidad entidad) AL SIGM v3 Descripción y código Servicios Web SIGEM 162

163 Elimina el calendario de una entidad, identificado a partir de los datos recibidos como parámetros. borrardias (boolean): Objeto calendario con los nuevos datos del calendario entidad (Entidad): Objeto con el identificador de la entidad, cuyo calendario se va a eliminar. El resultado de la llamada al servicio web: RetornoServicio. Información del estado de la operación. errorcode: Código del error. 0 si todo fue correcto. returncode: Descripción asociada al error obtenerdiacalendario Método obtenerdiacalendario Método para modificar el calendario de una entidad Parámetros id Identificador del día entidad Identificador de la entidad Retorno CalendarioDia El día que correspondiente a ese identificador public CalendarioDia obtenerdiacalendario( id, Entidad entidad) Devuelve un día del calendario, identificado por los datos recibidos como parámetros. id (): Identificador del día a consultar entidad (Entidad): Objeto con el identificador de la entidad El resultado de la llamada al servicio web: CalendarioDia. Datos correspondientes al día del calendario encontrado nuevodiacalendario Método nuevodiacalendario Método para crear un nuevo día en el calendario de una entidad Parámetros dia datos para crear el nuevo día en el calendario entidad Identificador de la entidad Retorno RetornoServicio Resultado de la operación public RetornoServicio nuevodiacalendario(calendariodia dia, Entidad entidad) AL SIGM v3 Descripción y código Servicios Web SIGEM 163

164 Crea un nuevo días en el calendario de la entidad correspondiente, con los datos recibidos como parámetros. dia (CalendarioDia): Datos del nuevo día del calendario a crear entidad (Entidad): Objeto con el identificador de la entidad, cuyo calendario se va a eliminar. El resultado de la llamada al servicio web: CalendarioDia.Datos correspondientes al día del calendario encontrado actualizardiacalendario Método actualizardiacalendario Método para modificar el calendario de una entidad Parámetros dia datos para modificar el día en el calendario entidad Identificador de la entidad Retorno RetornoServicio Resultado de la operación public CalendarioDia actualizardiacalendario(calendariodia dia, Entidad entidad) Modifica un día en el calendario de la entidad correspondiente, con los datos recibidos como parámetros. dia (CalendarioDia): Datos del día del calendario a modificar entidad (Entidad): Objeto con el identificador de la entidad. El resultado de la llamada al servicio web: RetornoServicio. Información del estado de la operación. errorcode: Código del error. 0 si todo fue correcto. returncode: Descripción asociada al error eliminardiacalendario Método eliminardiacalendario Método para eliminar un día del calendario de una entidad Parámetros id Identificador del día a eliminar entidad Identificador de la entidad Retorno RetornoServicio Resultado de la operación public CalendarioDia eliminardiacalendario( id, Entidad entidad) Elimina un día del calendario de la entidad correspondiente, con los datos recibidos como parámetros. AL SIGM v3 Descripción y código Servicios Web SIGEM 164

165 id (): Identificador del día a eliminar entidad (Entidad): Objeto con el identificador de la entidad. El resultado de la llamada al servicio web: RetornoServicio. Información del estado de la operación. errorcode: Código del error. 0 si todo fue correcto. returncode: Descripción asociada al error obtenerdiascalendario Método eliminardiacalendario Método para obtener un determinado día del calendario de una entidad Parámetros tipo Tipo de los días a obtener del calendario. 0=laborable, 1=no laborable. entidad Identificador de la entidad Retorno CalendarioDias Días que cumplen con los criterios de la búsqueda. public CalendarioDias obtenerdiascalendario(int tipo, Entidad entidad) Recupera los días del calendario de un determinado tipo. tipo (int): Tipo de los días a recuperar entidad (Entidad): Objeto con el identificador de la entidad. El resultado de la llamada al servicio web: CalendarioDias. Vector de objetos CalendarioDia que cumplen los criterios de búsqueda proximolaborable Método proximolaborable Método para obtener el próximo día laborable del calendario de una entidad Parámetros fecha con la fecha a partir del cual buscar el siguiente día laborable. entidad Identificador de la entidad Retorno RetornoCalendario Resultado de la operación public RetornoCalendario proximolaborable( fecha, Entidad entidad) Recupera el siguiente día laborable a partir de una fecha, en el calendario de una entidad. AL SIGM v3 Descripción y código Servicios Web SIGEM 165

166 fecha (): con formato "dd/mm/yy HH:mm:ss", que identifica la fecha a partir de la cual se debe buscar el próximo laborable. entidad (Entidad): Objeto con el identificador de la entidad. El resultado de la llamada al servicio web: RetornoCalendario: Objeto con el resultado de la operación Clases Calendario Campo Tipo Descripción dias [] Vector con las cadenas para días del calendario horainicio Hora de inicio de la jornada laboral minutoinicio Minutos de la hora de inicio de la jornada laboral. horafin Hora de fin de la jornada laboral minutofin Minutos de la hora de fin de la jornada laboral CalendarioDias Campo Tipo Descripción dias CalendarioDia[] Vector con objetos DiaCalendario con los datos de los días del calendario CalendarioDia Campo Tipo Descripción id int Identificador numérico del día fecha Cadena con la descripción Descripción asociada al día fijo boolean Permite especificar si se trata de un día fijo en el calendario o no. AL SIGM v3 Descripción y código Servicios Web SIGEM 166

167 RetornoCalendario Campo Tipo Descripción proximolaborable int Cadena con la fecha con el próximo día laborable laborable boolean Valor booleano para especificar si el día anterior es laborable o no. Todos los objetos extienden del objeto RetornoServicio: RetornoServicio Campo Tipo Descripción errorcode Código de error. returncode Código de retorno. OK: Operación realizada con éxito ERROR: Se ha producido un error en la operación Códigos de error =Error: en la base de datos del catálogo de trámites =Error: Al recuperar el calendario =Error: No hay calendario definido =Error: Al añadir el calendario =Error: Al actualizar el calendario =Error: Al eliminar el calendario =Error: Al recuperar un día del calendario =Error: No hay día del calendario =Error: Al añadir un día al calendario =Error: Al actualizar un día del calendario =Error: Al eliminar un día del calendario =Error: Al recuperar los días del calendario =Error: Al obtener el identificador del día del calendario. AL SIGM v3 Descripción y código Servicios Web SIGEM 167

168 3.25 Servicio Web de Certificación Este servicio proporciona al sistema SIGEM la funcionalidad para la gestión de las certificaciones. El servicio se despliega como un servicio web independiente. El servicio web se basa en la implementación Axis. El servicio de distribuye como una aplicación web dentro de un archivo war: SIGEM_CertificacionWS.war Métodos generarcertificacionpagos Método generarcertificacionpagos Método que genera el PDF correspondiente a un conjunto de operaciones de pago. Parámetros pagos Vecror de pagos a certificar usuario Datos del usuario entidad Identificador de la entidad Retorno RetornoPdf El PDF del resultado de la certificación public RetornoPdf generacertificacionpagos(pago[] pagos,usuario usuario,entidad entidad) Devuleve el PDF con el resultado de la certificación de los pagos y el usuario recibidos correspondiente a una entidad, a partir de los datos recibidos cómo parámetros. pagos (Pago[]): Vector con objetos Pago con los datos de los pagos a certificar usuario (Usuario): Datos de usuario para la operación de certificación. Entidad (Entidad) Objeto con el identificador de la entidad. El resultado de la llamada al servicio web: RetornoPdf. Objeto con el PDF resultado de la operación de certificación altacertificacion Método altacertificacion Método que obtiene el calendario correspondiente a una determinada entidad Parámetros idusuario Identificador del usuario de la certificación. idfichero Identificador del fichero para la certificación. entidad Identificador de la entidad AL SIGM v3 Descripción y código Servicios Web SIGEM 168

169 Retorno RetornoServicio Resultado de la operación public RetornoServicio altacertificacion( idusuario, idfichero,entidad entidad) Realiza el alta de una certificación a partir de los datos recibidos como parámetros. idusuario(): Identificador del usuario para la certificación. idfichero (): Identificador del fichero para la certificación. Entidad (Entidad) Objeto con el identificador de la entidad. El resultado de la llamada al servicio web: RetornoServicio. Información del estado de la operación. errorcode: Código del error. 0 si todo fue correcto. returncode: Descripción asociada al error eliminarcertificacion Método eliminarcertificacion Método que elimina una certificación del sistema Parámetros idfichero Identificador del fichero para la certificación. entidad Identificador de la entidad Retorno RetornoServicio Resultado de la operación public RetornoServicio eliminarcertificacion( idfichero,entidad entidad) Realiza la eliminación de una certificación a partir de los datos recibidos como parámetros. idfichero (): Identificador del fichero de la certificación. Entidad (Entidad) Objeto con el identificador de la entidad. El resultado de la llamada al servicio web: RetornoServicio. Información del estado de la operación. errorcode: Código del error. 0 si todo fue correcto. returncode: Descripción asociada al error. AL SIGM v3 Descripción y código Servicios Web SIGEM 169

170 obtenercertificacion Método obtenercertificacion Método para obtener una certificación ya generada Parámetros idusuario Identificador del usuario para obtener la certificación. idfichero Identificador del fichero para la certificación. entidad Identificador de la entidad Retorno Certificacion Objeto con los datos de la certificación public Certificacion obtenercertificacion( idusuario, idfichero,entidad entidad) Devuelve un objeto Certificación con los datos de la certificación identificada por los datos recibidos cómo parámetros. idusuario(): Identificador del usuario para la certificación. idfichero (): Identificador del fichero de la certificación. Entidad (Entidad) Objeto con el identificador de la entidad. El resultado de la llamada al servicio web: Certificacion.Objeto con los datos de la certificación devuelta por la consulta Clases Pago Campo Tipo Descripción identidademisora Identificador de la entidad que ha emitido la orden de pago. (6 dígitos) idtasa Identificador de la tasa del pago importe Importe del pago nif NIF de la persona que realiza el pago. idioma Idioma del pago. fecha Cadena con la fecha del pago hora Cadena con la hora del pago. AL SIGM v3 Descripción y código Servicios Web SIGEM 170

171 entidadbancaria Identificador de la entidad bancaria mediopago para almacenar el medio de pago. ccc Código de la cuenta bancaria numerotarjetacredito Identificador de la tarjeta de crédito. fechacaducidadtarjetacredito Cadena para la fecha de caducidad de la tarjeta de crédito con formato DDMMyAAAA referencia Numero de referencia para la liquidación domicialización Almacena si se trata de un pago domiciliado. cccdomicilización Sting Número de cuenta bancaria domiciliada. nrc NRC identificadora del pago realizado. estado Estado actual del pago. 00 pendiente 01 pagado tasa Tasa Objeto tasa asociada con el pago. Liquidación Liquidacion Objeto liquidación asociada al pago. ejercicio remesa acreditacion fechadevengo informacionespecifica expediente Cadena con el año del pago, necesario para los pagos con las modalidades 1 y 2 del cuaderno 60 Campo especial utilizado en las modalidades 1 y 2 del cuaderno 60. Campo especial utilizado en la modalidad 3 del cuaderno 60. Campo especial utilizado en la modalidad 3 del cuaderno 60. Campo especial utilizado en la modalidad 3 del cuaderno 60. Identificador del expediente. Campo especial utilizado en la modalidad 3 del cuaderno 60. Liquidacion Campo Tipo Descripción referencia Identificador para la liquidación identidademisora Identificador de la entidad que emitió la orden de pago. AL SIGM v3 Descripción y código Servicios Web SIGEM 171

172 idtasa Identificador de la tasa ejercicio Año en el que se realiza el pago. vencimiento Fecha de vencimiento de la orden de pago. discrimiante Campo discriminante usado por algunos cuadernos remesa Campo especial usado por las modalidades 1 y 2 del cuaderno 60 importe Importe de la liquidación a pagar nif NIF del ciudadano que realiza el pago nrc NRC identificadora del pago realizado. estado Estado actual del pago. 00 pendiente 01 pagado tasa Tasa Objeto con los datos de la tasa asociada con la liquidación nombre Nombre identificativo de la liquidación datosespecificos inicioperiodo finperiodo Solicitud byte[] fechapago Campo especial utilizado en la modalidad 3 del cuaderno 60. Cadena con la fecha en formato DD/MM/AAAA, del inicio del periodo al que pertenece la liquidación Cadena con la fecha en formato DD/MM/AAAA, del fin del periodo al que pertenece la liquidación Vector de bytes con el contenido del XML de la solicitud asociada. Cadena con formato DD/MM/AAAA con la fecha del pago. Tasa Campo Tipo Descripción codigo Código de la tasa identidademisora Identificador de la entidad que emitió la orden de pago. nombre Cadena identificadora del tributo tipo Tipo de la tasa AL1, AL2, AL3 o C57 AL SIGM v3 Descripción y código Servicios Web SIGEM 172

173 modelo datosespecificos Campo especial utilizado en la modalidad 3 del cuaderno 60. Campo especial utilizado en la modalidad 3 del cuaderno 60. RetornoPdf Campo Tipo Descripción contenido byte[] Vector de bytes con el PDF devuelto por la operación de certificación identificador Identificador asociado con la certificación Entidad Campo Tipo Descripción codigo Identificador de la entidad descripcion Descripción asociada a la entidad Usuario Campo Tipo nombre Descripción Nombre del ciudadano apellidos Apellidos del ciudadano nif NIF del ciudadano telefono Teléfono domicilio Dirección localidad Localidad provincia Provincia cp Código postal idioma Idioma natural del ciudadano AL SIGM v3 Descripción y código Servicios Web SIGEM 173

174 Certificaciones Campo Tipo Descripción certificaciones Certificacion[] Vector de objetos Certificacion Certificacion Campo Tipo idusuario Descripción Identificador del usuario idfichero Identificador del fichero de la certificación. Todos los objetos extienden del objeto RetornoServicio: RetornoServicio Campo Tipo Descripción errorcode Código de error. returncode Código de retorno. OK: Operación realizada con éxito ERROR: Se ha producido un error en la operación Códigos de error =Se ha producido un error inesperado =Se ha producido un error en la lectura del fichero de configuración =Se ha producido un error en la lectura del fichero de certificación =Se ha producido un error al generar los datos comunes de la certificación =Se ha encontrado un elemento no reconocido en el fichero de configuración =Se ha producido un error al obtener la posición de un elemento =Se ha producido un error al procesar un valor de los datos de cabecera =Se ha producido un error al procesar un valor de los datos de certificación =Se ha producido un error al procesar un valor de los datos centrales =Se ha producido un error al añadir un valor del fichero de configuración =Se ha producido un error al procesar un valor de los datos de imágenes =Se ha producido un error al firmar el PDF =Se ha producido un error al generar la certificación en formato PDF =Se ha producido un error al insertar la marca de agua de la certificación =Se ha producido un error al crear los datos de cabecera =Se ha producido un error al crear los datos de certificación =Se ha producido un error al crear los datos centrales AL SIGM v3 Descripción y código Servicios Web SIGEM 174

175 =Se ha producido un error al insertar la imagen de cabecera de la certificación =Se ha producido un error al obtener el máximo número de campos de una línea =Se ha producido un error al obtener el número de campos de una línea =Se ha producido un error al obtener el número de líneas =Se ha producido un error al obtener los campos de una línea =Se ha producido un error al intentar ordenar los campos =Se ha producido un error al obtener un valor del XML =Se ha producido un error al obtener valores múltiples del XML =Se ha producido un error al redistribuir las longitudes de las columnas del PDF =Se ha producido un error en la generación del XML =Se ha producido un obtener el certificado de firma del PDF de la entidad =Se ha producido un error al obtener la certificación =Se ha producido un error al obtener las certificaciones del usuario =Se ha producido un error al dar de alta la certificación =Se ha producido un error al eliminar la certificación =Se ha producido un error al almacenar la certificación en base de datos AL SIGM v3 Descripción y código Servicios Web SIGEM 175

176 3.26 Servicio Web de Entidades Este servicio proporciona al sistema SIGEM la funcionalidad para la gestión de las entidades del sistema. El servicio se despliega como un servicio web independiente. El servicio web se basa en la implementación Axis. El servicio de distribuye como una aplicación web dentro de un archivo war: SIGEM_EntidadesWS.war Métodos nuevaentidad Método nuevaentidad Método para dar de alta una nueva entidad en el sistema Parámetros poentidad Objeto con los dato de la entidad Retorno Entidad El objeto pasado originalmente, con el identificador relleno public Entorno nuevaentidad(entidad poentidad) Permite dar de alta una nueva entidad en el sistema. poentidad (Entidad): Objeto con los datos de la entidad a crear El resultado de la llamada al servicio web: Entidad Objeto con el identificador relleno, como resultado correcto de la operación. Null si hubo fallo eliminarentidad Método eliminarentidad Método para eliminar una nueva entidad en el sistema Parámetros poentidad Objeto con los dato de la entidad Retorno RetornoServicio Resultado de la operación public RetornoServicio eliminarentidad(entidad poentidad) Permite dar de alta una nueva entidad en el sistema. poentidad (Entidad): Objeto con los datos de la entidad a crear AL SIGM v3 Descripción y código Servicios Web SIGEM 176

177 El resultado de la llamada al servicio web: RetornoServicio. Información del estado de la operación. errorcode: Código del error. 0 si todo fue correcto. returncode: Descripción asociada al error actualizarentidad Método actualizarentidad Método para actualizar los datos de una entidad Parámetros poentidad Objeto con los dato de la entidad Retorno Entidad El objeto pasado originalmente, con el resultado de la operación public Entidad actualizarentidad(entidad poentidad) Modifica una entidad, de acuerdo a los datos recibidos como parámetro. poentidad (Entidad): Objeto con los nuevos datos de la entidad a modificar El resultado de la llamada al servicio web: Entidad Objeto Entidad con el resultado de la operación obtenerentidad Método obtenerentidad Método para de consulta de una entidad a partir de su identificador Parámetros identificador Cadena con el identificador de la entidad a buscar Retorno Entidad Datos de la entidad buscada devueltos por la consulta public Entidad obtenerentidad( identificador) Recupera los datos de una entidad a partir del identificador de la entidad que recibe como parámetro. identificador (): Cadena con el identificador de la entidad a buscar El resultado de la llamada al servicio web: Entidad Objeto Entidad con el resultado de la operación. AL SIGM v3 Descripción y código Servicios Web SIGEM 177

178 buscarentidades Método buscarentidades Método que devuelve entidades que cumplen unos determinados criterios Parámetros pocriterios Criterios que deben cumplir los resultados de la consulta Retorno Entidades Vector de las entidades devueltas por la consulta public Entidades buscarentidades(criteriobusquedaentidades pocriterio) Recupera los datos de las entidades que cumplen con unos criterios que recibe como parámetro. pocriterios (CriterioBusquedaEntidades): Objeto con los criterios de la búsqueda a realizar El resultado de la llamada al servicio web: Entidades Objeto con el vector de objetos Entidad con los datos de las entidades devueltos por la consulta obtenerentidades Método obtenerentidades Método que devuelve los datos de todas las entidades del sistema Retorno Entidades Vector con las entidades en el sistema public Entidades obtenerentidades() Recupera los datos de todas las entidades registradas en el sistema. El resultado de la llamada al servicio web: Entidades Objeto con el vector de objetos Entidad con los datos de todas las entidades del sistema obteneridentificadorentidad Método obteneridentificadorentidad Método que obtiene el identificador de la nueva entidad Retorno RetornoCadena Identificador de la nueva entidad public RetornoCadena obteneridentificadorentidad() AL SIGM v3 Descripción y código Servicios Web SIGEM 178

179 Recupera el identificador asignado por el sistema para la siguiente entidad a crear. El resultado de la llamada al servicio web: RetornoCadena Objeto con la cadena con el identificador devuelto como resultados de la operación Clases Entidad Campo Tipo Descripción identificador Identificador de la entidad nombrecorto Nombre corto de la entidad nombrelargo Descripción de la entidad codigoine Código INE asociado con la entidad CriterioBusquedaEntidades Campo Tipo Descripción nombrecorto Nombre corto de la entidad a buscar nombrelargo Nombre largo de la entidad a buscar Entidades Campo Tipo entidades Entidad[] Descripción Vector de objetos Entidad RetornoCadena Campo Tipo valor Descripción Valor de la cadena devuelta AL SIGM v3 Descripción y código Servicios Web SIGEM 179

180 Todos los objetos extienden del objeto RetornoServicio: RetornoServicio Campo Tipo Descripción errorcode Código de error. returncode Código de retorno. OK: Operación realizada con éxito ERROR: Se ha producido un error en la operación Códigos de error =Error inesperado en módulo de entidades =Error entidad no encontrada =Error en alta de entidad =Error cerrando conexión a base de datos =Error elimando entidad =Error actualizando entidad =Error parámetros incorrectos AL SIGM v3 Descripción y código Servicios Web SIGEM 180

181 3.27 Servicio Web de Estructura Organizativa Este servicio proporciona al sistema SIGEM la funcionalidad para la gestión de la estructura organizativa. El servicio se despliega como un servicio web independiente. El servicio web se basa en la implementación Axis. El servicio de distribuye como una aplicación web dentro de un archivo war: SIGEM_EstructuraOrganizativaWS.war Métodos getusuariosdepartamento Método getusuariosdepartamento Método para obtener los usuarios pertenecientes a un departamento Parámetros iddept Identificador del departamento entidad Identificador de la entidad Retorno Usuarios El objeto pasado originalmente, con el identificador relleno public Usuarios getusuariosdepartamento (int iddept, entidad) Recupera los usuarios de un determinado departamento identificado por los datos recibidos como parámetros. iddept (int): Identificador numérico del departamento entidad (): Identificador de la entidad El resultado de la llamada al servicio web: Usuarios Objeto con un vector con los usuarios devueltos por la consulta getusuarioporid Método getusuarioporid Método para obtener los datos de un usuario a partir de su id Parámetros iduser Identificador del usuario entidad Identificador de la entidad Retorno Usuario Datos del usuario devuelto por la operación public Usuario getusuarioporid (int iduser, entidad) AL SIGM v3 Descripción y código Servicios Web SIGEM 181

182 Recupera los datos de un usuario identificado por los identificadores que recibe como parámetro. iduser (int): Identificador numérico del usuario entidad (): Identificador de la entidad El resultado de la llamada al servicio web: Usuario Objeto con los datos del usuario devuelto por la consulta getusuariopornombre Método getusuariopornombre Método para obtener los datos de un usuario a partir de un nombre de usuario Parámetros nameuser Nombre del usuario entidad Identificador de la entidad Retorno Usuario Datos del usuario devuelto por la operación public Usuario getusuariopornombre( nameuser, entidad) Recupera los datos de un usuario identificado por el nombre, recibido como parámetro. nameuser (): Nombre del usuario entidad (): Identificador de la entidad El resultado de la llamada al servicio web: Usuario Objeto con los datos del usuario devuelto por la consulta getusuarioporidcertificado Método getusuariopornombre Método para obtener los datos de un usuario a partir del identificador asociado a su certificado. Parámetros idcert Identificador del certificado entidad Identificador de la entidad Retorno Usuario Datos del usuario devuelto por la operación public Usuario getusuarioporidcertificado( idcert, entidad) Recupera los datos de un usuario partir del identificador el certificado asociado. AL SIGM v3 Descripción y código Servicios Web SIGEM 182

183 idcert (): Identificador del certificado entidad (): Identificador de la entidad El resultado de la llamada al servicio web: Usuario Objeto con los datos del usuario devuelto por la consulta getusuariosaplicacion Método getusuariosaplicacion Método para obtener los datos de los usuarios asociados con una aplicación en concreto. Parámetros aplicacion Identificador de la aplicación sinpermisos Indica si se deben devolver usuarios sin permisos usuarios Indica si deben devolverse usuarios normales superusuarios Indica si deben devolverse usuarios administradores entidad Identificador de la entidad Retorno Usuarios Vector de usuarios devuelto por la operación public Usuarios getusuariosaplicacion(int aplicación,boolean sinpermisos, boolean usuarios, boolean superusuarios, entidad) Recupera los datos de los usuarios de una determinada aplicación, teniendo en cuenta una seria de banderas adicionales también recibidas por parámetro para configurar el tipo de los usuarios a devolver. aplicación (int): Identificador de la aplicación sinpermisos (boolean): Valor booleano para indicar si la respuesta debe incluir usuarios sin permisos usuarios (boolean): Valor booleano para indicar si la respuesta debe incluir usuarios normales superusuarios (boolean): Valor booleano para indicar si la respuesta debe incluir usuarios administradores entidad (): Identificador de la entidad El resultado de la llamada al servicio web: Usuarios Objeto con un vector con los usuarios devueltos por la consulta. AL SIGM v3 Descripción y código Servicios Web SIGEM 183

184 getusuariosgrupo Método getusuariosgrupo Método para obtener los datos de los usuarios pertenecientes a un grupo. Parámetros idgrupo Identificador del grupo entidad Identificador de la entidad Retorno Usuarios Vector de usuarios devuelto por la operación public Usuarios getusuariosgrupo(int idgrupo, entidad) Recupera los datos de los usuarios pertenecientes a un determinado grupo. idgrupo (int): Identificador numérico del grupo entidad (): Identificador de la entidad El resultado de la llamada al servicio web: Usuarios Objeto con un vector con los usuarios devueltos por la consulta getdepartamentosporpadre Método getdepartamentosporpadre Método para obtener los datos de los departamentos de otro departamento padre. Parámetros iddeptpadre Identificador del departamento padre entidad Identificador de la entidad Retorno Departamentos Vector de departamentos devuelto por la operación public Departamentos getdepartamentosporpadre(int iddeptpadre, entidad) Recupera los datos de los departamentos pertenecientes a un determinado departamento padre. iddeptpadre (int): Identificador del departamento padre entidad (): Identificador de la entidad El resultado de la llamada al servicio web: Departamentos Objeto con un vector con los departamentos devueltos por la consulta. AL SIGM v3 Descripción y código Servicios Web SIGEM 184

185 getgrupos Método getgrupos Método para obtener los datos de los grupos de una entidad. Parámetros entidad Identificador de la entidad Retorno Grupos Vector de grupos devuelto por la operación public Grupos getgrupos( entidad) Recupera los datos de los grupos pertenecientes a la entidad recida por parámetro. entidad (): Identificador de la entidad El resultado de la llamada al servicio web: Grupos Objeto con un vector con los grupos devueltos por la consulta getdepartamentos Método getdepartamentos Método para obtener los datos de los departamentos de una entidad. Parámetros entidad Identificador de la entidad Retorno Departamentos Lista de grupos devuelto por la operación public Grupos getgrupos( entidad) Recupera los datos de los departamentos pertenecientes a la entidad recida por parámetro. entidad (): Identificador de la entidad El resultado de la llamada al servicio web: Departamentos Objeto con los departamentos devueltos por la consulta. AL SIGM v3 Descripción y código Servicios Web SIGEM 185

186 getgrupo Método getgrupo Método para obtener los datos de un grupo de una entidad. Parámetros idgrupo Identificador del grupo entidad Identificador de la entidad Retorno Grupo Datos del grupo devuelto por la operación public Grupo getgrupo(int idgrupo, entidad) Recupera los datos del grupo perteneciente a una entidad, a partir del identificador también recibido como parámetro. idgrupo (int): Identificador numérico del grupo a devolver. entidad (): Identificador de la entidad El resultado de la llamada al servicio web: Grupo Objeto con los datos del grupo devuelto por la consulta getdepartamento Método getdepartamento Método para obtener los datos de un departamento de una entidad. Parámetros iddepto Identificador del departamento entidad Identificador de la entidad Retorno Grupo Datos del departamento devuelto por la operación public Grupo getdepartamento(int iddepto, entidad) Recupera los datos del departamento perteneciente a una entidad, a partir del identificador también recibido como parámetro. iddepto (int): Identificador numérico del departamento a devolver. entidad (): Identificador de la entidad El resultado de la llamada al servicio web: Departamento Objeto con los datos del departamento devuelto por la consulta. AL SIGM v3 Descripción y código Servicios Web SIGEM 186

187 creararchivador Método creararchivador Método para obtener los datos de un departamento de una entidad. Parámetros archive Datos del archivador a crear entidad Identificador de la entidad Retorno RetornoEntero Identificador del archivo creado public RetornoEntero creararchivador(archive archive, entidad) Crea en la entidad correspondiente, un nuevo archivador, a partir de los datos recibidos como parámetros. archive (Archive): Objeto con los datos del archivador a crear. entidad (): Identificador de la entidad El resultado de la llamada al servicio web: RetornoEntero Identificador numérico del archivador creado creararchivador Método creararchivador Método para obtener los datos de un departamento de una entidad. Parámetros archive Datos del archivador a crear entidad Identificador de la entidad Retorno RetornoEntero Identificador del archivo creado public RetornoEntero creararchivador(archive archive, entidad) Crea en la entidad correspondiente, un nuevo archivador, a partir de los datos recibidos como parámetros. archive (Archive): Objeto con los datos del archivador a crear. entidad (): Identificador de la entidad El resultado de la llamada al servicio web: RetornoEntero Identificador numérico del archivador creado. AL SIGM v3 Descripción y código Servicios Web SIGEM 187

188 editardepartamentocompleto Método editardepartamentocompleto Método para editar los datos de un departamento. Parámetros departamento Nuevos datos para el departamento a modificar entidad Identificador de la entidad Retorno RetornoServicio Resultado de la operación public RetornoServicio editardepartamentocompleto(departamento departamento, entidad) Modifica un departamento con los datos recibidos como parámetros. departamento (Departamento): Objeto con los datos del departamento a modificar. entidad (): Identificador de la entidad El resultado de la llamada al servicio web: RetornoServicio: Objeto con el resultado de la operación editarusuario Método editarusuario Método para editar los datos de un usuario. Parámetros usuario Nuevos datos para el usuario a modificar entidad Identificador de la entidad Retorno RetornoServicio Resultado de la operación public RetornoServicio editarusuario(usuario usuario, entidad) Modifica un usuario con los datos recibidos como parámetros. usuario (Usuario): Objeto con los datos del usuario a modificar. entidad (): Identificador de la entidad El resultado de la llamada al servicio web: RetornoServicio: Objeto con el resultado de la operación. AL SIGM v3 Descripción y código Servicios Web SIGEM 188

189 eliminararchivador Método eliminararchivador Método para eliminar un archivador del sistema. Parámetros userid Identificador del usuario archiveid Identificador del archivo a eliminar entidad Identificador de la entidad Retorno RetornoServicio Resultado de la operación public RetornoServicio eliminararchivador(int userid,int archiveid, entidad) Elimina un archivador del sistema identificado por los datos recibidos por parámetro. userid (int): Identificador numérico del usuario que realiza la eliminación archiveid (int): Identificador numérico del archivador a eliminar. entidad (): Identificador de la entidad El resultado de la llamada al servicio web: RetornoServicio: Objeto con el resultado de la operación getlistas Método getlistas Método para obtener todas las listas de una entidad. Parámetros entidad Identificador de la entidad Retorno Listas Listas devueltas por la operación public Listas getlistas( entidad) Recupera las listas pertenecientes a una determinada entidad, que recibe por parámetro. entidad (): Identificador de la entidad El resultado de la llamada al servicio web: Listas: Objeto con las listas devueltas por la operación. AL SIGM v3 Descripción y código Servicios Web SIGEM 189

190 getusuarios Método getusuarios Método para obtener los usuarios de acuerdo a unos determinados criterioros. Parámetros aplicación Identificador de la aplicación idsuser Vector de enteros con los identificadores de los usuarios a recuperar superusers Bandera para indicar si deben incluirse los usuarios administradores entidad Identificador de la entidad Retorno Usuarios Lista con los usuarios devueltos por la operación public Usuarios getusuarios(int aplicación,int idsuser[],boolean superusers, entidad) Recupera el listado de los usuarios que cumplen con los criterios que recibe como parámetros. Aplicación (int): Identificador numérico de la aplicación a la que pertenecen los usuarios a recuperar idsuser (int): Vector de identificadores de los usuarios a recuperar superusers (boolean): Bandera para indicar si deben incluirse los usuarios administradores entidad (): Identificador de la entidad El resultado de la llamada al servicio web: Usuarios: Objeto con la lista de usuarios devueltos por la operación getusuariosasociation Método getusuariosasociation Método para obtener los usuarios asociados con una determinada aplicación y departamento. Parámetros aplicación Identificador de la aplicación deptid Identificador del departamento al que pertenecen los usuarios superusers Bandera para indicar si deben incluirse los usuarios administradores entidad Identificador de la entidad Retorno Usuarios Lista con los usuarios devueltos por la operación public Usuarios getusuariosasociation(int aplicación,int deptid,boolean superusers, entidad) AL SIGM v3 Descripción y código Servicios Web SIGEM 190

191 Recupera el listado de los usuarios asociados con un determinado departamento, identificado por los datos recibidos por parámetros. aplicación (int): Identificador numérico de la aplicación a la que pertenecen los usuarios a recuperar deptoid (int): Identificador del departamento de los usuarios a recuperar superusers (boolean): Bandera para indicar si deben incluirse los usuarios administradores entidad (): Identificador de la entidad El resultado de la llamada al servicio web: Usuarios: Objeto con la lista de usuarios devueltos por la operación getusuariosyaasociados Método getusuariosyaasociation Método para obtener los usuarios asociados con una oficina. Parámetros idsuser Identificadores de los usuarios a recuperar idofic Identificador de la oficina entidad Identificador de la entidad Retorno Usuarios Lista con los usuarios devueltos por la operación public Usuarios getusuariosyaasociados(int idsuser[],int idofic, entidad) Recupera el listado de los usuarios asociados con una oficina, que cumplen con unos criterios que también recibe como parámetros. idsuser (int[]): Identificadores numéricos de los usuarios a recuperar idofic (int): Identificador de la oficina de los usuarios a recuperar entidad (): Identificador de la entidad El resultado de la llamada al servicio web: Usuarios: Objeto con la lista de usuarios devueltos por la operación. AL SIGM v3 Descripción y código Servicios Web SIGEM 191

192 getusuariosaplicacionpordepartamento Método Parámetros aplicacion deptid sinpermisos getusuariosaplicacionpordepartam ento users superusuarios Método para obtener los usuarios que pertenecen a unos departamentos, en una determinada aplicación Identificador de la aplicación Identificadores de los departamentos Indica si deben devolverse usuarios sin permisos Indica si deben devolverse usuarios normales Indica si deben devolverse usuarios administradores Identificador de la entidad entidad Retorno Usuarios Lista con los usuarios devueltos por la operación public Usuarios getusuariosaplicacionpordepartamento(int aplicación,int deptid[], boolean sinpermisos, boolean users, boolean superusuarios, entidad) Recupera el listado de los usuarios de una aplicación, que pertenezcan a una determinada aplicación, a partir de los criterios que recibe como parámetros. Aplicación (int): Identificador numérico de la aplicación deptid (int[]): Identificadores numéricos de los departamentos de los usuarios a recuperar sinpermisos (boolean): Permite indicar si la respuesta debe incluir usuarios sin permisos users (boolean): Permite indicar si la respuesta debe incluir usuarios normales superusuarios (boolean): Permite indicar si la respuesta debe incluir usuarios administradores entidad (): Identificador de la entidad El resultado de la llamada al servicio web: Usuarios: Objeto con la lista de usuarios devueltos por la operación creargrupoldap Método creargrupoldap Método para crear un grupo LDAP en el sistema Parámetros ldapguid Identificador de la aplicación ldapdn Identificadores de los departamentos type Tipo del grupo LDAP entidad Identificador de la entidad Retorno GrupoLdap Objeto con el grupo LDAP devuelto por la operación AL SIGM v3 Descripción y código Servicios Web SIGEM 192

193 public GrupoLdap creargrupoldap( ldapguid, ldpadn, int type, entidad) Realiza el alta de un grupo LDAP en el sistema a partir de los datos que recibe como parámetros. ldapguid (): Guid del grupo LDAP a crear ldapdn (): Dn del grupo a crear en LDAP type (int): Tipo del grupo LDAP entidad (): Identificador de la entidad El resultado de la llamada al servicio web: GrupoLdap: Objeto con los datos del grupo LDAP devuelto por la operación getgrupoldap Método getgrupoldap Método para obtener un grupo LDAP a partir de su Guid. Parámetros ldapguid Guid del grupo LDAP entidad Identificador de la entidad Retorno GrupoLdap Objeto con el grupo LDAP devuelto por la operación public GrupoLdap getgrupoldap( ldapguid, entidad) Recupera los datos del grupo LDAP identificado a partir del Guid recibido como parámetros. ldapguid (): Guid del grupo LDAP a recuperar. entidad (): Identificador de la entidad. El resultado de la llamada al servicio web: GrupoLdap: Objeto con los datos del grupo LDAP devuelto por la operación crearusuarioldap Método crearusuarioldap Método para crear un nuevo usuarioldap Parámetros ldapguid Guid del usuario LDAP name Nombre del usuario idperfil Identificador del perfil entidad Identificador de la entidad Retorno UsuarioLdap Objeto con el usuario LDAP devuelto por la operación AL SIGM v3 Descripción y código Servicios Web SIGEM 193

194 public UsuarioLdap crearusuarioldap( ldapguid, name,int idperfil, entidad) Realiza el alta de un usuario LDAP en el sistema a partir de los datos recibidos como parámetros. ldapguid (): Guid del grupo LDAP a recuperar. entidad (): Identificador de la entidad. El resultado de la llamada al servicio web: GrupoLdap: Objeto con los datos del grupo LDAP devuelto por la operación getusuarioldapbyguid Método getusuarioldapbyguid Método para obtener los datos del usuario LDAP identificado por un Guid Parámetros ldapguid Guid del usuario LDAP entidad Identificador de la entidad Retorno UsuarioLdap Objeto con el usuario LDAP devuelto por la operación public UsuarioLdap getusuarioldapbyguid( ldapguid, entidad) Recupera los datos de un usuario LDAP, identificado por el Guid recibido como parámetro. ldapguid (): Guid del usuario LDAP a recuperar. entidad (): Identificador de la entidad. El resultado de la llamada al servicio web: UsuarioLdap: Objeto con los datos del usuario LDAP devuelto por la operación getusuarioldapbyfullname Método getusuarioldapbyguid Método para obtener los datos del usuario LDAP identificado por el nombre completo. Parámetros fullname Nombre completo del usario entidad Identificador de la entidad Retorno UsuarioLdap Objeto con el usuario LDAP devuelto por la operación public UsuarioLdap getusuarioldapbyfullname( fullname, entidad) AL SIGM v3 Descripción y código Servicios Web SIGEM 194

195 Recupera los datos de un usuario LDAP, identificado por el nombre completo recibido como parámetro. fullname (): Nombre completo del usuario LDAP a recuperar. entidad (): Identificador de la entidad. El resultado de la llamada al servicio web: UsuarioLdap: Objeto con los datos del usuario LDAP devuelto por la operación getusuarioldapporidcertificado Método getusuarioldapporidcertificado Método para obtener los datos del usuario LDAP identificado por el nombre completo. Parámetros idcert Identificador del certificado. entidad Identificador de la entidad Retorno UsuarioLdap Objeto con el usuario LDAP devuelto por la operación public UsuarioLdap getusuarioldapporidcertificado( idcert, entidad) Recupera los datos de un usuario LDAP, identificado por el identificador del certificado recibido como parámetro. idcert (): Identificador del certificado del usuario LDAP a recuperar. entidad (): Identificador de la entidad. El resultado de la llamada al servicio web: UsuarioLdap: Objeto con los datos del usuario LDAP devuelto por la operación getusuariosldap Método getusuariosldap Método para obtener los datos de todos los usuarios LDAP de una entidad. Parámetros entidad Identificador de la entidad Retorno UsuariosLdap Lista de usuarios LDAP devueltos por la operación public UsuariosLdap getusuariosldap( entidad) AL SIGM v3 Descripción y código Servicios Web SIGEM 195

196 Recupera los datos de todos los usuarios LDAP, pertenecientes a la entidad recibida como parámetro. entidad (): Identificador de la entidad. El resultado de la llamada al servicio web: UsuariosLdap: Objeto con los datos de los usuarios LDAP devueltos por la operación getusuarioldap Método getusuarioldap Método para obtener los datos de un usuario LDAP identificador por su id. Parámetros id Identificador del usuario LDAP a recuperar entidad Identificador de la entidad Retorno UsuarioLdap Datos del usuario LDAP devuelto por la operación public UsuarioLdap getusuarioldap( id, entidad) Recupera los datos del usuario LDAP, identificado por el identificador del usuario LDAP recibido como parámetro. id (): Identificador del usuario LDAP a recuperar. entidad (): Identificador de la entidad. El resultado de la llamada al servicio web: UsuarioLdap: Objeto con los datos del usuario LDAP devuelto por la operación getusuariosldapyaasociados Método getusuariosldapyaasociados Método para obtener los datos de los usuarios LDAP de una entidad, asociados con una oficina. Parámetros idsuser Identificadores de los usuarios LDAP a recuperar idofic Identificador de la oficina entidad Identificador de la entidad Retorno UsuariosLdap Objeto con los datos de los usuario LDAP devuelto por la operación public UsuariosLdap getusuariosldapyaasociados(int[] idsuser,int idofic, entidad) AL SIGM v3 Descripción y código Servicios Web SIGEM 196

197 Recupera los datos de los usuarios LDAP, pertenecientes a una oficina, según los datos recibidos como parámetros. idsuser (int[]): Identificadores numéricos de los usuario LDAP a recuperar. idofic (int): Identificador de la oficina entidad (): Identificador de la entidad. El resultado de la llamada al servicio web: UsuariosLdap: Objeto con datos de los usuarios LDAP devueltos por la operación editarusuarioldap Método editorusuarioldap Método para modificar los datos de un usuario LDAP. Parámetros usuarioldap Nuevos datos para el usuario LDAP a modificar entidad Identificador de la entidad Retorno RetornoServicio Objeto con la respuesta devuelta por la operación public RetornoServicio editarusuarioldap(usuarioldap usuarioldap, entidad) Modifica los datos de un usuario LDAP, a partir de los datos recibidos como parámetros. usuarioldap (UsuarioLdap): Objeto con los nuevos datos para el usuario LDAP a modificar. entidad (): Identificador de la entidad. El resultado de la llamada al servicio web: RetornoServicio: Objeto con resultado devuelto por la operación eliminarusuarioldap Método eliminarusuarioldap Método para eliminar un usuario LDAP del sistema. Parámetros id Identificador del usuario LDAP a eliminar entidad Identificador de la entidad Retorno RetornoServicio Objeto con la respuesta devuelta por la operación AL SIGM v3 Descripción y código Servicios Web SIGEM 197

198 public RetornoServicio eliminarusuarioldap(int id, entidad) Elimina un usuario LDAP del sistema, identificado por el identificador y la entidad recibidos como parámetros. id (int): Identificador numérico del usuario LDAP a eliminar. entidad (): Identificador de la entidad. El resultado de la llamada al servicio web: RetornoServicio: Objeto con resultado devuelto por la operación getusuarioldapbasicbyid Método getusuarioldapbasicbyid Método para obtener un usuario LDAP básico del sistema. Parámetros id Identificador del usuario LDAP entidad Identificador de la entidad Retorno RetornoCadema Objeto con la respuesta devuelta por la operación public RetornoCadena getusuarioldapbasicbyid(int id, entidad) Recupera de un usuario LDAP básico del sistema, identificado por el identificador y la entidad recibidos como parámetros. id (int): Identificador numérico del usuario LDAP. entidad (): Identificador de la entidad. El resultado de la llamada al servicio web: RetornoCadena: Objeto con resultado devuelto por la operación getdepartamentolite Método getdepartamentolite Método para obtener los datos de un departamento. Parámetros arg0 Identificador del departamento arg1 Identificador de la entidad Retorno Departamento Objeto con los datos del departamento devuelto por la operación public Departamento getdepartamentolite(int arg0, arg1) Recupera los datos de un departamento, identificado por un identificador y la entidad recibidos como parámetros. AL SIGM v3 Descripción y código Servicios Web SIGEM 198

199 arg0 (int): Identificador numérico del departamento. arg1 (): Identificador de la entidad. El resultado de la llamada al servicio web: Departamento: Objeto con los datos del departamento devuelto por la operación getgrupoldapbyid Método getgrupoldapbyid Método para obtener los datos de un grupo LDAP identificado por su identificador. Parámetros arg0 Identificador del grupo LDAP arg1 Identificador de la entidad Retorno GrupoLdap Objeto con los datos del grupo LDAP devuelto por la operación public GrupoLdap getgrupoldapbyid(int arg0, arg1) Recupera los datos de un grupo LDAP, identificado por un identificador y la entidad recibidos como parámetros. arg0 (int): Identificador numérico del grupo LDAP. arg1 (): Identificador de la entidad. El resultado de la llamada al servicio web: GrupoLdap: Objeto con los datos del grupo LDAP devuelto por la operación getusuariosldapaplicacion Método getusuariosldapaplicacion Método para obtener los datos de los usuarios LDAP pertenecientes a una determinada aplicación. Parámetros aplicacion Identificador de la aplicación. idsuser Identificadores de los usuarios a recuperar. superusers Bandera para determinar si deben incluirse en el resultado usuarios administradores entidad Identificador de la entidad Retorno UsuariosLdap Objeto con los datos del grupo LDAP devuelto por la operación AL SIGM v3 Descripción y código Servicios Web SIGEM 199

200 public UsuariosLdap getusuariosldapaplicacion(int aplicacion, int idsuser[], boolean superusers, entidad) Recupera los datos de los usuarios LDAP, pertenecientes a una determinada aplicación, identificados por los datos recibidos como parámetros. aplicación (int): Identificador numérico de la aplicación a la que pertenecen los usuarios a devolver. idsuser (int[]): Vector de identificadores de los usuarios a devolver. superusers (booelan): Bandera para determinar si deben devolverse usuarios administradores entidad (): Identificador de la entidad. El resultado de la llamada al servicio web: UsuariosLdap: Objeto con los usuarios LDAP devueltos por la operación getusuariosldapaplicacionpordepartamento Método Parámetros aplicacion deptid getusuariosldapaplicacionpordepa rtamento sinpermisos usuarios superusuarios Método para obtener los datos de los usuarios LDAP pertenecientes a una aplicación y departamentos determinados. Identificador de la aplicación. Identificadores de los departamentos de los usuarios a recuperar. Indica si se deben devolver usuarios sin permisos Indica si se deben devolver usuarios normales Indica si se deben devolver usuarios administradores Identificador de la entidad entidad Retorno UsuariosLdap Objeto con los datos de los usuarios LDAP devueltos por la operación public UsuariosLdap getusuariosldapaplicacionpordepartamento(int aplicacion, int[] deptid, boolean sinpermisos, boolean usuarios, boolean superusers, entidad) Recupera los datos de los usuarios LDAP, pertenecientes a una determinada aplicación y departamentos, identificados por los datos recibidos como parámetros. aplicación (int): Identificador numérico de la aplicación a la que pertenecen los usuarios a devolver. deptid (int[]): Vector de identificadores de los departamentos de los usuarios a devolver. sinpermisos (boolean): Permite indicar si la respuesta, debe incluir usuarios sin permisos AL SIGM v3 Descripción y código Servicios Web SIGEM 200

201 usuarios (boolean): Permite indicar si la respuesta, debe incluir usuarios normales superusers (boolean): Permite indicar si la respuesta, debe incluir usuarios administradores entidad (): Identificador de la entidad. El resultado de la llamada al servicio web: UsuariosLdap: Objeto con los usuarios LDAP devueltos por la operación Clases Usuarios Campo Tipo usuarios Usuario[] Descripción Vector de objetos Usuario Usuario Campo Tipo Descripción userconnected int _id int Identificador de usuario conectado a la aplicación de Estructura organizativa que está realizando la consulta o modificación de los datos del usuario. Identificador numérico del usuario sobre el que se está realizando operaciones de consulta ó modificación de sus datos. _name Nombre del usuario _password Contraseña del usuario oldpassword Contraseña anterior _ischange boolean Indica si hay alguna modificación en los datos _pwdmbc Especifica si la contraseña debe cambiarse (Y\N) _pwdvpcheck Especifica si se debe validad la caducidad de la contraseña (Y\N) _description Descripción del usuario _deptid int Identificador numérico del departamento _state Int Estado del usuario _profilesimpl PerfilesGenericos Lista de perfiles asociados al usuario AL SIGM v3 Descripción y código Servicios Web SIGEM 201

202 _permsimpl PermisosGenericos Lista de permisos _wasadmin boolean Indica si el usuario ha sido administrador _creatorid int Identificador del usuario creador _creationdate Date Fecha de creación _updaterid int Identificador del usuario que realizó la última modificación _updatedate Date _pwdlastupdts long Fecha de la última modificación Milisegundos desde el último cambio de la contraseña _pwdminlen int Longitud mínima de la contraseña PerfilesGenericos Campo Tipo Descripción perfilesusuario PerfilesUsuario Objeto con la lista de perfiles del usuario PerfilesUsuario Campo Tipo Descripción perfilesusuario PerfilUsuario[] Vector de objetos PerfilesUsuario PerfilUsuario Campo Tipo _userid int Descripción Identificador numérico del usuario _product int Identificador numérico de la aplicación _profile int Identificador numérico del perfil PermisosGenericos Campo Tipo permisos Permisos Descripción Objeto con la lista de los permisos AL SIGM v3 Descripción y código Servicios Web SIGEM 202

203 Permisos Campo Tipo permisos Permiso[] Descripción Vector de objetos Permiso Permiso Campo Tipo Descripción _id int Identificador numérico del destinatario del permiso _dest int _product int _perm int Tipo de destinatario del permiso: usuario(1), departamento(2), grupo(3) Identificador numérico de la aplicación sobre la que se aplica el permiso Identificador numérico del permiso: ninguno(0), consulta(1), modificación(2), creación(4), eliminación(8), impresión(16), todos(31) Departamentos Campo Tipo Descripción departamentoslista DepartamentosLista Lista de departamentos DepartamentosLista Campo Tipo Descripción departamentos Departamento[] Vector de objetos Departamento Departamento Campo Tipo Descripción _userconnected int Identificador de usuario conectado a la aplicación de Estructura organizativa que está realizando la consulta ó modificación de los datos del departamento _id int Identificador numérico del departamento _name Nombre del departamento _parentid int Identificador numérico del departamento padre _managerid int Identificador del usuario que es administrador del departamento _type int Tipo del departamento AL SIGM v3 Descripción y código Servicios Web SIGEM 203

204 _description Descripción del departamento _creatorid int Identificador del usuario creador del departamento _creationdate Date Fecha de creación _updaterid int Identificador del usuario que realizó la última modificación _updatedate Date Fecha de actualización _permsimpl PermisosGenericos Lista de permisos del departamento _users Usuarios Lista de usuarios _adminusers UsuariosBasicos Lista de administradores UsuariosBasicos Campo Tipo Descripción usuariosbasicos UsuarioBasico[] Vector de objetos UsuarioBasico UsuariosBasico Campo Tipo _name Descripción Nombre del usuario _id int Identificador numérico del usuario. Grupos Campo Tipo gruposlista GruposLista Descripción Lista para los grupos GruposLista Campo Tipo gruposs Grupo[] Descripción Vector de objetos Grupo Grupo Campo Tipo Descripción _userconnected int Identificador de usuario conectado a la aplicación de Estructura organizativa que está realizando la AL SIGM v3 Descripción y código Servicios Web SIGEM 204

205 consulta o modificación de los datos del grupo _id int Identificador del grupo _name Nombre del grupo _managerid Identificador del usuario administrador del grupo _type int Tipo del grupo _description Descripción _creatorid int Identificador numérico del usuario creador _creationdate Date Fecha de creación _updaterid int Identificador numérico del usuario que realizó la última actualización en el grupo _updatedate Date Fecha de actualización _permsimpl PermisosGenericos Lista de permisos del grupo _users Usuarios Lista de usuarios del grupo _adminusers UsuariosBasicos Lista de usuarios administradores del grupo RetornoEntero Campo Tipo Descripción valor int Valor numérico. Archive Campo Tipo Descripción archiveflds ArchiveFlds Objeto con los datos de los campos del archivador idxs ArchiveIdxs Objeto con la lista de índices invesdoc del archivador misc ArchiveMisc Objeto con información extendida del archivador name Nombre del archivo remarks Descripción AL SIGM v3 Descripción y código Servicios Web SIGEM 205

206 flags int Uso interno parentid int Identificador numérico del archivador padre adminuserid int Identificador del usuario de administración del archivador typeid int Identificador del tipo de archivo ArchiveFlds Campo Tipo Descripción archivefldslist ArchiveFld[] Vector de objetos ArchiveFld ArchiveFld Campo Tipo Descripción m_id int Identificador del campo del archivador m_name Nombre del campo m_type int Tipo del campo m_len int Longitud máxima del campo m_isnullable boolean Permite indicar si el campo puede ser nulo m_colname Nombre de la columna asociada m_isdoc boolean Permite indicar si se trata de m_ismult boolean Permite indicar si se trata de un campo multivalor m_remarks Descripción ArchiveIdxs Campo Tipo Descripción archiveindxlist ArchiveIdx[] Lista de objetos ArchiveIdx ArchiveIdx Campo Tipo Descripción id int Identificador único del índice AL SIGM v3 Descripción y código Servicios Web SIGEM 206

207 name Nombre lógico del índice isunique boolean Indica si es clave única o no fldsid Int[] Identificadores de los campos del ArchiveMisc Campo Tipo Descripción fdrname Forma de nombrar las carpetas del archivador vollisttype int Tipo de la lista de volúmenes vollistid int Identificador de la lista de volúmenes Listas Campo Tipo Descripción Listas Lista[] Vector de objetos Lista Lista Campo Tipo Descripción id int Identificador numérico de la lista name Nombre de la lista flags int Sin uso state int Estado de la lista remarks Descripción creatorid int Identificador numérico del usuario creador creationdate Date Fecha de creación updaterid int Identificador numérico del usuario que realizó la última modificación updatedate Date Fecha de actualización volid int Identificador numérico del volumen asociado con la lista. AL SIGM v3 Descripción y código Servicios Web SIGEM 207

208 GrupoLdap Campo Tipo Descripción _id int Identificador numérico del grupo Ldap _fullname Nombre completo del grupo _guid Guid del grupo en Ldap _type int Tipo del grupo Ldap UsuariosLdap Campo Tipo Descripción usuariosldap UsuarioLdap[] Vector de objetos UsuarioLdap Todos los objetos extienden del objeto RetornoServicio: RetornoServicio Campo Tipo Descripción errorcode Código de error. returncode Código de retorno. OK: Operación realizada con éxito ERROR: Se ha producido un error en la operación Códigos de error =Error genérico =Se intenta añadir un permiso que no existía previamente, esto debe hacerse desde la herramienta de Estructura Organizativa =Se intenta añadir un perfil que no existía previamente, esto debe hacerse desde la herramienta de Estructura Organizativa AL SIGM v3 Descripción y código Servicios Web SIGEM 208

209 3.28 Servicio Web de Geolocalización Este servicio proporciona al sistema SIGEM la funcionalidad para la consulta y validación de datos de Geolocalización. El servicio se despliega como un servicio web independiente. El servicio web se basa en la implementación Axis. El servicio de distribuye como una aplicación web dentro de un archivo war: SIGEM_GeoLocalizacionWS.war Métodos verplanoporcoordenadas Método verplanoporcoordenadas Método para obtener la URL del plano que contiene unas determinadas coordenadas Parámetros datoslocalización Coordenas a que deben contener la URL del plano a devolver. Retorno URLsPlano El objeto pasado originalmente, con el identificador relleno public URLsPlano verplanoporcoordenadas(peticionplanocoordenadas datoslocalizacion) Recupera la URL del plano que contiene las coordenadas recibidas como parámetros. datoslocalizacion (PeticionPlanoCoordenadas): Objeto que contiene las coordenadas a localizar en los planos El resultado de la llamada al servicio web: URLsPlano Objeto con un la URL del plano devuelto por la consulta verplanoporreferenciacatastral Método verplanoporreferenciacatastral Método para obtener la URL del plano que contiene una determinada referencia catastral Parámetros datoslocalización Referencia catastral que debe contener la URL del plano a devolver. Retorno URLsPlano El objeto con la URL devuelta como resultado de la operación AL SIGM v3 Descripción y código Servicios Web SIGEM 209

210 public URLsPlano datoslocalizacion) verplanoporreferenciacatastral(peticionplanoreferenciacatastral Recupera la URL del plano que contiene la referencia catastral recibida como parámetro. datoslocalizacion (PeticionPlanoReferenciaCatastral): Objeto que contiene la referencia catastral a localizar en los planos El resultado de la llamada al servicio web: URLsPlano Objeto con un la URL del plano devuelto por la consulta verplanoporidvia Método verplanoporidvia Método para obtener la URL del plano que contiene una determinada vía Parámetros datoslocalización Identificador de la via. Retorno URLsPlano El objeto con la URL devuelta como resultado de la operación public URLsPlano verplanoporidvial(peticionplanovia datoslocalizacion) Recupera la URL del plano que contiene la vía, identificada por el dato recibido como parámetro. datoslocalizacion (PeticionPlanoVia): Objeto que contiene el identificador de la vía a localizar en los planos El resultado de la llamada al servicio web: URLsPlano Objeto con un la URL del plano devuelto por la consulta verplanoporidnumeropolicia Método verplanoporidvia Método para obtener la URL del plano que contiene un determinado número de portal Parámetros datoslocalización Identificador del portal. Retorno URLsPlano El objeto con la URL devuelta como resultado de la operación public URLsPlano verplanoporidnumeropolicial(peticionplanoportal datoslocalizacion) Recupera la URL del plano que contiene el número de portal, identificada por el dato recibido como parámetro. AL SIGM v3 Descripción y código Servicios Web SIGEM 210

211 AL SIGM v3 Descripción y código Servicios Web SIGEM 211

212 datoslocalizacion (PeticionPlanoVia): Objeto que contiene el número de portal a localizar en los planos El resultado de la llamada al servicio web: URLsPlano Objeto con un la URL del plano devuelto por la consulta verplanospublicados Método verplanospublicados Método para obtener los mapas publicador en un determinado municipio Parámetros codigoinemunicipio Código INE del municipio Retorno Mapas Lista de mapas devueltos como resultado de la operación public URLsPlano verplanoporidnumeropolicial(int codigoinemunicipio) Recupera los mapas del sistema que están publicador para un determinado municpio, a partir de los datos recibidos como parámetros. codigoinemunicipio (int): Código INE del municipio, de los mapas publicados a devolver El resultado de la llamada al servicio web: Mapas Objeto los mapas devueltos por la consulta validarvia Método validarvia Método para validar una vía en un determinado municipio Parámetros nombrevia Nombre de la vía codigoinemunicipio Código INE del municipio Retorno Vias Lista de vias devueltos como resultado de la operación public Vias validarvia( nombrevia, int codigoinemunicipio) Valida si una vía existe en un determinado municipio, identificado por su código INE, también recibido como parámetro. Devuelve todas las vías encontradas nombrevia (): Nombre de la vía a validar codigoinemunicipio (int): Código INE del municipio AL SIGM v3 Descripción y código Servicios Web SIGEM 212

213 El resultado de la llamada al servicio web: Vias: objeto con las vías devueltas por la consulta validarportal Método validarportal Método para validar un portal en una determinada vía Parámetros idvia Identificador de la vía numeroportal Numero de portal a validar Retorno Portales Lista de portales devueltos como resultado de la operación public Portales validarportal(int idvia, numeroportal) Valida si un portal en una determinado vía, a partir de los datos recibidos como parámetros. Devuelve todos portales encontrados en esa vía con ese número idvi (int)a: Identificador de la vía numeroportal (): Numero del portal a validar El resultado de la llamada al servicio web: Portales: objeto con los portales devueltos por la consulta obtenerportal Método obtenerportal Método para obtener un portal a partir de su identificador Parámetros idportal Identificador del portal Retorno Portal Datos del portal devuelto como resultado de la operación public Portal obtenerportal(int idportal) Recupera los datos de un portal, identificado por el identificador recibido por parámetro idportal (int): Identificador numérico del portal El resultado de la llamada al servicio web: Portal: objeto con los datos del portal devuelto por la consulta. AL SIGM v3 Descripción y código Servicios Web SIGEM 213

214 validardireccionpostal Método validardireccionpostal Método para validar una dirección postal Parámetros tipovia Tipo de la vía nombrevia Nombre de la vía numeroportal Número del portal codigoinemunicipio Codigo INE del municipio Retorno RetornoLogico El valor devuelto como resultado de la operación public RetornoLógico validardireccionpostal( tipovia, nombrevia, numeroportal, int codigoinemunicipio) Valida una dirección postal, identificada a partir de los datos recibidos como parámetros. tipovia (): Tipo de la vía de la dirección postal a validar nombrevia (): Nombre de la vía numeroportal (): Número del portal codigoinemunicpio (int): Código INE del municipio El resultado de la llamada al servicio web: RetornoLogico: objeto con el valor de la validación devuelto por la consulta validardireccionpostalcompleta Método validardireccionpostal Método para realizar una validación completa una dirección postal Parámetros tipovia Tipo de la vía nombrevia Nombre de la vía numeroportal Número del portal codigoinemunicipio Codigo INE del municipio Retorno Via La vía devuelta como resultado de la operación public Via validardireccionpostalcompleta( tipovia, nombrevia, numeroportal, int codigoinemunicipio) Realiza una validación completa de una dirección postal, identificada a partir de los datos recibidos como parámetros. Devuelve la vía identificada por dichos parámetros AL SIGM v3 Descripción y código Servicios Web SIGEM 214

215 tipovia (): Tipo de la vía de la dirección postal a validar nombrevia (): Nombre de la vía numeroportal (): Número del portal codigoinemunicpio (int): Código INE del municipio El resultado de la llamada al servicio web: Via: objeto con los datos de la vía devuelta por la consulta obtenerprovincias Método obtenerprovincias Método para obtener todas las provincias Retorno Provincias Lista de provincias devueltas como resultado de la operación public Provincias obtenerprovincias() Recupera los datos de todas las provincias definidas en el sistema. El resultado de la llamada al servicio web: Provincias: objeto con la lista de provincias devuelta por la consulta obtenermunicipios Método obtenermunicipios Método para obtener los municpios de una provincia Parámetros idprovincia Identificador de la provincia Retorno Municipios Los municipios devueltos como resultado de la operación public Municpios obtenermunicipios( idprovincia) Recupera los datos de los municipios en una determinada provincia recibida como parámetro idprovincia (): Identificador numérico de la provincia. El resultado de la llamada al servicio web: Municipios: objeto con la lista de municipios devueltos por la consulta. AL SIGM v3 Descripción y código Servicios Web SIGEM 215

216 obtenertiposdevia Método obtenertiposdevia Método para obtener todos los tipos de vías definidos Retorno TiposVia Los tipos de vía devueltos como resultado de la operación public TiposVia obtenertipodevia() Recupera los datos de los tipos de vía definidos en el sistema El resultado de la llamada al servicio web: TiposVia: objeto con la lista de tipo de vía devueltos por la consulta Clases PeticionPlanoCoordenadas Campo Tipo Descripción coordx double Valor de la coordenada X coordy double Valor de la coordenada Y PeticionPlano Campo idmapa Tipo Descripción int Identificador numérico del mapa ancho int Ancho del mapa alto int Alto del mapa escala int Escala del mapa codigoinemunicipio int Código INE asociado al Municipio URLsPlano Campo Tipo Descripción urlguiaurbana URL para acceder a la aplicación Guía Urbana de localgis urlmapserver URL de la imagen del plano AL SIGM v3 Descripción y código Servicios Web SIGEM 216

217 PeticionPlanoReferenciaCatastral Campo Tipo Descripción referenciacatastral Referencia catastral PeticionPlanoVia Campo Tipo Descripción via int Identificador numérico de la vía PeticionPlanoPortal Campo Tipo Descripción portal int Número de portal Mapas Campo Tipo Descripción mapas Mapa[] Vector de objetos Mapa Mapa Campo mapdefault Tipo Descripción Short mapid Integer Identificador del mapa mapidgeopista Integer mapidmunicpio Integer mappublic Short maxx Double Coordenada X máxima en el mapa maxy Double Coordenada Y máxima en el mapa minx Double Coordenada X mínima en el mapa miny Double Coordenada X mínima en el mapa name Nombre del mapa AL SIGM v3 Descripción y código Servicios Web SIGEM 217

218 srid Vias Campo Tipo Descripción vias Via[] Vector de objetos Via Via Campo Tipo Descripción nombrevia Nombre de la vía idvia int Identificador numérico de la vía tipovia Tipo de vía clasenombre Nombre de la clase Idioma Idioma del nombre de la vía estatus Estado actual de la vía fuente coordenadas ConjuntoCoordenadas Conjunto de coordenadas de la vía portales Portales Lista de portales en la vía codigoinemunicipio int Código INE del municipio provincia int Identificador numérico de la provincia ConjuntoCoordenadas Campo Tipo Descripción conjuntocoordenadas Coordenadas[] Vector de objetos Coordenadas Coordenadas Campo Tipo Descripción coordenadas Coordenada[] Vector de objetos Coordenada AL SIGM v3 Descripción y código Servicios Web SIGEM 218

219 Coordenada Campo Tipo Descripción coordx double Coordenada X coordy double Coordenada Y Portales Campo Tipo Descripción portales Portal[] Vector de objetos Portal Portal Campo Tipo Descripción codigoinemunicipio int Código INE del municipio idportal int Identificador numérico del portal idvia in Identificador numérico de la vía coords Coordenada Coordenadas del portal numportal Número del portal idioma Idioma del portal clasenombre Clase del nombre del portal estatus Estado del portal fuente tipoportal Tipo del portal provincia int Identificador numérico para la provincia Provincias Campo Tipo Descripción provincias Provincia[] Vector de objetos Provincia AL SIGM v3 Descripción y código Servicios Web SIGEM 219

220 Provincia Campo Tipo Descripción codigoine int Código INE de la provincia comunidadautonoma Nombre de la comunidad autónoma nombrecooficial Nombre cooficial de la provincia nombreoficial Nombre oficial de la provincia Municipios Campo Tipo Descripción municipios Municipio[] Vector de objetos Municipio Municipio Campo Tipo Descripción codigoine int Código INE del municipio nombrecooficial Nombre Cooficial del municipio nombreoficial Nombre oficial del municipio TiposVia Campo Tipo Descripción tiposvia TipoVia[] Vector de objetos TipoVia TipoVia Campo Tipo Descripción descripcion Descripción del tipo de vía patrón Patrón del tipo de vía AL SIGM v3 Descripción y código Servicios Web SIGEM 220

221 Todos los objetos extienden del objeto RetornoServicio: RetornoServicio Campo Tipo Descripción errorcode Código de error. returncode Código de retorno. OK: Operación realizada con éxito ERROR: Se ha producido un error en la operación Códigos de error =Error inesperado en la aplicación =Error al obtener el plano solicitado por coordenadas =Error al obtener el plano solicitado por número de referencia catastral =Error al obtener el plano solicitado por identificador de vía =Error al obtener el plano solicitado por identificador de número de policía =Error al obtener planos publicados del municipio =Error al validar la vía =Error al validar el número de portal =Error al validar una dirección postal =El nombre de la vía no es válido =No se han encontrado vías =Error al obtener el listado de provincias =Error al obtener el listado de municipios =Error al obtener el listado de tipos de vía. AL SIGM v3 Descripción y código Servicios Web SIGEM 221

222 3.29 Servicio Web de Población para Registro Telemático Este servicio proporciona al sistema SIGEM la funcionalidad para la recuperación la información de terceros, desde los formularios del registro telemático a través de DWR. El servicio se despliega como un servicio web independiente. El servicio web se basa en la implementación Axis. El servicio de distribuye como una aplicación web dentro de un archivo war: SIGEM_RegistroTelematicoDefaultTercerosConnectorWS.war Métodos buscartercero Método buscartercero Método para obtener un tercero a partir de su identificador, en todas las entidades Parámetros identificador Identificador del tercero. Retorno TerceroVO Los datos del tercero devuelto public TerceroVO buscartercero( identificador) Recupera los datos de un tercero, a partir del identificador recibido como parámetros. identificador (): Identificador del tercero a recuperar El resultado de la llamada al servicio web: TerceroVO Objeto con los datos del tercero devueltos por la consulta buscarterceroporentidad Método buscarterceroporentidad Método para obtener un tercero a partir de su identificador, en una entidad Parámetros entidad Identificador de la entidad identificador Identficador del tercero Retorno TerceroVO Los datos del tercero devuelto public TerceroVO buscarterceroporentidad( entidad, identificador) Recupera los datos de un tercero, en una determinada entidad, a partir de los datos recibidos como parámetros. AL SIGM v3 Descripción y código Servicios Web SIGEM 222

223 entidad (): Identificador de la entidad identificador (): Identificador del tercero a recuperar El resultado de la llamada al servicio web: TerceroVO Objeto con los datos del tercero devueltos por la consulta Clases TerceroVO Campo identificador Tipo Descripción Identificador del documento de identificación del tercero nombre Nombre del tercero primerapellido Primer apellido segundoapellido Segundo apellido terceroid Identificador del tercero en el sistema de terceros AL SIGM v3 Descripción y código Servicios Web SIGEM 223

224 3.30 Servicio Web de Gestión de CSV Este servicio proporciona al sistema SIGEM la funcionalidad para la generación del CSV (Código Seguro de Verificación) asociado a los documentos, y gestión de dichos documentos. El servicio se despliega como un servicio web independiente. El servicio web se basa en la implementación Axis. El servicio de distribuye como una aplicación web dentro de un archivo war: SIGEM_GestionCVSWS.war Métodos generarcsv Método generarcsv Método para generar el CSV de un documento. Parámetros entidad Identificador de la entidad infodocumentoform Datos del documento Retorno InfoDocumentoCSVRetorno Información del documento con el CSV public InfoDocumentoCSVRetorno generarcsv(entidad entidad,infodocumentocsvformdto infodocumentoform) Genera el CSV de un documento identificado por los datos recibidos por parámetro y almacena su información en el sistema. entidad (Entidad): Objeto con el identificador de la entidad infodocumentoform (InfoDocumentoCSVFormDTO): Objeto con los datos del documento. El resultado de la llamada al servicio web: InfoDocumentoCSVRetorno Objeto con los datos del documento con el CSV getinfodocumentobycsv Método getinfodocumentobycsv Método para obtener la información de un documento a partir de su CSV Parámetros entidad Identificador de la entidad csv Código seguro de verificación del documento Retorno InfoDocumentoCSVRetorno Información del documento con el CSV public InfoDocumentoCSVRetorno getinfodocumentobycsv(entidad entidad, csv) AL SIGM v3 Descripción y código Servicios Web SIGEM 224

225 Recupera la información de un documento a partir del código recibido como parámetro. entidad (Entidad): Identificador de la entidad csv (): Código Seguro de Verificación asociado al documento a recuperar El resultado de la llamada al servicio web: InfoDocumentoCSVRetorno Objeto con la información del documento con el csv getdocumentobycsv Método getdocumentobycsv Método para obtener la información de un documento, incluido su contenido a partir de su CSV Parámetros entidad Identificador de la entidad csv Código seguro de verificación del documento Retorno DocumentoCSVRetorno Información del documento con el CSV y su contenido public DocumentoCSVRetorno getdocumentobycsv(entidad entidad, csv) Recupera la información del documento con el CSV y su contenido, a partir del identificador recibido como parámetro. entidad (Entidad): Identificador de la entidad cvs () Código Seguro de Verificación asociado al documento a recuperar El resultado de la llamada al servicio web: TerceroVO Objeto con los datos del tercero devueltos por la consulta deleteinfodocumento Método deleteinfodocumento Método para eliminar la información de un documento. Parámetros entidad Identificador de la entidad id Identificador del documento Retorno RetornoServicio Resultado de la operación public RetornoServicio deleteinfodocumento(entidad entidad, id) AL SIGM v3 Descripción y código Servicios Web SIGEM 225

226 Elimina la información de un documento, identificado por los datos recibidos como parámetros. entidad (Entidad): Identificador de la entidad id (): Identificador del documento a eliminar El resultado de la llamada al servicio web: RetornoServicio Objeto con el resultado de la operación existecontenidodocumento Método existecontenidodocumento Método para comprobar si esl contenido del documento se puede descargar de la aplicación externa. Parámetros entidad Identificador de la entidad id Identificador del documento Retorno BooelanoRetorno Resultado de la operación public BooleanoRetorno existecontenidodocumento(entidad entidad, id) Comprueba si el contenido del documento identificado por los datos recibidos como parámetros, se puede descargar de la aplicación externa. entidad (Entidad): Identificador de la entidad id (): Identificador del documento El resultado de la llamada al servicio web: BooleanRetorno Objeto con el resultado de la operación getcontenidodocumento Método getcontenidodocumento Método para obtener el contenido de un documento a partir de su identificador. Parámetros entidad Identificador de la entidad id Identificador del documento Retorno B64 Contenido del documento public B64 getcontenidodocumento(entidad entidad, id) Recupera el contenido de un documento identificado a partir de los datos recibidos como parámetros. AL SIGM v3 Descripción y código Servicios Web SIGEM 226

227 entidad (Entidad): Identificador de la entidad id (): Identificador del documento El resultado de la llamada al servicio web: B64 Objeto con el contenido del documento existecontenidodocumento Método existecontenidodocumento Método para comprobar si esl contenido del documento se puede descargar de la aplicación externa. Parámetros entidad Identificador de la entidad id Identificador del documento Retorno BooelanoRetorno Resultado de la operación public BooleanoRetorno existecontenidodocumento(entidad entidad, id) Comprueba si el contenido del documento identificado por los datos recibidos como parámetros, se puede descargar de la aplicación externa. entidad (Entidad): Identificador de la entidad id (): Identificador del documento El resultado de la llamada al servicio web: BooleanRetorno Objeto con el resultado de la operación writedocumento Método writedocumento Método para escribir el contenido de un documento Parámetros entidad Identificador de la entidad id Identificador del documento stringb64encoded Cadena para generar el OutputStream destino Retorno B64 Contenido del documento public RetornoServicio writedocumento(entidad entidad, id, stringb64encoded) Escribre el contenido de un documento identificado a partir de los datos recibidos como parámetros, un destino obtenido también a partir de uno de los parámetros. AL SIGM v3 Descripción y código Servicios Web SIGEM 227

228 entidad (Entidad): Identificador de la entidad id (): Identificador del documento stringb64encoded (): Cadena para generar el OutputStream destino El resultado de la llamada al servicio web: RetornoServicio Objeto con el resultado de la operación Clases InfoDocumentoCSVFormDTO Campo nombre Tipo Descripción Nombre del documento tipomime Tipo MIME del documento fechacreacion Date Fecha de creación del documento fechacaducidad Date Fecha de caducidad del documento codigoaplicacion Código de la aplicación a la que pertenece el documento disponible boolean Disponibilidad del documento InfoDocumentoCSVRetorno Campo id Tipo Descripción Identificador del documento csv CSV asignado al documento fechacsv Date Fecha de generación del CSV del documento nombreaplicacion Nombre de la aplicación a la que pertenece el documento nombre Nombre del documento tipomime Tipo MIME del documento fechacreacion Date Fecha de creación del documento fechacaducidad Date Fecha de caducidad del documento AL SIGM v3 Descripción y código Servicios Web SIGEM 228

229 codigoaplicacion Código de la aplicación a la que pertenece el documento disponible boolean Disponibilidad del documento DocumentoCSVRetorno Campo Tipo Descripción contenido byte[] Array de bytes con el contenido del documento BooleanRetorno Campo Tipo Descripción valor boolean Valor booleano (true/false) B64 Campo Tipo Descripción stringb64 Contenido en base 64 Todos los objetos extienden del objeto RetornoServicio: RetornoServicio Campo Tipo Descripción errorcode Código de error. returncode Código de retorno. OK: Operación realizada con éxito ERROR: Se ha producido un error en la operación AL SIGM v3 Descripción y código Servicios Web SIGEM 229

230 3.31 Servicio Web de Consulta de Documentos de Registro Telematico por CVS Este servicio proporciona al sistema SIGEM la funcionalidad para consulta y obtención de contenido de documentos del Registro Telemático, a través del CSV. El servicio se despliega como un servicio web independiente. El servicio web se basa en la implementación Axis. El servicio de distribuye como una aplicación web dentro de un archivo war: SIGEM_RegistroTelematicoWS.war Métodos existedocumento Método existedocumento Método para comprobar si existe un documento Parámetros csv CSV del documento entidad Identificador de la entidad Retorno boolean Resultado de la comprobación public boolean existedocumento( csv,entidad entidad) Comprueba si existe un documento en el sistema a partir de los datos recibidos como parámetros. csv (): Código Seguro de Verificación del documento a comprobar entidad (Entidad): Objeto con el identificador de la entidad El resultado de la llamada al servicio web: boolean Valor boolean con el resultado de la operación getcontenidodocumento Método getcontenidodocumento Método para obtener el contenido de un documento Parámetros csv CSV del documento entidad Identificador de la entidad Retorno byte[] Contenido del documento public byte[] getcontenidodocumento( csv,entidad entidad) Recupera el contenido de un documento, identificado a partir de los datos recibidos como parámetros. AL SIGM v3 Descripción y código Servicios Web SIGEM 230

231 csv (): Código Seguro de Verificación del documento a comprobar. Entidad (Entidad): Objeto con el identificador de la entidad. El resultado de la llamada al servicio web: byte[] Contenido del documento devuelto como resultado de la operación. AL SIGM v3 Descripción y código Servicios Web SIGEM 231

232 4 Anexo I: Ejemplos de uso del Servicio Web de Consulta de Expedientes 4.1 Llamadas al servicio web consultarexpedientesnif Consulta todos los expedientes que existen relacionados con un NIF Parámetros de entrada: - CriteriosBusquedaExpedientes Clase ieci.tecdoc.sgm.ct.ws.client.criteriosbusquedaexpedientes - Entidad Clase ieci.tecdoc.sgm.ct.ws.client Entidad Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); CriterioBusquedaExpedientes criterios = new CriterioBusquedaExpedientes(); criterios.setnif( X ); //Se obtiene de la tabla SGM_CTINEXP la columna CNIF ieci.tecdoc.sgm.ct.ws.client.expedientes expedientes = oservicio.consultarexpedientesnif(criterios, entidad); Retorno: Expedientes Clase ieci.tecdoc.sgm.ct.ws.client.expedientes consultarexpedientes Consulta todos los expedientes que existen en función de unos criterios de búsqueda establecidos Parámetros de entrada: - CriteriosBusquedaExpedientes Clase ieci.tecdoc.sgm.ct.ws.client.criteriosbusquedaexpedientes - Entidad Clase ieci.tecdoc.sgm.ct.ws.client Entidad Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); AL SIGM v3 Descripción y código Servicios Web SIGEM 232

233 entidad.setidentificador( 000 ); CriterioBusquedaExpedientes criterios = new CriterioBusquedaExpedientes(); criterios.setnif( X ); //Se obtiene de la tabla SGM_CTINEXP la columna CNIF criterios.setestado( 0 ); // 0 Abierto; 1 - Finalizado Expedientes expedientes = oservicio.consultarexpedientes(criterios, entidad) NOTA: Debe establecerse al menos un criterio de búsqueda para que la consulta devuelva algún resultado Retorno: Expedientes Clase ieci.tecdoc.sgm.ct.ws.client.expedientes (Array de elementos Expediente) obtenerurlaportacionexpedientes Se obtiene la url de aportación de documentos cuando hay subsanación Parámetros de entrada: No existen Código de ejemplo de llamada al servicio web: url = oservicio.obtenerurlaportacionexpedientes(); Retorno: URL del enlace de aportación de documentos (Subsanación) Ejemplo: SIGEM_RegistroTelematicoWeb/prepararSubsanacion.do obtenerurlnotificacionexpedientes Se obtiene la url con la que se notifican los expedientes Parámetros de entrada: No existen Código de ejemplo de llamada al servicio web: AL SIGM v3 Descripción y código Servicios Web SIGEM 233

234 url = oservicio.obtenerurlnotificacionexpedientes(); Retorno: URL de enlace a la notificación Ejemplo: obtenerurlpagotasas Se obtiene la url de llamada al Pago de Tasas Parámetros de entrada: No existen Código de ejemplo de llamada al servicio web: url = oservicio.obtenerurlpagotasas(); Retorno: URL de enlace a la notificación Ejemplo: SIGEM_PagoElectronicoWeb/cargarFormularioAutoliquidacion.do obtenerdetalle A partir de un número de expediente, se obtiene un objeto tipo Expediente Parámetros de entrada: - Expediente - Clase ieci.tecdoc.sgm.ct.ws.client.expediente - Entidad Clase ieci.tecdoc.sgm.ct.ws.client Entidad Código de ejemplo de llamada al servicio web: ieci.tecdoc.sgm.ct.ws.client.entidad entidad = new ieci.tecdoc.sgm.ct.ws.client.entidad(); entidad.setidentificador( 000 ); AL SIGM v3 Descripción y código Servicios Web SIGEM 234

235 Expediente expediente = new Expediente(); expediente.setnumero( EXP2009/66 ); ieci.tecdoc.sgm.ct.ws.client.expediente expediente = oservicio.obtenerdetalle(expediente, entidad); Retorno: - Expediente Clase ieci.tecdoc.sgm.ct.ws.client.expediente obtenerhistoricoexpediente Obtiene los hitos de un expediente Parámetros de entrada: - Expediente - Clase ieci.tecdoc.sgm.ct.ws.client.expediente - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); Expediente expediente = new Expediente(); expediente.setnumero( EXP2009/147 ); ieci.tecdoc.sgm.ct.ws.client.hitosexpediente hitos = oservicio.obtenerhistoricoexpediente (expediente, entidad); Retorno: - HitosExpediente Clase ieci.tecdoc.sgm.ct.ws.client.hitosexpediente (Array de elementos HitoExpediente) obtenerhitoestado Obtiene el hito actual de un expediente Parámetros de entrada: - Expediente - Clase ieci.tecdoc.sgm.ct.ws.client.expediente - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: AL SIGM v3 Descripción y código Servicios Web SIGEM 235

236 Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); Expediente expediente = new Expediente(); expediente.setnumero( EXP2009/147 ); //Se obtiene de la tabla SGM_CTINFOEXP la columna CNUMEXP ieci.tecdoc.sgm.ct.ws.client.hitoexpediente hito = oservicio.obtenerhitoestado (expediente, entidad); Retorno: - HitoExpediente Clase ieci.tecdoc.sgm.ct.ws.client.hitoexpediente (Ojo, el resultado del hito actual del expediente en ese momento) obtenerficheroshito Obtiene un listado de ficheros asociados a un hito del expediente Parámetros de entrada: - HitoExpediente Clase ieci.tecdoc.sgm.ct.ws.client.hitoexpediente - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); HitoExpediente hito = new HitoExpediente(); hito.setguid( N9766BB00C2511DD8000F3C72467C459 ); // Ojo este guid es el obtenido de la propiedad guid del objeto HitoExpediente (hitoexpediente.getguid(); - Se obtiene de la tabla SGM_CTHITOHITEXP ieci.tecdoc.sgm.ct.ws.client.ficheroshito ficheros = oservicio.obtenerficheroshito(hito, entidad); Retorno: - FicherosHito Clase ieci.tecdoc.sgm.ct.ws.client.ficheroshito. (Array de elementos FicheroHito) obtenerficheroshitos Obtiene un listado de ficheros asociados a un listado de hitos de un expediente Parámetros de entrada: - HitosExpediente - Clase ieci.tecdoc.sgm.ct.ws.client.hitosexpediente AL SIGM v3 Descripción y código Servicios Web SIGEM 236

237 - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); // Obtenemos los hitos históricos del expediente Expediente expediente = new Expediente(); expediente.setnumero("exp2009/147"); //Se obtiene de la tabla SGM_CTINFOEXP la columna CNUMEXP HitosExpediente hitosexpediente = oservicio.obtenerhistoricoexpediente(expediente, entidad); HitoExpediente[] hito = hitosexpediente.gethitosexpedientes(); HitoExpediente hito1 = null; FicherosHito ficheros; for(int i = 0; i < hito.length; i++) { hito1 = new HitoExpediente(); hito1.setguid(((hitoexpediente)hito[i]).getguid()); ficheros = oservicio.obtenerficheroshito(hito1,entidad); } NOTA: Se debe primero obtener los hitos históricos del expediente pasando el número de expediente y la entidad y luego se obtienen los ficheros de los hitos del expediente uno a uno. Retorno: - FicherosHitos Clase ieci.tecdoc.sgm.ct.ws.client.ficheroshitos. (Array de elementos FicheroHito) nuevoexpediente Da de alta un nuevo expediente Parámetros de entrada: - Expediente - Clase ieci.tecdoc.sgm.ct.ws.client.expediente - Interesado - Clase ieci.tecdoc.sgm.ct.ws.client.interesado - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); ieci.tecdoc.sgm.ct.ws.client.expediente expediente = new ieci.tecdoc.sgm.ct.ws.client.expediente(); // Rellenamos los datos del expediente expediente.setnumero("exp2009/288"); expediente.setprocedimiento("pcd-4 Concesión de subvención"); expediente.setfechainicio(" "); AL SIGM v3 Descripción y código Servicios Web SIGEM 237

238 expediente.setaportacion("n"); expediente.setcodigopresentacion("1"); expediente.setestado(ieci.tecdoc.sgm.ct.ws.client.expediente.cod_estado_expediente_iniciado); expediente.setfecharegistro(" "); expediente.setnumeroregistro(" "); // Rellenamos los datos del Interesado ieci.tecdoc.sgm.ct.ws.client.interesado interesado = new ieci.tecdoc.sgm.ct.ws.client.interesado(); interesado.setnif(" x"); interesado.setnumeroexpediente(expediente.getnumero()); interesado.setprincipal("s"); interesado.setnombre("usuario usuario"); interesado.setinformacionauxiliar("informacionauxiliar"); // Creamos el nuevo expediente oservicio.nuevoexpediente(expediente, interesado, entidad); NOTA: Tener cuidado con el nombre del procedimiento, (debe existir previamente), el número de Expediente y también el nif y el nombre del interesado. En definitiva los datos deben ser lógicos Retorno: - RetornoServicio - Clase ieci.tecdoc.sgm.ct.ws.client.retornoservicio eliminarexpediente Elimina de la base de datos el expediente que se desee Parámetros de entrada: - Expediente - Clase ieci.tecdoc.sgm.ct.ws.client.expediente - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); ieci.tecdoc.sgm.ct.ws.client.expediente expediente = new ieci.tecdoc.sgm.ct.ws.client.expediente(); expediente.setnumero("exp2009/288"); //Se obtiene de la tabla SGM_CTINFOEXP la columna CNUMEXP oservicio.eliminarexpediente(expediente, entidad); NOTA: Solamente es necesario indicar en el objeto Expediente el número de Expediente Retorno: - RetornoServicio - Clase ieci.tecdoc.sgm.ct.ws.client.retornoservicio AL SIGM v3 Descripción y código Servicios Web SIGEM 238

239 nuevointeresado Da de alta un nuevo interesado Parámetros de entrada: - Interesado - Clase ieci.tecdoc.sgm.ct.ws.client.interesado - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); // Rellenamos los datos del Interesado ieci.tecdoc.sgm.ct.ws.client.interesado interesado = new ieci.tecdoc.sgm.ct.ws.client.interesado(); interesado.setnif(" h"); interesado.setprincipal("s"); interesado.setnombre("emilio Acuña Morgado"); interesado.setnumeroexpediente("exp2009/288"); // Damos de alta el nuevo Interesado oservicio.nuevointeresado(interesado, entidad); NOTA: El Nif, (debe ser un nif válido), el nombre y el número de Expediente son obligatorios) Retorno: - RetornoServicio - Clase ieci.tecdoc.sgm.ct.ws.client.retornoservicio eliminarinteresado Elimina un interesado Parámetros de entrada: - Interesado - Clase ieci.tecdoc.sgm.ct.ws.client.interesado - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); AL SIGM v3 Descripción y código Servicios Web SIGEM 239

240 ieci.tecdoc.sgm.ct.ws.client.interesado interesado = new ieci.tecdoc.sgm.ct.ws.client.interesado(); interesado.setnif(" h"); //Se obtiene de la tabla SGM_CTINTEXP la columna CNIF interesado.setnumeroexpediente("exp2009/288"); //Se obtiene de la tabla SGM_CTINFOEXP la columna CNUMEXP oservicio.eliminarinteresado(interesado, entidad); NOTA: Sólo es necesario el nif del interesado y el número de expediente para eliminar el interesado Retorno: - RetornoServicio - Clase ieci.tecdoc.sgm.ct.ws.client.retornoservicio eliminarinteresadoexpediente Elimina al interesado asociado a un expediente Parámetros de entrada: - Número de Expediente - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); numeroexpediente = "EXP2009/288"; //Se obtiene de la tabla SGM_CTINFOEXP la columna CNUMEXP oservicio.eliminarinteresadoexpediente(numeroexpediente, entidad); NOTA: Sólo es necesario el número de expediente para eliminar el interesado asociado al expediente Retorno: - RetornoServicio - Clase ieci.tecdoc.sgm.ct.ws.client.retornoservicio establecerhitoactual Establece un nuevo hito actual del expediente Parámetros de entrada: AL SIGM v3 Descripción y código Servicios Web SIGEM 240

241 - Hito Clase ieci.tecdoc.sgm.ct.ws.client.hitoexpediente - Fichero - Clase ieci.tecdoc.sgm.ct.ws.client.ficheroshito - Historico Clase ieci.tecdoc.sgm.ct.ws.client.hitorico - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); // Datos del hito a establecer como actual ieci.tecdoc.sgm.ct.ws.client.hitoexpediente hito = null; // Ficheros asociados al hito ieci.tecdoc.sgm.ct.ws.client.ficheroshito fichero = null; ieci.tecdoc.sgm.ct.ws.client.ficherohito ficherohito = null; // Determina si se deben pasar el hito al histórico o no ieci.tecdoc.sgm.ct.ws.client.historico historico = new ieci.tecdoc.sgm.ct.ws.client.historico(); historico.setpasohistoricohitoactual( S ); hito = new ieci.tecdoc.sgm.ct.ws.client.hitoexpediente(); hito.setcodigo("1"); hito.setdescripcion("<labels><label locale=\"es\">[es]subsanación de documentación</label><label locale=\"eu\">[eu]subsanación de documentación</label><label locale=\"ca\">[ca]subsanación de documentación</label><label locale=\"gl\">[gl]subsanación de documentación</label></labels>"); java.text.simpledateformat fmt = new java.text.simpledateformat("yyyy-mm-dd HH:mm:ss"); date = fmt.format(java.util.calendar.getinstance().gettime()); hito.setfecha(date); hito.setguid("nc df811dd8000b5ae8cd9c5f6"); hito.setinformacionauxiliar("información Auxiliar"); hito.setnumeroexpediente("exp2009/147"); //Se obtiene de la tabla SGM_CTINFOEXP la columna CNUMEXP fichero = new ieci.tecdoc.sgm.ct.ws.client.ficheroshito(); ficherohito = new ieci.tecdoc.sgm.ct.ws.client.ficherohito(); ieci.tecdoc.sgm.ct.ws.client.ficherohito[] ficherohitoarray = new ieci.tecdoc.sgm.ct.ws.client.ficherohito[1]; ieci.tecdoc.sgm.ct.ws.client.ficherohito ficherohito = new ieci.tecdoc.sgm.ct.ws.client.ficherohito(); ficherohito.setguid(("n9766bb00c2511dd8000f3c72467c450"); ficherohito.setguidhito(hito.getguid()); ficherohito.settitulo(("solicitud subsanación"); ficherohitoarray[0] = ficherohito; ficheroshito = new ieci.tecdoc.sgm.ct.ws.client.ficheroshito(); ficheroshito.setficheroshito(ficherohitoarray); oservicio.establecerhitoactual(hito, ficheroshito, historico, entidad); Retorno: - RetornoServicio - Clase ieci.tecdoc.sgm.ct.ws.client.retornoservicio AL SIGM v3 Descripción y código Servicios Web SIGEM 241

242 eliminarhitoactual Elimina un nuevo hito actual de un expediente Parámetros de entrada: - Expediente - Clase ieci.tecdoc.sgm.ct.ws.client.expediente - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); ieci.tecdoc.sgm.ct.ws.client.expediente expediente = new ieci.tecdoc.sgm.ct.ws.client.expediente(); expediente.setnumero("exp2009/147"); //Se obtiene de la tabla SGM_CTINFOEXP la columna CNUMEXP oservicio.eliminarhitoactual (expediente, entidad); Retorno: - RetornoServicio - Clase ieci.tecdoc.sgm.ct.ws.client.retornoservicio nuevohitohistorico Crea un nuevo hito histórico para un expediente Parámetros de entrada: - Hito - Clase ieci.tecdoc.sgm.ct.ws.client.hitoexpediente - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); ieci.tecdoc.sgm.ct.ws.client.hitoexpediente hito = new ieci.tecdoc.sgm.ct.ws.client.hitoexpediente(); hito.setcodigo("1"); hito.setdescripcion("<labels><label locale=\"es\">[es]subsanación de documentación</label><label locale=\"eu\">[eu]subsanación de documentación</label><label locale=\"ca\">[ca]subsanación de documentación</label><label locale=\"gl\">[gl]subsanación de documentación</label></labels>"); AL SIGM v3 Descripción y código Servicios Web SIGEM 242

243 java.text.simpledateformat fmt = new java.text.simpledateformat("yyyy-mm-dd HH:mm:ss"); date = fmt.format(java.util.calendar.getinstance().gettime()); hito.setfecha(date); hito.setguid("nc df811dd8000b5ae8cd9c5f6"); hito.setinformacionauxiliar("información Auxiliar"); hito.setnumeroexpediente("exp2009/288"); oservicio.nuevohitohistorico(hito, entidad); Retorno: - RetornoServicio - Clase ieci.tecdoc.sgm.ct.ws.client.retornoservicio eliminarhitohistorico Elimina un hito histórico para un expediente Parámetros de entrada: - HitoExpediente Clase ieci.tecdoc.sgm.ct.ws.client.hitoexpediente - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); ieci.tecdoc.sgm.ct.ws.client.hitoexpediente hito = new ieci.tecdoc.sgm.ct.ws.client.hitoexpediente(); hito.setguid("nc df811dd8000b5ae8cd9c5f6"); hito.setnumeroexpediente("exp2009/288"); oservicio.eliminarhitohistorico(hito, entidad); Retorno: - RetornoServicio - Clase ieci.tecdoc.sgm.ct.ws.client.retornoservicio cargardocumento Permite cargar el path de un documento asociado a un expediente Parámetros de entrada: AL SIGM v3 Descripción y código Servicios Web SIGEM 243

244 - Guid del documento (Se localiza en la tabla sgm_ctfichhito, columna cguidfich con el título del documento) - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); ieci.tecdoc.sgm.ct.ws.client.infodocumento infodoc = new ieci.tecdoc.sgm.ct.ws.client.infodocumento(); infodoc.setguid("n96aabe00c2511dd8000f3c72467c459"); ieci.tecdoc.sgm.ct.ws.client.infodocumento documento = oservicio.cargardocumento(infodoc, entidad); Retorno: - InfoDocumento Clase ieci.tecdoc.sgm.ct.ws.client.infodocumento recogerdocumento Permite cargar un documento asociado a un expediente Parámetros de entrada: - Guid del documento (Se localiza en la tabla sgm_ctfichhito, columna cguidfich con el título del documento) - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); InfoDocumento infodocumento = new InfoDocumento(); infodocumento.setguid("n96aabe00c2511dd8000f3c72467c459"); ieci.tecdoc.sgm.ct.ws.client.infodocumento documento = oservicio.recogerdocumento(infodocumento, entidad); Retorno: - InfoDocumento ieci.tecdoc.sgm.ct.ws.client.infodocumento busquedaexpedientes AL SIGM v3 Descripción y código Servicios Web SIGEM 244

245 Busca expedientes pudiendo filtrar por estado, fecha desde, fecha hasta, nif y operador consulta Parámetros de entrada: - CriteriosBusquedaExpedientes Clase ieci.tecdoc.sgm.ct.ws.client.criteriosbusquedaexpedientes - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); ieci.tecdoc.sgm.ct.ws.client.criteriobusquedaexpedientes ocriterio = new ieci.tecdoc.sgm.ct.ws.client.criteriobusquedaexpedientes(); ocriterio.setnif(" x"); // Se obtiene de la tabla SGM_CTINTEXP ieci.tecdoc.sgm.ct.ws.client.expedientes expedientes = oservicio.busquedaexpedientes(ocriterio, entidad); NOTA: Debe establecerse al menos un criterio de búsqueda para que la consulta devuelva algún resultado. Es similar al método consultarexpedientes() Retorno: - Expedientes - Clase ieci.tecdoc.sgm.ct.ws.client.expedientes anexarficheroshitoactual Permite anexar ficheros al hito actual del expediente Parámetros de entrada: - FicherosHito Clase ieci.tecdoc.sgm.ct.ws.client.ficheroshito - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); ieci.tecdoc.sgm.ct.ws.client.ficheroshito ficheros = new ieci.tecdoc.sgm.ct.ws.client.ficheroshito(); ieci.tecdoc.sgm.ct.ws.client.ficherohito fichero = new ieci.tecdoc.sgm.ct.ws.client.ficherohito(); // Rellenamos el objeto fichero del hito actual fichero.setguid(" "); fichero.setguidhito("n854b1b00baf11de8000f763e8a625c5"); fichero.settitulo("título del fichero"); AL SIGM v3 Descripción y código Servicios Web SIGEM 245

246 ieci.tecdoc.sgm.ct.ws.client.ficherohito[] ficherohitoenv = new ieci.tecdoc.sgm.ct.ws.client.ficherohito[1]; ieci.tecdoc.sgm.ct.ws.client.ficheroshito ficheroshito = new ieci.tecdoc.sgm.ct.ws.client.ficheroshito(); ficherohitoenv[0] = fichero; ficheroshito.setficheroshito(ficherohitoenv); oservicio.anexarficheroshitoactual(ficheroshito, entidad); Retorno: - RetornoServicio - Clase ieci.tecdoc.sgm.ct.ws.client.retornoservicio existennotificaciones Verifica si existen notificaciones para un expediente determinado Parámetros de entrada: - Expediente Clase ieci.tecdoc.sgm.ct.ws.client.expediente - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); ieci.tecdoc.sgm.ct.ws.client.expediente expediente = new ieci.tecdoc.sgm.ct.ws.client.expediente(); expediente.setnumero("exp2009/288"); //Se obtiene de la tabla SGM_CTINFOEXP la columna CNUMEXP RetornoLogico retorno = oservicio.existennotificaciones(numeroexpediente, entidad); Retorno: - RetornoLogico Clase ieci.tecdoc.sgm.ct.ws.client.retornologico existensubsanaciones Verifica si existen subsanaciones para un expediente determinado Parámetros de entrada: AL SIGM v3 Descripción y código Servicios Web SIGEM 246

247 - Expediente Clase ieci.tecdoc.sgm.ct.ws.client.expediente - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); ieci.tecdoc.sgm.ct.ws.client.expediente expediente = new ieci.tecdoc.sgm.ct.ws.client.expediente(); expediente.setnumero("exp2009/240"); //Se obtiene de la tabla SGM_CTINFOEXP la columna CNUMEXP RetornoLogico retorno = oservicio.existensubsanaciones(numeroexpediente, entidad); Retorno: - RetornoLogico Clase ieci.tecdoc.sgm.ct.ws.client.retornologico existenpagos Verifica si existen pagos para un expediente determinado Parámetros de entrada: - Expediente Clase ieci.tecdoc.sgm.ct.ws.client.expediente - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); ieci.tecdoc.sgm.ct.ws.client.expediente expediente = new ieci.tecdoc.sgm.ct.ws.client.expediente(); expediente.setnumero("exp2009/241"); //Se obtiene de la tabla SGM_CTINFOEXP la columna CNUMEXP RetornoLogico retorno = oservicio.existenpagos(numeroexpediente, entidad); Retorno: - RetornoLogico Clase ieci.tecdoc.sgm.ct.ws.client.retornologico AL SIGM v3 Descripción y código Servicios Web SIGEM 247

248 recogernotificaciones Obtiene las notificaciones pendientes del expediente Parámetros de entrada: - Expediente Clase ieci.tecdoc.sgm.ct.ws.client.expediente - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); ieci.tecdoc.sgm.ct.ws.client.expediente expediente = new ieci.tecdoc.sgm.ct.ws.client.expediente(); expediente.setnumero("exp2009/241"); //Se obtiene de la tabla SGM_CTINFOEXP la columna CNUMEXP exediente.setnif( X ); // Se obtiene de la tabla SGM_CTINTEXP la columna CNIF NotificacionesPendientes notificaciones = oservicio.recogernotificaciones (expediente, entidad); Retorno: - NotificacionesPedientes Clase ieci.tecdoc.sgm.ct.ws.client.notificacionespendientes altasolicitudsubsanacion Crea una nueva solicitud de subsanación asociada a un expediente - Subsanacion Clase ieci.tecdoc.sgm.ct.ws.client.subsanacion - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); ieci.tecdoc.sgm.ct.ws.client.subsanacion subsanacion = new ieci.tecdoc.sgm.ct.ws.client.subsanacion(); java.text.simpledateformat fmt = new java.text.simpledateformat("yyyy-mm-dd HH:mm:ss"); date = fmt.format(java.util.calendar.getinstance().gettime()); subsanacion.setfecha(date); subsanacion.setiddocumento( N96AABE00C2511DD8000F3C72467C459 ); subsanacion.setidentificador( H00FFBE00C22221BF9123G89890KYD89 ); subsanacion.setidentificadorhito( N854B1B00BAF11DE8000F763E8A625C5 ); // Se corresponde con la columna CGUID de la tabla SGM_CTHITOHISTEXP AL SIGM v3 Descripción y código Servicios Web SIGEM 248

249 subsanacion.setmensajeparaelciudadano( Mensaje para el ciudadano ); subsanacion.setnumeroexpediente( EXP2009/288 ); // Se obtiene de la tabla SGM_CTINFOEXP la columna CNUMEXP oservicio.altasolicitudsubsanacion (subsanacion, entidad); Retorno: - RetornoServicio - Clase ieci.tecdoc.sgm.ct.ws.client.retornoservicio obtenersubsanacioneshitoactual Obtiene las subsanaciones de un expediente en el hito actual Parámetros de entrada: - Expediente Clase ieci.tecdoc.sgm.ct.ws.client.expediente - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); ieci.tecdoc.sgm.ct.ws.client.expediente expediente = new ieci.tecdoc.sgm.ct.ws.client.expediente(); expediente.setnumero("exp2009/242"); //Se obtiene de la tabla SGM_CTINFOEXP la columna CNUMEXP ieci.tecdoc.sgm.ct.ws.client.subsanaciones subsanaciones = oservicio.obtenersubsanacioneshitoactual(expediente, entidad); Retorno: - Subsanaciones Clase ieci.tecdoc.sgm.ct.ws.client.subsanaciones obtenersubsanacioneshito Devuelve las subsanaciones asociadas al hito actual del expediente Parámetros de entrada: - HitoExpediente Clase ieci.tecdoc.sgm.ct.ws.client HitoExpediente - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad AL SIGM v3 Descripción y código Servicios Web SIGEM 249

250 Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); ieci.tecdoc.sgm.ct.ws.client.hitoexpediente hitoexpediente = new ieci.tecdoc.sgm.ct.ws.client.hitoexpediente(); hitoexpediente.setguid( N1F84A90062D11DE8000B7E460BA8184 ); //Se corresponde con el identificador del hito actual del expediente de la tabla SGM_CTHITOHISTEXP la columna CGUID hitoexpediente.setnumeroexpediente( EXP2009/288 ); ieci.tecdoc.sgm.ct.ws.client.subsanaciones subsanaciones = oservicio.obtenersubsanacioneshito(hitoexpediente, entidad); Retorno: - Subsanaciones Clase ieci.tecdoc.sgm.ct.ws.client.subsanaciones altasolicitudpago Da de alta una solicitud de pago asociada al hito actual del expediente Parámetros de entrada: - Pago Clase ieci.tecdoc.sgm.ct.ws.client.pago - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); ieci.tecdoc.sgm.ct.ws.client.pago popago = new ieci.tecdoc.sgm.ct.ws.client.pago(); popago.setautoliquidacionid("9000"); popago.setentidademisoraid("000001"); java.text.simpledateformat fmt = new java.text.simpledateformat("yyyy-mm-dd HH:mm:ss"); date = fmt.format(java.util.calendar.getinstance().gettime()); popago.setfecha(date); popago.setiddocumento("2-1"); popago.setidentificador("bba253c00a0a11de8000be125f0b3a49"); popago.setidentificadorhito("nba253c00a0a11de8000be125f0b3a47"); //Se corresponde con el identificador del hito actual del expediente de la tabla SGM_CTHITOHISTEXP la columna CGUID popago.setmensajeparaelciudadano("mensaje para el ciudadano"); popago.setimporte("1000"); popago.setnumeroexpediente("exp2009/288"); //Se corresponde con el número de expediente de la tabla SGM_CTINFOEXP la columna CNUMEXP oservicio.altasolicitudpago(popago, entidad); AL SIGM v3 Descripción y código Servicios Web SIGEM 250

251 NOTA: La fecha de pago debe ir en formato yyyy-mm-dd HH:mm:ss Retorno: RetornoServicio - Clase ieci.tecdoc.sgm.ct.ws.client.retornoservicio obtenerpagoshitoactual Devuelve un listados de pagos asociados al hito actual del expediente Parámetros de entrada: - Expediente Clase ieci.tecdoc.sgm.ct.ws.client.expediente - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); ieci.tecdoc.sgm.ct.ws.client.expediente expediente = new ieci.tecdoc.sgm.ct.ws.client.expediente(); expediente.setnumero("exp2009/242"); //Se obtiene de la tabla SGM_CTINFOEXP la columna CNUMEXP ieci.tecdoc.sgm.ct.ws.client.pagos pagos = oservicio.obtenerpagoshitoactual(expediente, entidad); Retorno: - Pagos Clase ieci.tecdoc.sgm.ct.ws.client.pagos obtenerpagoshito Devuelve un listado de pagos asociados a un hito determinado del expediente Parámetros de entrada: - HitoExpediente Clase ieci.tecdoc.sgm.ct.ws.client.hitoexpediente - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: AL SIGM v3 Descripción y código Servicios Web SIGEM 251

252 Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); ieci.tecdoc.sgm.ct.ws.client.hitoexpediente hitoexpediente = new ieci.tecdoc.sgm.ct.ws.client.hitoexpediente(); hitoexpediente.setguid("nba253c00a0a11de8000be125f0b3a47"); // Se corresponde con el identificador del hito en la tabla SGM_CTHITOHISTEXP la columna CGUID hitoexpediente.setnumeroexpediente( EXP2009/288 ); ieci.tecdoc.sgm.ct.ws.client.pagos pagos = oservicio.obtenerpagoshito(hitoexpediente, entidad); Retorno: - Pagos Clase ieci.tecdoc.sgm.ct.ws.client.pagos altanotificacion Crea una notificación asignada a un expediente Parámetros de entrada: - HitoExpediente Clase ieci.tecdoc.sgm.ct.ws.client.hitoexpediente - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: ieci.tecdoc.sgm.ct.ws.client.entidad entidad = new ieci.tecdoc.sgm.ct.ws.client.entidad(); entidad.setidentificador( 000 ); ieci.tecdoc.sgm.ct.ws.client.notificacion notificacion = new ieci.tecdoc.sgm.ct.ws.client.notificacion(); notificacion.setdescripcion( Descripción de la notificación ); notificacion.setdeu( [email protected] ); notificacion.setexpediente( EXP2009/288 ); java.text.simpledateformat fmt = new java.text.simpledateformat("yyyy-mm-dd HH:mm:ss"); date = fmt.format(java.util.calendar.getinstance().gettime()); notificacion.setfechanotificacion(date); notificacion.sethitoid("nba253c00a0a11de8000be125f0b3a47"); // Se corresponde con el identificador del hito en la tabla SGM_CTHITOESTEXP la columna CGUID notificacion.setnotificacionid("drg253c11a0a33de8111be125f0b6783"); notificacion.setservicionotificionesid("cda894cfga0a22de84300be125f0b3896"); oservicio.altanotificacion(notificacion,, entidad); Retorno: AL SIGM v3 Descripción y código Servicios Web SIGEM 252

253 - RetornoServicio - Clase ieci.tecdoc.sgm.ct.ws.client.retornoservicio obtenernotificacioneshitoactual Devuelve un listado de notificaciones del hito actual asociado a un expediente Parámetros de entrada: - Expediente Clase ieci.tecdoc.sgm.ct.ws.client.expediente - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); ieci.tecdoc.sgm.ct.ws.client.expediente expediente = new ieci.tecdoc.sgm.ct.ws.client.expediente(); expediente.setnumero("exp2009/288"); //Se obtiene de la tabla SGM_CTINFOEXP la columna CNUMEXP ieci.tecdoc.sgm.ct.ws.client.notificaciones notificaciones = oservicio.obtenernotificacioneshitoactual(expediente, entidad); Retorno: - Notificaciones Clase ieci.tecdoc.sgm.ct.ws.client.notificaciones obtenernotificioneshito Devuelve las notificaciones de un hito asociado a un expediente Parámetros de entrada: - HitoExpediente Clase ieci.tecdoc.sgm.ct.ws.client.hitoexpediente - Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Código de ejemplo de llamada al servicio web: Entidad entidad = new Entidad(); entidad.setidentificador( 000 ); ieci.tecdoc.sgm.ct.ws.client.hitoexpediente hitoexpediente = new ieci.tecdoc.sgm.ct.ws.client.hitoexpediente(); hitoexpediente.setnumeroexpediente("exp2009/288"); //Se obtiene de la tabla AL SIGM v3 Descripción y código Servicios Web SIGEM 253

254 SGM_CTINFOEXP la columna CNUMEXP hitoexpediente.setguid("nba253c00a0a11de8000be125f0b3a47"); // Se corresponde con el identificador del hito en la tabla SGM_CTHITOHISTEXP la columna CGUID ieci.tecdoc.sgm.ct.ws.client.notificaciones notificaciones = oservicio.obtenernotificioneshito(hitoexpediente, entidad); Retorno: - Notificaciones Clase ieci.tecdoc.sgm.ct.ws.client.notificaciones 4.2 Clases utilizadas CriterioBusquedaExpedientes Clase ieci.tecdoc.sgm.ct.ws.client. CriterioBusquedaExpedientes Propiedades: NIF (NIF de búsqueda) fechadesde (Fecha desde la que se desea buscar) fechahasta (Fecha hasta la que se desea buscar) operadorconsulta (Operador de consulta, >, <, =) estado (Estado 0 - Abierto, 1 - Pendiente, 2 - Finalizado) Entidad Clase ieci.tecdoc.sgm.ct.ws.client.entidad Propiedades: Identificador (Identificador de la Entidad (Ej: 000) Nombre (Nombre de la Entidad) Expedientes Clase ieci.tecdoc.sgm.ct.ws.client.expedientes Propiedades: Expedientes List Expediente (Listado de expedientes) Expediente Clase ieci.tecdoc.sgm.ct.ws.client.expediente Propiedades: numero (Número Código de expediente) procedimiento - (Nombre del procedimiento asociado al expediente) fechainicio (Fecha de inicio del expediente) numeroregistro (Número de registro del expediente) fecharegistro (Fecha del registro) informacionauxiliar (Información auxiliar del registro) aportacion (S Si ; N No) codigopresentacion (Código de presentación (32 acaracteres) notificacion (S- Si; N- No) pagos - (S- Si; N- No) estado (0 Expediente Iniciado; 1 Expediente finalizado) HitosExpediente AL SIGM v3 Descripción y código Servicios Web SIGEM 254

255 Clase ieci.tecdoc.sgm.ct.ws.client.hitosexpedientes Propiedades: HitosExpedientes List HitoExpediente (Listado de hitos expediente) HitoExpediente Clase ieci.tecdoc.sgm.ct.ws.client.hitoexpediente Propiedades: numeroexpediente (Número-Código del expediente) guid (GUID identificativo del hito del expediente (32 caracteres)) codigo (Código asignado al hito del expediente) fecha (Fecha de alta del hito) descripcion (descripción del Hito del expediente) informacionauxiliar (Información auxiliar del hito) Interesado Clase ieci.tecdoc.sgm.ct.ws.client.intersado Propiedades: NIF (Nif del interesado) expedientes List Expediente (Expedientes asociados al interesado) informacionauxiliar (Información Auxiliar del interesado) nombre (Nombre del interesado) numeroexpediente (Numero de expediente del interesado) principal (S Si, N No) FicheroHito Clase ieci.tecdoc.sgm.ct.ws.client.ficherohito Propiedades: guidhito (GUID del hito del expediente (32 caracteres)) guid (GUID del fichero hito del expediente (32 caracteres)) titulo (Título del Fichero hito del expediente) FicherosHito Clase ieci.tecdoc.sgm.ct.ws.client.ficheroshito Propiedades: guidhito (GUID identificativo del Hito del expediente (32 caracteres)) ficheroshito List FicheroHito (Listado de Ficheros Hito) FicherosHitos Clase ieci.tecdoc.sgm.ct.ws.client.ficheroshitos Propiedades: ficheroshitos List FicherosHito (Listado de Ficheros Hito) InfoDocumento Clase ieci.tecdoc.sgm.ct.ws.client.infodocumento Propiedades: guid- (GUID Identificativo del Documento (32 caracteres)) content byte[] (Contenido del fichero (En array de bytes)) extensión (Extensión del documento) mimetype (Tipo mime del documento) Subsanaciones Clase ieci.tecdoc.sgm.ct.ws.client.subsanaciones Propiedades: Subsanaciones List Subsanacion (Listado de Subsanaciones) Subsanacion AL SIGM v3 Descripción y código Servicios Web SIGEM 255

256 Clase ieci.tecdoc.sgm.ct.ws.client.subsanacion Propiedades: identificador (Identificador de la Subsanación GUID (32 caracteres)) iddocumento (Identificador del Documento de Subsanación GUID (32 caracteres)) mensajeparaelciudadano (Mensaje de texto para el ciudadano) identificadorhito (Identificador del Hito GUID (32 caracteres)) fecha (Fecha de alta de la subsanación) numeroexpediente (Número-Código del expediente) Pagos Clase ieci.tecdoc.sgm.ct.ws.client.pagos Propiedades: Pagos List Pago (Listado de Pagos) Pago Clase ieci.tecdoc.sgm.ct.ws.client.pago Propiedades: entidademisoraid (Identificador de la entidad emisora GUID (32 caracteres)) autoliquidacionid (Identificador de la autoliquidación GUID (32 caracteres)) importe (Importe del pago) Notificaciones Clase ieci.tecdoc.sgm.ct.ws.client.notificaciones Propiedades: Notificaciones List Notificacion (Listado de notificaciones) Notificacion Clase ieci.tecdoc.sgm.ct.ws.client.notificacion Propiedades: notificacionid (Identificador de la notificación GUID (32 caracteres)) fechanotificacion (Fecha de alta de la notificación) deu (dirección electrónica del usuario) servicionotificionesid (Identificador del servicio de notificaciones GUID (32 caracteres) expediente (Número-Código del expediente) descripción (Descripción de la notificación) hitoid (Identificador del hito al que se le asocia la notificación GUID (32 caracteres)) RetornoServicio Clase ieci.tecdoc.sgm.ct.ws.client.retornoservicio Propiedades: returncode - (Tipo de error) errorcode (Código de error) RetornoLogico Clase ieci.tecdoc.sgm.ct.ws.client.retornologico Propiedades: valor (true (Si existen) o false (no existen)) NotificacionesPendientes Clase ieci.tecdoc.sgm.ct.ws.client.notificacionespendientes Propiedades: notificacionespendientes (Notificaciones pendientes) Historico AL SIGM v3 Descripción y código Servicios Web SIGEM 256

257 Clase ieci.tecdoc.sgm.ct.ws.client.historico Propiedades: pasohistoricohitoactual (Pasar a histórico el hito (S Si; N - No)) AL SIGM v3 Descripción y código Servicios Web SIGEM 257