Versions Compared

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 En este apartado se explicarán los servicios de PAU, cómo invocar, parámetros que devuelve y un ejemplo de invocación de cada servicio


ÍNDICE DE SERVICIOS

Table of Contents
maxLevel3


Servicios IInfoServicePortType

Búsquedas y consultas de aplicaciones

Método 'applicationList'

Servicio que devuelve una lista de aplicaciones definidas en la aplicación PAU, en función de la información que se pasa como parámetro en el objeto ParamApplicationList.

La información devuelta de cada aplicación incluye, el alias de la aplicación, el nombre de la aplicación, las Ips asignadas o los métodos que tiene asociados.


Expand
titleMás detalles

Signatura

ResultApplicationList applicationList(ParamApplicationList paramApplicationList)

Parámetros de invocación


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


Parámetros de respuesta



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


Códigos error



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


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamApplicationList params = new ParamApplicationList();
ApplicationSearch appSearch = new ApplicationSearch();
appSearch.setAlias("PAU");
params.setApplicationSearch(appSearch);
ResultApplicationList result = pauAgent.applicationList(params);


Método 'applicationRelationList'

Servicio que devuelve una lista con las relaciones de acceso existentes entre dos aplicaciones, dada de alta en PAU, en función de la información pasada como parámetro en el objeto paramApplicationRelationList

Esta relación es la que permite que una aplicación utilice servicios de otra aplicación.


Expand
titleMás detalles

Signatura

ResultApplicationRelationList applicationRelationList (ParamApplicationRelationList paramApplicationRelationList)

Parámetros de invocación


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


Parámetros de respuesta



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


Códigos error



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


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamApplicationRelationList params = new ParamApplicationRelationList();
ApplicationRelationSearch appSearch = new ApplicationRelationSearch();
appSearch.setApplicationAliasA("SVCD");
params.setApplicationRelationSearch(appSearch);
ResultApplicationRelationList result = pauAgent.applicationRelationList(params);


Método 'authorizeApplication'

Servicio que comprueba si una aplicación tiene autorización sobre otra para acceder a un determinado método. Se comprueba también si la ip desde la que accede es una de las permitidas para dicha aplicación.

La relación entre la aplicación invocante y los servicios de la aplicación invocada debe estar dada de alta en PAU. La Ip tambien debe estar dada de alta en PAU.


Expand
titleMás detalles

Signatura

ResultAuthorizeApplication authorizeApplication(ParamAuthorizeApplication paramAuthorizeApplication)

Parámetros de invocación


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


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError


Códigos error



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


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamAuthorizeApplication paramAuthorizeApplication = new ParamAuthorizeApplication();
paramAuthorizeApplication.setApplicationAliasA("App A");
paramAuthorizeApplication.setApplicationAliasB("App B");
// ha de ser ip desde la que accede appA
paramAuthorizeApplication.setIp("127.0.0.3");
paramAuthorizeApplication.setMethodCode("MET00296");
ResultAuthorizeApplication result = pauAgent.authorizeApplication(paramAuthorizeApplication);


Método 'methodApplicationList'

Servicio que devuelve dentro del objeto ResultMethodApplicationList un vector de IPs y un vector de Métodos asociados con la aplicación que se pasa como parámetro en el objeto ParamApplicationList.ParamMethodApplicationList

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 asociadoslista de métodos y de Ips relacionadas con una aplicación, deben estar dadas de alta en PAU.


Expand
titleMás detalles

Signatura

ResultApplicationList applicationList(ParamApplicationList paramApplicationListResultMethodApplicationList methodApplicationList (ParamMethodApplicationList paramMethodApplicationList)

Parámetros de invocación


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


Parámetros de respuesta



Tamaño de la lista applications devuelta
NombreTipoDescripción
resultError1242693904Objeto ResultError
applicationsmethods1242693904[]Lista de objetos Applicationsizeintobjetos Method, métodos de la aplicación
ips1242693904[]Lista de objetos Ip, Ips de la aplicación


Códigos error



APPLICATIONLIST
Código
Descripción
APPLICATIONLISTMETHODAPPLICATIONLIST_00Error durante el proceso de búsqueda de aplicaciones.
APPLICATIONLISTMETHODAPPLICATIONLIST_01El objeto ParamApplicationList ParamMethodApplicationList es nulo.
APPLICATIONLISTMETHODAPPLICATIONLIST_02No se han encontrado aplicaciones para estos 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.
APPLICATIONLISTMETHODAPPLICATIONLIST_04Error El Alias de paginación al realizar la búsqueda.la Aplicación es nulo


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamApplicationListParamMethodApplicationList params = new ParamApplicationList();
ApplicationSearch appSearch = new ApplicationSearch();
appSearch.setAlias("PAU"ParamMethodApplicationList();
params.setApplicationSearchsetApplicationAlias(appSearch"SIU");
ResultApplicationListResultMethodApplicationList result = pauAgent.applicationListmethodList(params);


Búsquedas y consultas de acciones

Método '

...

actionList'

Servicio que devuelve una lista con las relaciones de acceso existentes entre dos aplicaciones, dada de alta en PAU, en de acciones en función de la información pasada como parámetro en el objeto paramApplicationRelationListEsta relación es la que permite que una aplicación utilice servicios de otra ParamActionList

Estas acciones deben estar dadas de alta en PAU. Se puede buscar la acción mediante su código, el alias de la aplicación, el nombre de la aplicación.


Expand
titleMás detalles

Signatura

ResultApplicationRelationList applicationRelationList (ParamApplicationRelationList paramApplicationRelationListResultActionList actionList(ParamActionList paramActionList)

Parámetros de invocación


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


Parámetros de respuesta



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


Códigos error



Ha ocurrido algún error al realizar la búsqueda.
Código
Descripción
APPLICATIONRELATIONLISTACTIONLIST_00Error durante el proceso de búsqueda de relaciones entre aplicacionesAPPLICATIONRELATIONLISTHa ocurrido algún error al realizar la búsqueda
ACTIONLIST_01El objeto ParamApplicationRelationList paramActionList es nulo
APPLICATIONRELATIONLISTACTIONLIST_02No se han encontrado relaciones entre aplicaciones para estos parámetros de búsquedaAPPLICATIONRELATIONLIST_03acciones con los parámetros de búsqueda indicados


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamApplicationRelationListParamActionList params = new ParamApplicationRelationListParamActionList();
ApplicationRelationSearchActionSearch appSearchsearch = new ApplicationRelationSearchActionSearch();
appSearchsearch.setApplicationAliasAsetAlias("SVCDINSERTAR_SELLOS");
params.setApplicationRelationSearchsetActionSearch(appSearchsearch);
ResultApplicationRelationListResultActionList result = pauAgent.applicationRelationListactionList(params);



Búsquedas y consultas de usuarios


Método '

...

admRoleList'

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

ResultAuthorizeApplication authorizeApplication(ParamAuthorizeApplication paramAuthorizeApplicationResultAdmRoleList admRoleList(ParamAdmRoleList paramAdmRoleList)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
applicationAliasAadmRoleSearchStringAlias aplicación A
applicationAliasBStringAlias aplicación B
methodCodeStringCódigo del método
ipStringDirección Ip
1242693904Objeto AdmRoleSearch con campos de búsqueda


Parámetros de respuesta



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


Códigos error



La ip no está en la lista de ip's permitidas.
Código
Descripción
AUTHORIZEAPPLICATIONADMROLELIST_00Error durante el proceso de autorización.búsqueda
AUTHORIZEAPPLICATIONADMROLELIST_01El parámetro alias de la aplicación la aplicación A objeto ParamAdmRoleList es nulo.
AUTHORIZEAPPLICATIONADMROLELIST_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_06No 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
ParamAuthorizeApplicationParamAdmRoleList paramAuthorizeApplicationparams = new ParamAuthorizeApplication();
paramAuthorizeApplication.setApplicationAliasA("App A"ParamAdmRoleList;
AdmRoleSearch admRoleSearch = new AdmRoleList();
paramAuthorizeApplicationadmRoleSearch.setApplicationAliasBsetname("App B");
// ha de ser ip desde la que accede appA
paramAuthorizeApplication.setIp("127.0.0.3nombre del perfil");
paramAuthorizeApplicationparams.setMethodCodesetAdmRoleSearch("MET00296"admRoleSearch);
ResultAuthorizeApplicationResultAdmRoleList result = pauAgent.authorizeApplicationadmRoleList(paramAuthorizeApplicationparams);


Método '

...

assignedRoleList'

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 una lista de roles asignados a un usuario en función de la información pasada como parámetro en el objeto ParamMethodApplicationListLa lista de métodos y de Ips relacionadas con una aplicación, deben estar dadas de alta en PAUParamAssignedRoleList.

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

ResultMethodApplicationList methodApplicationList (ParamMethodApplicationList paramMethodApplicationListResultAssignedRoleList assignedRoleList(ParamAssignedRoleList paramAssignedRoleList)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
applicationAliasassignedRoleSearchStringAlias de la aplicación1242693904Objeto AssignedRoleSearch con campos de búsqueda


Parámetros de respuesta



Lista de objetos Ip, Ips de la aplicación
NombreTipoDescripción
resultError1242693904Objeto ResultError
methodsassignedRoles1242693904[]Lista de objetos Method, métodos de la aplicaciónips1242693904[]objetos AssignedRole, con los datos de los roles
sizeintTamaño de la lista assignedRoles devuelta


Códigos error



METHODAPPLICATIONLIST
Código
Descripción
METHODAPPLICATIONLISTASSIGNEDROLELIST_00Error durante el proceso de búsqueda de roles asignados
METHODAPPLICATIONLISTASSIGNEDROLELIST_01El objeto ParamMethodApplicationList paramAssignedRoleList es nulo
METHODAPPLICATIONLISTASSIGNEDROLELIST_02No hay Ips ni métodos asociados a la aplicaciónse han encontrado asignaciones para esos parámetros de búsqueda.
ASSIGNEDROLELIST_03Ha ocurrido algún error al realizar la búsqueda.
METHODAPPLICATIONLISTASSIGNEDROLELIST_04El Alias de la Aplicación es nuloDebe indicarse el código de organismo


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamMethodApplicationList paramsParamAssignedRoleList param = new ParamAssignedRoleList();
AssignedRoleSearch s = new ParamMethodApplicationListAssignedRoleSearch();
paramss.setApplicationAliassetFiscalAnagram("SIU29120602AMARTSANJ");
ResultMethodApplicationListparam.setAssignedRoleSearch(s);
ResultAssignedRoleList result = pauAgent.methodListassignedRoleList(paramsparam);

Búsquedas y consultas de acciones



Método '

...

assignedRoleList1'

Servicio que devuelve una lista de acciones roles asignados a un usuario en función de la información pasada como parámetro en el objeto ParamActionListEstas acciones deben estar dadas de alta en PAU. Se puede buscar la acción mediante su códigoParamAssignedRoleListByBranch

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 nombre de la aplicacióno un código de rol específico o la rama de un organismo.


Expand
titleMás detalles

Signatura

ResultActionList actionList(ParamActionList paramActionListResultAssignedRoleList assignedRoleList(ParamAssignedRoleListByBranch paramAssignedRoleListByBranch)

Parámetros de invocación


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


Parámetros de respuesta



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


Códigos error



Código
Descripción
ACTIONLISTASSIGNEDROLELIST_00Ha ocurrido algún error al realizar la búsquedaACTIONLISTError durante el proceso de búsqueda de roles asignados
ASSIGNEDROLELIST_01El objeto paramActionList paramAssignedRoleList es nulo
ACTIONLISTASSIGNEDROLELIST_02No se han encontrado acciones con los parámetros de búsqueda indicadosasignaciones 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
ParamActionListParamAssignedRoleList paramsparam = new ParamActionListParamAssignedRoleList();
ActionSearchAssignedRoleTreeSearch searchs = new ActionSearch( AssignedRoleTreeSearch();
s.setFiscalAnagram("29120602AMARTSANJ");
searchs.setAliassetOrganismCode("INSERTAR_SELLOSORG00021");
paramsparam.setActionSearchsetAssignedRoleSearch(searchs);
ResultActionListResultAssignedRoleList result = pauAgent.actionListassignedRoleList(paramsparam);

Búsquedas y consultas de usuarios


Método '

...

assignedRoleList2'

Servicio que devuelve el listado de perfiles administrativos con el que se puede crear una asignación de un grupo de gestión una lista de roles asignados 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 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

ResultAdmRoleList admRoleList(ParamAdmRoleList paramAdmRoleListResultAssignedRoleList assignedRoleList(ParamAssignedRoleListByTree paramAssignedRoleListByTree)

Parámetros de invocación


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


Parámetros de respuesta



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


Códigos error



Código
Descripción
ADMROLELISTASSIGNEDROLELIST_00Error durante el proceso de búsqueda de roles asignados
ADMROLELISTASSIGNEDROLELIST_01El objeto ParamAdmRoleList paramAssignedRoleList es nulo
ADMROLELISTASSIGNEDROLELIST_02No existe ningún administrador de rol se han encontrado asignaciones para esos parámetros de búsqueda.
ADMROLELISTASSIGNEDROLELIST_03Ha ocurrido algún tipo de error al buscar el rol en la base de datosrealizar la búsqueda.
ASSIGNEDROLELIST_04Debe indicarse el código de organismo


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamAdmRoleListParamAssignedRoleList paramsparam = new ParamAdmRoleListParamAssignedRoleList();
AdmRoleSearchAssignedRoleTreeSearch admRoleSearchs = new AdmRoleListAssignedRoleTreeSearch();
admRoleSearchs.setnamesetFiscalAnagram("nombre del perfil29120602AMARTSANJ");
s.setOrganismCode("ORG00021");
paramsparam.setAdmRoleSearchsetAssignedRoleSearch(admRoleSearchs);
ResultAdmRoleListResultAssignedRoleList result = pauAgent.admRoleListassignedRoleList(paramsparam);



Método '

...

assignedRolesUserList'

Servicio que devuelve una lista de con los roles asignados a un usuario en función de la información pasada como parámetro cada uno de los usuarios pasados como parámetros en el objeto ParamAssignedRoleList.Se puede buscar los 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

ResultAssignedRoleList assignedRoleList(ParamAssignedRoleList paramAssignedRoleListResultAssignedRolesUserList assignedRolesUserList(ParamAssignedRolesUserList paramAssignedRoleUserList)

Parámetros de invocación


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

1242693904

Objeto AssignedRoleSearch AssignedRolesUserListSearch con campos de búsqueda


Parámetros de respuesta



Tamaño de la lista assignedRoles devuelta
NombreTipoDescripción
resultError1242693904Objeto ResultError
assignedRolesassignedRolesToUserList1242693904[]Lista de objetos AssignedRoleAssignedRolesToUser, con los datos de los rolessizeint


Códigos error



Código
Descripción
ASSIGNEDROLELISTASSIGNEDROLESUSERLIST_00Error durante el proceso de búsqueda de roles asignados
ASSIGNEDROLELISTASSIGNEDROLESUSERLIST_01El objeto paramAssignedRoleList paramAssignedRolesUserList es nulo
ASSIGNEDROLELISTASSIGNEDROLESUSERLIST_02No se han encontrado asignaciones para esos Los parámetros de búsqueda son nulos o no se ha definido ningún usuario (anagramas fiscales).
ASSIGNEDROLELISTASSIGNEDROLESUSERLIST_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
ParamAssignedRoleListParamAssignedRolesUserList paramparams = new ParamAssignedRoleListParamAssignedRolesUserList();
AssignedRoleSearchAssignedRolesUserListSearch sassignedRolesUserListSearch = new AssignedRoleSearchAssignedRolesUserListSearch();
sassignedRolesUserListSearch.setFiscalAnagramsetFiscalAnagramList("29120602AMARTSANJ11111111T");
paramparams.setAssignedRoleSearchsetAssignedRolesUserListSearch(sassignedRolesUserListSearch);
ResultAssignedRoleListResultAssignedRolesUserList result = pauAgent.assignedRoleListassignedRolesUserList(paramparams);


Método '

...

authorize'

Servicio que devuelve una lista de roles asignados autoriza 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 organismocomprobando 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

ResultAssignedRoleList assignedRoleList(ParamAssignedRoleListByBranch paramAssignedRoleListByBranchResultAuthorize authorize(ParamAuthorize paramAuthorize)

Parámetros de invocación


organismCode
NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
assignedRoleTreeSearchorganismCode1242693904Objeto AssignedRoleTreeSearch con campos de búsquedaStringCódigo de organismo
applicationAliasStringCódigo Alias de organismola aplicación


Parámetros de respuesta



int
NombreTipoDescripción
resultError1242693904Objeto ResultError
assignedRolesrole1242693904[]Lista de objetos AssignedRoleRole, con los datos de los rolessizeTamaño de la lista assignedRoles devuelta


Códigos error



Código
Descripción
ASSIGNEDROLELIST
AUTHORIZE_00Error durante el proceso de
búsqueda de roles asignadosASSIGNEDROLELIST
autorización
AUTHORIZE_01El objeto
paramAssignedRoleList
ParamAuthorize es nulo.
ASSIGNEDROLELISTASSIGNEDROLELIST_03
AUTHORIZE_02
No se han encontrado asignaciones para esos parámetros de búsqueda.
El parámetro alias de aplicación es nulo.
AUTHORIZE_03El parámetro anagrama fiscal es nulo.
AUTHORIZE_04El parámetro código de organismo es nulo.
AUTHORIZE_05No existen datos para ese usuario u organismo.
AUTHORIZE_06El funcionario no tiene roles para esa aplicación y organismo.
AUTHORIZE_07Ha ocurrido algún tipo de error al
realizar la búsqueda.ASSIGNEDROLELIST_04Debe indicarse el código de organismo
buscar el rol en la base de datos.


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamAssignedRoleListParamAuthorize paramparams = new ParamAssignedRoleListParamAuthorize();
AssignedRoleTreeSearch s = new AssignedRoleTreeSearch(params.setApplicationAlias("SVCD");
sparams.setFiscalAnagram("29120602AMARTSANJ25152907SDIAZMEDM");
sparams.setOrganismCode("ORG00021ORG00002");
param.setAssignedRoleSearch(s);
ResultAssignedRoleListResultAuthorize result = pauAgent.assignedRoleListauthorize(paramparams);


Método '

...

getLastConnection'

Servicio que devuelve una lista de roles asignados a un usuario en función de la información pasada como parámetro en el objeto ParamAssignedRoleListByTree.Se puede buscar los roles asignados buscando por el fiscal anagram del usuario, el código de organismo, el alias de la aplicación o un código de rol específico o el árbol al que pertenece de un organismola última conexión de un usuario en una aplicación.


Debe indicarse el código de organismo
Expand
titleMás detalles

Signatura

ResultAssignedRoleList assignedRoleList(ParamAssignedRoleListByTree paramAssignedRoleListByTreeResultGetLastConnection getLastConnection(ParamGetLastConnection paramGetLastConnection)

Parámetros de invocación


Código de organismo
NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
assignedRoleTreeSearchuserConSearch1242693904Objeto AssignedRoleTreeSearch con campos de búsquedaorganismCodeStringEl objeto UserConSearch, contiene criterios de búsqueda de UserCon, así como los parámetros de paginación y ordenación.


Parámetros de respuesta


Tamaño de la lista assignedRoles devuelta
NombreTipoDescripción
resultError1242693904Objeto ResultError
assignedRolesuserCon

1242693904

[]
Lista de objetos AssignedRole, con los datos de los rolessizeint

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


Códigos error


Código
Descripción
ASSIGNEDROLELIST
GETLASTCONNECTION_00 Error durante el proceso de búsqueda
de roles asignados
.
ASSIGNEDROLELIST
GETLASTCONNECTION_01 El
objeto paramAssignedRoleList
parámetro paramGetLastConnection es nulo.
ASSIGNEDROLELIST
GETLASTCONNECTION_02
No se han encontrado asignaciones para esos parámetros de búsqueda.
ASSIGNEDROLELIST_03Ha ocurrido algún error al realizar la búsqueda.
ASSIGNEDROLELIST_04
 El objeto userConSearch es nulo.
GETLASTCONNECTION_03 El parametro del fiscal anagrama es nulo.
GETLASTCONNECTION_04 El parametro de la aplicacion es nulo.
GETLASTCONNECTION_05 No se han encontrado conexiones para esos parametros de busqueda


Ejemplo de invocación

ParamAssignedRoleList param = new ParamAssignedRoleList(); AssignedRoleTreeSearch s
Code Block
languagejava
titleEjemplo de invocación
ParamGetLasConnection params = new AssignedRoleTreeSearchParamGetLasConnection();
sparams.setFiscalAnagram("29120602AMARTSANJ11111111H");
sparams.setOrganismCodesetApplicationAlias("ORG00021PAU");
param.setAssignedRoleSearch(s);
ResultAssignedRoleList ResultGetLasConnection result = pauAgent.assignedRoleListgetLasConnection(paramparams);



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 con los roles asignados a cada uno de los usuarios pasados como parámetros 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íficode 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

ResultAssignedRolesUserList assignedRolesUserList(ParamAssignedRolesUserList paramAssignedRoleUserListResultRoleList roleList(ParamRoleList paramRoleList)

Parámetros de invocación


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


Parámetros de respuesta


NombreTipoDescripción
resultError1242693904Objeto ResultError
assignedRolesToUserListroles

1242693904[]

Lista de objetos AssignedRolesToUser, con los datos de los rolesListado de roles encontrados
sizeintTamaño del listado


Códigos error


Código
Descripción
ASSIGNEDROLESUSERLISTROLELIST_00 Error durante el proceso de búsqueda de roles asignados.
ASSIGNEDROLESUSERLISTROLELIST_01 El objeto paramAssignedRolesUserList paramRoleList es nulo.
ASSIGNEDROLESUSERLISTROLELIST_02Los 04 No se han encontrado roles para estos parámetros de búsqueda son nulos o no se ha definido ningún usuario (anagramas fiscales).
ASSIGNEDROLESUSERLISTROLELIST_0305 Ha ocurrido algún error al realizar la búsqueda.


Ejemplo de invocación


Code Block
languagejava
titleEjemplo de invocación
ParamAssignedRolesUserListaramRoleList params = new ParamAssignedRolesUserListParamRoleList();
AssignedRolesUserListSearchRoleSearch assignedRolesUserListSearchsearch = new AssignedRolesUserListSearchRoleSearch();
assignedRolesUserListSearchsearch.setFiscalAnagramListsetApplicationAlias("11111111Talias");
params.setAssignedRolesUserListSearchsetRoleSearch(assignedRolesUserListSearchsearch);
ResultAssignedRolesUserListResultRoleList result = pauAgent.assignedRolesUserListroleList(params);


Método '

...

userByOrganismTree'

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



AUTHORIZEAUTHORIZE
Expand
titleMás detalles

Signatura

ResultAuthorize authorize(ParamAuthorize paramAuthorizeResultUserByOrganismTree userByOrganismTree(ParamUserByOrganismTree paramUserByOrganismTree)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
organismCodeorganismsCodeTreeString[]Código de organismoLista 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
roleuser1242693904[]Lista de objetos Role, con los datos de los rolesobjetos User.


Códigos error



Código
Descripción
AUTHORIZE
USERSORGANISMTREE_01El objeto paramUserByOrganismTree es nulo.
USERSORGANISMTREE_00Error durante el proceso de
autorización
AUTHORIZE_01El objeto ParamAuthorize es nulo.
AUTHORIZE_03El parámetro anagrama fiscal es nulo.
búsqueda
USERSORGANISMTREE_02
El parámetro alias de aplicación es nulo.
La 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
parámetro código de organismo es nulo.AUTHORIZE_05No existen datos para ese usuario u organismo.AUTHORIZE_06El funcionario no tiene roles para esa aplicación y organismo.AUTHORIZE_07Ha ocurrido algún tipo de error al buscar el rol en la base de datos.
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
ParamAuthorize paramsString[] organismsCodeTree = new String[2];
organismsCodeTree[0] = "ORG00007";
organismsCodeTree[1] = "ORG00012";
String roleName = "PREPARADOR-COMPULSOR";
String applicationAlias = "SCE";
ParamUserByOrganismTree param = new ParamAuthorizeParamUserByOrganismTree();
paramsparam.setApplicationAliassetOrganismsCodeTree("SVCD"organismsCodeTree);
paramsparam.setFiscalAnagramsetApplicationAlias("25152907SDIAZMEDM"applicationAlias);
paramsparam.setOrganismCodesetRoleName("ORG00002"roleName);
ResultAuthorizeResultUserByOrganismTree result = pauAgent.authorizeuserByOrganismTree(paramsparam);



Método '

...

userByOrganismTreeExtended' @deprecated


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


GETLASTCONNECTION
Expand
titleMás detalles

Signatura

ResultGetLastConnection getLastConnection(ParamGetLastConnection paramGetLastConnectionResultUserByOrganismTreeExtended userByOrganismTreeExtended( ParamUserByOrganismTreeExtended  paramUserByOrganismTree)


Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
userConSearchorganismsCodeTree1242693904El objeto UserConSearch, contiene criterios de búsqueda de UserCon, así como los parámetros de paginación y ordenación.String[]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
userConuser1242693904Objeto con la información de la última conexión de usuario.[]Lista de objetos User


Códigos error


Código
Descripción
GETLASTCONNECTION
USERSORGANISMTREE_00 Error durante el proceso de búsqueda.
GETLASTCONNECTION
USERSORGANISMTREE_01 El
parámetro paramGetLastConnection
objeto paramUserByOrganismTree es nulo.
GETLASTCONNECTION
USERSORGANISMTREE_02
 El objeto userConSearch es nulo.
No se han encontrado usuarios para este
organismo y rol.
USERSORGANISMTREE_03 El
parametro del fiscal anagrama
parámetro nombre de rol es nulo
.
GETLASTCONNECTION
USERSORGANISMTREE_04 El
parametro
parámetro alias de la
aplicacion
aplicación es nulo
.
GETLASTCONNECTION
USERSORGANISMTREE_05 El rol no existe en el sistema
USERSORGANISMTREE_06 No se han encontrado
conexiones para esos parametros de busqueda

Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamGetLasConnection params
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 ParamGetLasConnectionParamUserByOrganismTree();
paramsparam.setFiscalAnagramsetOrganismsCodeTree("11111111H"organismsCodeTree);
paramsparam.setApplicationAlias("PAU"“SNT”);
param.setRoleName(roleName);
ResultGetLasConnectionResultUserByOrganismTree result = pauAgent.getLasConnectionuserByOrganismTree(paramsparam);



Método '

...

UserListByProcedureAndRole'

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 roluna lista de usuarios en función del procedimiento y, opcionalmente, un listado de roles. Estos usuarios tendrán los procedimientos y los roles asignados en PAU.



Expand
titleMás detalles

Signatura

ResultRoleList roleList(ParamRoleList paramRoleListResultUserListByProcedureAndRole userListByProcedureAndRole (ParamUserListByProcedureAndRole paramUserListByProcedureAndRole )


Parámetros de invocación


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


Parámetros de respuesta


NombreTipoDescripción
resultError1242693904Objeto ResultError
rolesuserList1242693904[]Listado de roles encontrados
sizeintTamaño del listado
usuarios obtenidos.


Códigos error


Ha ocurrido algún error al realizar la búsqueda.
Código
Descripción
ROLELISTUSERLISTBYPROCEDUREANDROLE_00 ROLELIST_05 Error durante el proceso de búsqueda de roles.
ROLELIST_01 El objeto paramRoleList es nulo.
ROLELIST_04 No se han encontrado roles para estos parámetros de búsqueda.
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
aramRoleListParamUserListByProcedureAndRole params = new ParamRoleListParamUserListByProcedureAndRole();
RoleSearch search = new RoleSearch();
search.setApplicationAlias("aliasparams.setSignature("signature");
params.setRoleSearchsetEntity(search“entity”);
ResultRoleListResultUserListByProcedureAndRole result = pauAgent.roleListuserListByProcedureAndRole(params);




Búsquedas y consultas de grupos


Método '

...

gestionGroupList' @deprecated


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 con los grupos de gestión en función a la información pasada como parámetro en el objeto ParamGGList.

Los grupos de gestión se consultarán en PAU por nombre del grupo, código del grupo o por procedimientos asignados al grupo.


Expand
titleMás detalles

Signatura

ResultUserByOrganismTree userByOrganismTree(ParamUserByOrganismTree paramUserByOrganismTreeResultGGList gestionGroupList(ParamGGList paramGGList)

Parámetros de invocación


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


Parámetros de respuesta



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


Códigos error



Código
Descripción
USERSORGANISMTREE_01El objeto paramUserByOrganismTree es nulo.
USERSORGANISMTREE_GESTIONGROUPLIST_00Error durante el proceso de búsqueda
USERSORGANISMTREE_02La lista de organismos está vacía o es nula.
USERSORGANISMTREE_03No se ha encontrado ningún rol para esos parámetros de búsqueda.
USERSORGANISMTREE_04El alias de la aplicación es nulo
USERSORGANISMTREE_05El rol no existe en el sistema
USERSORGANISMTREE_06El nombre del rol es nulo
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
String[]ParamGGList organismsCodeTreeparams = new String[2]ParamGGList();
organismsCodeTree[0] = "ORG00007";
organismsCodeTree[1] = "ORG00012";
String roleName = "PREPARADOR-COMPULSOR";
String applicationAlias = "SCE";
ParamUserByOrganismTree param = new ParamUserByOrganismTreeGGSearch search = new GGSearch();
paramsearch.setOrganismsCodeTreesetDescription(organismsCodeTree"descripción");
paramparams.setApplicationAliassetGgSearch(applicationAliassearch);
param.setRoleName(roleName);
ResultUserByOrganismTreeResultGGList result = pauAgent.userByOrganismTreegestionGroupList(paramparams);


Método '

...

gestionGroupListByApplication' @deprecated


Servicio que devuelve los usuarios que pertenezcan a a algún organismo de los indicados con alguno de los roles indicados.Estos usuarios con sus roles estarán dados de alta 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.


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
Expand
titleMás detalles

Signatura

ResultUserByOrganismTreeExtended userByOrganismTreeExtended( ParamUserByOrganismTreeExtended  paramUserByOrganismTreeResultGestionGroupListByApplication gestionGroupListByApplication (ParamGestionGroupListByApplication paramGestionGroupListByApplication)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
organismsCodeTreeapplicationGGSearchString[]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
1242693904Objeto ApplicationGGSearch
params1242693904Objeto SearchParams


Parámetros de respuesta



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


Códigos error



USERSORGANISMTREE_04
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
GESTIONGROUPLISTBYAPPLICATION_00Error durante el proceso de búsqueda
GESTIONGROUPLISTBYAPPLICATION_01El parámetro paramGestionGroupListByApplication es nulo
GESTIONGROUPLISTBYAPPLICATION_02El parámetro alias de la aplicación es nulo
USERSORGANISMTREEGESTIONGROUPLISTBYAPPLICATION_05 El rol no existe en el sistemaUSERSORGANISMTREE_06 03No se han encontrado usuarios para esos
parámetros de búsqueda

Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
grupos de gestión para esa aplicación
GESTIONGROUPLISTBYAPPLICATION_04Ha ocurrido algún error en el proceso de búsqueda


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamGestionGroupListByApplication params = new ParamGestionGroupListByApplication();
params.setApplicationAlias("PAU");
ResultGestionGroupListByApplication result = pauAgent.userByOrganismTreegestionGroupListByApplication(paramparams);


Método '

...

gestionGroupListByUser' @deprecated


Servicio que devuelve una lista de usuarios en función del procedimiento y, opcionalmente, un listado de roles. Estos usuarios tendrán los procedimientos y los roles asignados 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

ResultUserListByProcedureAndRole userListByProcedureAndRole (ParamUserListByProcedureAndRole paramUserListByProcedureAndRole ResultGestionGroupListByUser gestionGroupListByUser(ParamGestionGroupListByUser paramGestionGroupListByUser)

Parámetros de invocación


signatureListado de Roles asociados a los usuarios
NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscalStringProcedimiento asociado al Grupo de Gestión.
entityStringIdentificador de la entidad del procedimiento
roleCodeString[]Anagrama fiscal
userGGSearch1242693904Objeto UserGGSearch
paramsSearchParamsObjeto SearchParams


Parámetros de respuesta


NombreTipoDescripción
resultError1242693904ResultErrorObjeto ResultError
userListggUserList1242693904UserGG[]Listado de usuarios obtenidos.Lista de objetos UserGG
sizeintTamaño de la lista ggUserList devuelta


Códigos error


Código
Descripción
USERLISTBYPROCEDUREANDROLEGESTIONGROUPLISTBYUSER_00Error durante el proceso de búsqueda de gestion group.
USERLISTBYPROCEDUREANDROLEGESTIONGROUPLISTBYUSER_01El objeto paramUserListByProcedureAndRole ParamGestionGroupListByUser es nulo.
USERLISTBYPROCEDUREANDROLEGESTIONGROUPLISTBYUSER_02El parámetro signature fiscalAnagram es nulo.
USERLISTBYPROCEDUREANDROLEGESTIONGROUPLISTBYUSER_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 nulo03No 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
ParamUserListByProcedureAndRoleParamGestionGroupListByUser params = new ParamUserListByProcedureAndRoleParamGestionGroupListByUser();
params.setSignaturesetFiscalAnagram("signature11111111H");
params.setEntity(“entity”);
ResultUserListByProcedureAndRole result = pauAgent.userListByProcedureAndRoleResultGestionGroupListByUser result=pauAgent.gestionGroupListByUser(params);

Búsquedas y consultas de grupos


Método '

...

gestionGroupListByUserLike' @deprecated


Servicio que devuelve una lista con los de grupos de gestión en función a la información a partir de un fiscal anagram/gestion group, o ambos campos vacíos, pasada como parámetro en el objeto ParamGGListparamGestionGroupListByUser usando el criterio LIKE para el grupo de gestión.
Los grupos de
gestión se consultarán en PAU por nombre del grupo, código del grupo o por procedimientos asignados al grupogestión y la asociación con los usuarios se realizará en PAU.


Expand
titleMás detalles

Signatura

ResultGGList gestionGroupList(ParamGGList paramGGListResultGestionGroupListByUser gestionGroupListByUserLike(ParamGestionGroupListByUser paramGestionGroupListByUser)


Parámetros de invocación


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

1242693904

Filtro de búsqueda para el objeto UserGG


Parámetros de respuesta


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


Códigos error


04 estos parámetros de búsqueda
Código
Descripción
GESTIONGROUPLISTGESTIONGROUPLISTBYUSER_00Error durante el proceso de búsqueda de gestion group.
GESTIONGROUPLISTGESTIONGROUPLISTBYUSER_01El objeto paramGGList ParamGestionGroupListByUser es nulo.
GESTIONGROUPLISTBYUSER_02El fiscalAnagram es nulo.GESTIONGROUPLIST
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
ParamGGListParamGestionGroupListByUser params = new ParamGGListParamGestionGroupListByUser();
GGSearchUserGGSearch searchuserGGSearch = new GGSearchUserGGSearch();
searchuserGGSearch.setDescriptionsetFiscalAnagram("descripción11111111T");
params.setGgSearchsetUserGGSearch(searchuserGGSearch);
ResultGGListResultGestionGroupListByUser
result = pauAgent.gestionGroupListgestionGroupListByUserLike(params);


Método '

...

gestionGroupListWithoutProcedures' @deprecated


Servicio que devuelve una lista de con los grupos de gestión por alias de aplicación encapsulada en función a la información pasada como parámetro en el objeto pasado como parámetro paramGestionGroupListByApplicationParamGGList.
Estos grupos de gestión y los alias de las aplicaciones se consultarán en PAU 

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

Expand
titleMás detalles

Signatura

ResultGestionGroupListByApplication gestionGroupListByApplication (ParamGestionGroupListByApplication paramGestionGroupListByApplicationResultGGList gestionGroupListWithoutProcedures(ParamGGList paramGGList)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
applicationGGSearchggSearch1242693904Objeto ApplicationGGSearch
params1242693904Objeto SearchParams
Objeto GGSearch


Parámetros de respuesta



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


Códigos error



GESTIONGROUPLISTBYAPPLICATION_03 esa aplicaciónHa ocurrido algún error en el proceso
Código
Descripción
GESTIONGROUPLISTBYAPPLICATIONGESTIONGROUPLIST_01El objeto paramGGList es nulo
GESTIONGROUPLIST_00Error durante el proceso de búsqueda
GESTIONGROUPLISTBYAPPLICATION_01El parámetro paramGestionGroupListByApplication es nulo
GESTIONGROUPLISTBYAPPLICATION_02El parámetro alias de la aplicación es nulo
de gestion group
GESTIONGROUPLIST_04No se han encontrado grupos de gestión para GESTIONGROUPLISTBYAPPLICATION_04estos parámetros de búsqueda


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamGestionGroupListByApplicationParamGGList params = new ParamGGList();
GGSearch ggSearch = new ParamGestionGroupListByApplicationGGSearch();
paramsggSearch.setApplicationAliassetGGCode("PAU"CODE01");
params.setGgSearch(ggSearch);
ResultGestionGroupListByApplicationResultGGList result = pauAgent.gestionGroupListByApplicationgestionGroupListWithoutProcedures(params);



Método '

...

gestionGroupListWithSize' @deprecated


Servicio que devuelve una lista un listado de grupos de gestión por usuario encapsulada en el objeto pasado como parámetro paramGestionGroupListByUsere indica el tamaño del mismo.
Los grupos de gestión asignados a los usuarios se encontrarán dados , se dan de alta en PAU.


Expand
titleMás detalles

Signatura

ResultGestionGroupListByUser gestionGroupListByUser(ParamGestionGroupListByUser paramGestionGroupListByUserResultGGListWithSize gestionGroupListWithSize (ParamGGListWithSize paramGGListWithSize)


Parámetros de invocación


userGGSearch
NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
ggSearch1242693904Objeto UserGGSearch
paramsSearchParamsObjeto SearchParams
Lista de anagramas fiscales


Parámetros de respuesta


NombreTipoDescripción
resultErrorResultError1242693904Objeto ResultError
ggUserListgestionGroupUserGG1242693904[]Lista de objetos UserGGListado de los grupos de gestión encontrados.
sizeintTamaño de la lista ggUserList devueltalista de grupos de gestión.


Códigos error


ese usuario.La lista de anagramas fiscales es nula o esta vacía
Código
Descripción
GESTIONGROUPLISTBYUSERGESTIONGROUPLIST_00 Error durante el proceso de búsqueda de gestion group.
GESTIONGROUPLISTBYUSERGESTIONGROUPLIST_01 El objeto ParamGestionGroupListByUser paramGGList es nulo.
GESTIONGROUPLISTBYUSER_03GESTIONGROUPLISTBYUSERGESTIONGROUPLIST_02El fiscalAnagram es nulo.04 No se han encontrado grupos de gestión para
GESTIONGROUPLISTBYUSER_04Ha ocurrido algún error en el proceso de búsqueda.
GESTIONGROUPLISTBYUSER_05estos parámetros de búsqueda.


Ejemplo de invocación


Code Block
languagejava
titleEjemplo de invocación
ParamGestionGroupListByUserParamGGListWithSize params = new ParamGGListWithSize();
GGSearch search = new ParamGestionGroupListByUser( GGSearch();
search.setDescription("descripción");
params.setFiscalAnagramsetGgSearch("11111111H"search);
ResultGestionGroupListByUserResultGGListWithSize result = pauAgent.gestionGroupListByUsergestionGroupListWithSize(params);


Búsquedas y consultas de procedimientos


Método '

...

assignedProcedureListByOrganism'

...

Servicio que devuelve una lista de grupos de gestión a partir de un fiscal anagram/gestion group, o ambos campos vacíos, pasada como parámetro en el objeto paramGestionGroupListByUser usando el criterio LIKE para el grupo de gestión.
Los grupos de gestión y la asociación con los usuarios se realizará en PAU.
los procedimientos asociados a un usuario bajo un organismo.

Expand
titleMás detalles

Signatura

ResultGestionGroupListByUser gestionGroupListByUserLike(ParamGestionGroupListByUser paramGestionGroupListByUser
ResultGetAssignedProcedures assignedProcedureListByOrganism(ParamAssignedProcedureRoleList procedureSearchBean)

Parámetros de invocación


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


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultErrorggUserList
size1242693904[]Lista de objetos UserGGsizeintTamaño de la lista ggUserList devueltaintTamaño lista de procedimientos recuperada
procedureRolesList<1242693904>Listado de procedimientos recuperado


Códigos error



La lista de anagramas fiscales es nula o esta vacía.
Código
Descripción
GESTIONGROUPLISTBYUSERPROCEDURELISTBYORGANISMROLE_00Error durante el proceso de búsqueda de gestion groupque proviene del webservices.
GESTIONGROUPLISTBYUSERPROCEDURELISTBYORGANISMROLE_01El objeto ParamGestionGroupListByUser ParamAssignedProcedureRoleList es nulo.
GESTIONGROUPLISTBYUSERPROCEDURELISTBYORGANISMROLE_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_05No existen procedimientos para los parámetros de busqueda
PROCEDURELISTBYORGANISMROLE_03Error inesperado
PROCEDURELISTBYORGANISMROLE_04El objeto procedureSearchBean es nulo


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamGestionGroupListByUserParamAssignedProcedureRoleList paramsparamAssignedProcedureRoleList = new ParamGestionGroupListByUserParamAssignedProcedureRoleList();
UserGGSearchAssignedProcedureRoleVSearchBean userGGSearchprocedureRoleSearchBean = new UserGGSearchAssignedProcedureRoleVSearchBean();
userGGSearchprocedureRoleSearchBean.setFiscalAnagramsetSignature("11111111T1");
paramsparamAssignedProcedureRoleList.setUserGGSearchsetProcedureRoleSearchBean(userGGSearchprocedureRoleSearchBean);
ResultGestionGroupListByUserResultGetAssignedProcedures result =pauAgent client.gestionGroupListByUserLikeassignedProcedureListByOrganism(paramsparamAssignedProcedureRoleList);


Método '

...

getProcedureAttributes'

...

Servicio que devuelve una lista con los grupos de gestión en función a 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 ParamGGListParamGetProcedureAttributes. 

...


Estos atributos se consultan en SEDA.


Expand
titleMás detalles

Signatura

ResultGGList gestionGroupListWithoutProcedures(ParamGGList paramGGListResultGetProcedureAttributes getProcedureAttributes(ParamGetProcedureAttributes paramGetProcedureAttributes)

Parámetros de invocación


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


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
gestionGroupprocedureAttributes1242693904[]Lista de objetos GestionGroupListado de atributos del procedimento buscado


Códigos error



GESTIONGROUPLIST00
Código
Descripción
PROCEDUREATTRIBUTES_00 Error que proviene del webservices.
PROCEDUREATTRIBUTES_01 El objeto paramGGList paramGetProcedureAttributes es nulo.GESTIONGROUPLIST
PROCEDUREATTRIBUTES_Error durante el proceso de búsqueda de gestion groupGESTIONGROUPLIST_04No se han encontrado grupos de gestión para estos parámetros de búsqueda02 La signatura es nula.
PROCEDUREATTRIBUTES_03 El idEntity es nulo.


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamGGListParamGetProcedureAttributes params = new ParamGGListParamGetProcedureAttributes();
GGSearch ggSearch = new GGSearch();
ggSearch.setGGCode("CODE01params.setSignature("474");
params.setGgSearchsetIdEntity(ggSearch"0");
ResultGGListResultGetProcedureAttributes result =pauAgent client.gestionGroupListWithoutProceduresgetProcedureAttributes(params);


Método '

...

procedureDetail'

...

Servicio que devuelve un listado de grupos de gestión e indica el tamaño del mismo.
Los grupos de gestión, se dan de alta en PAUel detalle de un procedimiento de catálogo de la DGA dado en función de la información pasada como parámetro en el objeto ParamProcedureDetail.
Los datos del procedimiento se consultan en SEDA.


Expand
titleMás detalles

Signatura

ResultGGListWithSize gestionGroupListWithSize (ParamGGListWithSize paramGGListWithSizeResultProcedureDetail procedureDetail(ParamProcedureDetail paramProcedureDetail)

Parámetros de invocación


ggSearchLista de anagramas fiscales
NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
signature1242693904StringSignature o código del procedimiento


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
gestionGroupprocedure1242693904[]Listado de los grupos de gestión encontrados.
sizeintTamaño de la lista de grupos de gestión.
Objeto Procedure, con los datos del procedimiento


Códigos error



Código
Descripción
GESTIONGROUPLISTPROCEDUREDETAIL_00Error durante el proceso de búsqueda de gestion group.GESTIONGROUPLISTprocedure detail
PROCEDUREDETAIL_01El objeto paramGGList paramProcedureDetail es nulo.
GESTIONGROUPLISTPROCEDUREDETAIL_04 02No se han encontrado grupos de gestión para estos parámetros de búsqueda.existe un procedimiento para esa signature
PROCEDUREDETAIL_03La Signature es nula


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamGGListWithSizeParamProcedureDetail params = new ParamGGListWithSizeParamProcedureDetail();
GGSearch search = new GGSearch();
search.setDescription("descripción");
params.setGgSearch(search);
ResultGGListWithSize//se va a detallar por ejemplo el procedimiento de signatura 400
params.setSignature("400");
ResultProcedureDetail result = pauAgent.gestionGroupListWithSizeprocedureDetail(params);

Búsquedas y consultas de procedimientos


Método '

...

procedureDetail'

Servicio que devuelve los procedimientos asociados a un usuario bajo un organismoel detalle de un procedimiento de catálogo de la DGA dado en función de la información pasada como parámetro en el objeto ParamProcedureDetailByIdEntity. Es similar al servicio 6.3.1.7, pero en este caso es obligatorio introducir como campo de búsqueda la entidad del procedimiento, además de la signatura.

Los datos del procedimiento se consultan en SEDA.


Expand
titleMás detalles

Signatura

ResultGetAssignedProcedures assignedProcedureListByOrganism(ParamAssignedProcedureRoleList procedureSearchBean

ResultProcedureDetail procedureDetail (ParamProcedureDetailByIdEntity paramProcedureDetailByIdEntity)

Parámetros de invocación


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

Anagrama fiscal

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


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
sizeintTamaño lista de procedimientos recuperada
procedureRolesList<1242693904>Listado de procedimientos recuperadoprocedure1242693904Objeto Procedure, con los datos del procedimiento


Códigos error



PROCEDURELISTBYORGANISMROLEEl objeto procedureSearchBean es nulo
Código
Descripción
PROCEDURELISTBYORGANISMROLEPROCEDUREDETAILBYIDENTITY_00 Error que proviene del webservicesdurante el proceso de búsqueda de
procedure detail.
PROCEDURELISTBYORGANISMROLEPROCEDUREDETAILBYIDENTITY_01 El objeto ParamAssignedProcedureRoleList paramProcedureDetailByIdEntity es
nulo.
PROCEDURELISTBYORGANISMROLEPROCEDUREDETAILBYIDENTITY_02 No existen procedimientos para los parámetros de busquedaLa signatura es nula.
PROCEDUREDETAILBYIDENTITY_03 Error inesperadoPROCEDURELISTBYORGANISMROLELa entidad es nula.
PROCEDUREDETAILBYIDENTITY_04 Error que proviene del webservices


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamAssignedProcedureRoleListParamProcedureDetailByIdEntity paramAssignedProcedureRoleListparams = new
ParamAssignedProcedureRoleListParamProcedureDetailByIdEntity();
AssignedProcedureRoleVSearchBean procedureRoleSearchBean = new AssignedProcedureRoleVSearchBean();
procedureRoleSearchBean//se va a detallar por ejemplo el procedimiento de signatura 400
params.setSignature("1400");
paramAssignedProcedureRoleListparams.setProcedureRoleSearchBeansetIdEntity(procedureRoleSearchBean"0");
ResultGetAssignedProceduresResultProcedureDetail result = clientpauAgent.assignedProcedureListByOrganismprocedureDetail(paramAssignedProcedureRoleListparams);


Método '

...

procedureDetailBySIACod'

Servicio que devuelve los atributos el detalle 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 Catálogo de Procedimientos a partir del código SIA.

Los datos del procedimiento se consultan en DESFORSEDA.


Expand
titleMás detalles

Signatura

ResultGetProcedureAttributes getProcedureAttributes(ParamGetProcedureAttributes paramGetProcedureAttributesResultProcedureDetailSIA procedureDetailBySIACod(ParamProcedureDetailBySIACod paramProcedureDetailBySIACod)

Parámetros de invocación


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


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
procedureAttributesprocedureSIA1242693904[]Listado de atributos del procedimento buscadoObjeto ProcedureSIA, con los datos del procedimiento


Códigos error



PROCEDUREATTRIBUTES
Código
Descripción
PROCEDUREATTRIBUTESPROCEDUREDETAILBYSIA_00Error que proviene del webservices.PROCEDUREATTRIBUTESdurante el proceso de búsqueda de procedureDetailBySIACod
PROCEDUREDETAILBYSIA_01El objeto paramGetProcedureAttributes ParamProcedureDetailBySIACod es nulo.
PROCEDUREATTRIBUTESPROCEDUREDETAILBYSIA_02La signatura es nula.No existe un procedimiento para ese código SIA
PROCEDUREDETAILBYSIA_03El idEntity código SIA es nulo.


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamGetProcedureAttributesParamProcedureDetailBySIACod params = new ParamGetProcedureAttributesParamProcedureDetailBySIACod();
params.setSignatureapplicationId("474PAU");
params.setIdEntitysetCodSIA("0213285");
ResultGetProcedureAttributesResultProcedureDetailSIA result = clientpauAgent.getProcedureAttributesprocedureDetailBySIACod(params);


Método '

...

procedureDetailList'

Servicio que devuelve el detalle para cada uno de un procedimiento de catálogo de la DGA dado en función de la información pasada como parámetro en el objeto ParamProcedureDetaillos procedimientos de un listado a partir de parámetros de búsqueda.

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


Expand
titleMás detalles

Signatura

ResultProcedureDetail procedureDetail(ParamProcedureDetail paramProcedureDetailResultProcedureDetailList procedureDetailList (ParamProcedureDetailList paramProcedureDetailList)


Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
signatureprocedureSearchStringSignature o código del procedimiento1242693904Objeto 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
procedureprocedures1242693904Objeto Procedure, con los datos del procedimiento[]Listado de procedimientos encontrados


Códigos error


PROCEDUREDETAIL
Código
Descripción
PROCEDUREDETAILPROCEDUREDETAILLIST_00 Error durante en el proceso de búsqueda de procedure detailPROCEDUREDETAILlistado de procedimientos
PROCEDUREDETAILLIST_01 El objeto paramProcedureDetail paramProcedureDetailList es nulo.
PROCEDUREDETAILPROCEDUREDETAILLIST_02 No existe un procedimiento para esa signatureexisten procedimientos para los parámetros de búsqueda.
PROCEDUREDETAILLIST_03 La Signature es nulaEl id de la entidad es nulo


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureDetailParamProcedureDetailList params = new ParamProcedureDetailParamProcedureDetailList();
//seProcedureSearch vaprocedureSearch a= detallar por ejemplo el procedimiento de signatura 400
params.setSignature("400");
ResultProcedureDetail result = pauAgent.procedureDetailnew ProcedureSearch();
procedureSearch.setIdEntidad("0");
procedureSearch.setDenomination("registro oficial");
params.setProcedureSearch(procedureSearch);
ResultProcedureDetailList
result=pauAgent.procedureDetailList(params);


Método '

...

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.

...

procedureDetailWithManagingOrganismList'

Busca procedimientos junto a sus organismos gestores.

Los datos de los procedimientos se consultan en SEDA.


Expand
titleMás detalles

Signatura

ResultProcedureDetail procedureDetail (ParamProcedureDetailByIdEntity paramProcedureDetailByIdEntityResultProcedureDetailList procedureDetailList (ParamProcedureDetailList paramProcedureDetailList)


Parámetros de invocación


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


Parámetros de respuesta


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


Códigos error


PROCEDUREDETAILBYIDENTITY02 Error que proviene del webservices
Código
Descripción
PROCEDUREDETAILBYIDENTITY_00 Error durante el proceso de búsqueda de
procedure detail.
PROCEDUREDETAILBYIDENTITYPROCEDURELIST_01El objeto paramProcedureDetailByIdEntity ParamSignaturesAndIdEntity es
nulo.
PROCEDURELIST_La signatura es nula.
PROCEDUREDETAILBYIDENTITY_03 La entidad es nula.
PROCEDUREDETAILBYIDENTITY_04 03El objeto signatures es nulo
PROCEDURELIST_05El objeto signatures está vacío
PROCEDURELIST_06No se han encontrado procedimientos para los parámetros de búsqueda.


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureDetailByIdEntityGestionGroup paramsgestionGroup = new ParamProcedureDetailByIdEntityGestionGroup();
//se va a detallar por ejemplo el procedimiento de signatura 400
paramsgestionGroup.setName("nombre GG");
gestionGroup.setDescription("descripción GG");
Procedure procedure1 = new Procedure();
procedure1.setSignature("4001");
paramsprocedure1.setIdEntitysetDenomination("0den1");
ResultProcedureDetail result = pauAgent.procedureDetail(params);


Método '

...

procedureDetailWithSIA'

Servicio que devuelve el detalle de un procedimiento del Catálogo de Procedimientos a partir del incluyendo el código SIA.

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


Expand
titleMás detalles

Signatura

ResultProcedureDetailSIA procedureDetailBySIACodprocedureDetailWithSIA(ParamProcedureDetailBySIACod paramProcedureDetailBySIACodParamProcedureDetailByIdEntity paramProcedureDetail)

Parámetros de invocación


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


Parámetros de respuesta



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


Códigos error



PROCEDUREDETAILBYSIA
Código
Descripción
PROCEDUREDETAILBYSIAPROCEDUREDETAILSIA_00Error durante el proceso de búsqueda de procedureDetailBySIACodprocedure detail
PROCEDUREDETAILBYSIAPROCEDUREDETAILSIA_01El objeto ParamProcedureDetailBySIACod paramProcedureDetail es nulo
PROCEDUREDETAILBYSIAPROCEDUREDETAILSIA_02No existe un procedimiento para ese código SIAesa signature
PROCEDUREDETAILSIA_03El código SIA es nuloLa Signature es nula
PROCEDUREDETAILSIA_04La Entidad es nula


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureDetailBySIACodParamProcedureDetailByIdEntity params = new ParamProcedureDetailBySIACodParamProcedureDetailByIdEntity();
params.applicationId("PAU");
params.setCodSIAsetfiscalAnagram("11111111H");
params.setSignature("400");
params.setIdEntity("2132850");
ResultProcedureDetailSIA result = pauAgent.procedureDetailBySIACodprocedureDetailWithSIA(params);


Método '

...

procedureList'

Servicio que devuelve el detalle para cada uno de los procedimientos de un listado a partir de parámetros de búsquedade 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 DESFORSEDA.


Expand
titleMás detalles

Signatura

ResultProcedureDetailList procedureDetailList (ParamProcedureDetailList paramProcedureDetailListResultProcedureList procedureList(ParamProcedureList paramProcedureList)

Parámetros de invocación


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


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
proceduresprocedure1242693904[]Listado Lista de procedimientos encontradosobjetos Procedure


Códigos error



PROCEDUREDETAILLIST
Código
Descripción
PROCEDUREDETAILLISTPROCEDURELIST_00Error en durante el proceso de búsqueda de listado de procedimientosprocedure
PROCEDUREDETAILLISTPROCEDURELIST_01El objeto paramProcedureDetailList paramProcedureList es nulo.
PROCEDUREDETAILLISTPROCEDURELIST_02No existen procedimientos para los parámetros de búsqueda.Error que proviene del webservices
PROCEDURELIST_03El id de la entidad objeto ProcedureSearch es nulo


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureDetailListParamProcedureList params = new ParamProcedureDetailListParamProcedureList();
ProcedureSearch procedureSearch = new ProcedureSearch();
procedureSearch.setIdEntidadsetSignature("0");
procedureSearch.setDenominationsetVersion("registro oficial");
procedureSearch.setIdOrgano("");
params.setProcedureSearch(procedureSearch);
ResultProcedureDetailListResultProcedureList result = pauAgent.procedureDetailListprocedureList(params);



Método '

...

procedureList1'

Busca procedimientos junto a sus organismos gestoresServicio que devuelve un listado de procedimientos dados de alta en catálogo por la DGA en función de la información pasada como parámetro en el objeto ParamProcedureListByUser. Es similar al servicio referenciado en el punto 6.3.1.2, siendo obligatorio introducir el campo “idEntidad”.
Los datos de los procedimientos se consultan en DESFORSEDA.


Expand
titleMás detalles

Signatura

ResultProcedureDetailList procedureDetailList (ParamProcedureDetailList paramProcedureDetailListResultProcedureList procedureList(ParamProcedureListAndEntity paramProcedureListAndEntity)


Parámetros de invocación


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


Parámetros de respuesta


NombreTipoDescripción
resultError1242693904Objeto ResultError
proceduresprocedure1242693904[]Listado de procedimientos encontrados junto a sus órganos gestores.Lista de objetos Procedure


Códigos error


signatures 05 objeto signatures está vacío
Código
Descripción
PROCEDURELIST_00Error durante el proceso de búsqueda de procedure
PROCEDURELIST_01El objeto ParamSignaturesAndIdEntity paramProcedureList es nulo
PROCEDURELIST_02Error que proviene del webservices
PROCEDURELIST_03El objeto ProcedureSearch es nulo
PROCEDURELIST_04El
PROCEDURELIST_06No se han encontrado procedimientos para los parámetros de búsqueda.
parámetro idEntidad es nulo


Ejemplo de invocación


Code Block
languagejava
titleEjemplo de invocación
GestionGroup gestionGroupParamProcedureListAndIdEntity params = new ParamProcedureListAndIdEntity();
ProcedureSearch procedureSearch = new GestionGroupProcedureSearch();
gestionGroupprocedureSearch.setNamesetSignature(""nombre GG);
procedureSearch.setVersion("");
gestionGroupprocedureSearch.setDescriptionsetIdOrgano("descripción GG");
Procedure procedure1 = new Procedure(procedureSearch.setIdEntidad("0");
procedure1params.setSignaturesetProcedureSearch("1"procedureSearch);
procedure1.setDenomination("den1"
ResultProcedureList result = pauAgent.procedureList(params);


Método '

...

procedureListbyAplicationAndIdEntity'

Servicio que devuelve el detalle de un procedimiento del Catálogo de Procedimientos incluyendo el código SIA.Los datos de los procedimientos se consultan en DESFORun listado de procedimientos existentes asociados a una aplicación y con una entidad suministrada.

Estos procedimientos no se consultan en SEDA.

Expand
titleMás detalles

Signatura

ResultProcedureDetailSIA procedureDetailWithSIA(ParamProcedureDetailByIdEntity paramProcedureDetailVResultProcedureRoleList procedureListByAplicationAndIdEntity(VParamProcedureRoleList vparamProcedureRoleList)


Parámetros de invocación


Código del procedimiento que se quiere obtener el detalle
NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
idEntityprocedureSearchBeanStringCódigo de la entidad asociadasignatureString1242693904Objeto VProcedureRoleSearchBean, campos de búsqueda para procedimientos


Parámetros de respuesta


NombreTipoDescripción
resultError1242693904Objeto ResultError
procedureSIAprocedureRoles1242693904Objeto ProcedureSIA, con los datos del procedimientoLista de objetos VProcedureRole
sizeintTamaño de la lista de procedimientos recuperados


Códigos error


La Entidad es nula
Código
Descripción
PROCEDUREDETAILSIAPROCEDURELISTBYAPLICATIONANDIDENTITY_00Error durante el proceso de búsqueda de procedure detail
PROCEDUREDETAILSIAPROCEDURELISTBYAPLICATIONANDIDENTITY_01El objeto paramProcedureDetail ParamAssignedProcedureRoleList es nulo
PROCEDUREDETAILSIAPROCEDURELISTBYAPLICATIONANDIDENTITY_02No existe un procedimiento para esa signature
PROCEDUREDETAILSIA_03La Signature es nula
PROCEDUREDETAILSIA_04hay 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
ParamProcedureDetailByIdEntityVParamProcedureRoleList params = new ParamProcedureDetailByIdEntityVParamProcedureRoleList();
params.applicationIdsetApplicationId("PAUSFE");
params.setfiscalAnagramsetFiscalAnagram("11111111H"00000000T");
VProcedureRoleSearchBean procedureSearchBean= new VProcedureRoleSearchBean();		
paramsprocedureSearchBean.setSignaturesetAppAlias("400SFE");
paramsprocedureSearchBean.setIdEntitysetEntity("0");
ResultProcedureDetailSIAparams.setProcedureSearchBean(procedureSearchBean);
VResultProcedureRoleList result = pauAgentclient.procedureDetailWithSIAprocedureListByAplicationAndIdEntity(params);


Método '

...

ProcedureListByOrganism'

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


Expand
titleMás detalles

Signatura

ResultProcedureList procedureList(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("");
procedureSearch.setVersion("");
procedureSearch.setIdOrgano("
//se van a listar, por ejemplo, los procedimientos del organismo “ORG04174” y la entidad “0”
params.setOrganismCode("ORG04174");
params.setProcedureSearchsetIdEntity(procedureSearch"0");
ResultProcedureListResultProcedureListByOrganism result =
pauAgentclient.procedureListprocedureListByOrganism(params);


Método '

...

procedureListByUser'

Servicio que devuelve un listado de los procedimientos dados de alta en catálogo por la DGA catálogo a los que un usuario puede acceder en función de la información pasada como parámetro en el objeto ParamProcedureListByUser. Es similar al servicio referenciado en el punto 6.3.1.2, siendo obligatorio introducir el campo “idEntidad”.del grupo de gestión al que esté asignado.
Los datos de los procedimientos se consultan en DESFORSEDA.


Expand
titleMás detalles

Signatura

ResultProcedureList procedureList(ParamProcedureListAndEntity paramProcedureListAndEntityResultProcedureListByUser procedureListByUser(ParamProcedureListByUser paramProcedureListByUser)

Parámetros de invocación


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


Parámetros de respuesta


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


Códigos error


PROCEDURELIST
Código
Descripción
PROCEDURELISTPROCEDURELISTBYUSER_00 Error durante el proceso de búsqueda de
procedure by user.
PROCEDURELISTPROCEDURELISTBYUSER_01 El objeto paramProcedureList paramProcedureListByUser es nulo.
PROCEDURELISTPROCEDURELISTBYUSER_02 Error que proviene del webservicesEl fiscal anagrama es nulo.
PROCEDURELISTBYUSER_03 El objeto ProcedureSearch es nuloPROCEDURELIST_04El parámetro idEntidad es nulousuario 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
ParamProcedureListAndIdEntityParamProcedureListByUser params = new ParamProcedureListAndIdEntityParamProcedureListByUser();
ProcedureSearch procedureSearch = new ProcedureSearch();
procedureSearch.setSignature("");
procedureSearch.setVersion("");
procedureSearch.setIdOrgano("");
procedureSearch.setIdEntidad("0");
params.setProcedureSearch(procedureSearch);
ResultProcedureList params.setFiscalAnagram("anagrama fiscal");
ResultProcedureListByUser result = pauAgent.procedureListprocedureListByUser(params);


Método '

...

procedureListByUser1'

Servicio que devuelve un listado de procedimientos existentes asociados a una aplicación y con una entidad suministrada.Estos procedimientos no se consultan en DESFORlos procedimientos de catálogo a los que un usuario puede acceder en función del grupo de gestión al que esté asignado y a su entidad correspondiente. Es similar al servicio procedureListByUser, pero en este es último es solamente necesario el anagrama fiscal como parámetro de búsqueda.
Los datos de los procedimientos se consultan en SEDA.


Expand
titleMás detalles

Signatura

VResultProcedureRoleList procedureListByAplicationAndIdEntity(VParamProcedureRoleList vparamProcedureRoleListResultProcedureListByUser procedureListByUser(ParamProcedureListByUserAndEntity paramProcedureListByUserAndEntity)

Parámetros de invocación


NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
procedureSearchBeanidEntity1242693904Objeto VProcedureRoleSearchBean, campos de búsqueda para procedimientosStringCódigo de la entidad asociada


Parámetros de respuesta


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


Códigos error


El objeto procedureSearchBean
Código
Descripción
PROCEDURELISTBYAPLICATIONANDIDENTITYPROCEDURELISTBYUSER_00Error durante el proceso de búsqueda de procedure by user
PROCEDURELISTBYAPLICATIONANDIDENTITYPROCEDURELISTBYUSER_01El objeto ParamAssignedProcedureRoleList paramProcedureListByUser es nulo
PROCEDURELISTBYAPLICATIONANDIDENTITYPROCEDURELISTBYUSER_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 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
VParamProcedureRoleList params = new VParamProcedureRoleList();
params.setApplicationId("SFE");
params.setFiscalAnagram("00000000T");
VProcedureRoleSearchBean procedureSearchBeanParamProcedureListByUserAndEntity params = new VProcedureRoleSearchBeanParamProcedureListByUserAndEntity();		
procedureSearchBeanparams.setAppAliassetFiscalAnagram("SFE72979986C");
procedureSearchBeanparams.setEntitysetIdEntity("0");
params.setProcedureSearchBean(procedureSearchBean);
VResultProcedureRoleList ResultProcedureListByUser result = clientpauAgent.procedureListByAplicationAndIdEntityprocedureListByUser(params);



Método '

...

procedurePublishedList'

Servicio que devuelve la lista un listado de procedimientos de Catálogo de la DGA cuyo organismo productor sea el indicado publicados en el catálogo por la DGA en función de la información pasada como parámetro en el objeto ParamProcedureListByOrganism. Además de los procedimientos correspondientes al organismo productor indicado, también se devuelven los procedimientos horizontales.ParamProcedureList
Los datos de los procedimientos se consultan en DESFORSEDA.


Expand
titleMás detalles

Signatura

ResultProcedureListByOrganism procedureListByOrganism(ParamProcedureListByOrganism paramProcedureListByOrganismResultProcedureList procedurePublishedList(ParamProcedureList paramProcedureList)

Parámetros de invocación


organismCode String
NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método.
fiscalAnagramStringAnagrama fiscal.
procedureSearch1242693904Código de organismo del que se quieren obtener sus procedimientos asociados.
idEntity String Código de identificación de entidad.
Objeto ProcedureSearch, campos de búsqueda para procedimientos


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
proceduresprocedure1242693904[]Lista de objetos Procedure
sizeintTamaño de la lista de procedimientos


Códigos error



PROCEDURELISTBYORGANISM
Código
Descripción
PROCEDURELISTBYORGANISMPROCEDURELIST_00Error durante el proceso de búsqueda de procedure by organism.
PROCEDURELISTBYORGANISMPROCEDURELIST_01El objeto paramProcedureListByOrganism paramProcedureList es nulo.
PROCEDURELISTBYORGANISMPROCEDURELIST_02El organismCode es nulo.Error que proviene del webservices
PROCEDURELIST_03El idEntity objeto ProcedureSearch es nulo.
PROCEDURELISTBYORGANISM_04 El organismo no tiene procedimientos asociados.


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureListByOrganismParamProcedureList params = new ParamProcedureListByOrganismParamProcedureList();
//seProcedureSearch vanprocedureSearch a= listar, por ejemplo, los procedimientos del organismo “ORG04174” y la entidad “0”
params.setOrganismCode("ORG04174new ProcedureSearch();
procedureSearch.setSignature("1");
params.setIdEntitysetProcedureSearch("0"procedureSearch);
ResultProcedureListByOrganismResultProcedureList result = clientpauAgent.procedureListByOrganismprocedurePublishedList(params);



Método '

...

getJobsBySignature'

Servicio que devuelve los

...

puestos que tienen asociada una signature.


Anagrama fiscal
Expand
titleMás detalles

Signatura

ResultProcedureListByUser procedureListByUser(ParamProcedureListByUser paramProcedureListByUserResultGetJobsBySignature getJobsBySignature(ParamGetJobsBySignature paramGetJobsBySignature)

Parámetros de invocación


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


Parámetros de respuesta



Nombre
Tipo
Descripción
resultErrorprocedure1242693904[]Lista de objetos Procedure
jobCodes
1242693904Objeto ResultError
List <String>Lista de jobCodes
sizeintTamaño del listado devuelto


Códigos error


PROCEDURELISTBYUSER
Código
Descripción
PROCEDURELISTBYUSER_00 Error durante el proceso de búsqueda de
procedure by user.
GET_JOBS_BY_SIGNATURE_01El objeto
paramProcedureListByUser
paramGetJobsBySignature es nulo
.PROCEDURELISTBYUSER_02 El fiscal anagrama es nulo.PROCEDURELISTBYUSER_03 El usuario no existe en la base de datosPROCEDURELISTBYUSER_04 Error que proviene del webservices
GET_JOBS_BY_SIGNATURE_02Los parametros signature y state son obligatorios
GET_JOBS_BY_SIGNATURE_03El campo state introducido no es valido. Debe ser alta o baja
GET_JOBS_BY_SIGNATURE_04El campo signature debe ser numerico
GET_JOBS_BY_SIGNATURE_05No se encuentran puestos asociados


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureListByUserParamGetJobsBySignature params = new ParamProcedureListByUserParamGetJobsBySignature();
params.setFiscalAnagram("anagrama fiscalTestConstants.DEFAULT_FISCAL_ANAGRAM);
params.setApplicationId(TestConstants.DEFAULT_ENTITY_ID);
params.setSignature("466");
params.setState("alta");
ResultProcedureListByUserResultGetJobsBySignature result = pauAgenttestClient.procedureListByUsergetJobsBySignature(params);






Método '

...

procedureGetAssignedJobList'

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 DESFORpuestos asociados a un procedimiento.

Expand
titleMás detalles

Signatura

ResultProcedureListByUser procedureListByUser(ParamProcedureListByUserAndEntity paramProcedureListByUserAndEntityResultProceduresGetAssignedJobList procedureGetAssignedJobList(ParamProcedureGetAssignedJobList paramProcedureList)

Parámetros de invocación


ejecuta el métodoCódigo de la entidad asociada
NombreTipoDescripción
applicationIdStringAplicación que invoca al servicio
fiscalAnagramStringAnagrama fiscalidEntityStringFiscal anagram del usuario
signaturesLong[]Array de signaturas por las que se quiere buscar.
stateBoolean TRUE para los que están dados de alta y FALSE, para bajas.


Parámetros de respuesta



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


Códigos error



PROCEDURELISTBYUSER02 fiscal anagrama PROCEDURELISTBYUSER03El id de la entidad es nulo
Código
Descripción
PROCEDURELISTBYUSERPROCEDUREGETASSIGNEDJOBLIST_00Error durante el proceso de búsqueda de procedure by userPROCEDURELISTBYUSER_01El objeto paramProcedureListByUser ParamProcedureGetAssignedJobList es nulo.
PROCEDUREGETASSIGNEDJOBLIST_01El objeto signatures es nulo
PROCEDUREGETASSIGNEDJOBLIST_El usuario no existe en la base de datos
PROCEDURELISTBYUSER_04Error que proviene del webservices
PROCEDURELISTBYUSER_0502No hay procedimientos relacionados con estos parámetros de búsqueda
PROCEDUREGETASSIGNEDJOBLIST_03Ha ocurrido algún tipo de error al listar los procedimientos


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureListByUserAndEntityParamProcedureGetAssignedJobList paramsparam = new ParamProcedureListByUserAndEntityParamProcedureGetAssignedJobList();
params.setFiscalAnagram("72979986C");
params.setIdEntity("0");
ResultProcedureListByUser result = pauAgent.procedureListByUser(params);

Método 'proceduresByGestionGroup'

...

;
Long[] signatures = new Long[1];
signatures[0] = Long.parseLong(signature);
param.setSignatures(signatures);
param.setState(true);
ResultProceduresGetAssignedJobList resultProcedureJobList = pauAgent.procedureGetAssignedJobList(param);


Búsquedas y consultas de puestos

Método 'jobGetAssignedRoleList'

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


Expand
titleMás detalles

Signatura

ResultProcedureDetailList proceduresByGestionGroup(ParamGGList paramGGListResultJobGetAssignedRoleList jobGetAssignedRoleList(ParamJobGetAssignedRoleList param)

Parámetros de invocación


Objeto de búsqueda del grupo de gestión
NombreTipoDescripción
applicationIdjobCodeStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
ggSearch1242693904[]Array de códigos de puestos de SIU por los que se quiere buscar.


Parámetros de respuesta



Tamaño de la lista de procedimientos
NombreTipoDescripción
resultError1242693904Objeto ResultError
procedure1242693904[]Lista de objetos ProcedureRoleJobsList<RoleJob>Lista de RoleJob
sizeint tamaño del listado devuelto
jobCodeStringcódigo del puesto en SIU


Códigos error



GESTIONGROUPLIST
Código
Descripción
GESTIONGROUPLIST_00 Error en la operación. Error durante el proceso de búsqueda.
Descripción
JOB_GET_ASSIGNED_ROLE_LIST_00Ha ocurrido algún tipo de error al listar los resultados
JOB_GET_ASSIGNED_ROLE_LIST_01El objeto ParamGGList de entrada es nulo.
GESTIONGROUPLIST_04Error en la operación. No se han encontrado grupos de gestión para estos parámetros de búsquedaJOB_GET_ASSIGNED_ROLE_LIST_02La lista de códigos de puestos en SIU es nula.
JOB_GET_ASSIGNED_ROLE_LIST_03La lista de códigos de puestos en SIU está vacía.


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamGGListParamJobGetAssignedRoleList paramsparam = new ParamGGListParamJobGetAssignedRoleList();
GGSearch ggSearch = new GGSearch();
ggSearch.setGgCode("CODE01");
params.setGgSearch(ggSearch);
ResultProcedureDetailList result=pauAgent.proceduresByGestionGroup (paramsparam.setJobCode(new String[] { "JOB_0001", "JOB_0002" });
ResultJobGetAssignedRoleList result = testClient.jobGetAssignedRoleList(param);



Método '

...

jobGetAssignedProcedureListServicesAndVariants'

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 DESFORServicio que consultan los procedimientos asociados a los usuarios en PAU con la nueva estructura derivada del cambio de servicio/variante.

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


Expand
titleMás detalles

Signatura

ResultProcedureList procedurePublishedList(ParamProcedureList paramProcedureListResultGetAssignedProcedureListServicesAndVariants jobGetAssignedProcedureListServicesAndVariants(ParamJobGetAssignedProcedureListServicesAndVariants param)

Parámetros de invocación


Objeto ProcedureSearch, campos de búsqueda para procedimientos
NombreTipoDescripción
applicationIdjobCodeStringAplicación que ejecuta el método
fiscalAnagramStringAnagrama fiscal
procedureSearch1242693904[]Array de codigos de puestos de SIU por los que se quiere buscar.
signatureLongParámetro opcional que nos permite filtrar por el signature
serviceStringS, V o A, para filtrar por servicios o variantes (o ambas). Si no se rellena devolverá ambos, como si se hubiera rellenado A.
stateStringA o T, para filtrar por publicados o todos.
activeStringS, N o T, para filtrar si están de alta, de baja o todos.


Parámetros de respuesta



NombreTipoDescripción
resultError1242693904Objeto ResultError
procedure1242693904[]Lista de objetos ProcedureresultSEDAServicesList<PAU v3.10 - Manual de integración - servicios para integradores#ResultSEDAService>Lista de ResultSEDAService
sizeint tamaño del listado devuelto



Códigos error



El objeto ProcedureSearch es nulo
Código
Descripción
PROCEDURELISTJOB_GET_ASSIGNED_PROCEDURE_LIST_00Error durante el proceso de búsqueda de procedurePROCEDURELISTHa ocurrido algún tipo de error al listar los resultados
JOB_GET_ASSIGNED_PROCEDURE_LIST_01PROCEDURELIST_03El objeto paramProcedureList de entrada es nulo
PROCEDURELIST_02Error que proviene del webservices
.
JOB_GET_ASSIGNED_PROCEDURE_LIST_02La lista de códigos de puestos en SIU es nula.
JOB_GET_ASSIGNED_PROCEDURE_LIST_03La lista de códigos de puestos en SIU está vacía.


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureListParamJobGetAssignedProcedureList paramsparam = new ParamProcedureListParamJobGetAssignedProcedureList();
ProcedureSearch procedureSearch = new ProcedureSearch();
procedureSearch.setSignature("1");
params.setProcedureSearch(procedureSearch);
ResultProcedureListparam.setJobCode(new String[] { "JOB_0001", "JOB_0002" });
ResultJobGetAssignedRoleList result = pauAgenttestClient.procedurePublishedListjobGetAssignedRoleList(paramsparam);


Método '

...

procedureListServicesAndVariants'

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

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


Expand
titleMás detalles

Signatura

ResultProceduresGetAssignedJobList procedureGetAssignedJobList(ParamProcedureGetAssignedJobList paramProcedureListResultGetListServicesAndVariants procedureListServicesAndVariants(ParamGetListServicesAndVariants param)

Parámetros de invocación


Array de signaturas por las que se quiere buscarTRUE para los que están dados de alta y FALSE, para bajas
NombreTipoDescripción
applicationIdsignatureStringLongAplicación que invoca al servicio
fiscalAnagramStringFiscal anagram del usuario
signaturesLong[]Parámetro opcional que nos permite filtrar por el signature
serviceStringS, V o A, para filtrar por servicios o variantes (o ambas). Si no se rellena devolverá ambos, como si se hubiera rellenado A.
stateBoolean StringA o T, para filtrar por publicados o todos.


Parámetros de respuesta



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



Códigos error



PROCEDUREGETASSIGNEDJOBLISTHa ocurrido algún tipo de error al listar los procedimientos
Código
Descripción
PROCEDUREGETASSIGNEDJOBLIST_00El objeto ParamProcedureGetAssignedJobList es nulo.
PROCEDUREGETASSIGNEDJOBLISTJOB_GET_ASSIGNED_PROCEDURE_LIST_00Ha ocurrido algún tipo de error al listar los resultados
JOB_GET_ASSIGNED_PROCEDURE_LIST_01El objeto signatures de entrada es nulo.
JOB_GET_ASSIGNED_PROCEDURE_LIST_02No hay procedimientos relacionados con estos parámetros de búsquedaPROCEDUREGETASSIGNEDJOBLIST_03La lista de códigos de puestos en SIU es nula.
JOB_GET_ASSIGNED_PROCEDURE_LIST_03La lista de códigos de puestos en SIU está vacía.


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureGetAssignedJobListParamGetListServicesAndVariants param = new ParamProcedureGetAssignedJobListParamGetListServicesAndVariants();
Long[] signatures = new Long[1];
signatures[0] = Long.parseLong(signatureparam.setService(ServiceEnum.ALL.getValue());
param.setSignaturessetSignature(signaturesnull);//opcional
param.setState(trueStatusEnum.ALL.getValue());
ResultProceduresGetAssignedJobListResultGetListServicesAndVariants resultProcedureJobListresult = pauAgenttestClient.procedureGetAssignedJobListprocedureListServicesAndVariants(param);

Búsquedas y consultas de puestos


Método '

...

jobGetAssignedProcedureList'

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


Expand
titleMás detalles

Signatura

ResultJobGetAssignedRoleList jobGetAssignedRoleList(ParamJobGetAssignedRoleList param)

Parámetros de invocación


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


Parámetros de respuesta



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


Códigos error



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


Ejemplo de invocación

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



Método '

...

roleGetAssignedJobList'

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


Expand
titleMás detalles

Signatura

ResultJobGetAssignedRoleList jobGetAssignedRoleList(ParamJobGetAssignedRoleList paramResultRoleGetAssignedJobList roleGetAssignedJobList(ParamRoleGetAssignedJobList paramRoleGetAssignedJobList)

Parámetros de invocación


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


Parámetros de respuesta



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


Códigos error



JOBPROCEDUREJOBPROCEDURELa lista de códigos de puestos en SIU está vacía.
Código
Descripción
JOBROLE_GET_ASSIGNED_PROCEDURE_LIST_00Ha ocurrido algún tipo de error al listar los resultadosJOB_GET_ASSIGNED_PROCEDURE_LIST_01El objeto de entrada paramRoleGetAssignedJobList es nulo.
ROLE_GET_ASSIGNED_JOB_LIST_02La lista de códigos de puestos en SIU es nula.El objeto paramRoleGetAssignedJobList es nulo
ROLE_GET_ASSIGNED_JOB_LIST_03El tamaño de paramRoleGetAssignedJobList.getRoleCode() es 0


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamJobGetAssignedProcedureListParamRoleGetAssignedJobList param = new ParamJobGetAssignedProcedureListParamRoleGetAssignedJobList();
param.setJobCodesetRoleCode(new String[] { "JOB_0001ROLE0001", "JOB_0002ROLE0002" });
ResultJobGetAssignedRoleListResultRoleGetAssignedJobList result = testClient.jobGetAssignedRoleListroleGetAssignedJobList(param);


Método '

...

procedureGetAssignedJobList'

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


Expand
titleMás detalles

Signatura

ResultRoleGetAssignedJobList roleGetAssignedJobList(ParamRoleGetAssignedJobList paramRoleGetAssignedJobListResultProceduresGetAssignedJobList procedureGetAssignedJobList(ParamProcedureGetAssignedJobList paramProcedureGetAssignedJobList)

Parámetros de invocación


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


Parámetros de respuesta



NombreTipoDescripción
RoleJobListprocedureJobsList<RoleJob>List<ProcedureJobList>Lista de RoleJobPRocedureJob
sizeint tamaño Tamaño del listado devuelto


Códigos error



Código
Descripción
ROLE_GET_ASSIGNED_JOB_LIST_PROCEDURELISTBYORGANISMROLE_00Error que proviene del webservices
PROCEDURELISTBYORGANISMROLE_01El objeto paramRoleGetAssignedJobList es nulo
ROLE_GET_ASSIGNED_JOB_LIST_02El objeto paramRoleGetAssignedJobList es nulo
ROLE_GET_ASSIGNED_JOB_LIST_03El tamaño de paramRoleGetAssignedJobList.getRoleCode() es 0

Ejemplo de invocación

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

Método 'procedureGetAssignedJobList'

...

ParamProcedureGetAssignedJobList es nulo
PROCEDURELISTBYORGANISMROLE_02No existen procedimientos para los parametros de busqueda
PROCEDURELISTBYORGANISMROLE_03Error inesperado


Ejemplo de invocación

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


Método 'procedureListByUserWithServices'

Servicio que devuelve los procedimientos de catálogo a los que un usuario puede acceder en función del grupo de gestión al que esté asignado y de una serie de parámetros referentes a los servicios o variantes. Es similar al servicio procedureListByUser, pero en este es último es solamente necesario el anagrama fiscal como parámetro de búsqueda.

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


Estado de alta o baja
Expand
titleMás detalles

Signatura

ResultProceduresGetAssignedJobList procedureGetAssignedJobList(ParamProcedureGetAssignedJobList paramProcedureGetAssignedJobListResultProcedureListByUserWithServices procedureListByUserWithServices (ParamProcedureListByUserWithServices paramProcedureListByUserWithServices)

Parámetros de invocación


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


Parámetros de respuesta


Nombre
Tipo
Descripción
procedureJobs
resultSEDAByUserWithServices
List<ProcedureJobList>
List<ResultSEDAByUserWithServices>Lista
de PRocedureJob
de ResultSEDAByUserWithServices
sizeintTamaño del listado devuelto


Códigos error


Código
Descripción
PROCEDURELISTBYORGANISMROLE
PROCEDURELISTBYUSER_00Error
que proviene del webservicesPROCEDURELISTBYORGANISMROLE
durante el proceso de búsqueda de
procedure by user.
PROCEDURELISTBYUSER_01El objeto
ParamProcedureGetAssignedJobList
paramProcedureListByUser es nulo
PROCEDURELISTBYUSER_02El fiscal anagrama es nulo
PROCEDURELISTBYORGANISMROLE
PROCEDURELISTBYUSER_
02No existen procedimientos para los parametros de busquedaPROCEDURELISTBYORGANISMROLE_03Error inesperado
04Error que proviene del Webservice
PROCEDURELISTBYUSER_07El tipo de consulta introducida no es válida


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureGetAssignedJobListParamProcedureListByUserWithServices param = new ParamProcedureGetAssignedJobList();ParamProcedureListByUserWithServices();
param.setFiscalAnagram("99999999R");//Obligatorio
param.setService(ServiceEnum.ALL.getValue());//A
param.setSignature(new String[] { "595", "1011" });
ResultProceduresGetAssignedJobListnull);//opcional
param.setState(StatusEnum.ALL.getValue());//T
//Si no le pasamos active como parametro, por defecto T
//param.setActive(StatusProcEnum.ALL.getValue());
ResultProcedureListByUserWithServices result = testClient.procedureGetAssignedJobListprocedureListByUserWithServices(param);


Anexos

Objetos comunes

...

Nombre
Tipo
Descripción
gestionGroup

1242693904

Objeto GestionGroup
params1242693904Objeto SearchParams

...

Objeto 'RoleJob
Anchor
RoleJob
RoleJob


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

initialDate

DateFecha de inicio
finalDateDateFecha de Fin


Objeto 'SearchParams
Anchor
SearchParams
SearchParams

...

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


Objeto 'User
Anchor
User
User

...

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

...

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

...