Versions Compared

Version Old Version 6 New Version 7
Changes made by

Servicios Digitales de Aragón

Servicios Digitales de Aragón

Saved on

Key

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

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.

...

titleMás detalles

Signatura

ResultApplicationList applicationList(ParamApplicationList paramApplicationList)

Parámetros de invocación

...

Parámetros de respuesta

...

Códigos error

...

Código

...

Descripción

...

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.

...

titleMás detalles

Signatura

ResultApplicationRelationList applicationRelationList (ParamApplicationRelationList paramApplicationRelationList)

Parámetros de invocación

...

Parámetros de respuesta

...

Códigos error

...

Código

...

Descripción

...

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.

...

titleMás detalles

Signatura

ResultAuthorizeApplication authorizeApplication(ParamAuthorizeApplication paramAuthorizeApplication)

Parámetros de invocación

...

Parámetros de respuesta

...

Códigos error

...

Código

...

Descripción

...

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.

...

titleMás detalles

Signatura

ResultMethodApplicationList methodApplicationList (ParamMethodApplicationList paramMethodApplicationList)

Parámetros de invocación

...

Parámetros de respuesta

...

Códigos error

...

Código

...

Descripción

...

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.

...

titleMás detalles

Signatura

ResultActionList actionList(ParamActionList paramActionList)

Parámetros de invocación

...

Parámetros de respuesta

...

Códigos error

...

Código

...

Descripción

...

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 disponiblesEn 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

ResultAdmRoleList admRoleList(ParamAdmRoleList paramAdmRoleListResultApplicationList applicationList(ParamApplicationList paramApplicationList)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
admRoleSearchapplicationSearch1242693904Objeto AdmRoleSearch con campos de búsquedaObjeto ApplicationSearch


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
admRoleapplications1242693904[]Lista de objetos AdmRole, con los datos de los rolesobjetos Application
sizeintTamaño de la lista admRole applications devuelta


Códigos error



Código
Descripción
ADMROLELISTAPPLICATIONLIST_00Error durante el proceso de búsquedaADMROLELISTbúsqueda de aplicaciones.
APPLICATIONLIST_01El objeto ParamAdmRoleList ParamApplicationList es nulo.
ADMROLELISTAPPLICATIONLIST_02No existe ningún administrador de rol para esos se han encontrado aplicaciones para estos parámetros de búsqueda.
ADMROLELISTAPPLICATIONLIST_03Ha ocurrido algún tipo de error al buscar el rol en la base de datosrealizar la búsqueda.
APPLICATIONLIST_04Error de paginación al realizar la búsqueda.


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamAdmRoleListParamApplicationList params = new ParamAdmRoleListParamApplicationList();
AdmRoleSearchApplicationSearch admRoleSearchappSearch = new AdmRoleListApplicationSearch();
admRoleSearchappSearch.setnamesetAlias("nombre del perfilPAU");
params.setAdmRoleSearchsetApplicationSearch(admRoleSearchappSearch);
ResultAdmRoleListResultApplicationList result = pauAgent.admRoleListapplicationList(params);


Método '

...

applicationRelationList'

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íficocon 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

ResultAssignedRoleList assignedRoleList(ParamAssignedRoleList paramAssignedRoleListResultApplicationRelationList applicationRelationList (ParamApplicationRelationList paramApplicationRelationList)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
assignedRoleSearchapplicationRelationSearch1242693904Objeto AssignedRoleSearch con campos de búsquedaObjeto ApplicationRelationSearch


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
assignedRolesapplicationRelations1242693904[]Lista de objetos AssignedRole, con los datos de los rolesobjetos ApplicationRelation
sizeintTamaño de la lista assignedRoles lista applicationRelations devuelta


Códigos error



Código
Descripción
ASSIGNEDROLELISTAPPLICATIONRELATIONLIST_00Error durante el proceso de búsqueda de roles asignadosASSIGNEDROLELISTrelaciones entre aplicaciones
APPLICATIONRELATIONLIST_01El objeto paramAssignedRoleList ParamApplicationRelationList es nulo
ASSIGNEDROLELISTAPPLICATIONRELATIONLIST_02No se han encontrado asignaciones relaciones entre aplicaciones para esos estos parámetros de búsqueda.
ASSIGNEDROLELISTAPPLICATIONRELATIONLIST_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
ParamAssignedRoleListParamApplicationRelationList paramparams = new ParamAssignedRoleListParamApplicationRelationList();
AssignedRoleSearchApplicationRelationSearch sappSearch = new AssignedRoleSearchApplicationRelationSearch();
sappSearch.setFiscalAnagramsetApplicationAliasA("29120602AMARTSANJSVCD");
paramparams.setAssignedRoleSearchsetApplicationRelationSearch(sappSearch);
ResultAssignedRoleListResultApplicationRelationList result = pauAgent.assignedRoleListapplicationRelationList(paramparams);


Método '

...

authorizeApplication'

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 ParamAssignedRoleListByBranchSe 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 organismocomprueba 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

ResultAssignedRoleList assignedRoleList(ParamAssignedRoleListByBranch paramAssignedRoleListByBranchResultAuthorizeApplication authorizeApplication(ParamAuthorizeApplication paramAuthorizeApplication)

Parámetros de invocación


organismCode
NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
assignedRoleTreeSearch1242693904Objeto AssignedRoleTreeSearch con campos de búsqueda
applicationAliasAStringAlias aplicación A
applicationAliasBStringAlias aplicación B
methodCodeStringCódigo de organismodel método
ipStringDirección Ip


Parámetros de respuesta



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


Códigos error



Código
Descripción
ASSIGNEDROLELISTAUTHORIZEAPPLICATION_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
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
ParamAssignedRoleListParamAuthorizeApplication paramparamAuthorizeApplication = new ParamAssignedRoleListParamAuthorizeApplication();
AssignedRoleTreeSearch s = new AssignedRoleTreeSearch(paramAuthorizeApplication.setApplicationAliasA("App A");
sparamAuthorizeApplication.setFiscalAnagramsetApplicationAliasB("29120602AMARTSANJApp B");
s.setOrganismCode("ORG00021// ha de ser ip desde la que accede appA
paramAuthorizeApplication.setIp("127.0.0.3");
paramparamAuthorizeApplication.setAssignedRoleSearchsetMethodCode(s"MET00296");
ResultAssignedRoleListResultAuthorizeApplication result = pauAgent.assignedRoleListauthorizeApplication(paramparamAuthorizeApplication);


Método '

...

methodApplicationList'

Servicio que devuelve una lista de roles asignados a un usuario en función de la información pasada 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 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 organismoParamMethodApplicationList

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

ResultAssignedRoleList assignedRoleList(ParamAssignedRoleListByTree paramAssignedRoleListByTreeResultMethodApplicationList methodApplicationList (ParamMethodApplicationList paramMethodApplicationList)

Parámetros de invocación


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


Parámetros de respuesta



Tamaño de la lista assignedRoles devuelta
NombreTipoDescripción
resultError1242693904Objeto ResultError
assignedRolesmethods1242693904[]Lista de objetos AssignedRole, con los datos de los rolessizeintobjetos Method, métodos de la aplicación
ips1242693904[]Lista de objetos Ip, Ips de la aplicación


Códigos error



ASSIGNEDROLELIST
Código
Descripción
ASSIGNEDROLELISTMETHODAPPLICATIONLIST_00Error durante el proceso de búsqueda de roles asignados
ASSIGNEDROLELISTMETHODAPPLICATIONLIST_01El objeto paramAssignedRoleList ParamMethodApplicationList es nulo
ASSIGNEDROLELISTMETHODAPPLICATIONLIST_02No se han encontrado asignaciones para esos parámetros de búsqueda.hay Ips ni métodos asociados a la aplicación
METHODAPPLICATIONLIST_03Ha ocurrido algún error al realizar la búsqueda.
ASSIGNEDROLELISTMETHODAPPLICATIONLIST_04Debe indicarse el código de organismoEl Alias de la Aplicación es nulo


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamAssignedRoleListParamMethodApplicationList paramparams = new ParamAssignedRoleListParamMethodApplicationList();
AssignedRoleTreeSearch s = new AssignedRoleTreeSearch();
s.setFiscalAnagram("29120602AMARTSANJ");
s.setOrganismCode("ORG00021");
param.setAssignedRoleSearch(s);
ResultAssignedRoleListparams.setApplicationAlias("SIU");
ResultMethodApplicationList result = pauAgent.assignedRoleListmethodList(paramparams);


Búsquedas y consultas de acciones

Método '

...

actionList'

Servicio que devuelve una lista con los roles asignados a cada uno de los usuarios pasados como parámetros de acciones en función de la información pasada como parámetro en el objeto ParamAssignedRolesUserListAdemá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íficoParamActionList

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

ResultAssignedRolesUserList assignedRolesUserList(ParamAssignedRolesUserList paramAssignedRoleUserListResultActionList actionList(ParamActionList paramActionList)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
assignedRolesUserListSearchactionSearchAssignedRolesUserListSearchObjeto AssignedRolesUserListSearch con campos de búsqueda1242693904Objeto ActionSearch


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
assignedRolesToUserListactions1242693904[]Lista de objetos AssignedRolesToUser, con los datos de los rolesobjetos Action
sizeintTamaño de la lista actions devuelta


Códigos error



Código
Descripción
ASSIGNEDROLESUSERLISTACTIONLIST_00Error durante el proceso de búsqueda de roles asignadosASSIGNEDROLESUSERLISTHa ocurrido algún error al realizar la búsqueda
ACTIONLIST_01El objeto paramAssignedRolesUserList paramActionList es nulo
ASSIGNEDROLESUSERLISTACTIONLIST_02Los No se han encontrado acciones con los 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.
indicados


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamAssignedRolesUserListParamActionList params = new ParamAssignedRolesUserListParamActionList();
AssignedRolesUserListSearchActionSearch assignedRolesUserListSearchsearch = new AssignedRolesUserListSearchActionSearch();
assignedRolesUserListSearchsearch.setFiscalAnagramListsetAlias("11111111TINSERTAR_SELLOS");
params.setAssignedRolesUserListSearchsetActionSearch(assignedRolesUserListSearchsearch);
ResultAssignedRolesUserListResultActionList result = pauAgent.assignedRolesUserListactionList(params);



Búsquedas y consultas de usuarios


Método '

...

admRoleList'

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óndevuelve 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

ResultAuthorize authorize(ParamAuthorize paramAuthorizeResultAdmRoleList admRoleList(ParamAdmRoleList paramAdmRoleList)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
organismCodeadmRoleSearchString1242693904Código de organismo
applicationAliasStringAlias de la aplicación
Objeto AdmRoleSearch con campos de búsqueda


Parámetros de respuesta



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


Códigos error



Código
Descripción
AUTHORIZE
ADMROLELIST_00Error durante el proceso de
autorización
búsqueda
AUTHORIZE
ADMROLELIST_01El objeto
ParamAuthorize
ParamAdmRoleList es nulo
.
AUTHORIZE
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_07
ADMROLELIST_02
El parámetro alias de aplicación es nulo.
No 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
ParamAuthorizeParamAdmRoleList params = new ParamAuthorize()ParamAdmRoleList;
params.setApplicationAlias("SVCD"
AdmRoleSearch admRoleSearch = new AdmRoleList();
paramsadmRoleSearch.setFiscalAnagramsetname("25152907SDIAZMEDMnombre del perfil");
params.setOrganismCodesetAdmRoleSearch("ORG00002"admRoleSearch);
ResultAuthorizeResultAdmRoleList result = pauAgent.authorizeadmRoleList(params);


Método '

...

assignedRoleList'

Servicio que devuelve la última conexión de un usuario en una aplicaciónuna 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

ResultGetLastConnection getLastConnection(ParamGetLastConnection paramGetLastConnectionResultAssignedRoleList assignedRoleList(ParamAssignedRoleList paramAssignedRoleList)

Parámetros de invocación


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


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
userConassignedRolesUserConObjeto con la información de la última conexión de usuario.1242693904[]Lista de objetos AssignedRole, con los datos de los roles
sizeintTamaño de la lista assignedRoles devuelta


Códigos error



Código
Descripción
GETLASTCONNECTION
ASSIGNEDROLELIST_00Error durante el proceso de búsqueda
.
de roles asignados
GETLASTCONNECTION
ASSIGNEDROLELIST_01El
parámetro paramGetLastConnection
objeto paramAssignedRoleList es nulo
.
GETLASTCONNECTION
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
ASSIGNEDROLELIST_02
 El objeto userConSearch es nulo.
No 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
ParamGetLasConnection paramsParamAssignedRoleList param = new ParamAssignedRoleList();
AssignedRoleSearch s = new ParamGetLasConnectionAssignedRoleSearch();
paramss.setFiscalAnagram("11111111H29120602AMARTSANJ");
paramsparam.setApplicationAliassetAssignedRoleSearch("PAU"s);
ResultGetLasConnectionResultAssignedRoleList result = pauAgent.getLasConnectionassignedRoleList(paramsparam);



Método '

...

assignedRoleList1'

Servicio que devuelve dentro del objeto ResultRoleList un vector una lista de roles asignados a un usuario en función del contenido del parámetro paramRoleList.
Devuelve una lista de roles dados de alta en PAU, pudiendo filtrar por 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 , el o un código del rol, el nombre del rol, o la descripción del rolde rol específico o la rama de un organismo.


Expand
titleMás detalles

Signatura

ResultRoleList roleList(ParamRoleList paramRoleListResultAssignedRoleList assignedRoleList(ParamAssignedRoleListByBranch paramAssignedRoleListByBranch)

Parámetros de invocación


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


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
rolesassignedRolesAppRole1242693904[]Listado de roles encontradosLista de objetos AssignedRole, con los datos de los roles
sizeintTamaño del listadoTamaño de la lista assignedRoles devuelta


Códigos error



Código
Descripción
ROLELISTASSIGNEDROLELIST_00Error durante el proceso de búsqueda de roles .asignados
ROLELISTASSIGNEDROLELIST_01El objeto paramRoleList paramAssignedRoleList es nulo.
ROLELISTASSIGNEDROLELIST_04 02No se han encontrado roles asignaciones para estos esos parámetros de búsqueda.
ROLELISTASSIGNEDROLELIST_05 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
aramRoleListParamAssignedRoleList paramsparam = new ParamRoleListParamAssignedRoleList();
RoleSearchAssignedRoleTreeSearch searchs = new RoleSearch( AssignedRoleTreeSearch();
s.setFiscalAnagram("29120602AMARTSANJ");
searchs.setApplicationAliassetOrganismCode("aliasORG00021");
paramsparam.setRoleSearchsetAssignedRoleSearch(searchs);
ResultRoleListResultAssignedRoleList result = pauAgent.roleListassignedRoleList(paramsparam);


Método '

...

assignedRoleList2'

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 PAUuna 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

ResultUserByOrganismTree userByOrganismTree(ParamUserByOrganismTree paramUserByOrganismTreeResultAssignedRoleList assignedRoleList(ParamAssignedRoleListByTree paramAssignedRoleListByTree)

Parámetros de invocación


Alias de la aplicación
NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
organismsCodeTreeassignedRoleTreeSearchString[]Lista de códigos de organismos a los que puede pertenecer el usuario
roleNameStringNombre del rol
applicationAliasString1242693904Objeto AssignedRoleTreeSearch con campos de búsqueda
organismCodeStringCódigo de organismo


Parámetros de respuesta



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


Códigos error



USERSORGANISMTREEUSERSORGANISMTREE02USERSORGANISMTREE_03 ha ningún rol
Código
Descripción
USERSORGANISMTREE_01El objeto paramUserByOrganismTree es nulo.
Descripción
ASSIGNEDROLELIST_00Error durante el proceso de búsqueda de roles asignados
ASSIGNEDROLELIST_La lista de organismos está vacía o es nula.01El objeto paramAssignedRoleList es nulo
ASSIGNEDROLELIST_02No se han encontrado asignaciones para esos parámetros de búsqueda.
USERSORGANISMTREEASSIGNEDROLELIST_04El alias de la aplicación es nulo
USERSORGANISMTREE_05El rol no existe en el sistema
USERSORGANISMTREE_06El nombre del rol es nulo03Ha ocurrido algún error al realizar la búsqueda.
ASSIGNEDROLELIST_04Debe indicarse el código de organismo


Ejemplo de invocación

String[] organismsCodeTree = new String[2]; organismsCodeTree[0] = "ORG00007"; organismsCodeTree[1] = "ORG00012"; String roleName = "PREPARADOR-COMPULSOR"; String applicationAlias = "SCE"; ParamUserByOrganismTree param
Code Block
languagejava
titleEjemplo de invocación
Ejemplo de invocación
ParamAssignedRoleList param = new ParamAssignedRoleList();
AssignedRoleTreeSearch s = new ParamUserByOrganismTreeAssignedRoleTreeSearch();
params.setOrganismsCodeTreesetFiscalAnagram(organismsCodeTree"29120602AMARTSANJ");
params.setApplicationAliassetOrganismCode(applicationAlias"ORG00021");
param.setRoleNamesetAssignedRoleSearch(roleNames);
ResultUserByOrganismTreeResultAssignedRoleList result = pauAgent.userByOrganismTreeassignedRoleList(param);



Método '

...

assignedRolesUserList'

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 PAUuna 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

ResultUserByOrganismTreeExtended userByOrganismTreeExtended( ParamUserByOrganismTreeExtended  paramUserByOrganismTreeResultAssignedRolesUserList assignedRolesUserList(ParamAssignedRolesUserList paramAssignedRoleUserList)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
organismsCodeTreeassignedRolesUserListSearchString[]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
AssignedRolesUserListSearchObjeto AssignedRolesUserListSearch con campos de búsqueda


Parámetros de respuesta



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


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'

...

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

ResultUserListByProcedureAndRole userListByProcedureAndRole (ParamUserListByProcedureAndRole paramUserListByProcedureAndRole ResultAuthorize authorize(ParamAuthorize paramAuthorize)

Parámetros de invocación


entity
NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
signatureorganismCodeStringProcedimiento asociado al Grupo de Gestión.Código de organismo
applicationAliasStringIdentificador Alias de la entidad del procedimiento
roleCodeString[]Listado de Roles asociados a los usuarios
aplicación


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
userListrole1242693904Role[]Listado de usuarios obtenidos.Lista de objetos Role, con los datos de los roles


Códigos error



Código
Descripción
USERLISTBYPROCEDUREANDROLE
AUTHORIZE_00Error durante el proceso de
búsqueda.
autorización
USERLISTBYPROCEDUREANDROLE
AUTHORIZE_01El objeto
paramUserListByProcedureAndRole
ParamAuthorize es nulo.
USERLISTBYPROCEDUREANDROLE
AUTHORIZE_02El parámetro alias de aplicación es nulo.
AUTHORIZE_03El parámetro
signature
anagrama fiscal es nulo.
USERLISTBYPROCEDUREANDROLE
AUTHORIZE_04
Error que proviene del webservice
El parámetro código de organismo es nulo.
USERLISTBYPROCEDUREANDROLE
AUTHORIZE_05No existen
usuarios para los roles introducidos
datos para ese usuario u organismo.
USERLISTBYPROCEDUREANDROLE
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
AUTHORIZE_06
No existen usuarios para el parámetro signature introducido.
El 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
ParamUserListByProcedureAndRoleParamAuthorize params = new ParamUserListByProcedureAndRole( new ParamAuthorize();
params.setApplicationAlias("SVCD");
params.setSignaturesetFiscalAnagram("signature25152907SDIAZMEDM");
params.setEntitysetOrganismCode(“entity”"ORG00002");
ResultUserListByProcedureAndRoleResultAuthorize result = pauAgent.userListByProcedureAndRoleauthorize(params);

Búsquedas y consultas de grupos


Método '

...

getLastConnection'

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 grupola última conexión de un usuario en una aplicación.


Expand
titleMás detalles

Signatura

ResultGGList gestionGroupList(ParamGGList paramGGListResultGetLastConnection getLastConnection(ParamGetLastConnection paramGetLastConnection)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
ggSearchuserConSearch1242693904Objeto GGSearchEl 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
gestionGroupuserCon1242693904[]Lista de objetos GestionGroupUserConObjeto con la información de la última conexión de usuario.


Códigos error


Código
Descripción
GESTIONGROUPLIST
GETLASTCONNECTION_00 Error durante el proceso de búsqueda
de gestion group
.
GESTIONGROUPLIST
GETLASTCONNECTION_01 El parámetro paramGetLastConnection es nulo.
El objeto paramGGList
GETLASTCONNECTION_02  El objeto userConSearch es nulo.
GETLASTCONNECTION_03 El parametro del fiscal anagrama es nulo.
GESTIONGROUPLIST
GETLASTCONNECTION_04 El parametro de la aplicacion es nulo.
GETLASTCONNECTION_05 No se han encontrado
grupos de gestión para estos parámetros de búsqueda.
conexiones para esos parametros de busqueda


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamGGListParamGetLasConnection params = new ParamGGListParamGetLasConnection();
GGSearch search = new GGSearch();
search.setDescription("descripciónparams.setFiscalAnagram("11111111H");
params.setGgSearchsetApplicationAlias(search"PAU");
ResultGGListResultGetLasConnection result = pauAgent.gestionGroupListgetLasConnection(params);

Método 'gestionGroupListByApplication'

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é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

ResultGestionGroupListByApplication gestionGroupListByApplication (ParamGestionGroupListByApplication paramGestionGroupListByApplicationResultRoleList roleList(ParamRoleList paramRoleList)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
applicationGGSearchroleSearch1242693904Objeto ApplicationGGSearch
params1242693904Objeto SearchParams
Objeto ParamRoleList con campos de búsqueda


Parámetros de respuesta


NombreTipoDescripción
resultError1242693904Objeto ResultError
applicationGGroles1242693904AppRole[]Lista de objetos ApplicationGG (grupos de gestión)Listado de roles encontrados
sizeintTamaño de la lista applicationGG devueltadel listado


Códigos error


GESTIONGROUPLISTBYAPPLICATION_03 grupos de gestión para esa aplicaciónGESTIONGROUPLISTBYAPPLICATION_04
Código
Descripción
GESTIONGROUPLISTBYAPPLICATIONROLELIST_00 Error durante el proceso de búsqueda
GESTIONGROUPLISTBYAPPLICATION_01El parámetro paramGestionGroupListByApplication es nulo
GESTIONGROUPLISTBYAPPLICATION_02El parámetro alias de la aplicación es nulo
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 en el proceso de búsquedaal realizar la búsqueda.


Ejemplo de invocación


Code Block
languagejava
titleEjemplo de invocación
ParamGestionGroupListByApplicationaramRoleList params = new ParamRoleList();
RoleSearch search = new ParamGestionGroupListByApplicationRoleSearch();
paramssearch.setApplicationAlias("PAUalias");
ResultGestionGroupListByApplicationparams.setRoleSearch(search);
ResultRoleList result = pauAgent.gestionGroupListByApplicationroleList(params);


Método '

...

userByOrganismTree'

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 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

ResultGestionGroupListByUser gestionGroupListByUser(ParamGestionGroupListByUser paramGestionGroupListByUserResultUserByOrganismTree userByOrganismTree(ParamUserByOrganismTree paramUserByOrganismTree)

Parámetros de invocación


Objeto SearchParams
NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
userGGSearch1242693904Objeto UserGGSearch
params1242693904
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
ggUserListuser1242693904[]Lista de objetos UserGG
sizeintTamaño de la lista ggUserList devuelta
objetos User.


Códigos error



Código
Descripción
GESTIONGROUPLISTBYUSERUSERSORGANISMTREE_01El objeto paramUserByOrganismTree es nulo.
USERSORGANISMTREE_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'

...

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'

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

ResultGestionGroupListByUser gestionGroupListByUserLike(ParamGestionGroupListByUser paramGestionGroupListByUserResultUserByOrganismTreeExtended userByOrganismTreeExtended( ParamUserByOrganismTreeExtended  paramUserByOrganismTree)


Parámetros de invocación


userGGSearchFiltro de búsqueda para el objeto UserGG
NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
organismsCodeTreeUserGGSearchString[]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
ggUserListuser1242693904[]Lista de objetos UserGG
sizeintTamaño de la lista ggUserList devuelta
objetos User


Códigos error


GESTIONGROUPLISTBYUSER_03
Código
Descripción
GESTIONGROUPLISTBYUSERUSERSORGANISMTREE_00 Error durante el proceso de búsqueda de gestion group.
GESTIONGROUPLISTBYUSER_01El objeto ParamGestionGroupListByUser es nulo.
GESTIONGROUPLISTBYUSER_02El fiscalAnagram es nulo.
.
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 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.usuarios para esos
parámetros de búsqueda


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamGestionGroupListByUser paramsString[] organismsCodeTree = new String[2];
organismsCodeTree[0] = "ORG00007";
organismsCodeTree[1] = "ORG00012";
String[] rolenName = new ParamGestionGroupListByUser();
UserGGSearch userGGSearch String[2];
rolesName[0] = "EDITOR";
rolesName[1] = "ISSUER";
ParamUserByOrganismTree param = new UserGGSearch(ParamUserByOrganismTree();
param.setOrganismsCodeTree(organismsCodeTree);
userGGSearchparam.setFiscalAnagramsetApplicationAlias("11111111T"“SNT”);
paramsparam.setUserGGSearchsetRoleName(userGGSearchroleName);
ResultGestionGroupListByUserResultUserByOrganismTree result = pauAgent.gestionGroupListByUserLikeuserByOrganismTree(paramsparam);



Método '

...

UserListByProcedureAndRole'

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. 

...

usuarios en función del procedimiento y, opcionalmente, un listado de roles. Estos usuarios tendrán los procedimientos y los roles asignados en PAU.



No se han encontrado grupos de gestión para estos parámetros de búsqueda
Expand
titleMás detalles

Signatura

ResultGGList gestionGroupListWithoutProcedures(ParamGGList paramGGListResultUserListByProcedureAndRole userListByProcedureAndRole (ParamUserListByProcedureAndRole paramUserListByProcedureAndRole )


Parámetros de invocación


Objeto GGSearch
NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscalggSearch1242693904
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


Código
Descripción
GESTIONGROUPLIST_01El objeto paramGGList es nulo
GESTIONGROUPLIST_00Error durante el proceso de búsqueda de gestion group
GESTIONGROUPLIST_04
NombreTipoDescripción
resultError1242693904Objeto ResultError
gestionGroupuserListGestionGroup1242693904[]Lista Listado de objetos GestionGroup

Códigos error

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
ParamGGListParamUserListByProcedureAndRole params = new ParamGGListParamUserListByProcedureAndRole();
GGSearch ggSearch = new GGSearch();
ggSearch.setGGCode("CODE01params.setSignature("signature");
params.setGgSearchsetEntity(ggSearch“entity”);
ResultGGListResultUserListByProcedureAndRole result = pauAgent.gestionGroupListWithoutProceduresuserListByProcedureAndRole(params);




Búsquedas y consultas de grupos


Método '

...

gestionGroupList'

Servicio que devuelve un listado de una lista con los grupos de gestión e indica el tamaño del mismoen función a la información pasada como parámetro en el objeto ParamGGList.

Los grupos de gestión, se dan de alta en PAUgestió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

ResultGGListWithSize gestionGroupListWithSize (ParamGGListWithSize paramGGListWithSizeResultGGList gestionGroupList(ParamGGList paramGGList)

Parámetros de invocación


Lista de anagramas fiscales
NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
ggSearch1242693904Objeto GGSearch


Parámetros de respuesta



Tamaño de la lista de grupos de gestión.
NombreTipoDescripción
resultError1242693904Objeto ResultError
gestionGroup1242693904[]Listado de los grupos de gestión encontrados.sizeintLista 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
ParamGGListWithSizeParamGGList params = new ParamGGListWithSizeParamGGList();
GGSearch search = new GGSearch();
search.setDescription("descripción");
params.setGgSearch(search);
ResultGGListWithSizeResultGGList result = pauAgent.gestionGroupListWithSizegestionGroupList(params);

Búsquedas y consultas de procedimientos


Método '

...

gestionGroupListByApplication'

Servicio que devuelve los procedimientos asociados a un usuario bajo un organismouna 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

ResultGetAssignedProcedures assignedProcedureListByOrganism(ParamAssignedProcedureRoleList procedureSearchBean

ResultGestionGroupListByApplication gestionGroupListByApplication (ParamGestionGroupListByApplication paramGestionGroupListByApplication)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
procedureRoleSearchBeanAssignedProcedureRoleVSearchBeanObjeto AssignedProcedureRoleVSearchBean con los parámetros de búsquedaapplicationGGSearch1242693904Objeto ApplicationGGSearch
params1242693904Objeto SearchParams


Parámetros de respuesta



size
NombreTipoDescripción
resultErrorResultError1242693904Objeto ResultError
applicationGGintTamaño lista de procedimientos recuperadaprocedureRolesList<VProcedureRole>Listado de procedimientos recuperado1242693904[]Lista de objetos ApplicationGG (grupos de gestión)
sizeintTamaño de la lista applicationGG devuelta


Códigos error



El objeto procedureSearchBean es nulo
Código
Descripción
PROCEDURELISTBYORGANISMROLEGESTIONGROUPLISTBYAPPLICATION_00Error que proviene del webservices.PROCEDURELISTBYORGANISMROLEdurante el proceso de búsqueda
GESTIONGROUPLISTBYAPPLICATION_01El objeto ParamAssignedProcedureRoleList parámetro paramGestionGroupListByApplication es nulo
PROCEDURELISTBYORGANISMROLEGESTIONGROUPLISTBYAPPLICATION_02No existen procedimientos para los parámetros de busqueda
PROCEDURELISTBYORGANISMROLE_03Error inesperado
PROCEDURELISTBYORGANISMROLE_04El 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
ParamAssignedProcedureRoleListParamGestionGroupListByApplication paramAssignedProcedureRoleListparams = new ParamAssignedProcedureRoleListParamGestionGroupListByApplication();
AssignedProcedureRoleVSearchBean procedureRoleSearchBean = new AssignedProcedureRoleVSearchBean();
procedureRoleSearchBean.setSignature("1params.setApplicationAlias("PAU");
paramAssignedProcedureRoleList.setProcedureRoleSearchBean(procedureRoleSearchBean);
ResultGetAssignedProceduresResultGestionGroupListByApplication result = clientpauAgent.assignedProcedureListByOrganismgestionGroupListByApplication(paramAssignedProcedureRoleListparams);


Método '

...

gestionGroupListByUser'

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 DESFORuna 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

ResultGetProcedureAttributes getProcedureAttributes(ParamGetProcedureAttributes paramGetProcedureAttributesResultGestionGroupListByUser gestionGroupListByUser(ParamGestionGroupListByUser paramGestionGroupListByUser)

Parámetros de invocación


Código de identificación de entidad.
NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
signatureStringSignature o código del procedimiento
idEntityStringuserGGSearch1242693904Objeto UserGGSearch
params1242693904Objeto SearchParams


Parámetros de respuesta


NombreTipoDescripción
resultError1242693904Objeto ResultError
procedureAttributesggUserList1242693904[]Listado de atributos del procedimento buscadoLista de objetos UserGG
sizeintTamaño de la lista ggUserList devuelta


Códigos error


Código
Descripción
PROCEDUREATTRIBUTESGESTIONGROUPLISTBYUSER_00Error que proviene del webservicesdurante el proceso de búsqueda de gestion group.
PROCEDUREATTRIBUTESGESTIONGROUPLISTBYUSER_01El objeto paramGetProcedureAttributes ParamGestionGroupListByUser es nulo.
PROCEDUREATTRIBUTESGESTIONGROUPLISTBYUSER_02La signatura El fiscalAnagram es nulanulo.
PROCEDUREATTRIBUTESGESTIONGROUPLISTBYUSER_03El idEntity es nuloNo 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
ParamGetProcedureAttributesParamGestionGroupListByUser params = new ParamGetProcedureAttributes();
params.setSignature("474"ParamGestionGroupListByUser();
params.setIdEntitysetFiscalAnagram("011111111H");
ResultGetProcedureAttributesResultGestionGroupListByUser result = clientpauAgent.getProcedureAttributesgestionGroupListByUser(params);


Método '

...

gestionGroupListByUserLike'

Servicio que devuelve el detalle de un procedimiento de catálogo de la DGA dado en función de la información 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 ParamProcedureDetailparamGestionGroupListByUser usando el criterio LIKE para el grupo de gestión.
Los datos del procedimiento se consultan en DESFORgrupos de gestión y la asociación con los usuarios se realizará en PAU.


Expand
titleMás detalles

Signatura

ResultProcedureDetail procedureDetail(ParamProcedureDetail paramProcedureDetailResultGestionGroupListByUser gestionGroupListByUserLike(ParamGestionGroupListByUser paramGestionGroupListByUser)


Parámetros de invocación


signatureSignature o código del procedimiento
NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
userGGSearchStringUserGGSearchFiltro de búsqueda para el objeto UserGG


Parámetros de respuesta


NombreTipoDescripción
resultError1242693904Objeto ResultError
procedureggUserList1242693904Objeto Procedure, con los datos del procedimiento[]Lista de objetos UserGG
sizeintTamaño de la lista ggUserList devuelta


Códigos error


Código
Descripción
PROCEDUREDETAILGESTIONGROUPLISTBYUSER_00Error durante el proceso de búsqueda de procedure detailPROCEDUREDETAILgestion group.
GESTIONGROUPLISTBYUSER_01El objeto paramProcedureDetail ParamGestionGroupListByUser es nulo.
PROCEDUREDETAILGESTIONGROUPLISTBYUSER_02El fiscalAnagram es nulo.No existe un procedimiento para esa signaturePROCEDUREDETAIL_03
La Signature es nulaGESTIONGROUPLISTBYUSER_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
ParamProcedureDetailParamGestionGroupListByUser params = new ParamProcedureDetailParamGestionGroupListByUser();
//seUserGGSearch vauserGGSearch a= detallar por ejemplo el procedimiento de signatura 400
params.setSignature("400");
ResultProcedureDetail result = pauAgent.procedureDetailnew UserGGSearch();
userGGSearch.setFiscalAnagram("11111111T");
params.setUserGGSearch(userGGSearch);
ResultGestionGroupListByUser
result=pauAgent.gestionGroupListByUserLike(params);


Método '

...

gestionGroupListWithoutProcedures'

Servicio que devuelve el detalle de un procedimiento de catálogo de la DGA dado en función de la una lista con los grupos de gestión en función a 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 DESFORParamGGList. 

De cada grupo devuelve código, nombre, descripción y la lista de procedimientos asociados.

Expand
titleMás detalles

Signatura

ResultProcedureDetail procedureDetail (ParamProcedureDetailByIdEntity paramProcedureDetailByIdEntityResultGGList gestionGroupListWithoutProcedures(ParamGGList paramGGList)

Parámetros de invocación


idEntity
NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
ggSearchStringCódigo de la entidad asociada
signatureStringSignature o código del procedimiento
1242693904Objeto GGSearch


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
proceduregestionGroup1242693904Objeto Procedure, con los datos del procedimientoGestionGroup[]Lista de objetos GestionGroup


Códigos error



PROCEDUREDETAILBYIDENTITYError que proviene del webservices
Código
Descripción
GESTIONGROUPLIST_01El objeto paramGGList es nulo
GESTIONGROUPLIST_00Error 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 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
ParamProcedureDetailByIdEntityParamGGList params = new ParamProcedureDetailByIdEntityParamGGList();
//seGGSearch vaggSearch a= detallar por ejemplo el procedimiento de signatura 400
params.setSignature("400new GGSearch();
ggSearch.setGGCode("CODE01");
params.setIdEntitysetGgSearch("0"ggSearch);
ResultProcedureDetailResultGGList result = pauAgent.procedureDetailgestionGroupListWithoutProcedures(params);



Método '

...

gestionGroupListWithSize'

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 DESFORun 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

ResultProcedureDetailSIA procedureDetailBySIACod(ParamProcedureDetailBySIACod paramProcedureDetailBySIACodResultGGListWithSize gestionGroupListWithSize (ParamGGListWithSize paramGGListWithSize)


Parámetros de invocación


codSIACódigo SIA asociado
NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
ggSearchString1242693904Lista de anagramas fiscales


Parámetros de respuesta


NombreTipoDescripción
resultError1242693904Objeto ResultError
procedureSIAgestionGroup1242693904Objeto ProcedureSIA, con los datos del procedimiento[]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
PROCEDUREDETAILBYSIAGESTIONGROUPLIST_00 Error durante el proceso de búsqueda de procedureDetailBySIACodgestion group.
PROCEDUREDETAILBYSIAGESTIONGROUPLIST_01 El objeto ParamProcedureDetailBySIACod paramGGList es nulo.
PROCEDUREDETAILBYSIAGESTIONGROUPLIST_02No existe un procedimiento para ese código SIA
PROCEDUREDETAILBYSIA_03El código SIA es nulo
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
ParamProcedureDetailBySIACodParamGGListWithSize params = new ParamProcedureDetailBySIACod ParamGGListWithSize();
GGSearch search = new GGSearch();
paramssearch.applicationIdsetDescription("PAUdescripción");
params.setCodSIAsetGgSearch("213285"search);
ResultProcedureDetailSIAResultGGListWithSize result = pauAgent.procedureDetailBySIACodgestionGroupListWithSize(params);


Búsquedas y consultas de procedimientos


Método '

...

assignedProcedureListByOrganism'

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.

El servicio devuelve la información completa del procedimiento, que no se muestra en el servicio anterior 'procedureDetail'.

los procedimientos asociados a un usuario bajo un organismo.

Expand
titleMás detalles

Signatura

ResultProcedureExtendedDetailprocedureDetailExtended(ParamProcedureDetailparamProcedureDetail
ResultGetAssignedProcedures assignedProcedureListByOrganism(ParamAssignedProcedureRoleList procedureSearchBean)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
signatureprocedureRoleSearchBeanStringSignature o código del procedimiento1242693904Objeto AssignedProcedureRoleVSearchBean con los parámetros de búsqueda


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultErrorprocedureExtended1242693904Objeto ProcedureDetailExtended, con los datos del procedimiento completos
sizeintTamaño lista de procedimientos recuperada
procedureRolesList<1242693904>Listado de procedimientos recuperado


Códigos error



La Signature es nula
Código
Descripción
PROCEDUREDETAILPROCEDURELISTBYORGANISMROLE_00Error durante el proceso de búsqueda de procedure detailPROCEDUREDETAILque proviene del webservices.
PROCEDURELISTBYORGANISMROLE_01El objeto paramProcedureDetail ParamAssignedProcedureRoleList es nulo
PROCEDUREDETAILPROCEDURELISTBYORGANISMROLE_02No existe un procedimiento para esa signaturePROCEDUREDETAIL_03existen 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
ParamProcedureDetailParamAssignedProcedureRoleList paramsparamAssignedProcedureRoleList = new ParamProcedureDetailParamAssignedProcedureRoleList();
//se va a detallar por ejemplo el procedimiento de signatura 400
params.setApplicationId("PAU");
params.setFiscalAnagram("00000000T
AssignedProcedureRoleVSearchBean procedureRoleSearchBean = new AssignedProcedureRoleVSearchBean();
procedureRoleSearchBean.setSignature("1");
paramsparamAssignedProcedureRoleList.setSignaturesetProcedureRoleSearchBean("400"procedureRoleSearchBean);
ResultProcedureExtendedDetailResultGetAssignedProcedures result = pauAgentclient.procedureDetailExtendedassignedProcedureListByOrganism(paramsparamAssignedProcedureRoleList);


Método '

...

getProcedureAttributes'

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 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.


Expand
titleMás detalles

Signatura

ResultProcedureDetailList procedureDetailList (ParamProcedureDetailList paramProcedureDetailListResultGetProcedureAttributes getProcedureAttributes(ParamGetProcedureAttributes paramGetProcedureAttributes)

Parámetros de invocación


Objeto procedureSearch. Contiene criterios de búsqueda de Procedure, así como los parámetros de paginación y ordenación
NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscalprocedureSearchProcedureSearch
signatureStringSignature o código del procedimiento
idEntityStringCódigo de identificación de entidad.


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
proceduresprocedureAttributesProcedure1242693904[]Listado de procedimientos encontradosatributos del procedimento buscado


Códigos error



Código
Descripción
PROCEDUREDETAILLISTPROCEDUREATTRIBUTES_00 Error en el proceso de búsqueda de listado de procedimientosPROCEDUREDETAILLISTque proviene del webservices.
PROCEDUREATTRIBUTES_01 El objeto paramProcedureDetailList paramGetProcedureAttributes es nulo.
PROCEDUREDETAILLISTPROCEDUREATTRIBUTES_02 No existen procedimientos para los parámetros de búsquedaLa signatura es nula.
PROCEDUREDETAILLISTPROCEDUREATTRIBUTES_03 El id de la entidad idEntity es nulo.


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureDetailListParamGetProcedureAttributes params = new ParamProcedureDetailListParamGetProcedureAttributes();
ProcedureSearch procedureSearch = new ProcedureSearch();
procedureSearch.setIdEntidad("0params.setSignature("474");
procedureSearchparams.setDenominationsetIdEntity("registro oficial0");
params.setProcedureSearch(procedureSearch);
ResultProcedureDetailList
result=pauAgent.procedureDetailListResultGetProcedureAttributes 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 de los procedimientos del procedimiento se consultan en DESFOR.


Expand
titleMás detalles

Signatura

ResultProcedureDetailList procedureDetailList (ParamProcedureDetailList paramProcedureDetailListResultProcedureDetail procedureDetail(ParamProcedureDetail paramProcedureDetail)

Parámetros de invocación


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


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
proceduresprocedure1242693904[]Listado de procedimientos encontrados junto a sus órganos gestores.Objeto Procedure, con los datos del procedimiento


Códigos error



No se han encontrado procedimientos para los parámetros de búsqueda.
Código
Descripción
PROCEDURELISTPROCEDUREDETAIL_01El objeto ParamSignaturesAndIdEntity es nuloPROCEDURELIST_0300Error durante el proceso de búsqueda de procedure detail
PROCEDUREDETAIL_01El objeto signatures paramProcedureDetail es nulo
PROCEDURELISTPROCEDUREDETAIL_05El objeto signatures está vacíoPROCEDURELIST_0602No existe un procedimiento para esa signature
PROCEDUREDETAIL_03La Signature es nula


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
GestionGroupParamProcedureDetail gestionGroupparams = new GestionGroupParamProcedureDetail();
gestionGroup.setName("nombre GG");
gestionGroup.setDescription("descripción GG
//se va a detallar por ejemplo el procedimiento de signatura 400
params.setSignature("400");
ProcedureResultProcedureDetail procedure1result = 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.

...

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.


Expand
titleMás detalles

Signatura

ResultProcedureDetailSIA procedureDetailWithSIAResultProcedureDetail procedureDetail (ParamProcedureDetailByIdEntity paramProcedureDetailparamProcedureDetailByIdEntity)

Parámetros de invocación


Código que se quiere obtener el detalle
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
procedureSIAprocedure1242693904Objeto ProcedureSIAProcedure, con los datos del procedimiento


Códigos error



PROCEDUREDETAILSIALa Entidad es nula
Código
Descripción
PROCEDUREDETAILSIAPROCEDUREDETAILBYIDENTITY_00 Error durante el proceso de búsqueda de
procedure detail.
PROCEDUREDETAILSIAPROCEDUREDETAILBYIDENTITY_01 El objeto paramProcedureDetail paramProcedureDetailByIdEntity es
nulo.
PROCEDUREDETAILSIAPROCEDUREDETAILBYIDENTITY_02 No existe un procedimiento para esa signatureLa signatura es nula.
PROCEDUREDETAILBYIDENTITY_03 La Signature entidad es nula.PROCEDUREDETAILSIA
PROCEDUREDETAILBYIDENTITY_04 Error que proviene del webservices


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureDetailByIdEntity params = new
ParamProcedureDetailByIdEntity();
params.applicationId("PAU");
params.setfiscalAnagram("11111111H");
//se va a detallar por ejemplo el procedimiento de signatura 400
params.setSignature("400");
params.setIdEntity("0");
ResultProcedureDetailSIAResultProcedureDetail result = pauAgent.procedureDetailWithSIAprocedureDetail(params);


Método '

...

procedureDetailBySIACod'

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 ParamProcedureListel detalle de un procedimiento del Catálogo de Procedimientos a partir del código SIA.

Los datos de los procedimientos del procedimiento se consultan en DESFOR.


Expand
titleMás detalles

Signatura

ResultProcedureList procedureList(ParamProcedureList paramProcedureListResultProcedureDetailSIA procedureDetailBySIACod(ParamProcedureDetailBySIACod paramProcedureDetailBySIACod)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
procedureSearchcodSIA1242693904Objeto ProcedureSearch, campos de búsqueda para procedimientosStringCódigo SIA asociado


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
procedureprocedureSIA1242693904[]Lista de objetos ProcedureObjeto ProcedureSIA, con los datos del procedimiento


Códigos error



PROCEDURELIST
Código
Descripción
PROCEDURELISTPROCEDUREDETAILBYSIA_00Error durante el proceso de búsqueda de procedureprocedureDetailBySIACod
PROCEDURELISTPROCEDUREDETAILBYSIA_01El objeto paramProcedureList ParamProcedureDetailBySIACod es nulo
PROCEDURELISTPROCEDUREDETAILBYSIA_02Error que proviene del webservicesNo existe un procedimiento para ese código SIA
PROCEDUREDETAILBYSIA_03El objeto ProcedureSearch código SIA es nulo


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureListParamProcedureDetailBySIACod params = new ParamProcedureListParamProcedureDetailBySIACod();
ProcedureSearch procedureSearch = new ProcedureSearch();
procedureSearch.setSignatureparams.applicationId("PAU");
procedureSearchparams.setVersionsetCodSIA("213285");
procedureSearch.setIdOrgano("");
params.setProcedureSearch(procedureSearch);
ResultProcedureListResultProcedureDetailSIA result = pauAgent.procedureListprocedureDetailBySIACod(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.


Expand
titleMás detalles

Signatura

ResultProcedureList procedureList(ParamProcedureListAndEntity paramProcedureListAndEntityResultProcedureDetailList procedureDetailList (ParamProcedureDetailList paramProcedureDetailList)


Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
procedureSearch1242693904Objeto ProcedureSearch, campos de búsqueda para procedimientosProcedureSearchObjeto 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
procedureprocedures1242693904Procedure[]Lista Listado de objetos Procedureprocedimientos encontrados


Códigos error


PROCEDURELIST
Código
Descripción
PROCEDURELISTPROCEDUREDETAILLIST_00 Error durante en el proceso de búsqueda de listado de procedureprocedimientos
PROCEDURELISTPROCEDUREDETAILLIST_01 El objeto paramProcedureList paramProcedureDetailList es nulo.
PROCEDURELISTPROCEDUREDETAILLIST_02 Error que proviene del webservicesNo existen procedimientos para los parámetros de búsqueda.
PROCEDUREDETAILLIST_03 El objeto ProcedureSearch es nuloPROCEDURELIST_04El parámetro idEntidad id de la entidad es nulo


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureListAndIdEntityParamProcedureDetailList params = new ParamProcedureListAndIdEntityParamProcedureDetailList();
ProcedureSearch procedureSearch = new ProcedureSearch();
procedureSearch.setSignaturesetIdEntidad("0");
procedureSearch.setVersionsetDenomination("");
procedureSearch.setIdOrgano("");
procedureSearch.setIdEntidad("0registro oficial");
params.setProcedureSearch(procedureSearch);
ResultProcedureListResultProcedureDetailList
result = pauAgent.procedureListprocedureDetailList(params);


Método '

...

procedureDetailWithManagingOrganismList'

Servicio que devuelve un listado de procedimientos existentes asociados a una aplicación y con una entidad suministrada.

Estos procedimientos no Busca procedimientos junto a sus organismos gestores.

Los datos de los procedimientos se consultan en DESFOR.


Expand
titleMás detalles

Signatura

VResultProcedureRoleList procedureListByAplicationAndIdEntity(VParamProcedureRoleList vparamProcedureRoleListResultProcedureDetailList procedureDetailList (ParamProcedureDetailList paramProcedureDetailList)


Parámetros de invocación


Objeto VProcedureRoleSearchBean, campos de búsqueda para procedimientos
NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscalprocedureSearchBeanVProcedureRoleSearchBean
signaturesString[]Códigos de los procedimiento de los que se quiere obtener el detalle
idEntityStringCódigo de la entidad asociada


Parámetros de respuesta


Tamaño de la lista de procedimientos recuperados
NombreTipoDescripción
resultErrorResultErrorObjeto ResultError
procedureRolesVProcedureRoleLista de objetos VProcedureRole
sizeint1242693904Objeto ResultError
procedures1242693904[]Listado de procedimientos encontrados junto a sus órganos gestores.


Códigos error


Código
Descripción
PROCEDURELISTBYAPLICATIONANDIDENTITYPROCEDURELIST_00Error durante el proceso de búsquedaPROCEDURELISTBYAPLICATIONANDIDENTITY_0101El objeto ParamSignaturesAndIdEntity es nulo
PROCEDURELIST_03El objeto ParamAssignedProcedureRoleList signatures 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
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
VParamProcedureRoleListGestionGroup paramsgestionGroup = new VParamProcedureRoleListGestionGroup();
paramsgestionGroup.setApplicationIdsetName("SFEnombre GG");
paramsgestionGroup.setFiscalAnagramsetDescription("00000000Tdescripción GG");;
Procedure VProcedureRoleSearchBeanprocedure1 procedureSearchBean= new VProcedureRoleSearchBeanProcedure();		
procedureSearchBeanprocedure1.setAppAliassetSignature("SFE1");
procedureSearchBeanprocedure1.setEntitysetDenomination("0");
params.setProcedureSearchBean(procedureSearchBean);
VResultProcedureRoleList result = client.procedureListByAplicationAndIdEntity(paramsden1");


Método '

...

procedureDetailWithSIA'

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 horizontalesel detalle de un procedimiento del Catálogo de Procedimientos incluyendo el código SIA.

Los datos de los procedimientos se consultan en DESFOR.


Expand
titleMás detalles

Signatura

ResultProcedureListByOrganism procedureListByOrganism(ParamProcedureListByOrganism paramProcedureListByOrganismResultProcedureDetailSIA procedureDetailWithSIA(ParamProcedureDetailByIdEntity paramProcedureDetail)

Parámetros de invocación


organismCode organismo del que se quieren obtener sus procedimientos asociados.idEntity
NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método.
fiscalAnagramStringAnagrama fiscal.
idEntityStringCódigo de la entidad asociada
signatureStringCódigo de identificación de entidad.del procedimiento que se quiere obtener el detalle


Parámetros de respuesta



Tamaño de la lista de procedimientos
NombreTipoDescripción
resultError1242693904Objeto ResultError
proceduresprocedureSIA1242693904[]

Lista de objetos Procedure

sizeintObjeto ProcedureSIA, con los datos del procedimiento


Códigos error



PROCEDURELISTBYORGANISM
Código
Descripción
PROCEDURELISTBYORGANISMPROCEDUREDETAILSIA_00Error durante el proceso de búsqueda de procedure by organism.detail
PROCEDURELISTBYORGANISMPROCEDUREDETAILSIA_01El objeto paramProcedureListByOrganism paramProcedureDetail es nulo.
PROCEDURELISTBYORGANISMPROCEDUREDETAILSIA_02El organismCode es nulo.No existe un procedimiento para esa signature
PROCEDUREDETAILSIA_03El idEntity es nulo.PROCEDURELISTBYORGANISMLa Signature es nula
PROCEDUREDETAILSIA_04El organismo no tiene procedimientos asociados.La Entidad es nula


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureListByOrganismParamProcedureDetailByIdEntity params = new ParamProcedureListByOrganismParamProcedureDetailByIdEntity();
//se van a listar, por ejemplo, los procedimientos del organismo “ORG04174” y la entidad “0”
params.setOrganismCode("ORG04174params.applicationId("PAU");
params.setfiscalAnagram("11111111H");
params.setSignature("400");
params.setIdEntity("0");
ResultProcedureListByOrganismResultProcedureDetailSIA result = clientpauAgent.procedureListByOrganismprocedureDetailWithSIA(params);


Método '

...

procedureList'

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é asignadoun 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.


Expand
titleMás detalles

Signatura

ResultProcedureListByUser procedureListByUser(ParamProcedureListByUser paramProcedureListByUserResultProcedureList 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



PROCEDURELISTBYUSER_04
Código
Descripción
PROCEDURELISTBYUSERPROCEDURELIST_00Error durante el proceso de búsqueda de
procedure by user.
PROCEDURELISTBYUSERPROCEDURELIST_01El objeto paramProcedureListByUser paramProcedureList es nulo.
PROCEDURELISTBYUSERPROCEDURELIST_02El fiscal anagrama es nulo.
PROCEDURELISTBYUSER_03 El usuario no existe en la base de datos
Error que proviene del webservices
PROCEDURELIST_03El objeto ProcedureSearch es nulo


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureListByUserParamProcedureList params = new ParamProcedureList();
ProcedureSearch procedureSearch = new ParamProcedureListByUser( ProcedureSearch();
procedureSearch.setSignature("");
paramsprocedureSearch.setFiscalAnagramsetVersion(""anagrama fiscal);
procedureSearch.setIdOrgano("");
ResultProcedureListByUserparams.setProcedureSearch(procedureSearch);
ResultProcedureList result = pauAgent.procedureListByUserprocedureList(params);



Método '

...

procedureList1'

Servicio que devuelve los un listado de procedimientos dados de catálogo a los que un usuario puede acceder alta en catálogo por la DGA en función del grupo de gestión al que esté asignado y a su entidad correspondientede la información pasada como parámetro en el objeto ParamProcedureListByUser. Es similar al servicio procedureListByUser, pero en este es último es solamente necesario el anagrama fiscal como parámetro de búsquedaservicio referenciado en el punto 6.3.1.2, siendo obligatorio introducir el campo “idEntidad”.
Los datos de los procedimientos se consultan en DESFOR.


Expand
titleMás detalles

Signatura

ResultProcedureListByUser procedureListByUser(ParamProcedureListByUserAndEntity paramProcedureListByUserAndEntityResultProcedureList procedureList(ParamProcedureListAndEntity paramProcedureListAndEntity)


Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
idEntityprocedureSearchString1242693904Código de la entidad asociadaObjeto ProcedureSearch, campos de búsqueda para procedimientos


Parámetros de respuesta


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


Códigos error


PROCEDURELISTBYUSER
Código
Descripción
PROCEDURELISTBYUSERPROCEDURELIST_00Error durante el proceso de búsqueda de procedure by user
PROCEDURELISTBYUSERPROCEDURELIST_01El objeto paramProcedureListByUser paramProcedureList es nulo
PROCEDURELISTBYUSERPROCEDURELIST_02El fiscal anagrama es nuloError que proviene del webservices
PROCEDURELIST_03El usuario no existe en la base de datos
PROCEDURELISTBYUSER_04Error que proviene del webservices
PROCEDURELISTBYUSER_05El id de la entidad objeto ProcedureSearch es nulo
PROCEDURELIST_04El parámetro idEntidad es nulo


Ejemplo de invocación


Code Block
languagejava
titleEjemplo de invocación
ParamProcedureListByUserAndEntityParamProcedureListAndIdEntity params = new ParamProcedureListByUserAndEntity( ParamProcedureListAndIdEntity();
ProcedureSearch procedureSearch = new ProcedureSearch();
procedureSearch.setSignature("");
procedureSearch.setVersion("");
paramsprocedureSearch.setFiscalAnagramsetIdOrgano("72979986C");
paramsprocedureSearch.setIdEntitysetIdEntidad("0");
params.setProcedureSearch(procedureSearch);
ResultProcedureListByUserResultProcedureList result = pauAgent.procedureListByUserprocedureList(params);


Método '

...

procedureListbyAplicationAndIdEntity'

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 un listado de procedimientos existentes asociados a una aplicación y con una entidad suministrada.

Estos procedimientos no se consultan en DESFOR. Los grupos de gestión se consultan en PAU.

Expand
titleMás detalles

Signatura

ResultProcedureDetailList proceduresByGestionGroup(ParamGGList paramGGListVResultProcedureRoleList procedureListByAplicationAndIdEntity(VParamProcedureRoleList vparamProcedureRoleList)


Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
ggSearchprocedureSearchBeanGGSearch1242693904Objeto VProcedureRoleSearchBean, campos de búsqueda del grupo de gestiónpara procedimientos


Parámetros de respuesta


NombreTipoDescripción
resultError1242693904Objeto ResultError
procedureprocedureRoles1242693904[]Lista de objetos Procedureobjetos VProcedureRole
sizeintTamaño de la lista de procedimientos recuperados


Códigos error


Código
Descripción
GESTIONGROUPLISTPROCEDURELISTBYAPLICATIONANDIDENTITY_00Error en la operación. Error durante el proceso de búsqueda.
GESTIONGROUPLISTPROCEDURELISTBYAPLICATIONANDIDENTITY_01El objeto ParamGGList ParamAssignedProcedureRoleList es nulo.
GESTIONGROUPLISTPROCEDURELISTBYAPLICATIONANDIDENTITY_0402Error en la operación. No se han encontrado grupos de gestión para No 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
ParamGGListVParamProcedureRoleList params = new ParamGGList(VParamProcedureRoleList();
params.setApplicationId("SFE");
GGSearch ggSearch params.setFiscalAnagram("00000000T");
VProcedureRoleSearchBean procedureSearchBean= new GGSearch(VProcedureRoleSearchBean();		
procedureSearchBean.setAppAlias("SFE");
ggSearchprocedureSearchBean.setGgCodesetEntity("CODE010");
params.setGgSearchsetProcedureSearchBean(ggSearchprocedureSearchBean);
ResultProcedureDetailListVResultProcedureRoleList result =pauAgent client.proceduresByGestionGroup procedureListByAplicationAndIdEntity(params);


Método '

...

ProcedureListByOrganism'

Servicio que devuelve un listado la lista 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. 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.


Expand
titleMás detalles

Signatura

ResultProcedureList procedurePublishedList(ParamProcedureList paramProcedureListResultProcedureListByOrganism procedureListByOrganism(ParamProcedureListByOrganism paramProcedureListByOrganism)


Parámetros de invocación


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

Anagrama fiscal.

organismCode String Objeto ProcedureSearch, campos de búsqueda para procedimientosCó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
procedureprocedures1242693904[]

Lista de objetos Procedure

sizeintTamaño de la lista de procedimientos


Códigos error


PROCEDURELIST
Código
Descripción
PROCEDURELISTPROCEDURELISTBYORGANISM_00 Error durante el proceso de búsqueda de procedure by organism.
PROCEDURELISTPROCEDURELISTBYORGANISM_01 El objeto paramProcedureList paramProcedureListByOrganism es nulo.
PROCEDURELISTPROCEDURELISTBYORGANISM_02 Error que proviene del webservicesEl organismCode es nulo.
PROCEDURELISTBYORGANISM_03 El objeto ProcedureSearch idEntity es nulo.
PROCEDURELISTBYORGANISM_04 El organismo no tiene procedimientos asociados.


Ejemplo de invocación


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

Anexos

Objetos comunes

...


//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.


Expand
titleMás detalles

Signatura

ResultProcedureListByUser procedureListByUser(ParamProcedureListByUser paramProcedureListByUser)

Parámetros de invocación


NombreTipoDescripción

...

applicationIdString

...

Nombre

...

Tipo

...

Descripción

...

1242693904

...

Nombre

...

Tipo

...

Descripción

...

String

...

Aplicación que ejecuta el método
fiscalAnagramString

...

Anagrama 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 DESFOR.


Expand
titleMás detalles

Signatura

ResultProcedureListByUser procedureListByUser(ParamProcedureListByUserAndEntity paramProcedureListByUserAndEntity)

Parámetros de invocación


NombreTipoDescripción

...

applicationId

...

1242693904

...

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


Parámetros de respuesta


NombreTipoDescripción

...

resultError

...

1242693904

...

Objeto ResultError

...

procedure1242693904[]Lista de

...

objetos Procedure

...


Códigos error

...

Nombre

...

Tipo

...

Descripción

...

String

...


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 '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.


Expand
titleMás detalles

Signatura

ResultProcedureDetailList proceduresByGestionGroup(ParamGGList paramGGList)

Parámetros de invocación


NombreTipoDescripción

...

applicationId

...

1242693904

...

Nombre

...

Tipo

...

Descripción

...

String

...

StringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
ggSearchGGSearchObjeto de búsqueda del grupo de gestión


Parámetros de respuesta


NombreTipoDescripción
resultError1242693904Objeto ResultError
procedure1242693904[]

Lista de

...

Nombre

...

Tipo

...

Descripción

...

1242693904

...

Nombre

...

Tipo

...

Descripción

...

1242693904

...

roleType

...

Action[]

...

Nombre

...

Tipo

...

Descripción

...

VProcedureRole

...

Nombre

...

Tipo

...

Descripción

...

String

...

Nombre

...

Tipo

...

Descripción

...

1242693904

...

Nombre

...

Tipo

...

Descripción

...

String

...

Nombre

...

Tipo

...

Descripción

...

AssignedRole

...

Nombre

...

Tipo

...

Descripción

...

String[]

...

Nombre

...

Tipo

...

Descripción

...

Nombre

...

Tipo

...

Descripción

...

1242693904

...

objetos Procedure

sizeintTamaño de la lista de procedimientos


Códigos error


Código
Descripción
GESTIONGROUPLIST_00 Error en la operación. Error durante el proceso de búsqueda.
GESTIONGROUPLIST_01 El objeto ParamGGList es nulo.
GESTIONGROUPLIST_04Error en la operación. 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
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.


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);



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
addressalias

String

Dirección Ip

...

Nombre

...

Tipo

...

Descripción

...

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


idOrgano órgano del catálogoversion
Nombre
Tipo
Descripción
signatureapplicationAlias

String

Signatura del procedimiento
denominationStringDenominación del procedimiento
servicioStringServicio asociado al procedimiento
idEntidadStringCódigo de la entidad
Alias de la aplicación
ggCodeStringCódigo del grupo de gestión
ggNameStringVersióndescOrganoNombre del grupo de gestión
admRoleCodeStringDescripción Código del órgano del catálogorol
xmlDataadmRoleNameStringprocedureAttributesProcedureAttributes[]Lista de atributos del procedimientoNombre del rol


Objeto '

...

ApplicationGGSearch' 
Anchor

...

ApplicationGGSearch

...

ApplicationGGSearch


Valor del atributo del procedimiento
Nombre
Tipo
Descripción
codeStringCódigo del atributo del procedimiento
valueStringapplicationGG

1242693904

Objeto ApplicationGG
searchParams1242693904Objeto SearchParams


Objeto '

...

ApplicationRelation' 
Anchor

...

ApplicationRelation

...

ApplicationRelation


fiscalAnagramsignature
Nombre
Tipo
Descripción
applicationAliasA

String

Fiscal anagram del usuario al que se asocia el procedimientoAlias aplicación A
applicationAliasBStringSignatura del procedimientodenominationAlias aplicación B
applicationNameAStringDenominación del procedimientoentityNombre aplicación A
applicationNameBStringCó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)

...

Nombre 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


fiscalAnagramadmRole
Nombre
Tipo
Descripción
application

1242693904

StringFiscal anagram del usuario al que se asocia el procedimiento
signatureStringSignatura del procedimiento
denominationStringDenominación del procedimiento
entityStringCódigo de la entidad
Objeto Application
params1242693904Objeto SearchParams


Objeto 'AppRole' 
Anchor
AppRole
AppRole


NombreTipoDescripción
roleCodeStringCódigo del
perfil administrativoadmName
rol de la aplicación
nameStringNombre del
perfil administrativo
rol
organismCodeappAlias
descripcionString
Código del organismo bajo el que se ha asociado el procedimiento al usuario
Descripción del rol
applicationAliasString
Identificador
Alias de la aplicación
(por el momento solo lo usa SFE)paramSearchParamsObjeto SearchParams

roleType

intTipo de rol
actions

Action[]

Lista de objetos Action

Objeto '

...

AssignedProcedureRoleVSearchBean' 
Anchor

...

AssignedProcedureRoleVSearchBean

...

AssignedProcedureRoleVSearchBean


Nombre
Tipo
Descripción
atributos
procedureRoleV
AtributosWS[]Lista de atributos que tiene el procedimientoayudacoberturaStringCobertura de la ayudaayudaimporteStringImporte en la ayudabeneficiariosStringBeneficiarios del procedimientocanalaplicacionurlStringDirección url del formulario
dinámico asoccanalcitapreviahorarioStringHorario de atención de cita
previacanalcitapreviatfnStringNúmero de teléfono de cita previacanalcorreoordinarioStringDirección postalcanalemailStringDirección de correo electrónicocanalfaxStringNúmero de faxcanaloficinahorarioStringHorario de atención de la oficinacanaloficinasurlStringDirección url de la oficinacanalserviciourlStringDirección de servicio electrónicocanaltelefonoStringNúmero de teléfonocanaltelefonohorarioStringHorario de atencióndenominationStringDenominación del procedimientodepartamentoresolutorStringIdentificador del
departamento resolutor asociadodescDepartamentoStringDescripción del departamento.descOrganoStringDescripción del órgano del catálogodirigidoadministracionesStringAdministraciones a las que va dirigidodirigidociudadanosStringGrupo de ciudadanos al que va dirigidodirigidoempresasStringGrupo de empresas al que va dirigidodirigidoentidadescolabStringGrupo de entidades
colaboradoras al que va dirigidodocumentacionStringDocumentación del departamentoefecSilenAdmStringEfecto del silencio administrativofamiliaDescripcionStringDescripción de familia.fecPubBoletinStringFecha de publicación en el boletínfecpresentaciondesdeStringDesde, fecha de plazo de presentación de solicitudesfecpresentacionhastaStringHasta, fecha de plazo de presentación de solicitudesfileCaracteristicas1StringFichero Caracteristicas1 en Base64fileCaracteristicas2StringFichero Caracteristicas2 en Base64formasiniciartramiteStringFormas de iniciar el trámiteidDepartamentoStringIdentificador del departamento asociadoidEntidadStringCódigo de la entidad a la que perteneceidFamiliaStringIdentificador de la familiaidMateriaStringIdentificador de la materiaidOrganoStringCódigo del órgano del catálogoidProcedimientoStringIdentificador del procedimientoidorganoresolutorStringIdentificador del órgano resolutor asociadoidorganotramitadorStringIdentificador del órgano tramitador asociadoidsectoractividadStringIdentificador del sector de actividad al que va dirigidoincertificadoempStringCertificado de empadronamiento de la documentaciónindniStringDni de la documentacióninfAdicionalStringInformación adicional asociada al procedimientoinfechaprevisionStringFecha de previsióninidaplicaciongestoraStringAplicación gestorainlistaserviciosStringLista de servicios de la documentacióninnivelactualStringNivel actual de interaccióninnivelprevistoStringNivel previsto de interaccióninnumsolicitudesanStringNúmero de solicitudes anualesinobservacionesStringObservaciones del SIDinteraccionemailStringEnvío de avisos de correo electrónicointeraccionestadourlStringDirección de consulta sobre el estado de tramitacióninteraccionnotifurlStringDirección de notificaciones telemáticasinteraccionsmsStringEnvío de avisos vía smsinteracciontfnStringNúmero de información sobre el estado de tramitaciónmateriaDescripcionStringDescripción de la materianombreCaracteristicas1StringNombre del fichero caracteristicas1nombreCaracteristicas2StringNombre del fichero caracteristicas1normativaStringNormativa del procedimientoobjetoStringObjeto del procedimientoobservacionesStringObservaciones del procedimientoplazoResolucionStringPlazo de resoluciónplazopresentacionStringPlazo de presentación de solicitudespendientePlazobooleanPlazo pendienterecursosStringRecursos del procedimientorequisitosStringRequisitos del procedimientoservicioStringServicio asociado al procedimientosignatureStringSignatura del procedimientotasacodigoStringCodificación de la tasatasadescripcionStringDescripción de la tasatasaentidadespagoStringEntidades de pago en cajatasamediospagoStringMedios de pago de la tasatasapagoStringPago de tasastasaurlStringUrl de pago telemático de la tasatiempomedioresolucionStringTiempo medio de resoluciónversionStringVersión del procedimientovudsStringVentanilla única de directiva de serviciosvudscodigosStringDescripción de los códigos asociados a VUDSxmlDataStringprocedureAttributes1242693904[]Lista de atributos del procedimiento

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
assignedRoleAssignedRoleObjeto 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
procedureAttributesProcedureAttributes[]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 '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
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

...

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

...

Nombre
Tipo
Descripción
userGG1242693904Objeto UserGG
searchParams1242693904Objeto SearchParams


Objeto 'UserList' 
Anchor
UserList
UserList

...