Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

(En construcción)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

Table of Contents
maxLevel3


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.


Expand
titleMás detalles

Signatura

ResultApplicationList applicationList(ParamApplicationList paramApplicationList)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
applicationSearch1242693904Objeto ApplicationSearch


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
applications1242693904[]Lista de objetos Application
sizeintTamaño de la lista applications devuelta


Códigos error



Código
Descripción
APPLICATIONLIST_00Error durante el proceso de búsqueda de aplicaciones.
APPLICATIONLIST_01El objeto ParamApplicationList es nulo.
APPLICATIONLIST_02No se han encontrado aplicaciones para estos parámetros de búsqueda.
APPLICATIONLIST_03Ha ocurrido algún error al realizar la búsqueda.
APPLICATIONLIST_04Error de paginación al realizar la búsqueda.


Ejemplo de invocación

Code Block
languagejava
titleEjemplo 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.


Expand
titleMás detalles

Signatura

ResultApplicationRelationList applicationRelationList (ParamApplicationRelationList paramApplicationRelationList)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
applicationRelationSearch1242693904Objeto ApplicationRelationSearch


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
applicationRelations1242693904[]Lista de objetos ApplicationRelation
sizeintTamaño de la lista applicationRelations devuelta


Códigos error



Código
Descripción
APPLICATIONRELATIONLIST_00Error durante el proceso de búsqueda de relaciones entre aplicaciones
APPLICATIONRELATIONLIST_01El objeto ParamApplicationRelationList es nulo
APPLICATIONRELATIONLIST_02No se han encontrado relaciones entre aplicaciones para estos parámetros de búsqueda
APPLICATIONRELATIONLIST_03Ha ocurrido algún error al realizar la búsqueda.


Ejemplo de invocación

Code Block
languagejava
titleEjemplo 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.


Expand
titleMás detalles

Signatura

ResultAuthorizeApplication authorizeApplication(ParamAuthorizeApplication paramAuthorizeApplication)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
applicationAliasAStringAlias aplicación A
applicationAliasBStringAlias aplicación B
methodCodeStringCódigo del método
ipStringDirección Ip


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError


Códigos error



Código
Descripción
AUTHORIZEAPPLICATION_00Error durante el proceso de autorización.
AUTHORIZEAPPLICATION_01El parámetro alias de la aplicación la aplicación A es nulo.
AUTHORIZEAPPLICATION_02El parámetro alias de la aplicación B es nulo.
AUTHORIZEAPPLICATION_03El parámetro methodCode es nulo.
AUTHORIZEAPPLICATION_04El parámetro Ip es nulo.
AUTHORIZEAPPLICATION_05No existe una relación entre aplicaciones.
AUTHORIZEAPPLICATION_06La ip no está en la lista de ip's permitidas.


Ejemplo de invocación

Code Block
languagejava
titleEjemplo 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.


Expand
titleMás detalles

Signatura

ResultMethodApplicationList methodApplicationList (ParamMethodApplicationList paramMethodApplicationList)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
applicationAliasStringAlias de la aplicación


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
methods1242693904[]Lista de objetos Method, métodos de la aplicación
ips1242693904[]Lista de objetos Ip, Ips de la aplicación


Códigos error



Código
Descripción
METHODAPPLICATIONLIST_00Error durante el proceso de búsqueda
METHODAPPLICATIONLIST_01El objeto ParamMethodApplicationList es nulo
METHODAPPLICATIONLIST_02No hay Ips ni métodos asociados a la aplicación
METHODAPPLICATIONLIST_03Ha ocurrido algún error al realizar la búsqueda
METHODAPPLICATIONLIST_04El Alias de la Aplicación es nulo


Ejemplo de invocación

Code Block
languagejava
titleEjemplo 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.


Expand
titleMás detalles

Signatura

ResultActionList actionList(ParamActionList paramActionList)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
actionSearch1242693904Objeto ActionSearch


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
actions1242693904[]Lista de objetos Action
sizeintTamaño de la lista actions devuelta


Códigos error



Código
Descripción
ACTIONLIST_00Ha ocurrido algún error al realizar la búsqueda
ACTIONLIST_01El objeto paramActionList es nulo
ACTIONLIST_02No se han encontrado acciones con los parámetros de búsqueda indicados


Ejemplo de invocación

Code Block
languagejava
titleEjemplo 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.


Expand
titleMás detalles

Signatura

ResultAdmRoleList admRoleList(ParamAdmRoleList paramAdmRoleList)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
admRoleSearch1242693904Objeto AdmRoleSearch con campos de búsqueda


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
admRole1242693904[]Lista de objetos AdmRole, con los datos de los roles
sizeintTamaño de la lista admRole devuelta


Códigos error



Código
Descripción
ADMROLELIST_00Error durante el proceso de búsqueda
ADMROLELIST_01El objeto ParamAdmRoleList es nulo
ADMROLELIST_02No existe ningún administrador de rol para esos parámetros de búsqueda
ADMROLELIST_03Ha ocurrido algún tipo de error al buscar el rol en la base de datos


Ejemplo de invocación

Code Block
languagejava
titleEjemplo 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.


Expand
titleMás detalles

Signatura

ResultAssignedRoleList assignedRoleList(ParamAssignedRoleList paramAssignedRoleList)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
assignedRoleSearch1242693904Objeto AssignedRoleSearch con campos de búsqueda


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
assignedRoles1242693904[]Lista de objetos AssignedRole, con los datos de los roles
sizeintTamaño de la lista assignedRoles devuelta


Códigos error



Código
Descripción
ASSIGNEDROLELIST_00Error durante el proceso de búsqueda de roles asignados
ASSIGNEDROLELIST_01El objeto paramAssignedRoleList es nulo
ASSIGNEDROLELIST_02No se han encontrado asignaciones para esos parámetros de búsqueda.
ASSIGNEDROLELIST_03Ha ocurrido algún error al realizar la búsqueda.
ASSIGNEDROLELIST_04Debe indicarse el código de organismo


Ejemplo de invocación

Code Block
languagejava
titleEjemplo 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.


Expand
titleMás detalles

Signatura

ResultAssignedRoleList assignedRoleList(ParamAssignedRoleListByBranch paramAssignedRoleListByBranch)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
assignedRoleTreeSearch1242693904Objeto AssignedRoleTreeSearch con campos de búsqueda
organismCodeStringCódigo de organismo


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
assignedRoles1242693904[]Lista de objetos AssignedRole, con los datos de los roles
sizeintTamaño de la lista assignedRoles devuelta


Códigos error



Código
Descripción
ASSIGNEDROLELIST_00Error durante el proceso de búsqueda de roles asignados
ASSIGNEDROLELIST_01El objeto paramAssignedRoleList es nulo
ASSIGNEDROLELIST_02No se han encontrado asignaciones para esos parámetros de búsqueda.
ASSIGNEDROLELIST_03Ha ocurrido algún error al realizar la búsqueda.
ASSIGNEDROLELIST_04Debe indicarse el código de organismo


Ejemplo de invocación

Code Block
languagejava
titleEjemplo 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.


Expand
titleMás detalles

Signatura

ResultAssignedRoleList assignedRoleList(ParamAssignedRoleListByTree paramAssignedRoleListByTree)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
assignedRoleTreeSearch1242693904Objeto AssignedRoleTreeSearch con campos de búsqueda
organismCodeStringCódigo de organismo


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
assignedRoles1242693904[]Lista de objetos AssignedRole, con los datos de los roles
sizeintTamaño de la lista assignedRoles devuelta


Códigos error



Código
Descripción
ASSIGNEDROLELIST_00Error durante el proceso de búsqueda de roles asignados
ASSIGNEDROLELIST_01El objeto paramAssignedRoleList es nulo
ASSIGNEDROLELIST_02No se han encontrado asignaciones para esos parámetros de búsqueda.
ASSIGNEDROLELIST_03Ha ocurrido algún error al realizar la búsqueda.
ASSIGNEDROLELIST_04Debe indicarse el código de organismo


Ejemplo de invocación

Code Block
languagejava
titleEjemplo 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.


Expand
titleMás detalles

Signatura

ResultAssignedRolesUserList assignedRolesUserList(ParamAssignedRolesUserList paramAssignedRoleUserList)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
assignedRolesUserListSearch

1242693904

Objeto AssignedRolesUserListSearch con campos de búsqueda


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
assignedRolesToUserList1242693904[]Lista de objetos AssignedRolesToUser, con los datos de los roles


Códigos error



Código
Descripción
ASSIGNEDROLESUSERLIST_00Error durante el proceso de búsqueda de roles asignados
ASSIGNEDROLESUSERLIST_01El objeto paramAssignedRolesUserList es nulo
ASSIGNEDROLESUSERLIST_02Los parámetros de búsqueda son nulos o no se ha definido ningún usuario (anagramas fiscales).
ASSIGNEDROLESUSERLIST_03Ha ocurrido algún error al realizar la búsqueda.


Ejemplo de invocación

Code Block
languagejava
titleEjemplo 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.


Expand
titleMás detalles

Signatura

ResultAuthorize authorize(ParamAuthorize paramAuthorize)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
organismCodeStringCódigo de organismo
applicationAliasStringAlias de la aplicación


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
role1242693904[]Lista de objetos Role, con los datos de los roles


Códigos error



Código
Descripción
AUTHORIZE_00Error durante el proceso de autorización
AUTHORIZE_01El objeto ParamAuthorize es nulo.
AUTHORIZE_02El parámetro alias de aplicación es nulo.
AUTHORIZE_03El parámetro anagrama fiscal es nulo.
AUTHORIZE_04El parámetro código de organismo es nulo.
AUTHORIZE_05No existen datos para ese usuario u organismo.
AUTHORIZE_06El funcionario no tiene roles para esa aplicación y organismo.
AUTHORIZE_07Ha ocurrido algún tipo de error al buscar el rol en la base de datos.


Ejemplo de invocación

Code Block
languagejava
titleEjemplo 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.


Expand
titleMás detalles

Signatura

ResultGetLastConnection getLastConnection(ParamGetLastConnection paramGetLastConnection)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
userConSearch1242693904El objeto UserConSearch, contiene criterios de búsqueda de UserCon, así como los parámetros de paginación y ordenación.


Parámetros de respuesta


NombreTipoDescripción
resultError1242693904Objeto ResultError
userCon

1242693904

Objeto con la información de la última conexión de usuario.


Códigos error


Código
Descripción
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

Code Block
languagejava
titleEjemplo 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.


Expand
titleMás detalles

Signatura

ResultRoleList roleList(ParamRoleList paramRoleList)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
roleSearch1242693904Objeto ParamRoleList con campos de búsqueda


Parámetros de respuesta


NombreTipoDescripción
resultError1242693904Objeto ResultError
roles

1242693904[]

Listado de roles encontrados
sizeintTamaño del listado


Códigos error


Código
Descripción
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


Code Block
languagejava
titleEjemplo 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.



Expand
titleMás detalles

Signatura

ResultUserByOrganismTree userByOrganismTree(ParamUserByOrganismTree paramUserByOrganismTree)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
organismsCodeTreeString[]Lista de códigos de organismos a los que puede pertenecer el usuario
roleNameStringNombre del rol
applicationAliasStringAlias de la aplicación


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
user1242693904[]Lista de objetos User.


Códigos error



Código
Descripción
USERSORGANISMTREE_01El objeto paramUserByOrganismTree es nulo.
USERSORGANISMTREE_00Error durante el proceso de búsqueda
USERSORGANISMTREE_02La lista de organismos está vacía o es nula.
USERSORGANISMTREE_03No se ha encontrado ningún rol para esos parámetros de búsqueda.
USERSORGANISMTREE_04El alias de la aplicación es nulo
USERSORGANISMTREE_05El rol no existe en el sistema
USERSORGANISMTREE_06El nombre del rol es nulo


Ejemplo de invocación

Code Block
languagejava
titleEjemplo 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.


Expand
titleMás detalles

Signatura

ResultUserByOrganismTreeExtended userByOrganismTreeExtended( ParamUserByOrganismTreeExtended  paramUserByOrganismTree)


Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
organismsCodeTreeString[]Lista de códigos de organismos a los que puede pertenecer el usuario
roleNameString[]Nombre de roles por los que se filtrará
applicationAliasStringAlias de la aplicación


Parámetros de respuesta


NombreTipoDescripción
resultError1242693904Objeto ResultError
user1242693904[]Lista de objetos User


Códigos error


Código
Descripción
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

Code Block
languagejava
titleEjemplo 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.



Expand
titleMás detalles

Signatura

ResultUserListByProcedureAndRole userListByProcedureAndRole (ParamUserListByProcedureAndRole paramUserListByProcedureAndRole )


Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
signatureStringProcedimiento asociado al Grupo de Gestión.
entityStringIdentificador de la entidad del procedimiento
roleCodeString[]Listado de Roles asociados a los usuarios


Parámetros de respuesta


NombreTipoDescripción
resultError1242693904Objeto ResultError
userList1242693904[]Listado de usuarios obtenidos.


Códigos error


Código
Descripción
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

Code Block
languagejava
titleEjemplo 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.


Expand
titleMás detalles

Signatura

ResultGGList gestionGroupList(ParamGGList paramGGList)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
ggSearch1242693904Objeto GGSearch


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
gestionGroup1242693904[]Lista de objetos GestionGroup


Códigos error



Código
Descripción
GESTIONGROUPLIST_00Error durante el proceso de búsqueda de gestion group.
GESTIONGROUPLIST_01El objeto paramGGList es nulo.
GESTIONGROUPLIST_04No se han encontrado grupos de gestión para estos parámetros de búsqueda.


Ejemplo de invocación

Code Block
languagejava
titleEjemplo 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.


Expand
titleMás detalles

Signatura

ResultGestionGroupListByApplication gestionGroupListByApplication (ParamGestionGroupListByApplication paramGestionGroupListByApplication)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
applicationGGSearch1242693904Objeto ApplicationGGSearch
params1242693904Objeto SearchParams


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
applicationGG1242693904[]Lista de objetos ApplicationGG (grupos de gestión)
sizeintTamaño de la lista applicationGG devuelta


Códigos error



Código
Descripción
GESTIONGROUPLISTBYAPPLICATION_00Error durante el proceso de búsqueda
GESTIONGROUPLISTBYAPPLICATION_01El parámetro paramGestionGroupListByApplication es nulo
GESTIONGROUPLISTBYAPPLICATION_02El parámetro alias de la aplicación es nulo
GESTIONGROUPLISTBYAPPLICATION_03No se han encontrado grupos de gestión para esa aplicación
GESTIONGROUPLISTBYAPPLICATION_04Ha ocurrido algún error en el proceso de búsqueda


Ejemplo de invocación

Code Block
languagejava
titleEjemplo 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.


Expand
titleMás detalles

Signatura

ResultGestionGroupListByUser gestionGroupListByUser(ParamGestionGroupListByUser paramGestionGroupListByUser)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
userGGSearch1242693904Objeto UserGGSearch
paramsSearchParamsObjeto SearchParams


Parámetros de respuesta


NombreTipoDescripción
resultErrorResultErrorObjeto ResultError
ggUserListUserGG[]Lista de objetos UserGG
sizeintTamaño de la lista ggUserList devuelta


Códigos error


Código
Descripción
GESTIONGROUPLISTBYUSER_00Error durante el proceso de búsqueda de gestion group.
GESTIONGROUPLISTBYUSER_01El objeto ParamGestionGroupListByUser es nulo.
GESTIONGROUPLISTBYUSER_02El fiscalAnagram es nulo.
GESTIONGROUPLISTBYUSER_03No se han encontrado grupos de gestión para ese usuario.
GESTIONGROUPLISTBYUSER_04Ha ocurrido algún error en el proceso de búsqueda.
GESTIONGROUPLISTBYUSER_05La lista de anagramas fiscales es nula o esta vacía.


Ejemplo de invocación

Code Block
languagejava
titleEjemplo 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.


Expand
titleMás detalles

Signatura

ResultGestionGroupListByUser gestionGroupListByUserLike(ParamGestionGroupListByUser paramGestionGroupListByUser)


Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
userGGSearch

1242693904

Filtro de búsqueda para el objeto UserGG


Parámetros de respuesta


NombreTipoDescripción
resultError1242693904Objeto ResultError
ggUserList1242693904[]Lista de objetos UserGG
sizeintTamaño de la lista ggUserList devuelta


Códigos error


Código
Descripción
GESTIONGROUPLISTBYUSER_00Error durante el proceso de búsqueda de gestion group.
GESTIONGROUPLISTBYUSER_01El objeto ParamGestionGroupListByUser es nulo.
GESTIONGROUPLISTBYUSER_02El fiscalAnagram es nulo.
GESTIONGROUPLISTBYUSER_03No se han encontrado grupos de gestión para ese usuario.
GESTIONGROUPLISTBYUSER_04Ha ocurrido algún error en el proceso de búsqueda.
GESTIONGROUPLISTBYUSER_05La lista de anagramas fiscales es nula o esta vacía.


Ejemplo de invocación

Code Block
languagejava
titleEjemplo 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.

Expand
titleMás detalles

Signatura

ResultGGList gestionGroupListWithoutProcedures(ParamGGList paramGGList)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
ggSearch1242693904Objeto GGSearch


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
gestionGroup1242693904[]Lista de objetos GestionGroup


Códigos error



Código
Descripción
GESTIONGROUPLIST_01El objeto paramGGList es nulo
GESTIONGROUPLIST_00Error durante el proceso de búsqueda de gestion group
GESTIONGROUPLIST_04No se han encontrado grupos de gestión para estos parámetros de búsqueda


Ejemplo de invocación

Code Block
languagejava
titleEjemplo 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.


Expand
titleMás detalles

Signatura

ResultGGListWithSize gestionGroupListWithSize (ParamGGListWithSize paramGGListWithSize)


Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
ggSearch1242693904Lista de anagramas fiscales


Parámetros de respuesta


NombreTipoDescripción
resultError1242693904Objeto ResultError
gestionGroup1242693904[]Listado de los grupos de gestión encontrados.
sizeintTamaño de la lista de grupos de gestión.


Códigos error


Código
Descripción
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


Code Block
languagejava
titleEjemplo 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.

Expand
titleMás detalles

Signatura

ResultGetAssignedProcedures assignedProcedureListByOrganism(ParamAssignedProcedureRoleList procedureSearchBean)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
procedureRoleSearchBean1242693904Objeto AssignedProcedureRoleVSearchBean con los parámetros de búsqueda


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
sizeintTamaño lista de procedimientos recuperada
procedureRolesList<1242693904>Listado de procedimientos recuperado


Códigos error



Código
Descripción
PROCEDURELISTBYORGANISMROLE_00Error que proviene del webservices.
PROCEDURELISTBYORGANISMROLE_01El objeto ParamAssignedProcedureRoleList es nulo
PROCEDURELISTBYORGANISMROLE_02No existen procedimientos para los parámetros de busqueda
PROCEDURELISTBYORGANISMROLE_03Error inesperado
PROCEDURELISTBYORGANISMROLE_04El objeto procedureSearchBean es nulo


Ejemplo de invocación

Code Block
languagejava
titleEjemplo 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 SEDA.


Expand
titleMás detalles

Signatura

ResultGetProcedureAttributes getProcedureAttributes(ParamGetProcedureAttributes paramGetProcedureAttributes)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
signatureStringSignature o código del procedimiento
idEntityStringCódigo de identificación de entidad.


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
procedureAttributes1242693904[]Listado de atributos del procedimento buscado


Códigos error



Código
Descripción
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

Code Block
languagejava
titleEjemplo 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 SEDA.


Expand
titleMás detalles

Signatura

ResultProcedureDetail procedureDetail(ParamProcedureDetail paramProcedureDetail)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
signatureStringSignature o código del procedimiento


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
procedure1242693904Objeto Procedure, con los datos del procedimiento


Códigos error



Código
Descripción
PROCEDUREDETAIL_00Error durante el proceso de búsqueda de procedure detail
PROCEDUREDETAIL_01El objeto paramProcedureDetail es nulo
PROCEDUREDETAIL_02No existe un procedimiento para esa signature
PROCEDUREDETAIL_03La Signature es nula


Ejemplo de invocación

Code Block
languagejava
titleEjemplo 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 SEDA.


Expand
titleMás detalles

Signatura

ResultProcedureDetail procedureDetail (ParamProcedureDetailByIdEntity paramProcedureDetailByIdEntity)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramString

Anagrama fiscal

idEntityStringCódigo de la entidad asociada
signatureStringSignature o código del procedimiento


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
procedure1242693904Objeto Procedure, con los datos del procedimiento


Códigos error



Código
Descripción
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

Code Block
languagejava
titleEjemplo 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 SEDA.


Expand
titleMás detalles

Signatura

ResultProcedureDetailSIA procedureDetailBySIACod(ParamProcedureDetailBySIACod paramProcedureDetailBySIACod)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
codSIAStringCódigo SIA asociado


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
procedureSIA1242693904Objeto ProcedureSIA, con los datos del procedimiento


Códigos error



Código
Descripción
PROCEDUREDETAILBYSIA_00Error durante el proceso de búsqueda de procedureDetailBySIACod
PROCEDUREDETAILBYSIA_01El objeto ParamProcedureDetailBySIACod es nulo
PROCEDUREDETAILBYSIA_02No existe un procedimiento para ese código SIA
PROCEDUREDETAILBYSIA_03El código SIA es nulo


Ejemplo de invocación

Code Block
languagejava
titleEjemplo 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 SEDA.


Expand
titleMás detalles

Signatura

ResultProcedureDetailList procedureDetailList (ParamProcedureDetailList paramProcedureDetailList)


Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
procedureSearch1242693904Objeto procedureSearch. Contiene criterios de búsqueda de Procedure, así como los parámetros de paginación y ordenación.


Parámetros de respuesta


NombreTipoDescripción
resultError1242693904Objeto ResultError
procedures1242693904[]Listado de procedimientos encontrados


Códigos error


Código
Descripción
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

Code Block
languagejava
titleEjemplo 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 SEDA.


Expand
titleMás detalles

Signatura

ResultProcedureDetailList procedureDetailList (ParamProcedureDetailList paramProcedureDetailList)


Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
signaturesString[]Códigos de los procedimiento de los que se quiere obtener el detalle
idEntityStringCódigo de la entidad asociada


Parámetros de respuesta


NombreTipoDescripción
resultError1242693904Objeto ResultError
procedures1242693904[]Listado de procedimientos encontrados junto a sus órganos gestores.


Códigos error


Código
Descripción
PROCEDURELIST_01El objeto ParamSignaturesAndIdEntity es nulo
PROCEDURELIST_03El objeto signatures es nulo
PROCEDURELIST_05El objeto signatures está vacío
PROCEDURELIST_06No se han encontrado procedimientos para los parámetros de búsqueda.


Ejemplo de invocación

Code Block
languagejava
titleEjemplo 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 SEDA.


Expand
titleMás detalles

Signatura

ResultProcedureDetailSIA procedureDetailWithSIA(ParamProcedureDetailByIdEntity paramProcedureDetail)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
idEntityStringCódigo de la entidad asociada
signatureStringCódigo del procedimiento que se quiere obtener el detalle


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
procedureSIA1242693904Objeto ProcedureSIA, con los datos del procedimiento


Códigos error



Código
Descripción
PROCEDUREDETAILSIA_00Error durante el proceso de búsqueda de procedure detail
PROCEDUREDETAILSIA_01El objeto paramProcedureDetail es nulo
PROCEDUREDETAILSIA_02No existe un procedimiento para esa signature
PROCEDUREDETAILSIA_03La Signature es nula
PROCEDUREDETAILSIA_04La Entidad es nula


Ejemplo de invocación

Code Block
languagejava
titleEjemplo 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 SEDA.


Expand
titleMás detalles

Signatura

ResultProcedureList procedureList(ParamProcedureList paramProcedureList)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
procedureSearch1242693904Objeto ProcedureSearch, campos de búsqueda para procedimientos


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
procedure1242693904[]Lista de objetos Procedure


Códigos error



Código
Descripción
PROCEDURELIST_00Error durante el proceso de búsqueda de procedure
PROCEDURELIST_01El objeto paramProcedureList es nulo
PROCEDURELIST_02Error que proviene del webservices
PROCEDURELIST_03El objeto ProcedureSearch es nulo


Ejemplo de invocación

Code Block
languagejava
titleEjemplo 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 SEDA.


Expand
titleMás detalles

Signatura

ResultProcedureList procedureList(ParamProcedureListAndEntity paramProcedureListAndEntity)


Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
procedureSearch1242693904Objeto ProcedureSearch, campos de búsqueda para procedimientos


Parámetros de respuesta


NombreTipoDescripción
resultError1242693904Objeto ResultError
procedure1242693904[]Lista de objetos Procedure


Códigos error


Código
Descripción
PROCEDURELIST_00Error durante el proceso de búsqueda de procedure
PROCEDURELIST_01El objeto paramProcedureList es nulo
PROCEDURELIST_02Error que proviene del webservices
PROCEDURELIST_03El objeto ProcedureSearch es nulo
PROCEDURELIST_04El parámetro idEntidad es nulo


Ejemplo de invocación


Code Block
languagejava
titleEjemplo 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 SEDA.

Expand
titleMás detalles

Signatura

VResultProcedureRoleList procedureListByAplicationAndIdEntity(VParamProcedureRoleList vparamProcedureRoleList)


Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
procedureSearchBean1242693904Objeto VProcedureRoleSearchBean, campos de búsqueda para procedimientos


Parámetros de respuesta


NombreTipoDescripción
resultError1242693904Objeto ResultError
procedureRoles1242693904Lista de objetos VProcedureRole
sizeintTamaño de la lista de procedimientos recuperados


Códigos error


Código
Descripción
PROCEDURELISTBYAPLICATIONANDIDENTITY_00Error durante el proceso de búsqueda
PROCEDURELISTBYAPLICATIONANDIDENTITY_01El objeto ParamAssignedProcedureRoleList es nulo
PROCEDURELISTBYAPLICATIONANDIDENTITY_02No hay procedimientos relacionados con estos parámetros de búsqueda
PROCEDURELISTBYAPLICATIONANDIDENTITY_03Ha ocurrido algún tipo de error al listar los procedimientos
PROCEDURELISTBYAPLICATIONANDIDENTITY_04El objeto procedureSearchBean es nulo


Ejemplo de invocación


Code Block
languagejava
titleEjemplo 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 SEDA.


Expand
titleMás detalles

Signatura

ResultProcedureListByOrganism procedureListByOrganism(ParamProcedureListByOrganism paramProcedureListByOrganism)


Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método.
fiscalAnagramString

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


NombreTipoDescripción
resultError1242693904Objeto ResultError
procedures1242693904[]

Lista de objetos Procedure

sizeintTamaño de la lista de procedimientos


Códigos error


Código
Descripción
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


Code Block
languagejava
titleEjemplo 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 SEDA.


Expand
titleMás detalles

Signatura

ResultProcedureListByUser procedureListByUser(ParamProcedureListByUser paramProcedureListByUser)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal


Parámetros de respuesta


NombreTipoDescripción
resultError1242693904Objeto ResultError
procedure1242693904[]Lista de objetos Procedure


Códigos error


Código
Descripción
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


Code Block
languagejava
titleEjemplo 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 SEDA.


Expand
titleMás detalles

Signatura

ResultProcedureListByUser procedureListByUser(ParamProcedureListByUserAndEntity paramProcedureListByUserAndEntity)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
idEntityStringCódigo de la entidad asociada


Parámetros de respuesta


NombreTipoDescripción
resultError1242693904Objeto ResultError
procedure1242693904[]Lista de objetos Procedure


Códigos error


Código
Descripción
PROCEDURELISTBYUSER_00Error durante el proceso de búsqueda de procedure by user
PROCEDURELISTBYUSER_01El objeto paramProcedureListByUser es nulo
PROCEDURELISTBYUSER_02El fiscal anagrama es nulo
PROCEDURELISTBYUSER_03El usuario no existe en la base de datos
PROCEDURELISTBYUSER_04Error que proviene del webservices
PROCEDURELISTBYUSER_05El id de la entidad es nulo


Ejemplo de invocación


Code Block
languagejava
titleEjemplo de invocación
ParamProcedureListByUserAndEntity params = new ParamProcedureListByUserAndEntity();
params.setFiscalAnagram("72979986C");
params.setIdEntity("0");
ResultProcedureListByUser result = pauAgent.procedureListByUser(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 SEDA.


Expand
titleMás detalles

Signatura

ResultProcedureList procedurePublishedList(ParamProcedureList paramProcedureList)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
procedureSearch1242693904Objeto ProcedureSearch, campos de búsqueda para procedimientos


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
procedure1242693904[]Lista de objetos Procedure


Códigos error



Código
Descripción
PROCEDURELIST_00Error durante el proceso de búsqueda de procedure
PROCEDURELIST_01El objeto paramProcedureList es nulo
PROCEDURELIST_02Error que proviene del webservices
PROCEDURELIST_03El objeto ProcedureSearch es nulo


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureList params = new ParamProcedureList();
ProcedureSearch procedureSearch = new ProcedureSearch();
procedureSearch.setSignature("1");
params.setProcedureSearch(procedureSearch);
ResultProcedureList result = pauAgent.procedurePublishedList(params);



Método 'getJobsBySignature'

Servicio que devuelve los puestos que tienen asociada una signature.


Expand
titleMás detalles

Signatura

ResultGetJobsBySignature getJobsBySignature(ParamGetJobsBySignature paramGetJobsBySignature)

Parámetros de invocación


Nombre
Tipo
Descripción
applicationIdStringAplicación que ejecuta el método.
fiscalAnagramStringFiscal anagram del usuario que invoca
signatureStringSignatura por la que se quiere buscar.
stateStringEstado de alta o baja.


Parámetros de respuesta



Nombre
Tipo
Descripción
jobCodesList <String>Lista de jobCodes
sizeintTamaño del listado devuelto


Códigos error


Código
Descripción
GET_JOBS_BY_SIGNATURE_01El objeto paramGetJobsBySignature es nulo
GET_JOBS_BY_SIGNATURE_02Los parametros signature y state son obligatorios
GET_JOBS_BY_SIGNATURE_03El campo state introducido no es valido. Debe ser alta o baja
GET_JOBS_BY_SIGNATURE_04El campo signature debe ser numerico
GET_JOBS_BY_SIGNATURE_05No se encuentran puestos asociados


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamGetJobsBySignature params = new ParamGetJobsBySignature();
params.setFiscalAnagram(TestConstants.DEFAULT_FISCAL_ANAGRAM);
params.setApplicationId(TestConstants.DEFAULT_ENTITY_ID);
params.setSignature("466");
params.setState("alta");
ResultGetJobsBySignature result = testClient.getJobsBySignature(params);






Método 'procedureGetAssignedJobList'

Servicio que devuelve los puestos asociados a un procedimiento.

Expand
titleMás detalles

Signatura

ResultProceduresGetAssignedJobList procedureGetAssignedJobList(ParamProcedureGetAssignedJobList paramProcedureList)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que invoca al servicio
fiscalAnagramStringFiscal anagram del usuario
signaturesLong[]Array de signaturas por las que se quiere buscar.
stateBoolean TRUE para los que están dados de alta y FALSE, para bajas.


Parámetros de respuesta



NombreTipoDescripción
procedureJobsList<ProcedureJobList>Lista de objetos PAU v3.8 - Manual de integración - servicios para integradores#ProcedureJobList
sizeint tamaño del listado devuelto


Códigos error



Código
Descripción
PROCEDUREGETASSIGNEDJOBLIST_00El objeto ParamProcedureGetAssignedJobList es nulo.
PROCEDUREGETASSIGNEDJOBLIST_01El objeto signatures es nulo
PROCEDUREGETASSIGNEDJOBLIST_02No hay procedimientos relacionados con estos parámetros de búsqueda
PROCEDUREGETASSIGNEDJOBLIST_03Ha ocurrido algún tipo de error al listar los procedimientos


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureGetAssignedJobList param = new ParamProcedureGetAssignedJobList();
Long[] signatures = new Long[1];
signatures[0] = Long.parseLong(signature);
param.setSignatures(signatures);
param.setState(true);
ResultProceduresGetAssignedJobList resultProcedureJobList = pauAgent.procedureGetAssignedJobList(param);


Búsquedas y consultas de puestos

Método 'jobGetAssignedRoleList'

Servicio que devuelve los roles asociados a uno o varios puestos de SIU.


Expand
titleMás detalles

Signatura

ResultJobGetAssignedRoleList jobGetAssignedRoleList(ParamJobGetAssignedRoleList param)

Parámetros de invocación


NombreTipoDescripción
jobCodeString[]Array de códigos de puestos de SIU por los que se quiere buscar.


Parámetros de respuesta



NombreTipoDescripción
RoleJobsList<RoleJob>Lista de RoleJob
sizeint tamaño del listado devuelto
jobCodeStringcódigo del puesto en SIU


Códigos error



Código
Descripción
JOB_GET_ASSIGNED_ROLE_LIST_00Ha ocurrido algún tipo de error al listar los resultados
JOB_GET_ASSIGNED_ROLE_LIST_01El objeto de entrada es nulo.
JOB_GET_ASSIGNED_ROLE_LIST_02La lista de códigos de puestos en SIU es nula.
JOB_GET_ASSIGNED_ROLE_LIST_03La lista de códigos de puestos en SIU está vacía.


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamJobGetAssignedRoleList param = new ParamJobGetAssignedRoleList();
param.setJobCode(new String[] { "JOB_0001", "JOB_0002" });
ResultJobGetAssignedRoleList result = testClient.jobGetAssignedRoleList(param);



Método 'jobGetAssignedProcedureListServicesAndVariants'

Servicio que consultan los procedimientos asociados a los usuarios en PAU con la nueva estructura derivada del cambio de servicio/variante.

*El parentSignature del servicio se mantendrá vacío, este campo se rellenará con la signature original del mismo en los casos especiales de servicio-variante “Estandar”. Esto sucede en el caso de existir variantes sin denominación, se devolverá como denominación de cada variante la de su servicio correspondiente; y la signature del servicio pasa a ser la de esta variante “Estandar”. De este modo es más fácil indentificar en la respuesta cuando se trata esta casuística.


Expand
titleMás detalles

Signatura

ResultGetAssignedProcedureListServicesAndVariants jobGetAssignedProcedureListServicesAndVariants(ParamJobGetAssignedProcedureListServicesAndVariants param)

Parámetros de invocación


NombreTipoDescripción
jobCodeString[]Array de codigos de puestos de SIU por los que se quiere buscar.
signatureLongParámetro opcional que nos permite filtrar por el signature
serviceStringS, V o A, para filtrar por servicios o variantes (o ambas). Si no se rellena devolverá ambos, como si se hubiera rellenado A.
stateStringA o T, para filtrar por publicados o todos.
activeStringS, N o T, para filtrar si están de alta, de baja o todos.


Parámetros de respuesta



NombreTipoDescripción
resultSEDAServicesList<PAU v3.10 - Manual de integración - servicios para integradores#ResultSEDAService>Lista de ResultSEDAService
sizeint tamaño del listado devuelto



Códigos error



Código
Descripción
JOB_GET_ASSIGNED_PROCEDURE_LIST_00Ha ocurrido algún tipo de error al listar los resultados
JOB_GET_ASSIGNED_PROCEDURE_LIST_01El objeto de entrada es nulo.
JOB_GET_ASSIGNED_PROCEDURE_LIST_02La lista de códigos de puestos en SIU es nula.
JOB_GET_ASSIGNED_PROCEDURE_LIST_03La lista de códigos de puestos en SIU está vacía.


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamJobGetAssignedProcedureList param = new ParamJobGetAssignedProcedureList();
param.setJobCode(new String[] { "JOB_0001", "JOB_0002" });
ResultJobGetAssignedRoleList result = testClient.jobGetAssignedRoleList(param);


Método 'procedureListServicesAndVariants'

Servicio que consultan los procedimientos asociados a los usuarios en PAU con la nueva estructura derivada del cambio de servicio/variante.

*El parentSignature del servicio se mantendrá vacío, este campo se rellenará con la signature original del mismo en los casos especiales de servicio-variante “Estandar”. Esto sucede en el caso de existir variantes sin denominación, se devolverá como denominación de cada variante la de su servicio correspondiente; y la signature del servicio pasa a ser la de esta variante “Estandar”. De este modo es más fácil indentificar en la respuesta cuando se trata esta casuística.


Expand
titleMás detalles

Signatura

ResultGetListServicesAndVariants procedureListServicesAndVariants(ParamGetListServicesAndVariants param)

Parámetros de invocación


NombreTipoDescripción
signatureLongParámetro opcional que nos permite filtrar por el signature
serviceStringS, V o A, para filtrar por servicios o variantes (o ambas). Si no se rellena devolverá ambos, como si se hubiera rellenado A.
stateStringA o T, para filtrar por publicados o todos.


Parámetros de respuesta



NombreTipoDescripción
resultSEDAServicesList<PAU v3.10 - Manual de integración - servicios para integradores#ResultSEDAServiceSimple>Lista de ResultSEDAServiceSimple
sizeint tamaño del listado devuelto



Códigos error



Código
Descripción
JOB_GET_ASSIGNED_PROCEDURE_LIST_00Ha ocurrido algún tipo de error al listar los resultados
JOB_GET_ASSIGNED_PROCEDURE_LIST_01El objeto de entrada es nulo.
JOB_GET_ASSIGNED_PROCEDURE_LIST_02La lista de códigos de puestos en SIU es nula.
JOB_GET_ASSIGNED_PROCEDURE_LIST_03La lista de códigos de puestos en SIU está vacía.


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamGetListServicesAndVariants param = new ParamGetListServicesAndVariants();
param.setService(ServiceEnum.ALL.getValue());
param.setSignature(null);//opcional
param.setState(StatusEnum.ALL.getValue());
ResultGetListServicesAndVariants result = testClient.procedureListServicesAndVariants(param);


Método 'jobGetAssignedProcedureList'

Servicio que devuelve los procedimientos asociados a uno o varios puestos de SIU.


Expand
titleMás detalles

Signatura

ResultJobGetAssignedRoleList jobGetAssignedRoleList(ParamJobGetAssignedRoleList param)

Parámetros de invocación


NombreTipoDescripción
jobCodeString[]Array de codigos de puestos de SIU por los que se quiere buscar.


Parámetros de respuesta



NombreTipoDescripción
ProcedureJobsList<ProcedureJob>Lista de ProcedureJob
sizeint tamaño del listado devuelto
jobCodeStringcódigo del puesto en SIU


Códigos error



Código
Descripción
JOB_GET_ASSIGNED_PROCEDURE_LIST_00Ha ocurrido algún tipo de error al listar los resultados
JOB_GET_ASSIGNED_PROCEDURE_LIST_01El objeto de entrada es nulo.
JOB_GET_ASSIGNED_PROCEDURE_LIST_02La lista de códigos de puestos en SIU es nula.
JOB_GET_ASSIGNED_PROCEDURE_LIST_03La lista de códigos de puestos en SIU está vacía.


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamJobGetAssignedProcedureList param = new ParamJobGetAssignedProcedureList();
param.setJobCode(new String[] { "JOB_0001", "JOB_0002" });
ResultJobGetAssignedRoleList result = testClient.jobGetAssignedRoleList(param);



Método 'roleGetAssignedJobList'

Servicio que devuelve los puestos asociados a uno o varios roles de SIU.


Expand
titleMás detalles

Signatura

ResultRoleGetAssignedJobList roleGetAssignedJobList(ParamRoleGetAssignedJobList paramRoleGetAssignedJobList)

Parámetros de invocación


NombreTipoDescripción
roleCodeString[]Array de codigos de roles de SIU por los que se quiere buscar.
stateStringEstado de alta o baja


Parámetros de respuesta



NombreTipoDescripción
RoleJobListList<RoleJob>Lista de RoleJob
sizeint tamaño del listado devuelto


Códigos error



Código
Descripción
ROLE_GET_ASSIGNED_JOB_LIST_01El objeto paramRoleGetAssignedJobList es nulo
ROLE_GET_ASSIGNED_JOB_LIST_02El objeto paramRoleGetAssignedJobList es nulo
ROLE_GET_ASSIGNED_JOB_LIST_03El tamaño de paramRoleGetAssignedJobList.getRoleCode() es 0


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamRoleGetAssignedJobList param = new ParamRoleGetAssignedJobList();
param.setRoleCode(new String[] { "ROLE0001", "ROLE0002" });
ResultRoleGetAssignedJobList result = testClient.roleGetAssignedJobList(param);


Método 'procedureGetAssignedJobList'

Servicio que devuelve los puestos asociados a uno o varios ptocedimientos.


Expand
titleMás detalles

Signatura

ResultProceduresGetAssignedJobList procedureGetAssignedJobList(ParamProcedureGetAssignedJobList paramProcedureGetAssignedJobList)

Parámetros de invocación


NombreTipoDescripción
signatureString[]Array de signaturas por los que se quiere buscar.
stateStringEstado de alta o baja


Parámetros de respuesta



NombreTipoDescripción
procedureJobsList<ProcedureJobList>Lista de PRocedureJob
sizeint Tamaño del listado devuelto


Códigos error



Código
Descripción
PROCEDURELISTBYORGANISMROLE_00Error que proviene del webservices
PROCEDURELISTBYORGANISMROLE_01El objeto ParamProcedureGetAssignedJobList es nulo
PROCEDURELISTBYORGANISMROLE_02No existen procedimientos para los parametros de busqueda
PROCEDURELISTBYORGANISMROLE_03Error inesperado


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureGetAssignedJobList param = new ParamProcedureGetAssignedJobList();
param.setSignature(new String[] { "595", "1011" });
ResultProceduresGetAssignedJobList result = testClient.procedureGetAssignedJobList(param);


Método 'procedureListByUserWithServices'

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 de una serie de parámetros referentes a los servicios o variantes. Es similar al servicio procedureListByUser, pero en este es último es solamente necesario el anagrama fiscal como parámetro de búsqueda.

*El parentSignature del servicio se mantendrá vacío, este campo se rellenará con la signature original del mismo en los casos especiales de servicio-variante “Estandar”. Esto sucede en el caso de existir variantes sin denominación, se devolverá como denominación de cada variante la de su servicio correspondiente; y la signature del servicio pasa a ser la de esta variante “Estandar”. De este modo es más fácil indentificar en la respuesta cuando se trata de esta casuística.


Expand
titleMás detalles

Signatura

ResultProcedureListByUserWithServices procedureListByUserWithServices (ParamProcedureListByUserWithServices paramProcedureListByUserWithServices)

Parámetros de invocación


Nombre
Tipo
Descripción
applicationIdStringAplicación que invoca al servicio
fiscalAnagramStringFiscal anagram del usuario
signatureStringParámetro opcional que nos permite filtrar por el signature
serviceStringS, V o A, para filtrar por servicios o variantes (o ambas). Si no se rellena devolverá ambos, como si se hubiera rellenado A.
stateStringA o T, para filtrar por publicados o todos.
activeStringS para los que están dados de alta, N para bajas y T, indistinto


Parámetros de respuesta


Nombre
Tipo
Descripción
resultSEDAByUserWithServicesList<ResultSEDAByUserWithServices>Lista de ResultSEDAByUserWithServices
sizeintTamaño del listado devuelto


Códigos error


Código
Descripción
PROCEDURELISTBYUSER_00Error durante el proceso de búsqueda de
procedure by user.
PROCEDURELISTBYUSER_01El objeto paramProcedureListByUser es nulo
PROCEDURELISTBYUSER_02El fiscal anagrama es nulo
PROCEDURELISTBYUSER_04Error que proviene del Webservice
PROCEDURELISTBYUSER_07El tipo de consulta introducida no es válida


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureListByUserWithServices param = new ParamProcedureListByUserWithServices();
param.setFiscalAnagram("99999999R");//Obligatorio
param.setService(ServiceEnum.ALL.getValue());//A
param.setSignature(null);//opcional
param.setState(StatusEnum.ALL.getValue());//T
//Si no le pasamos active como parametro, por defecto T
//param.setActive(StatusProcEnum.ALL.getValue());
ResultProcedureListByUserWithServices result = testClient.procedureListByUserWithServices(param);


Anexos

Objetos comunes


Objeto 'Action
Anchor
Action
Action


Nombre
Tipo
Descripción
actionCode

String

Código de acción
aliasStringNombre de la acción
descriptionStringDescripción de la acción
applicationNameStringNombre de la aplicación
applicationAliasStringAlias de la aplicación


Objeto 'ActionSearch
Anchor
ActionSearch
ActionSearch


Nombre
Tipo
Descripción
action

1242693904

Objeto Action
params1242693904Objeto SearchParams

Objeto 'AdmRole
Anchor
AdmRole
AdmRole


Nombre
Tipo
Descripción
admRoleCode

String

Código de rol
nameStringNombre del rol
descriptionStringDescripción

Objeto 'AdmRoleSearch
Anchor
AdmRoleSearch
AdmRoleSearch


Nombre
Tipo
Descripción
admRole

1242693904

Objeto AdmRole
params1242693904Objeto SearchParams

Objeto 'Application
Anchor
Application
Application


Nombre
Tipo
Descripción
alias

String

Alias aplicación
nameStringNombre
ipsIp[]Lista de direcciónes Ip
descriptionStringDescripción
versionStringVersión
responseUrlStringUrl asociada a la aplicación
organismCodeOwnerStringCódigo de organismo asociado
methods1242693904[]Lista de métodos


Objeto 'ApplicationGG
Anchor
ApplicationGG
ApplicationGG


Nombre
Tipo
Descripción
applicationAlias

String

Alias de la aplicación
ggCodeStringCódigo del grupo de gestión
ggNameStringNombre del grupo de gestión
admRoleCodeStringCódigo del rol
admRoleNameStringNombre del rol


Objeto 'ApplicationGGSearch
Anchor
ApplicationGGSearch
ApplicationGGSearch


Nombre
Tipo
Descripción
applicationGG

1242693904

Objeto ApplicationGG
searchParams1242693904Objeto SearchParams


Objeto 'ApplicationRelation
Anchor
ApplicationRelation
ApplicationRelation


Nombre
Tipo
Descripción
applicationAliasA

String

Alias aplicación A
applicationAliasBStringAlias aplicación B
applicationNameAStringNombre aplicación A
applicationNameBStringNombre aplicación B
methods1242693904[]Lista de métodos


Objeto 'ApplicationRelationSearch
Anchor
ApplicationRelationSearch
ApplicationRelationSearch


Nombre
Tipo
Descripción
applicationRelation

1242693904

Objeto ApplicationRelation
params1242693904Objeto SearchParams


Objeto 'ApplicationSearch
Anchor
ApplicationSearch
ApplicationSearch


Nombre
Tipo
Descripción
application

1242693904

Objeto Application
params1242693904Objeto SearchParams


Objeto 'AppRole
Anchor
AppRole
AppRole


NombreTipoDescripción
roleCodeStringCódigo del rol de la aplicación
nameStringNombre del rol
descripcionStringDescripción del rol
applicationAliasStringAlias de la aplicación

roleType

intTipo de rol
actions

1242693904[]

Lista de objetos Action

Objeto 'AssignedProcedureRoleVSearchBean
Anchor
AssignedProcedureRoleVSearchBean
AssignedProcedureRoleVSearchBean


Nombre
Tipo
Descripción
procedureRoleV

1242693904

Objeto VProcedureRole con los campos de consulta
params1242693904Objeto SearchParams con los campos de ordenación y paginación

Objeto 'AssignedRole
Anchor
AssignedRole
AssignedRole


Nombre
Tipo
Descripción
fiscalAnagram

String

Anagrama fiscal del usuario
organismCodeStringCódigo de organismo
roleCodeStringCódigo de rol
roleNameStringNombre del rol
appAliasStringAlias de la aplicación

Objeto 'AssignedRoleSearch'  
Anchor
AssignedRoleSearch
AssignedRoleSearch


Nombre
Tipo
Descripción
assignedRole

1242693904

Objeto AssignedRole
params1242693904Objeto SearchParams
organismsString[]Lista de organismos

Objeto 'AssignedRolesToUser
Anchor
AssignedRolesToUser
AssignedRolesToUser


Nombre
Tipo
Descripción
fiscalAnagram

String

Anagrama fiscal del usuario
assignedRoleListAssignedRole[]Lista de objetos AssignedRole

Objeto 'AssignedRoleTreeSearch
Anchor
AssignedRoleTreeSearch
AssignedRoleTreeSearch


Nombre
Tipo
Descripción
assignedRole

1242693904

Objeto AssignedRole
params1242693904Objeto SearchParams

Objeto 'AssignedRolesUserListSearch
Anchor
AssignedRolesUserListSearch
AssignedRolesUserListSearch


Nombre
Tipo
Descripción
fiscalAnagramList

String[]

Lista de anagramas fiscales
assignedRole1242693904Objeto AssignedRole

Objeto 'GestionGroup
Anchor
GestionGroup
GestionGroup


Nombre
Tipo
Descripción
ggCodeStringCódigo del grupo
nameStringNombre del grupo de gestión
descriptionStringDescripción del grupo
procedure1242693904[]Lista de procedimientos

Objeto 'GGSearch
Anchor
GGSearch
GGSearch


Nombre
Tipo
Descripción
gestionGroup

1242693904

Objeto GestionGroup
params1242693904Objeto SearchParams


Objeto 'Ip
Anchor
Ip
Ip


Nombre
Tipo
Descripción
address

String

Dirección Ip


Objeto 'Method
Anchor
Method
Method


Nombre
Tipo
Descripción
methodCode

String

Código asociado al método
nameStringNombre del método
descriptionStringDescripción del método
serviceStringNombre del servicio al que corresponde el método


Objeto 'Procedure
Anchor
Procedure
Procedure


Nombre
Tipo
Descripción
signatureStringSignatura del procedimiento
denominationStringDenominación del procedimiento
servicioStringServicio asociado al procedimiento
idEntidadStringCódigo de la entidad
idOrganoStringCódigo del órgano del catálogo
versionStringVersión
descOrganoStringDescripción del órgano del catálogo
xmlDataString
procedureAttributes1242693904[]Lista de atributos del procedimiento

Objeto 'ProcedureAttributes
Anchor
ProcedureAttributes
ProcedureAttributes


Nombre
Tipo
Descripción
codeStringCódigo del atributo del procedimiento
valueStringValor del atributo del procedimiento

Objeto 'ProcedureDetailExtended
Anchor
ProcedureDetailExtended
ProcedureDetailExtended


Nombre
Tipo
Descripción
atributosAtributosWS[]Lista de atributos que tiene el procedimiento
ayudacoberturaStringCobertura de la ayuda
ayudaimporteStringImporte en la ayuda
beneficiariosStringBeneficiarios del procedimiento
canalaplicacionurlStringDirección url del formulario
dinámico asoc
canalcitapreviahorarioStringHorario de atención de cita
previa
canalcitapreviatfnStringNúmero de teléfono de cita previa
canalcorreoordinarioStringDirección postal
canalemailStringDirección de correo electrónico
canalfaxStringNúmero de fax
canaloficinahorarioStringHorario de atención de la oficina
canaloficinasurlStringDirección url de la oficina
canalserviciourlStringDirección de servicio electrónico
canaltelefonoStringNúmero de teléfono
canaltelefonohorarioStringHorario de atención
denominationStringDenominación del procedimiento
departamentoresolutorStringIdentificador del
departamento resolutor asociado
descDepartamentoStringDescripción del departamento.
descOrganoStringDescripción del órgano del catálogo
dirigidoadministracionesStringAdministraciones a las que va dirigido
dirigidociudadanosStringGrupo de ciudadanos al que va dirigido
dirigidoempresasStringGrupo de empresas al que va dirigido
dirigidoentidadescolabStringGrupo de entidades
colaboradoras al que va dirigido
documentacionStringDocumentación del departamento
efecSilenAdmStringEfecto del silencio administrativo
familiaDescripcionStringDescripción de familia.
fecPubBoletinStringFecha de publicación en el boletín
fecpresentaciondesdeStringDesde, fecha de plazo de presentación de solicitudes
fecpresentacionhastaStringHasta, fecha de plazo de presentación de solicitudes
fileCaracteristicas1StringFichero Caracteristicas1 en Base64
fileCaracteristicas2StringFichero Caracteristicas2 en Base64
formasiniciartramiteStringFormas de iniciar el trámite
idDepartamentoStringIdentificador del departamento asociado
idEntidadStringCódigo de la entidad a la que pertenece
idFamiliaStringIdentificador de la familia
idMateriaStringIdentificador de la materia
idOrganoStringCódigo del órgano del catálogo
idProcedimientoStringIdentificador del procedimiento
idorganoresolutorStringIdentificador del órgano resolutor asociado
idorganotramitadorStringIdentificador del órgano tramitador asociado
idsectoractividadStringIdentificador del sector de actividad al que va dirigido
incertificadoempStringCertificado de empadronamiento de la documentación
indniStringDni de la documentación
infAdicionalStringInformación adicional asociada al procedimiento
infechaprevisionStringFecha de previsión
inidaplicaciongestoraStringAplicación gestora
inlistaserviciosStringLista de servicios de la documentación
innivelactualStringNivel actual de interacción
innivelprevistoStringNivel previsto de interacción
innumsolicitudesanStringNúmero de solicitudes anuales
inobservacionesStringObservaciones del SID
interaccionemailStringEnvío de avisos de correo electrónico
interaccionestadourlStringDirección de consulta sobre el estado de tramitación
interaccionnotifurlStringDirección de notificaciones telemáticas
interaccionsmsStringEnvío de avisos vía sms
interacciontfnStringNúmero de información sobre el estado de tramitación
materiaDescripcionStringDescripción de la materia
nombreCaracteristicas1StringNombre del fichero caracteristicas1
nombreCaracteristicas2StringNombre del fichero caracteristicas1
normativaStringNormativa del procedimiento
objetoStringObjeto del procedimiento
observacionesStringObservaciones del procedimiento
plazoResolucionStringPlazo de resolución
plazopresentacionStringPlazo de presentación de solicitudes
pendientePlazobooleanPlazo pendiente
recursosStringRecursos del procedimiento
requisitosStringRequisitos del procedimiento
servicioStringServicio asociado al procedimiento
signatureStringSignatura del procedimiento
tasacodigoStringCodificación de la tasa
tasadescripcionStringDescripción de la tasa
tasaentidadespagoStringEntidades de pago en caja
tasamediospagoStringMedios de pago de la tasa
tasapagoStringPago de tasas
tasaurlStringUrl de pago telemático de la tasa
tiempomedioresolucionStringTiempo medio de resolución
versionStringVersión del procedimiento
vudsStringVentanilla única de directiva de servicios
vudscodigosStringDescripción de los códigos asociados a VUDS
xmlDataString
procedureAttributesProcedureAttributes[]Lista de atributos del procedimiento

Objeto 'ProcedureJobInformation
Anchor
ProcedureJobInformation
ProcedureJobInformation


Nombre
Tipo
Descripción
codeLongCódigo identificador
siuJobStringPuesto al que se encuentra asociado
initialDateDateFecha de inicio de vigencia del procedimiento en el puesto
finalDateDateFecha de fin de vigencia del procedimiento en el puesto


Objeto 'ProcedureJobList
Anchor
ProcedureJobList
ProcedureJobList


Nombre
Tipo
Descripción
signatureLongSignature del procedimiento
procedureJobListList<ProcedureJobInformation>Lista de objetos PAU v3.8 - Manual de integración - servicios para integradores#ProcedureJobInformation


Objeto 'VProcedureRole
Anchor
VProcedureRole
VProcedureRole


Nombre
Tipo
Descripción
fiscalAnagramStringFiscal anagram del usuario al que se asocia el procedimiento
signatureStringSignatura del procedimiento
denominationStringDenominación del procedimiento
entityStringCódigo de la entidad
admRoleStringCódigo del perfil administrativo
admNameStringNombre del perfil administrativo
organismCodeStringCódigo del organismo bajo el que se ha asociado el procedimiento al usuario
appAliasStringIdentificador de la aplicación (por el momento solo lo usa SFE)

Objeto 'VProcedureRoleSearchBean
Anchor
VProcedureRoleSearchBean
VProcedureRoleSearchBean


Nombre
Tipo
Descripción
fiscalAnagramStringFiscal anagram del usuario al que se asocia el procedimiento
signatureStringSignatura del procedimiento
denominationStringDenominación del procedimiento
entityStringCódigo de la entidad
admRoleStringCódigo del perfil administrativo
admNameStringNombre del perfil administrativo
organismCodeStringCódigo del organismo bajo el que se ha asociado el procedimiento al usuario
appAliasStringIdentificador de la aplicación (por el momento solo lo usa SFE)
param1242693904Objeto SearchParams


Objeto 'ProcedureSearch
Anchor
ProcedureSearch
ProcedureSearch


Nombre
Tipo
Descripción
procedure1242693904Objeto Procedure
params1242693904Objeto SearchParams


Objeto 'ProcedureSIA
Anchor
ProcedureSIA
ProcedureSIA


Nombre
Tipo
Descripción
codigoSIAStringCódigo SIA
procedure1242693904Objeto Procedure


Objeto 'ResultError
Anchor
ResultError
ResultError


Nombre
Tipo
Descripción
errors

boolean

Indica si hay errores o no
errorMsgStringMensaje de error devuelto
errorCodeStringCódigo de error devuelto


Objeto 'Role
Anchor
Role
Role


Nombre
Tipo
Descripción
roleCode

String

Código del rol
nameStringNombre del rol
descripcionStringDescripción del rol
applicationAliasStringAlias de la aplicación
actions1242693904[]Lista de acciones
roleTypeIntegerTipo de rol

Objeto 'RoleSearch
Anchor
RoleSearch
RoleSearch


NombreTipoDescripción
searchParams1242693904Objeto SearchParams

Objeto 'RoleOrganism
Anchor
RoleOrganism
RoleOrganism


NombreTipoDescripción
organismCodeStringCódigo del organismo al que pertenece el rol

roleName

StringNombre del rol
roleCodeStringCódigo del rol


Objeto 'RoleJob
Anchor
RoleJob
RoleJob


NombreTipoDescripción
codeLongCódigo del registro - clave primaria
roleCodeStringCódigo del rol
jobCodeStringCódigo del puesto en SIU

initialDate

DateFecha de inicio
finalDateDateFecha de Fin


Objeto 'SearchParams
Anchor
SearchParams
SearchParams


Nombre
Tipo
Descripción
sortColumnStringColumna por la que queremos ordenar
ascendingBooleanIndica si el orden de ordenación es ascendente
fromIndexIntegerÍndice desde el que queremos buscar
toIndexIntegerÍndice hasta que el que queremos buscar


Objeto 'User
Anchor
User
User


Nombre
TipoDescripción
fiscalAnagramStringAnagrama fiscal del usuario
roleOrganism1242693904[]Lista de objetos RoleOrganism

Objeto 'UserCon
Anchor
UserCon
UserCon


Nombre
TipoDescripción
fiscalAnagramStringAnagrama fiscal
applicationAliasStringAlias de la aplicación
lastConnectionDateObjeto Date de la última conexión

Objeto 'UserConSearch
Anchor
UserConSearch
UserConSearch


Nombre
TipoDescripción
paramSearch1242693904Objeto ParamSearch

Objeto 'UserGG
Anchor
UserGG
UserGG


Nombre
Tipo
Descripción
fiscalAnagramStringAnagrama fiscal del usuario
ggCodeStringCódigo del grupo de gestión
admRoleCodeStringCódigo del rol
ggNameStringNombre del grupo de gestión
admRoleNameStringNombre del rol


Objeto 'UserGGSearch
Anchor
UserGGSearch
UserGGSearch


Nombre
Tipo
Descripción
userGG1242693904Objeto UserGG
searchParams1242693904Objeto SearchParams


Objeto 'UserList
Anchor
UserList
UserList


NombreTipoDescripción
fiscalAnagramStringAnagrama fiscal del usuario
emailStringEmail del usuario