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