En este apartado se explicarán los servicios de PAU, cómo invocar, parámetros que devuelve y un ejemplo de invocación de cada servicio
ÍNDICE DE SERVICIOS
Servicios IInfoServicePortType
Búsquedas y consultas de aplicaciones
Método 'applicationList'
Servicio que devuelve una lista de aplicaciones definidas en la aplicación PAU, en función de la información que se pasa como parámetro en el objeto ParamApplicationList.
La información devuelta de cada aplicación incluye, el alias de la aplicación, el nombre de la aplicación, las Ips asignadas o los métodos que tiene asociados.
Más detalles
Signatura
ResultApplicationList applicationList(ParamApplicationList paramApplicationList)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
applicationSearch | ApplicationSearch | Objeto ApplicationSearch |
Parámetros de respuesta
Nombre | Tipo | Descripción |
---|
resultError | ResultError | Objeto ResultError |
applications | Application[] | Lista de objetos Application |
size | int | Tamaño de la lista applications devuelta |
Códigos error
APPLICATIONLIST_00 | Error durante el proceso de búsqueda de aplicaciones. |
APPLICATIONLIST_01 | El objeto ParamApplicationList es nulo. |
APPLICATIONLIST_02 | No se han encontrado aplicaciones para estos parámetros de búsqueda. |
APPLICATIONLIST_03 | Ha ocurrido algún error al realizar la búsqueda. |
APPLICATIONLIST_04 | Error de paginación al realizar la búsqueda. |
Ejemplo de invocación
ParamApplicationList params = new ParamApplicationList();
ApplicationSearch appSearch = new ApplicationSearch();
appSearch.setAlias("PAU");
params.setApplicationSearch(appSearch);
ResultApplicationList result = pauAgent.applicationList(params);
Método 'applicationRelationList'
Servicio que devuelve una lista con las relaciones de acceso existentes entre dos aplicaciones, dada de alta en PAU, en función de la información pasada como parámetro en el objeto paramApplicationRelationList
Esta relación es la que permite que una aplicación utilice servicios de otra aplicación.
Más detalles
Signatura
ResultApplicationRelationList applicationRelationList (ParamApplicationRelationList paramApplicationRelationList)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
applicationRelationSearch | ApplicationRelationSearch | Objeto ApplicationRelationSearch |
Parámetros de respuesta
Nombre | Tipo | Descripción |
---|
resultError | ResultError | Objeto ResultError |
applicationRelations | ApplicationRelation[] | Lista de objetos ApplicationRelation |
size | int | Tamaño de la lista applicationRelations devuelta |
Códigos error
APPLICATIONRELATIONLIST_00 | Error durante el proceso de búsqueda de relaciones entre aplicaciones |
APPLICATIONRELATIONLIST_01 | El objeto ParamApplicationRelationList es nulo |
APPLICATIONRELATIONLIST_02 | No se han encontrado relaciones entre aplicaciones para estos parámetros de búsqueda |
APPLICATIONRELATIONLIST_03 | Ha ocurrido algún error al realizar la búsqueda. |
Ejemplo de invocación
ParamApplicationRelationList params = new ParamApplicationRelationList();
ApplicationRelationSearch appSearch = new ApplicationRelationSearch();
appSearch.setApplicationAliasA("SVCD");
params.setApplicationRelationSearch(appSearch);
ResultApplicationRelationList result = pauAgent.applicationRelationList(params);
Método 'authorizeApplication'
Servicio que comprueba si una aplicación tiene autorización sobre otra para acceder a un determinado método. Se comprueba también si la ip desde la que accede es una de las permitidas para dicha aplicación.
La relación entre la aplicación invocante y los servicios de la aplicación invocada debe estar dada de alta en PAU. La Ip tambien debe estar dada de alta en PAU.
Más detalles
Signatura
ResultAuthorizeApplication authorizeApplication(ParamAuthorizeApplication paramAuthorizeApplication)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
applicationAliasA | String | Alias aplicación A |
applicationAliasB | String | Alias aplicación B |
methodCode | String | Código del método |
ip | String | Dirección Ip |
Parámetros de respuesta
Nombre | Tipo | Descripción |
---|
resultError | ResultError | Objeto ResultError |
Códigos error
AUTHORIZEAPPLICATION_00 | Error durante el proceso de autorización. |
AUTHORIZEAPPLICATION_01 | El parámetro alias de la aplicación la aplicación A es nulo. |
AUTHORIZEAPPLICATION_02 | El parámetro alias de la aplicación B es nulo. |
AUTHORIZEAPPLICATION_03 | El parámetro methodCode es nulo. |
AUTHORIZEAPPLICATION_04 | El parámetro Ip es nulo. |
AUTHORIZEAPPLICATION_05 | No existe una relación entre aplicaciones. |
AUTHORIZEAPPLICATION_06 | La ip no está en la lista de ip's permitidas. |
Ejemplo de invocación
ParamAuthorizeApplication paramAuthorizeApplication = new ParamAuthorizeApplication();
paramAuthorizeApplication.setApplicationAliasA("App A");
paramAuthorizeApplication.setApplicationAliasB("App B");
// ha de ser ip desde la que accede appA
paramAuthorizeApplication.setIp("127.0.0.3");
paramAuthorizeApplication.setMethodCode("MET00296");
ResultAuthorizeApplication result = pauAgent.authorizeApplication(paramAuthorizeApplication);
Método 'methodApplicationList'
Servicio que devuelve dentro del objeto ResultMethodApplicationList un vector de IPs y un vector de Métodos asociados con la aplicación que se pasa como parámetro en el objeto ParamMethodApplicationList
La lista de métodos y de Ips relacionadas con una aplicación, deben estar dadas de alta en PAU.
Más detalles
Signatura
ResultMethodApplicationList methodApplicationList (ParamMethodApplicationList paramMethodApplicationList)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
applicationAlias | String | Alias de la aplicación |
Parámetros de respuesta
Nombre | Tipo | Descripción |
---|
resultError | ResultError | Objeto ResultError |
methods | Method[] | Lista de objetos Method, métodos de la aplicación |
ips | Ip[] | Lista de objetos Ip, Ips de la aplicación |
Códigos error
METHODAPPLICATIONLIST_00 | Error durante el proceso de búsqueda |
METHODAPPLICATIONLIST_01 | El objeto ParamMethodApplicationList es nulo |
METHODAPPLICATIONLIST_02 | No hay Ips ni métodos asociados a la aplicación |
METHODAPPLICATIONLIST_03 | Ha ocurrido algún error al realizar la búsqueda |
METHODAPPLICATIONLIST_04 | El Alias de la Aplicación es nulo |
Ejemplo de invocación
ParamMethodApplicationList params = new ParamMethodApplicationList();
params.setApplicationAlias("SIU");
ResultMethodApplicationList result = pauAgent.methodList(params);
Búsquedas y consultas de acciones
Método 'actionList'
Servicio que devuelve una lista de acciones en función de la información pasada como parámetro en el objeto ParamActionList
Estas acciones deben estar dadas de alta en PAU. Se puede buscar la acción mediante su código, el alias de la aplicación, el nombre de la aplicación.
Más detalles
Signatura
ResultActionList actionList(ParamActionList paramActionList)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
actionSearch | ActionSearch | Objeto ActionSearch |
Parámetros de respuesta
Nombre | Tipo | Descripción |
---|
resultError | ResultError | Objeto ResultError |
actions | Action[] | Lista de objetos Action |
size | int | Tamaño de la lista actions devuelta |
Códigos error
ACTIONLIST_00 | Ha ocurrido algún error al realizar la búsqueda |
ACTIONLIST_01 | El objeto paramActionList es nulo |
ACTIONLIST_02 | No se han encontrado acciones con los parámetros de búsqueda indicados |
Ejemplo de invocación
ParamActionList params = new ParamActionList();
ActionSearch search = new ActionSearch();
search.setAlias("INSERTAR_SELLOS");
params.setActionSearch(search);
ResultActionList result = pauAgent.actionList(params);
Búsquedas y consultas de usuarios
Método 'admRoleList'
Servicio que devuelve el listado de perfiles administrativos con el que se puede crear una asignación de un grupo de gestión a un usuario, dados de alta en PAU.
Al dar de alta a un usuario, se le asignan grupos de gestión, para lo que es necesario conocer los perfiles administrativos disponibles.
Más detalles
Signatura
ResultAdmRoleList admRoleList(ParamAdmRoleList paramAdmRoleList)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
admRoleSearch | AdmRoleSearch | Objeto AdmRoleSearch con campos de búsqueda |
Parámetros de respuesta
Nombre | Tipo | Descripción |
---|
resultError | ResultError | Objeto ResultError |
admRole | AdmRole[] | Lista de objetos AdmRole, con los datos de los roles |
size | int | Tamaño de la lista admRole devuelta |
Códigos error
ADMROLELIST_00 | Error durante el proceso de búsqueda |
ADMROLELIST_01 | El objeto ParamAdmRoleList es nulo |
ADMROLELIST_02 | No existe ningún administrador de rol para esos parámetros de búsqueda |
ADMROLELIST_03 | Ha ocurrido algún tipo de error al buscar el rol en la base de datos |
Ejemplo de invocación
ParamAdmRoleList params = new ParamAdmRoleList;
AdmRoleSearch admRoleSearch = new AdmRoleList();
admRoleSearch.setname("nombre del perfil");
params.setAdmRoleSearch(admRoleSearch);
ResultAdmRoleList result = pauAgent.admRoleList(params);
Método 'assignedRoleList'
Servicio que devuelve una lista de roles asignados a un usuario en función de la información pasada como parámetro en el objeto ParamAssignedRoleList.
Se puede buscar los roles asignados buscando por el fiscal anagram del usuario, el código de organismo, el alias de la aplicación o un código de rol específico.
Más detalles
Signatura
ResultAssignedRoleList assignedRoleList(ParamAssignedRoleList paramAssignedRoleList)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
assignedRoleSearch | AssignedRoleSearch | Objeto AssignedRoleSearch con campos de búsqueda |
Parámetros de respuesta
Nombre | Tipo | Descripción |
---|
resultError | ResultError | Objeto ResultError |
assignedRoles | AssignedRole[] | Lista de objetos AssignedRole, con los datos de los roles |
size | int | Tamaño de la lista assignedRoles devuelta |
Códigos error
ASSIGNEDROLELIST_00 | Error durante el proceso de búsqueda de roles asignados |
ASSIGNEDROLELIST_01 | El objeto paramAssignedRoleList es nulo |
ASSIGNEDROLELIST_02 | No se han encontrado asignaciones para esos parámetros de búsqueda. |
ASSIGNEDROLELIST_03 | Ha ocurrido algún error al realizar la búsqueda. |
ASSIGNEDROLELIST_04 | Debe indicarse el código de organismo |
Ejemplo de invocación
ParamAssignedRoleList param = new ParamAssignedRoleList();
AssignedRoleSearch s = new AssignedRoleSearch();
s.setFiscalAnagram("29120602AMARTSANJ");
param.setAssignedRoleSearch(s);
ResultAssignedRoleList result = pauAgent.assignedRoleList(param);
Método 'assignedRoleList1'
Servicio que devuelve una lista de roles asignados a un usuario en función de la información pasada como parámetro en el objeto ParamAssignedRoleListByBranch
Se puede buscar los roles asignados buscando por el fiscal anagram del usuario, el código de organismo, el alias de la aplicación o un código de rol específico o la rama de un organismo.
Más detalles
Signatura
ResultAssignedRoleList assignedRoleList(ParamAssignedRoleListByBranch paramAssignedRoleListByBranch)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
assignedRoleTreeSearch | AssignedRoleTreeSearch | Objeto AssignedRoleTreeSearch con campos de búsqueda |
organismCode | String | Código de organismo |
Parámetros de respuesta
Nombre | Tipo | Descripción |
---|
resultError | ResultError | Objeto ResultError |
assignedRoles | AssignedRole[] | Lista de objetos AssignedRole, con los datos de los roles |
size | int | Tamaño de la lista assignedRoles devuelta |
Códigos error
ASSIGNEDROLELIST_00 | Error durante el proceso de búsqueda de roles asignados |
ASSIGNEDROLELIST_01 | El objeto paramAssignedRoleList es nulo |
ASSIGNEDROLELIST_02 | No se han encontrado asignaciones para esos parámetros de búsqueda. |
ASSIGNEDROLELIST_03 | Ha ocurrido algún error al realizar la búsqueda. |
ASSIGNEDROLELIST_04 | Debe indicarse el código de organismo |
Ejemplo de invocación
ParamAssignedRoleList param = new ParamAssignedRoleList();
AssignedRoleTreeSearch s = new AssignedRoleTreeSearch();
s.setFiscalAnagram("29120602AMARTSANJ");
s.setOrganismCode("ORG00021");
param.setAssignedRoleSearch(s);
ResultAssignedRoleList result = pauAgent.assignedRoleList(param);
Método 'assignedRoleList2'
Servicio que devuelve una lista de roles asignados a un usuario en función de la información pasada como parámetro en el objeto ParamAssignedRoleListByTree.
Se puede buscar los roles asignados buscando por el fiscal anagram del usuario, el código de organismo, el alias de la aplicación o un código de rol específico o el árbol al que pertenece de un organismo.
Más detalles
Signatura
ResultAssignedRoleList assignedRoleList(ParamAssignedRoleListByTree paramAssignedRoleListByTree)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
assignedRoleTreeSearch | AssignedRoleTreeSearch | Objeto AssignedRoleTreeSearch con campos de búsqueda |
organismCode | String | Código de organismo |
Parámetros de respuesta
Nombre | Tipo | Descripción |
---|
resultError | ResultError | Objeto ResultError |
assignedRoles | AssignedRole[] | Lista de objetos AssignedRole, con los datos de los roles |
size | int | Tamaño de la lista assignedRoles devuelta |
Códigos error
ASSIGNEDROLELIST_00 | Error durante el proceso de búsqueda de roles asignados |
ASSIGNEDROLELIST_01 | El objeto paramAssignedRoleList es nulo |
ASSIGNEDROLELIST_02 | No se han encontrado asignaciones para esos parámetros de búsqueda. |
ASSIGNEDROLELIST_03 | Ha ocurrido algún error al realizar la búsqueda. |
ASSIGNEDROLELIST_04 | Debe indicarse el código de organismo |
Ejemplo de invocación
ParamAssignedRoleList param = new ParamAssignedRoleList();
AssignedRoleTreeSearch s = new AssignedRoleTreeSearch();
s.setFiscalAnagram("29120602AMARTSANJ");
s.setOrganismCode("ORG00021");
param.setAssignedRoleSearch(s);
ResultAssignedRoleList result = pauAgent.assignedRoleList(param);
Método 'assignedRolesUserList'
Servicio que devuelve una lista con los roles asignados a cada uno de los usuarios pasados como parámetros en el objeto ParamAssignedRolesUserList
Además se pueden filtrar los roles asignados buscando por el fiscal anagram del usuario, el código de organismo, el alias de la aplicación o un código de rol específico.
Más detalles
Signatura
ResultAssignedRolesUserList assignedRolesUserList(ParamAssignedRolesUserList paramAssignedRoleUserList)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
assignedRolesUserListSearch | AssignedRolesUserListSearch | Objeto AssignedRolesUserListSearch con campos de búsqueda |
Parámetros de respuesta
Nombre | Tipo | Descripción |
---|
resultError | ResultError | Objeto ResultError |
assignedRolesToUserList | AssignedRolesToUser[] | Lista de objetos AssignedRolesToUser, con los datos de los roles |
Códigos error
ASSIGNEDROLESUSERLIST_00 | Error durante el proceso de búsqueda de roles asignados |
ASSIGNEDROLESUSERLIST_01 | El objeto paramAssignedRolesUserList es nulo |
ASSIGNEDROLESUSERLIST_02 | Los parámetros de búsqueda son nulos o no se ha definido ningún usuario (anagramas fiscales). |
ASSIGNEDROLESUSERLIST_03 | Ha ocurrido algún error al realizar la búsqueda. |
Ejemplo de invocación
ParamAssignedRolesUserList params = new ParamAssignedRolesUserList();
AssignedRolesUserListSearch assignedRolesUserListSearch = new AssignedRolesUserListSearch();
assignedRolesUserListSearch.setFiscalAnagramList("11111111T");
params.setAssignedRolesUserListSearch(assignedRolesUserListSearch);
ResultAssignedRolesUserList result=pauAgent.assignedRolesUserList(params);
Método 'authorize'
Servicio que autoriza a un usuario comprobando el organismo al que pertenece y la aplicación a la que desea tener acceso. Se devuelve dentro del objeto ResultAuthorize un vector de Roles que posee el usuario.
Para poder acceder a una aplicación un usuario debe seleccionar un organismo en el que debe tener permisos para esa aplicación.
Más detalles
Signatura
ResultAuthorize authorize(ParamAuthorize paramAuthorize)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
organismCode | String | Código de organismo |
applicationAlias | String | Alias de la aplicación |
Parámetros de respuesta
Nombre | Tipo | Descripción |
---|
resultError | ResultError | Objeto ResultError |
role | Role[] | Lista de objetos Role, con los datos de los roles |
Códigos error
AUTHORIZE_00 | Error durante el proceso de autorización |
AUTHORIZE_01 | El objeto ParamAuthorize es nulo. |
AUTHORIZE_02 | El parámetro alias de aplicación es nulo. |
AUTHORIZE_03 | El parámetro anagrama fiscal es nulo. |
AUTHORIZE_04 | El parámetro código de organismo es nulo. |
AUTHORIZE_05 | No existen datos para ese usuario u organismo. |
AUTHORIZE_06 | El funcionario no tiene roles para esa aplicación y organismo. |
AUTHORIZE_07 | Ha ocurrido algún tipo de error al buscar el rol en la base de datos. |
Ejemplo de invocación
ParamAuthorize params = new ParamAuthorize();
params.setApplicationAlias("SVCD");
params.setFiscalAnagram("25152907SDIAZMEDM");
params.setOrganismCode("ORG00002");
ResultAuthorize result = pauAgent.authorize(params);
Método 'getLastConnection'
Servicio que devuelve la última conexión de un usuario en una aplicación.
Más detalles
Signatura
ResultGetLastConnection getLastConnection(ParamGetLastConnection paramGetLastConnection)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
userConSearch | UserConSearch | El objeto UserConSearch, contiene criterios de búsqueda de UserCon, así como los parámetros de paginación y ordenación. |
Parámetros de respuesta
Nombre | Tipo | Descripción |
---|
resultError | ResultError | Objeto ResultError |
userCon | UserCon | Objeto con la información de la última conexión de usuario. |
Códigos error
GETLASTCONNECTION_00 | Error durante el proceso de búsqueda. |
GETLASTCONNECTION_01 | El parámetro paramGetLastConnection es nulo. |
GETLASTCONNECTION_02 | El objeto userConSearch es nulo. |
GETLASTCONNECTION_03 | El parametro del fiscal anagrama es nulo. |
GETLASTCONNECTION_04 | El parametro de la aplicacion es nulo. |
GETLASTCONNECTION_05 | No se han encontrado conexiones para esos parametros de busqueda |
Ejemplo de invocación
ParamGetLasConnection params = new ParamGetLasConnection();
params.setFiscalAnagram("11111111H");
params.setApplicationAlias("PAU");
ResultGetLasConnection result = pauAgent.getLasConnection(params);
Método 'roleList'
Servicio que devuelve dentro del objeto ResultRoleList un vector de roles en función del contenido del parámetro paramRoleList.
Devuelve una lista de roles dados de alta en PAU, pudiendo filtrar por el alias de la aplicación, el código del rol, el nombre del rol, o la descripción del rol.
Más detalles
Signatura
ResultRoleList roleList(ParamRoleList paramRoleList)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
roleSearch | ParamRoleList | Objeto ParamRoleList con campos de búsqueda |
Parámetros de respuesta
Nombre | Tipo | Descripción |
---|
resultError | ResultError | Objeto ResultError |
roles | AppRole[] | Listado de roles encontrados |
size | int | Tamaño del listado |
Códigos error
ROLELIST_00 | Error durante el proceso de búsqueda de roles. |
ROLELIST_01 | El objeto paramRoleList es nulo. |
ROLELIST_04 | No se han encontrado roles para estos parámetros de búsqueda. |
ROLELIST_05 | Ha ocurrido algún error al realizar la búsqueda. |
Ejemplo de invocación
aramRoleList params = new ParamRoleList();
RoleSearch search = new RoleSearch();
search.setApplicationAlias("alias");
params.setRoleSearch(search);
ResultRoleList result = pauAgent.roleList(params);
Método 'userByOrganismTree'
Servicio que devuelve los usuarios que pertenezcan a una rama de organismos, dados de alta con un rol determinado dentro de una aplicación. Estos usuarios con sus roles estarán dados de alta en PAU.
Más detalles
Signatura
ResultUserByOrganismTree userByOrganismTree(ParamUserByOrganismTree paramUserByOrganismTree)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
organismsCodeTree | String[] | Lista de códigos de organismos a los que puede pertenecer el usuario |
roleName | String | Nombre del rol |
applicationAlias | String | Alias de la aplicación |
Parámetros de respuesta
Nombre | Tipo | Descripción |
---|
resultError | ResultError | Objeto ResultError |
user | User[] | Lista de objetos User. |
Códigos error
USERSORGANISMTREE_01 | El objeto paramUserByOrganismTree es nulo. |
USERSORGANISMTREE_00 | Error durante el proceso de búsqueda |
USERSORGANISMTREE_02 | La lista de organismos está vacía o es nula. |
USERSORGANISMTREE_03 | No se ha encontrado ningún rol para esos parámetros de búsqueda. |
USERSORGANISMTREE_04 | El alias de la aplicación es nulo |
USERSORGANISMTREE_05 | El rol no existe en el sistema |
USERSORGANISMTREE_06 | El nombre del rol es nulo |
Ejemplo de invocación
String[] organismsCodeTree = new String[2];
organismsCodeTree[0] = "ORG00007";
organismsCodeTree[1] = "ORG00012";
String roleName = "PREPARADOR-COMPULSOR";
String applicationAlias = "SCE";
ParamUserByOrganismTree param = new ParamUserByOrganismTree();
param.setOrganismsCodeTree(organismsCodeTree);
param.setApplicationAlias(applicationAlias);
param.setRoleName(roleName);
ResultUserByOrganismTree result = pauAgent.userByOrganismTree(param);
Método 'userByOrganismTreeExtended' @deprecated
Servicio que devuelve los usuarios que pertenezcan a a algún organismo de los indicados con alguno de los roles indicados. Estos usuarios con sus roles estarán dados de alta en PAU.
Más detalles
Signatura
ResultUserByOrganismTreeExtended userByOrganismTreeExtended( ParamUserByOrganismTreeExtended paramUserByOrganismTree)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
organismsCodeTree | String[] | Lista de códigos de organismos a los que puede pertenecer el usuario |
roleName | String[] | Nombre de roles por los que se filtrará |
applicationAlias | String | Alias de la aplicación |
Parámetros de respuesta
Nombre | Tipo | Descripción |
---|
resultError | ResultError | Objeto ResultError |
user | User[] | Lista de objetos User |
Códigos error
USERSORGANISMTREE_00 | Error durante el proceso de búsqueda. |
USERSORGANISMTREE_01 | El objeto paramUserByOrganismTree es nulo. |
USERSORGANISMTREE_02 | No se han encontrado usuarios para este organismo y rol. |
USERSORGANISMTREE_03 | El parámetro nombre de rol es nulo |
USERSORGANISMTREE_04 | El parámetro alias de la aplicación es nulo |
USERSORGANISMTREE_05 | El rol no existe en el sistema |
USERSORGANISMTREE_06 | No se han encontrado usuarios para esos parámetros de búsqueda |
Ejemplo de invocación
String[] organismsCodeTree = new String[2];
organismsCodeTree[0] = "ORG00007";
organismsCodeTree[1] = "ORG00012";
String[] rolenName = new String[2];
rolesName[0] = "EDITOR";
rolesName[1] = "ISSUER";
ParamUserByOrganismTree param = new ParamUserByOrganismTree();
param.setOrganismsCodeTree(organismsCodeTree);
param.setApplicationAlias(“SNT”);
param.setRoleName(roleName);
ResultUserByOrganismTree result = pauAgent.userByOrganismTree(param);
Método 'UserListByProcedureAndRole'
Servicio que devuelve una lista de usuarios en función del procedimiento y, opcionalmente, un listado de roles. Estos usuarios tendrán los procedimientos y los roles asignados en PAU.
Más detalles
Signatura
ResultUserListByProcedureAndRole userListByProcedureAndRole (ParamUserListByProcedureAndRole paramUserListByProcedureAndRole )
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
signature | String | Procedimiento asociado al Grupo de Gestión. |
entity | String | Identificador de la entidad del procedimiento |
roleCode | String[] | Listado de Roles asociados a los usuarios |
Parámetros de respuesta
Nombre | Tipo | Descripción |
---|
resultError | ResultError | Objeto ResultError |
userList | UserList[] | Listado de usuarios obtenidos. |
Códigos error
USERLISTBYPROCEDUREANDROLE_00 | Error durante el proceso de búsqueda. |
USERLISTBYPROCEDUREANDROLE_01 | El objeto paramUserListByProcedureAndRole es nulo. |
USERLISTBYPROCEDUREANDROLE_02 | El parámetro signature es nulo. |
USERLISTBYPROCEDUREANDROLE_04 | Error que proviene del webservice. |
USERLISTBYPROCEDUREANDROLE_05 | No existen usuarios para los roles introducidos. |
USERLISTBYPROCEDUREANDROLE_06 | No existen usuarios para el parámetro signature introducido. |
USERLISTBYPROCEDUREANDROLE_07 | Existen errores en alguno de los roles introducidos |
USERLISTBYPROCEDUREANDROLE_08 | Existen errores en el param signature introducido. |
USERLISTBYPROCEDUREANDROLE_09 | El id de la entidad es nulo |
Ejemplo de invocación
ParamUserListByProcedureAndRole params = new ParamUserListByProcedureAndRole();
params.setSignature("signature");
params.setEntity(“entity”);
ResultUserListByProcedureAndRole result = pauAgent.userListByProcedureAndRole(params);
Búsquedas y consultas de grupos
Método 'gestionGroupList' @deprecated
Servicio que devuelve una lista con los grupos de gestión en función a la información pasada como parámetro en el objeto ParamGGList.
Los grupos de gestión se consultarán en PAU por nombre del grupo, código del grupo o por procedimientos asignados al grupo.
Más detalles
Signatura
ResultGGList gestionGroupList(ParamGGList paramGGList)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
ggSearch | GGSearch | Objeto GGSearch |
Parámetros de respuesta
Nombre | Tipo | Descripción |
---|
resultError | ResultError | Objeto ResultError |
gestionGroup | GestionGroup[] | Lista de objetos GestionGroup |
Códigos error
GESTIONGROUPLIST_00 | Error durante el proceso de búsqueda de gestion group. |
GESTIONGROUPLIST_01 | El objeto paramGGList es nulo. |
GESTIONGROUPLIST_04 | No se han encontrado grupos de gestión para estos parámetros de búsqueda. |
Ejemplo de invocación
ParamGGList params = new ParamGGList();
GGSearch search = new GGSearch();
search.setDescription("descripción");
params.setGgSearch(search);
ResultGGList result = pauAgent.gestionGroupList(params);
Método 'gestionGroupListByApplication' @deprecated
Servicio que devuelve una lista de grupos de gestión por alias de aplicación encapsulada en el objeto pasado como parámetro paramGestionGroupListByApplication.
Estos grupos de gestión y los alias de las aplicaciones se consultarán en PAU.
Más detalles
Signatura
ResultGestionGroupListByApplication gestionGroupListByApplication (ParamGestionGroupListByApplication paramGestionGroupListByApplication)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
applicationGGSearch | ApplicationGGSearch | Objeto ApplicationGGSearch |
params | SearchParams | Objeto SearchParams |
Parámetros de respuesta
Nombre | Tipo | Descripción |
---|
resultError | ResultError | Objeto ResultError |
applicationGG | ApplicationGG[] | Lista de objetos ApplicationGG (grupos de gestión) |
size | int | Tamaño de la lista applicationGG devuelta |
Códigos error
GESTIONGROUPLISTBYAPPLICATION_00 | Error durante el proceso de búsqueda |
GESTIONGROUPLISTBYAPPLICATION_01 | El parámetro paramGestionGroupListByApplication es nulo |
GESTIONGROUPLISTBYAPPLICATION_02 | El parámetro alias de la aplicación es nulo |
GESTIONGROUPLISTBYAPPLICATION_03 | No se han encontrado grupos de gestión para esa aplicación |
GESTIONGROUPLISTBYAPPLICATION_04 | Ha ocurrido algún error en el proceso de búsqueda |
Ejemplo de invocación
ParamGestionGroupListByApplication params = new ParamGestionGroupListByApplication();
params.setApplicationAlias("PAU");
ResultGestionGroupListByApplication result = pauAgent.gestionGroupListByApplication(params);
Método 'gestionGroupListByUser' @deprecated
Servicio que devuelve una lista de grupos de gestión por usuario encapsulada en el objeto pasado como parámetro paramGestionGroupListByUser.
Los grupos de gestión asignados a los usuarios se encontrarán dados de alta en PAU.
Más detalles
Signatura
ResultGestionGroupListByUser gestionGroupListByUser(ParamGestionGroupListByUser paramGestionGroupListByUser)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
userGGSearch | UserGGSearch | Objeto UserGGSearch |
params | SearchParams | Objeto SearchParams |
Parámetros de respuesta
Nombre | Tipo | Descripción |
---|
resultError | ResultError | Objeto ResultError |
ggUserList | UserGG[] | Lista de objetos UserGG |
size | int | Tamaño de la lista ggUserList devuelta |
Códigos error
GESTIONGROUPLISTBYUSER_00 | Error durante el proceso de búsqueda de gestion group. |
GESTIONGROUPLISTBYUSER_01 | El objeto ParamGestionGroupListByUser es nulo. |
GESTIONGROUPLISTBYUSER_02 | El fiscalAnagram es nulo. |
GESTIONGROUPLISTBYUSER_03 | No se han encontrado grupos de gestión para ese usuario. |
GESTIONGROUPLISTBYUSER_04 | Ha ocurrido algún error en el proceso de búsqueda. |
GESTIONGROUPLISTBYUSER_05 | La lista de anagramas fiscales es nula o esta vacía. |
Ejemplo de invocación
ParamGestionGroupListByUser params = new ParamGestionGroupListByUser();
params.setFiscalAnagram("11111111H");
ResultGestionGroupListByUser result=pauAgent.gestionGroupListByUser(params);
Método 'gestionGroupListByUserLike' @deprecated
Servicio que devuelve una lista de grupos de gestión a partir de un fiscal anagram/gestion group, o ambos campos vacíos, pasada como parámetro en el objeto paramGestionGroupListByUser usando el criterio LIKE para el grupo de gestión.
Los grupos de gestión y la asociación con los usuarios se realizará en PAU.
Más detalles
Signatura
ResultGestionGroupListByUser gestionGroupListByUserLike(ParamGestionGroupListByUser paramGestionGroupListByUser)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
userGGSearch | UserGGSearch | Filtro de búsqueda para el objeto UserGG |
Parámetros de respuesta
Códigos error
GESTIONGROUPLISTBYUSER_00 | Error durante el proceso de búsqueda de gestion group. |
GESTIONGROUPLISTBYUSER_01 | El objeto ParamGestionGroupListByUser es nulo. |
GESTIONGROUPLISTBYUSER_02 | El fiscalAnagram es nulo. |
GESTIONGROUPLISTBYUSER_03 | No se han encontrado grupos de gestión para ese usuario. |
GESTIONGROUPLISTBYUSER_04 | Ha ocurrido algún error en el proceso de búsqueda. |
GESTIONGROUPLISTBYUSER_05 | La lista de anagramas fiscales es nula o esta vacía. |
Ejemplo de invocación
ParamGestionGroupListByUser params = new ParamGestionGroupListByUser();
UserGGSearch userGGSearch = new UserGGSearch();
userGGSearch.setFiscalAnagram("11111111T");
params.setUserGGSearch(userGGSearch);
ResultGestionGroupListByUser
result=pauAgent.gestionGroupListByUserLike(params);
Método 'gestionGroupListWithoutProcedures' @deprecated
Servicio que devuelve una lista con los grupos de gestión en función a la información pasada como parámetro en el objeto ParamGGList.
De cada grupo devuelve código, nombre, descripción y la lista de procedimientos asociados.
Más detalles
Signatura
ResultGGList gestionGroupListWithoutProcedures(ParamGGList paramGGList)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
ggSearch | 4.- Servicios de PAU#GGSearch | Objeto GGSearch |
Parámetros de respuesta
Códigos error
GESTIONGROUPLIST_01 | El objeto paramGGList es nulo |
GESTIONGROUPLIST_00 | Error durante el proceso de búsqueda de gestion group |
GESTIONGROUPLIST_04 | No se han encontrado grupos de gestión para estos parámetros de búsqueda |
Ejemplo de invocación
ParamGGList params = new ParamGGList();
GGSearch ggSearch = new GGSearch();
ggSearch.setGGCode("CODE01");
params.setGgSearch(ggSearch);
ResultGGList result=pauAgent.gestionGroupListWithoutProcedures(params);
Método 'gestionGroupListWithSize' @deprecated
Servicio que devuelve un listado de grupos de gestión e indica el tamaño del mismo.
Los grupos de gestión, se dan de alta en PAU.
Más detalles
Signatura
ResultGGListWithSize gestionGroupListWithSize (ParamGGListWithSize paramGGListWithSize)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
ggSearch | 4.- Servicios de PAU#GGSearch | Lista de anagramas fiscales |
Parámetros de respuesta
Códigos error
GESTIONGROUPLIST_00 | Error durante el proceso de búsqueda de gestion group. |
GESTIONGROUPLIST_01 | El objeto paramGGList es nulo. |
GESTIONGROUPLIST_04 | No se han encontrado grupos de gestión para estos parámetros de búsqueda. |
Ejemplo de invocación
ParamGGListWithSize params = new ParamGGListWithSize();
GGSearch search = new GGSearch();
search.setDescription("descripción");
params.setGgSearch(search);
ResultGGListWithSize result = pauAgent.gestionGroupListWithSize(params);
Búsquedas y consultas de procedimientos
Método 'assignedProcedureListByOrganism'
Servicio que devuelve los procedimientos asociados a un usuario bajo un organismo.
Más detalles
Signatura
ResultGetAssignedProcedures assignedProcedureListByOrganism(ParamAssignedProcedureRoleList procedureSearchBean)
Parámetros de invocación
Parámetros de respuesta
Códigos error
PROCEDURELISTBYORGANISMROLE_00 | Error que proviene del webservices. |
PROCEDURELISTBYORGANISMROLE_01 | El objeto ParamAssignedProcedureRoleList es nulo |
PROCEDURELISTBYORGANISMROLE_02 | No existen procedimientos para los parámetros de busqueda |
PROCEDURELISTBYORGANISMROLE_03 | Error inesperado |
PROCEDURELISTBYORGANISMROLE_04 | El objeto procedureSearchBean es nulo |
Ejemplo de invocación
ParamAssignedProcedureRoleList paramAssignedProcedureRoleList = new ParamAssignedProcedureRoleList();
AssignedProcedureRoleVSearchBean procedureRoleSearchBean = new AssignedProcedureRoleVSearchBean();
procedureRoleSearchBean.setSignature("1");
paramAssignedProcedureRoleList.setProcedureRoleSearchBean(procedureRoleSearchBean);
ResultGetAssignedProcedures result = client.assignedProcedureListByOrganism(paramAssignedProcedureRoleList);
Método 'getProcedureAttributes'
Servicio que devuelve los atributos de un procedimiento del catálogo de la DGA en función de la información pasada como parámetro en el objeto ParamGetProcedureAttributes.
Estos atributos se consultan en DESFOR.
Más detalles
Signatura
ResultGetProcedureAttributes getProcedureAttributes(ParamGetProcedureAttributes paramGetProcedureAttributes)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
signature | String | Signature o código del procedimiento |
idEntity | String | Código de identificación de entidad. |
Parámetros de respuesta
Códigos error
PROCEDUREATTRIBUTES_00 | Error que proviene del webservices. |
PROCEDUREATTRIBUTES_01 | El objeto paramGetProcedureAttributes es nulo. |
PROCEDUREATTRIBUTES_02 | La signatura es nula. |
PROCEDUREATTRIBUTES_03 | El idEntity es nulo. |
Ejemplo de invocación
ParamGetProcedureAttributes params = new ParamGetProcedureAttributes();
params.setSignature("474");
params.setIdEntity("0");
ResultGetProcedureAttributes result = client.getProcedureAttributes(params);
Método 'procedureDetail'
Servicio que devuelve el detalle de un procedimiento de catálogo de la DGA dado en función de la información pasada como parámetro en el objeto ParamProcedureDetail.
Los datos del procedimiento se consultan en DESFOR.
Más detalles
Signatura
ResultProcedureDetail procedureDetail(ParamProcedureDetail paramProcedureDetail)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
signature | String | Signature o código del procedimiento |
Parámetros de respuesta
Códigos error
PROCEDUREDETAIL_00 | Error durante el proceso de búsqueda de procedure detail |
PROCEDUREDETAIL_01 | El objeto paramProcedureDetail es nulo |
PROCEDUREDETAIL_02 | No existe un procedimiento para esa signature |
PROCEDUREDETAIL_03 | La Signature es nula |
Ejemplo de invocación
ParamProcedureDetail params = new ParamProcedureDetail();
//se va a detallar por ejemplo el procedimiento de signatura 400
params.setSignature("400");
ResultProcedureDetail result = pauAgent.procedureDetail(params);
Método 'procedureDetail'
Servicio que devuelve el detalle de un procedimiento de catálogo de la DGA dado en función de la información pasada como parámetro en el objeto ParamProcedureDetailByIdEntity. Es similar al servicio 6.3.1.7, pero en este caso es obligatorio introducir como campo de búsqueda la entidad del procedimiento, además de la signatura.
Los datos del procedimiento se consultan en DESFOR.
Más detalles
Signatura
ResultProcedureDetail procedureDetail (ParamProcedureDetailByIdEntity paramProcedureDetailByIdEntity)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
idEntity | String | Código de la entidad asociada |
signature | String | Signature o código del procedimiento |
Parámetros de respuesta
Códigos error
PROCEDUREDETAILBYIDENTITY_00 | Error durante el proceso de búsqueda de procedure detail. |
PROCEDUREDETAILBYIDENTITY_01 | El objeto paramProcedureDetailByIdEntity es nulo. |
PROCEDUREDETAILBYIDENTITY_02 | La signatura es nula. |
PROCEDUREDETAILBYIDENTITY_03 | La entidad es nula. |
PROCEDUREDETAILBYIDENTITY_04 | Error que proviene del webservices |
Ejemplo de invocación
ParamProcedureDetailByIdEntity params = new
ParamProcedureDetailByIdEntity();
//se va a detallar por ejemplo el procedimiento de signatura 400
params.setSignature("400");
params.setIdEntity("0");
ResultProcedureDetail result = pauAgent.procedureDetail(params);
Método 'procedureDetailBySIACod'
Servicio que devuelve el detalle de un procedimiento del Catálogo de Procedimientos a partir del código SIA.
Los datos del procedimiento se consultan en DESFOR.
Más detalles
Signatura
ResultProcedureDetailSIA procedureDetailBySIACod(ParamProcedureDetailBySIACod paramProcedureDetailBySIACod)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
codSIA | String | Código SIA asociado |
Parámetros de respuesta
Códigos error
PROCEDUREDETAILBYSIA_00 | Error durante el proceso de búsqueda de procedureDetailBySIACod |
PROCEDUREDETAILBYSIA_01 | El objeto ParamProcedureDetailBySIACod es nulo |
PROCEDUREDETAILBYSIA_02 | No existe un procedimiento para ese código SIA |
PROCEDUREDETAILBYSIA_03 | El código SIA es nulo |
Ejemplo de invocación
ParamProcedureDetailBySIACod params = new ParamProcedureDetailBySIACod();
params.applicationId("PAU");
params.setCodSIA("213285");
ResultProcedureDetailSIA result = pauAgent.procedureDetailBySIACod(params);
Método 'procedureDetailList'
Servicio que devuelve el detalle para cada uno de los procedimientos de un listado a partir de parámetros de búsqueda.
Los datos de los procedimientos se consultan en DESFOR.
Más detalles
Signatura
ResultProcedureDetailList procedureDetailList (ParamProcedureDetailList paramProcedureDetailList)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
procedureSearch | ProcedureSearch | Objeto procedureSearch. Contiene criterios de búsqueda de Procedure, así como los parámetros de paginación y ordenación. |
Parámetros de respuesta
Códigos error
PROCEDUREDETAILLIST_00 | Error en el proceso de búsqueda de listado de procedimientos |
PROCEDUREDETAILLIST_01 | El objeto paramProcedureDetailList es nulo. |
PROCEDUREDETAILLIST_02 | No existen procedimientos para los parámetros de búsqueda. |
PROCEDUREDETAILLIST_03 | El id de la entidad es nulo |
Ejemplo de invocación
ParamProcedureDetailList params = new ParamProcedureDetailList();
ProcedureSearch procedureSearch = new ProcedureSearch();
procedureSearch.setIdEntidad("0");
procedureSearch.setDenomination("registro oficial");
params.setProcedureSearch(procedureSearch);
ResultProcedureDetailList
result=pauAgent.procedureDetailList(params);
Método 'procedureDetailWithManagingOrganismList'
Busca procedimientos junto a sus organismos gestores.
Los datos de los procedimientos se consultan en DESFOR.
Más detalles
Signatura
ResultProcedureDetailList procedureDetailList (ParamProcedureDetailList paramProcedureDetailList)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
signatures | String[] | Códigos de los procedimiento de los que se quiere obtener el detalle |
idEntity | String | Código de la entidad asociada |
Parámetros de respuesta
Códigos error
PROCEDURELIST_01 | El objeto ParamSignaturesAndIdEntity es nulo |
PROCEDURELIST_03 | El objeto signatures es nulo |
PROCEDURELIST_05 | El objeto signatures está vacío |
PROCEDURELIST_06 | No se han encontrado procedimientos para los parámetros de búsqueda. |
Ejemplo de invocación
GestionGroup gestionGroup = new GestionGroup();
gestionGroup.setName("nombre GG");
gestionGroup.setDescription("descripción GG");
Procedure procedure1 = new Procedure();
procedure1.setSignature("1");
procedure1.setDenomination("den1");
Método 'procedureDetailWithSIA'
Servicio que devuelve el detalle de un procedimiento del Catálogo de Procedimientos incluyendo el código SIA.
Los datos de los procedimientos se consultan en DESFOR.
Más detalles
Signatura
ResultProcedureDetailSIA procedureDetailWithSIA(ParamProcedureDetailByIdEntity paramProcedureDetail)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
idEntity | String | Código de la entidad asociada |
signature | String | Código del procedimiento que se quiere obtener el detalle |
Parámetros de respuesta
Códigos error
PROCEDUREDETAILSIA_00 | Error durante el proceso de búsqueda de procedure detail |
PROCEDUREDETAILSIA_01 | El objeto paramProcedureDetail es nulo |
PROCEDUREDETAILSIA_02 | No existe un procedimiento para esa signature |
PROCEDUREDETAILSIA_03 | La Signature es nula |
PROCEDUREDETAILSIA_04 | La Entidad es nula |
Ejemplo de invocación
ParamProcedureDetailByIdEntity params = new ParamProcedureDetailByIdEntity();
params.applicationId("PAU");
params.setfiscalAnagram("11111111H");
params.setSignature("400");
params.setIdEntity("0");
ResultProcedureDetailSIA result = pauAgent.procedureDetailWithSIA(params);
Método 'procedureList'
Servicio que devuelve un listado de procedimientos publicados y despublicados del catálogo por la DGA en función de la información pasada como parámetro en el objeto ParamProcedureList.
Los datos de los procedimientos se consultan en DESFOR.
Más detalles
Signatura
ResultProcedureList procedureList(ParamProcedureList paramProcedureList)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
procedureSearch | 4.- Servicios de PAU#ProcedureSearch | Objeto ProcedureSearch, campos de búsqueda para procedimientos |
Parámetros de respuesta
Códigos error
PROCEDURELIST_00 | Error durante el proceso de búsqueda de procedure |
PROCEDURELIST_01 | El objeto paramProcedureList es nulo |
PROCEDURELIST_02 | Error que proviene del webservices |
PROCEDURELIST_03 | El objeto ProcedureSearch es nulo |
Ejemplo de invocación
ParamProcedureList params = new ParamProcedureList();
ProcedureSearch procedureSearch = new ProcedureSearch();
procedureSearch.setSignature("");
procedureSearch.setVersion("");
procedureSearch.setIdOrgano("");
params.setProcedureSearch(procedureSearch);
ResultProcedureList result = pauAgent.procedureList(params);
Método 'procedureList1'
Servicio que devuelve un listado de procedimientos dados de alta en catálogo por la DGA en función de la información pasada como parámetro en el objeto ParamProcedureListByUser. Es similar al servicio referenciado en el punto 6.3.1.2, siendo obligatorio introducir el campo “idEntidad”.
Los datos de los procedimientos se consultan en DESFOR.
Más detalles
Signatura
ResultProcedureList procedureList(ParamProcedureListAndEntity paramProcedureListAndEntity)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
procedureSearch | 4.- Servicios de PAU#ProcedureSearch | Objeto ProcedureSearch, campos de búsqueda para procedimientos |
Parámetros de respuesta
Códigos error
PROCEDURELIST_00 | Error durante el proceso de búsqueda de procedure |
PROCEDURELIST_01 | El objeto paramProcedureList es nulo |
PROCEDURELIST_02 | Error que proviene del webservices |
PROCEDURELIST_03 | El objeto ProcedureSearch es nulo |
PROCEDURELIST_04 | El parámetro idEntidad es nulo |
Ejemplo de invocación
ParamProcedureListAndIdEntity params = new ParamProcedureListAndIdEntity();
ProcedureSearch procedureSearch = new ProcedureSearch();
procedureSearch.setSignature("");
procedureSearch.setVersion("");
procedureSearch.setIdOrgano("");
procedureSearch.setIdEntidad("0");
params.setProcedureSearch(procedureSearch);
ResultProcedureList result = pauAgent.procedureList(params);
Método 'procedureListbyAplicationAndIdEntity'
Servicio que devuelve un listado de procedimientos existentes asociados a una aplicación y con una entidad suministrada.
Estos procedimientos no se consultan en DESFOR.
Más detalles
Signatura
VResultProcedureRoleList procedureListByAplicationAndIdEntity(VParamProcedureRoleList vparamProcedureRoleList)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
procedureSearchBean | 4.- Servicios de PAU#VProcedureRoleSearchBean | Objeto VProcedureRoleSearchBean, campos de búsqueda para procedimientos |
Parámetros de respuesta
Códigos error
PROCEDURELISTBYAPLICATIONANDIDENTITY_00 | Error durante el proceso de búsqueda |
PROCEDURELISTBYAPLICATIONANDIDENTITY_01 | El objeto ParamAssignedProcedureRoleList es nulo |
PROCEDURELISTBYAPLICATIONANDIDENTITY_02 | No hay procedimientos relacionados con estos parámetros de búsqueda |
PROCEDURELISTBYAPLICATIONANDIDENTITY_03 | Ha ocurrido algún tipo de error al listar los procedimientos |
PROCEDURELISTBYAPLICATIONANDIDENTITY_04 | El objeto procedureSearchBean es nulo |
Ejemplo de invocación
VParamProcedureRoleList params = new VParamProcedureRoleList();
params.setApplicationId("SFE");
params.setFiscalAnagram("00000000T");
VProcedureRoleSearchBean procedureSearchBean= new VProcedureRoleSearchBean();
procedureSearchBean.setAppAlias("SFE");
procedureSearchBean.setEntity("0");
params.setProcedureSearchBean(procedureSearchBean);
VResultProcedureRoleList result = client.procedureListByAplicationAndIdEntity(params);
Método 'ProcedureListByOrganism'
Servicio que devuelve la lista de procedimientos de Catálogo de la DGA cuyo organismo productor sea el indicado en el objeto ParamProcedureListByOrganism. Además de los procedimientos correspondientes al organismo productor indicado, también se devuelven los procedimientos horizontales.
Los datos de los procedimientos se consultan en DESFOR.
Más detalles
Signatura
ResultProcedureListByOrganism procedureListByOrganism(ParamProcedureListByOrganism paramProcedureListByOrganism)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método. |
fiscalAnagram | String | Anagrama fiscal. |
organismCode | String | Código de organismo del que se quieren obtener sus procedimientos asociados. |
idEntity | String | Código de identificación de entidad. |
Parámetros de respuesta
Códigos error
PROCEDURELISTBYORGANISM_00 | Error durante el proceso de búsqueda de procedure by organism. |
PROCEDURELISTBYORGANISM_01 | El objeto paramProcedureListByOrganism es nulo. |
PROCEDURELISTBYORGANISM_02 | El organismCode es nulo. |
PROCEDURELISTBYORGANISM_03 | El idEntity es nulo. |
PROCEDURELISTBYORGANISM_04 | El organismo no tiene procedimientos asociados. |
Ejemplo de invocación
ParamProcedureListByOrganism params = new
ParamProcedureListByOrganism();
//se van a listar, por ejemplo, los procedimientos del organismo “ORG04174” y la entidad “0”
params.setOrganismCode("ORG04174");
params.setIdEntity("0");
ResultProcedureListByOrganism result =
client.procedureListByOrganism(params);
Método 'procedureListByUser'
Servicio que devuelve los procedimientos de catálogo a los que un usuario puede acceder en función del grupo de gestión al que esté asignado.
Los datos de los procedimientos se consultan en DESFOR.
Más detalles
Signatura
ResultProcedureListByUser procedureListByUser(ParamProcedureListByUser paramProcedureListByUser)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
Parámetros de respuesta
Códigos error
PROCEDURELISTBYUSER_00 | Error durante el proceso de búsqueda de procedure by user. |
PROCEDURELISTBYUSER_01 | El objeto paramProcedureListByUser es nulo. |
PROCEDURELISTBYUSER_02 | El fiscal anagrama es nulo. |
PROCEDURELISTBYUSER_03 | El usuario no existe en la base de datos |
PROCEDURELISTBYUSER_04 | Error que proviene del webservices |
Ejemplo de invocación
ParamProcedureListByUser params = new ParamProcedureListByUser();
params.setFiscalAnagram("anagrama fiscal");
ResultProcedureListByUser result = pauAgent.procedureListByUser(params);
Método 'procedureListByUser1'
Servicio que devuelve los procedimientos de catálogo a los que un usuario puede acceder en función del grupo de gestión al que esté asignado y a su entidad correspondiente. Es similar al servicio procedureListByUser, pero en este es último es solamente necesario el anagrama fiscal como parámetro de búsqueda.
Los datos de los procedimientos se consultan en DESFOR.
Más detalles
Signatura
ResultProcedureListByUser procedureListByUser(ParamProcedureListByUserAndEntity paramProcedureListByUserAndEntity)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
idEntity | String | Código de la entidad asociada |
Parámetros de respuesta
Códigos error
PROCEDURELISTBYUSER_00 | Error durante el proceso de búsqueda de procedure by user |
PROCEDURELISTBYUSER_01 | El objeto paramProcedureListByUser es nulo |
PROCEDURELISTBYUSER_02 | El fiscal anagrama es nulo |
PROCEDURELISTBYUSER_03 | El usuario no existe en la base de datos |
PROCEDURELISTBYUSER_04 | Error que proviene del webservices |
PROCEDURELISTBYUSER_05 | El id de la entidad es nulo |
Ejemplo de invocación
ParamProcedureListByUserAndEntity params = new ParamProcedureListByUserAndEntity();
params.setFiscalAnagram("72979986C");
params.setIdEntity("0");
ResultProcedureListByUser result = pauAgent.procedureListByUser(params);
Método 'proceduresByGestionGroup'
Servicio que devuelve la lista de procedimientos de Catálogo de la DGA del grupo de gestión pasado como parámetro en el objeto ParamGGList. Además de los procedimientos correspondientes al grupo de gestión indicado, también se devuelven los procedimientos horizontales.
Los datos de los procedimientos se consultan en DESFOR. Los grupos de gestión se consultan en PAU.
Más detalles
Signatura
ResultProcedureDetailList proceduresByGestionGroup(ParamGGList paramGGList)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
ggSearch | GGSearch | Objeto de búsqueda del grupo de gestión |
Parámetros de respuesta
Códigos error
GESTIONGROUPLIST_00 | Error en la operación. Error durante el proceso de búsqueda. |
GESTIONGROUPLIST_01 | El objeto ParamGGList es nulo. |
GESTIONGROUPLIST_04 | Error en la operación. No se han encontrado grupos de gestión para estos parámetros de búsqueda. |
Ejemplo de invocación
ParamGGList params = new ParamGGList();
GGSearch ggSearch = new GGSearch();
ggSearch.setGgCode("CODE01");
params.setGgSearch(ggSearch);
ResultProcedureDetailList result=pauAgent.proceduresByGestionGroup (params);
Método 'procedurePublishedList'
Servicio que devuelve un listado de procedimientos publicados en el catálogo por la DGA en función de la información pasada como parámetro en el objeto ParamProcedureList.
Los datos de los procedimientos se consultan en DESFOR.
Más detalles
Signatura
ResultProcedureList procedurePublishedList(ParamProcedureList paramProcedureList)
Parámetros de invocación
Nombre | Tipo | Descripción |
---|
applicationId | String | Aplicación que ejecuta el método |
fiscalAnagram | String | Anagrama fiscal |
procedureSearch | 4.- Servicios de PAU#ProcedureSearch | Objeto ProcedureSearch, campos de búsqueda para procedimientos |
Parámetros de respuesta
Códigos error
PROCEDURELIST_00 | Error durante el proceso de búsqueda de procedure |
PROCEDURELIST_01 | El objeto paramProcedureList es nulo |
PROCEDURELIST_02 | Error que proviene del webservices |
PROCEDURELIST_03 | El objeto ProcedureSearch es nulo |
Ejemplo de invocación
ParamProcedureList params = new ParamProcedureList();
ProcedureSearch procedureSearch = new ProcedureSearch();
procedureSearch.setSignature("1");
params.setProcedureSearch(procedureSearch);
ResultProcedureList result = pauAgent.procedurePublishedList(params);
Anexos
Objetos comunes
Objeto 'Action'
actionCode | String | Código de acción |
alias | String | Nombre de la acción |
description | String | Descripción de la acción |
applicationName | String | Nombre de la aplicación |
applicationAlias | String | Alias de la aplicación |
Objeto 'ActionSearch'
Objeto 'AdmRole'
admRoleCode | String | Código de rol |
name | String | Nombre del rol |
description | String | Descripción |
Objeto 'AdmRoleSearch'
Objeto 'Application'
alias | String | Alias aplicación |
name | String | Nombre |
ips | Ip[] | Lista de direcciónes Ip |
description | String | Descripción |
version | String | Versión |
responseUrl | String | Url asociada a la aplicación |
organismCodeOwner | String | Código de organismo asociado |
methods | 4.- Servicios de PAU#Method[] | Lista de métodos |
Objeto 'ApplicationGG'
applicationAlias | String | Alias de la aplicación |
ggCode | String | Código del grupo de gestión |
ggName | String | Nombre del grupo de gestión |
admRoleCode | String | Código del rol |
admRoleName | String | Nombre del rol |
Objeto 'ApplicationGGSearch'
Objeto 'ApplicationRelation'
applicationAliasA | String | Alias aplicación A |
applicationAliasB | String | Alias aplicación B |
applicationNameA | String | Nombre aplicación A |
applicationNameB | String | Nombre aplicación B |
methods | 4.- Servicios de PAU#Method[] | Lista de métodos |
Objeto 'ApplicationRelationSearch'
Objeto 'ApplicationSearch'
Objeto 'AppRole'
Nombre | Tipo | Descripción |
---|
roleCode | String | Código del rol de la aplicación |
name | String | Nombre del rol |
descripcion | String | Descripción del rol |
applicationAlias | String | Alias de la aplicación |
roleType | int | Tipo de rol |
actions | Action[] | Lista de objetos Action |
Objeto 'AssignedProcedureRoleVSearchBean'
Objeto 'AssignedRole'
fiscalAnagram | String | Anagrama fiscal del usuario |
organismCode | String | Código de organismo |
roleCode | String | Código de rol |
roleName | String | Nombre del rol |
appAlias | String | Alias de la aplicación |
Objeto 'AssignedRoleSearch'
Objeto 'AssignedRolesToUser'
fiscalAnagram | String | Anagrama fiscal del usuario |
assignedRoleList | AssignedRole[] | Lista de objetos AssignedRole |
Objeto 'AssignedRoleTreeSearch'
Objeto 'AssignedRolesUserListSearch'
fiscalAnagramList | String[] | Lista de anagramas fiscales |
assignedRole | AssignedRole | Objeto AssignedRole |
Objeto 'GestionGroup'
ggCode | String | Código del grupo |
name | String | Nombre del grupo de gestión |
description | String | Descripción del grupo |
procedure | 4.- Servicios de PAU#Procedure[] | Lista de procedimientos |
Objeto 'GGSearch'
Objeto 'Ip'
address | String | Dirección Ip |
Objeto 'Method'
methodCode | String | Código asociado al método |
name | String | Nombre del método |
description | String | Descripción del método |
service | String | Nombre del servicio al que corresponde el método |
Objeto 'Procedure'
signature | String | Signatura del procedimiento |
denomination | String | Denominación del procedimiento |
servicio | String | Servicio asociado al procedimiento |
idEntidad | String | Código de la entidad |
idOrgano | String | Código del órgano del catálogo |
version | String | Versión |
descOrgano | String | Descripción del órgano del catálogo |
xmlData | String |
|
procedureAttributes | ProcedureAttributes[] | Lista de atributos del procedimiento |
Objeto 'ProcedureAttributes'
code | String | Código del atributo del procedimiento |
value | String | Valor del atributo del procedimiento |
Objeto 'VProcedureRole'
fiscalAnagram | String | Fiscal anagram del usuario al que se asocia el procedimiento |
signature | String | Signatura del procedimiento |
denomination | String | Denominación del procedimiento |
entity | String | Código de la entidad |
admRole | String | Código del perfil administrativo |
admName | String | Nombre del perfil administrativo |
organismCode | String | Código del organismo bajo el que se ha asociado el procedimiento al usuario |
appAlias | String | Identificador de la aplicación (por el momento solo lo usa SFE) |
Objeto 'VProcedureRoleSearchBean'
fiscalAnagram | String | Fiscal anagram del usuario al que se asocia el procedimiento |
signature | String | Signatura del procedimiento |
denomination | String | Denominación del procedimiento |
entity | String | Código de la entidad |
admRole | String | Código del perfil administrativo |
admName | String | Nombre del perfil administrativo |
organismCode | String | Código del organismo bajo el que se ha asociado el procedimiento al usuario |
appAlias | String | Identificador de la aplicación (por el momento solo lo usa SFE) |
param | 4.- Servicios de PAU#SearchParams | Objeto SearchParams |
Objeto 'ProcedureSearch'
Objeto 'ProcedureSIA'
Objeto 'ResultError'
errors | boolean | Indica si hay errores o no |
errorMsg | String | Mensaje de error devuelto |
errorCode | String | Código de error devuelto |
Objeto 'Role'
roleCode | String | Código del rol |
name | String | Nombre del rol |
descripcion | String | Descripción del rol |
applicationAlias | String | Alias de la aplicación |
actions | 4.- Servicios de PAU#Action[] | Lista de acciones |
roleType | Integer | Tipo de rol |
Objeto 'RoleSearch'
Objeto 'RoleOrganism'
Nombre | Tipo | Descripción |
---|
organismCode | String | Código del organismo al que pertenece el rol |
roleName | String | Nombre del rol |
roleCode | String | Código del rol |
Objeto 'SearchParams'
sortColumn | String | Columna por la que queremos ordenar |
ascending | Boolean | Indica si el orden de ordenación es ascendente |
fromIndex | Integer | Índice desde el que queremos buscar |
toIndex | Integer | Índice hasta que el que queremos buscar |
Objeto 'User'
Objeto 'UserCon'
| Tipo | Descripción |
---|
fiscalAnagram | String | Anagrama fiscal |
applicationAlias | String | Alias de la aplicación |
lastConnection | Date | Objeto Date de la última conexión |
Objeto 'UserConSearch'
Objeto 'UserGG'
fiscalAnagram | String | Anagrama fiscal del usuario |
ggCode | String | Código del grupo de gestión |
admRoleCode | String | Código del rol |
ggName | String | Nombre del grupo de gestión |
admRoleName | String | Nombre del rol |
Objeto 'UserGGSearch'
Objeto 'UserList'
Nombre | Tipo | Descripción |
---|
fiscalAnagram | String | Anagrama fiscal del usuario |
email | String | Email del usuario |