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

...

Método 'applicationRelationList'

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

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

...

Método 'userByOrganismTree'

Servicio que devuelve los usuarios que pertenezcan a una rama de organismos, dados de alta con un rol determinado dentro de una aplicación. Estos usuarios con sus roles estarán dados de alta en PAU.



Expand
titleMás detalles

Signatura

ResultUserByOrganismTree userByOrganismTree(ParamUserByOrganismTree paramUserByOrganismTree)

Parámetros de invocación


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


Parámetros de respuesta



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


Códigos error



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


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
String[] organismsCodeTree = new String[2];
organismsCodeTree[0] = "ORG00007";
organismsCodeTree[1] = "ORG00012";
String roleName = "PREPARADOR-COMPULSOR";
String applicationAlias = "SCE";
ParamUserByOrganismTree param = new ParamUserByOrganismTree();
param.setOrganismsCodeTree(organismsCodeTree);
param.setApplicationAlias(applicationAlias);
param.setRoleName(roleName);
ResultUserByOrganismTree result = pauAgent.userByOrganismTree(param);


...

Método 'userByOrganismTreeExtended' @deprecated


Servicio que devuelve los usuarios que pertenezcan a a algún organismo de los indicados con alguno de los roles indicados. Estos usuarios con sus roles estarán dados de alta en PAU.


Expand
titleMás detalles

Signatura

ResultUserByOrganismTreeExtended userByOrganismTreeExtended( ParamUserByOrganismTreeExtended  paramUserByOrganismTree)


Parámetros de invocación


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


Parámetros de respuesta


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


Códigos error


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


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
String[] organismsCodeTree = new String[2];
organismsCodeTree[0] = "ORG00007";
organismsCodeTree[1] = "ORG00012";
String[] rolenName = new String[2];
rolesName[0] = "EDITOR";
rolesName[1] = "ISSUER";
ParamUserByOrganismTree param = new ParamUserByOrganismTree();
param.setOrganismsCodeTree(organismsCodeTree);
param.setApplicationAlias(“SNT”);
param.setRoleName(roleName);
ResultUserByOrganismTree result = pauAgent.userByOrganismTree(param);


...

Servicio que devuelve los atributos de un procedimiento del catálogo de la DGA en función de la información pasada como parámetro en el objeto ParamGetProcedureAttributes.
Estos atributos se consultan en DESFORSEDA.


Expand
titleMás detalles

Signatura

ResultGetProcedureAttributes getProcedureAttributes(ParamGetProcedureAttributes paramGetProcedureAttributes)

Parámetros de invocación


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


Parámetros de respuesta



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


Códigos error



Código
Descripción
PROCEDUREATTRIBUTES_00 Error que proviene del webservices.
PROCEDUREATTRIBUTES_01 El objeto paramGetProcedureAttributes es nulo.
PROCEDUREATTRIBUTES_02 La signatura es nula.
PROCEDUREATTRIBUTES_03 El idEntity es nulo.


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamGetProcedureAttributes params = new ParamGetProcedureAttributes();
params.setSignature("474");
params.setIdEntity("0");
ResultGetProcedureAttributes result = client.getProcedureAttributes(params);


...

Servicio que devuelve el detalle de un procedimiento de catálogo de la DGA dado en función de la información pasada como parámetro en el objeto ParamProcedureDetail.
Los datos del procedimiento se consultan en DESFORSEDA.


Expand
titleMás detalles

Signatura

ResultProcedureDetail procedureDetail(ParamProcedureDetail paramProcedureDetail)

Parámetros de invocación


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


Parámetros de respuesta



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


Códigos error



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


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureDetail params = new ParamProcedureDetail();
//se va a detallar por ejemplo el procedimiento de signatura 400
params.setSignature("400");
ResultProcedureDetail result = pauAgent.procedureDetail(params);


...

Los datos del procedimiento se consultan en DESFORSEDA.


Expand
titleMás detalles

Signatura

ResultProcedureDetail procedureDetail (ParamProcedureDetailByIdEntity paramProcedureDetailByIdEntity)

Parámetros de invocación


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

Anagrama fiscal

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


Parámetros de respuesta



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


Códigos error



Código
Descripción
PROCEDUREDETAILBYIDENTITY_00 Error durante el proceso de búsqueda de
procedure detail.
PROCEDUREDETAILBYIDENTITY_01 El objeto paramProcedureDetailByIdEntity es
nulo.
PROCEDUREDETAILBYIDENTITY_02 La signatura es nula.
PROCEDUREDETAILBYIDENTITY_03 La entidad es nula.
PROCEDUREDETAILBYIDENTITY_04 Error que proviene del webservices


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureDetailByIdEntity params = new
ParamProcedureDetailByIdEntity();
//se va a detallar por ejemplo el procedimiento de signatura 400
params.setSignature("400");
params.setIdEntity("0");
ResultProcedureDetail result = pauAgent.procedureDetail(params);


...

Los datos del procedimiento se consultan en DESFORSEDA.


Expand
titleMás detalles

Signatura

ResultProcedureDetailSIA procedureDetailBySIACod(ParamProcedureDetailBySIACod paramProcedureDetailBySIACod)

Parámetros de invocación


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


Parámetros de respuesta



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


Códigos error



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


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureDetailBySIACod params = new ParamProcedureDetailBySIACod();
params.applicationId("PAU");
params.setCodSIA("213285");
ResultProcedureDetailSIA result = pauAgent.procedureDetailBySIACod(params);


...

Los datos de los procedimientos se consultan en DESFORSEDA.


Expand
titleMás detalles

Signatura

ResultProcedureDetailList procedureDetailList (ParamProcedureDetailList paramProcedureDetailList)


Parámetros de invocación


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


Parámetros de respuesta


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


Códigos error


Código
Descripción
PROCEDUREDETAILLIST_00 Error en el proceso de búsqueda de listado de procedimientos
PROCEDUREDETAILLIST_01 El objeto paramProcedureDetailList es nulo.
PROCEDUREDETAILLIST_02 No existen procedimientos para los parámetros de búsqueda.
PROCEDUREDETAILLIST_03 El id de la entidad es nulo


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureDetailList params = new ParamProcedureDetailList();
ProcedureSearch procedureSearch = new ProcedureSearch();
procedureSearch.setIdEntidad("0");
procedureSearch.setDenomination("registro oficial");
params.setProcedureSearch(procedureSearch);
ResultProcedureDetailList
result=pauAgent.procedureDetailList(params);


...

Los datos de los procedimientos se consultan en DESFORSEDA.


Expand
titleMás detalles

Signatura

ResultProcedureDetailList procedureDetailList (ParamProcedureDetailList paramProcedureDetailList)


Parámetros de invocación


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


Parámetros de respuesta


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


Códigos error


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


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
GestionGroup gestionGroup = new GestionGroup();
gestionGroup.setName("nombre GG");
gestionGroup.setDescription("descripción GG");
Procedure procedure1 = new Procedure();
procedure1.setSignature("1");
procedure1.setDenomination("den1");


...

Los datos de los procedimientos se consultan en DESFORSEDA.


Expand
titleMás detalles

Signatura

ResultProcedureDetailSIA procedureDetailWithSIA(ParamProcedureDetailByIdEntity paramProcedureDetail)

Parámetros de invocación


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


Parámetros de respuesta



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


Códigos error



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


Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamProcedureDetailByIdEntity params = new ParamProcedureDetailByIdEntity();
params.applicationId("PAU");
params.setfiscalAnagram("11111111H");
params.setSignature("400");
params.setIdEntity("0");
ResultProcedureDetailSIA result = pauAgent.procedureDetailWithSIA(params);


...

Servicio que devuelve un listado de procedimientos publicados y despublicados del catálogo por la DGA en función de la información pasada como parámetro en el objeto ParamProcedureList.
Los datos de los procedimientos se consultan en DESFORSEDA.


Expand
titleMás detalles

Signatura

ResultProcedureList procedureList(ParamProcedureList paramProcedureList)

Parámetros de invocación


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


Parámetros de respuesta



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


Códigos error



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


Ejemplo de invocación

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


...

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


Expand
titleMás detalles

Signatura

ResultProcedureList procedureList(ParamProcedureListAndEntity paramProcedureListAndEntity)


Parámetros de invocación


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


Parámetros de respuesta


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


Códigos error


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


Ejemplo de invocación


Code Block
languagejava
titleEjemplo de invocación
ParamProcedureListAndIdEntity params = new ParamProcedureListAndIdEntity();
ProcedureSearch procedureSearch = new ProcedureSearch();
procedureSearch.setSignature("");
procedureSearch.setVersion("");
procedureSearch.setIdOrgano("");
procedureSearch.setIdEntidad("0");
params.setProcedureSearch(procedureSearch);
ResultProcedureList result = pauAgent.procedureList(params);


...

Estos procedimientos no se consultan en DESFORSEDA.

Expand
titleMás detalles

Signatura

VResultProcedureRoleList procedureListByAplicationAndIdEntity(VParamProcedureRoleList vparamProcedureRoleList)


Parámetros de invocación


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


Parámetros de respuesta


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


Códigos error


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


Ejemplo de invocación


Code Block
languagejava
titleEjemplo de invocación
VParamProcedureRoleList params = new VParamProcedureRoleList();
params.setApplicationId("SFE");
params.setFiscalAnagram("00000000T");
VProcedureRoleSearchBean procedureSearchBean= new VProcedureRoleSearchBean();		
procedureSearchBean.setAppAlias("SFE");
procedureSearchBean.setEntity("0");
params.setProcedureSearchBean(procedureSearchBean);
VResultProcedureRoleList result = client.procedureListByAplicationAndIdEntity(params);


...

Servicio que devuelve la lista de procedimientos de Catálogo de la DGA cuyo organismo productor sea el indicado en el objeto ParamProcedureListByOrganism. Además de los procedimientos correspondientes al organismo productor indicado, también se devuelven los procedimientos horizontales.
Los datos de los procedimientos se consultan en DESFORSEDA.


Expand
titleMás detalles

Signatura

ResultProcedureListByOrganism procedureListByOrganism(ParamProcedureListByOrganism paramProcedureListByOrganism)


Parámetros de invocación


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

Anagrama fiscal.

organismCode String Código de organismo del que se quieren obtener sus procedimientos asociados.
idEntity String Código de identificación de entidad.


Parámetros de respuesta


NombreTipoDescripción
resultError1242693904Objeto ResultError
procedures1242693904[]

Lista de objetos Procedure

sizeintTamaño de la lista de procedimientos


Códigos error


Código
Descripción
PROCEDURELISTBYORGANISM_00 Error durante el proceso de búsqueda de procedure by organism.
PROCEDURELISTBYORGANISM_01 El objeto paramProcedureListByOrganism es nulo.
PROCEDURELISTBYORGANISM_02 El organismCode es nulo.
PROCEDURELISTBYORGANISM_03 El idEntity es nulo.
PROCEDURELISTBYORGANISM_04 El organismo no tiene procedimientos asociados.


Ejemplo de invocación


Code Block
languagejava
titleEjemplo de invocación
ParamProcedureListByOrganism params = new
ParamProcedureListByOrganism();
//se van a listar, por ejemplo, los procedimientos del organismo “ORG04174” y la entidad “0”
params.setOrganismCode("ORG04174");
params.setIdEntity("0");
ResultProcedureListByOrganism result =
client.procedureListByOrganism(params);


...

Servicio que devuelve los procedimientos de catálogo a los que un usuario puede acceder en función del grupo de gestión al que esté asignado.
Los datos de los procedimientos se consultan en DESFORSEDA.


Expand
titleMás detalles

Signatura

ResultProcedureListByUser procedureListByUser(ParamProcedureListByUser paramProcedureListByUser)

Parámetros de invocación


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


Parámetros de respuesta


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


Códigos error


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


Ejemplo de invocación


Code Block
languagejava
titleEjemplo de invocación
ParamProcedureListByUser params = new ParamProcedureListByUser();
params.setFiscalAnagram("anagrama fiscal");
ResultProcedureListByUser result = pauAgent.procedureListByUser(params);


...

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


Expand
titleMás detalles

Signatura

ResultProcedureListByUser procedureListByUser(ParamProcedureListByUserAndEntity paramProcedureListByUserAndEntity)

Parámetros de invocación


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


Parámetros de respuesta


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


Códigos error


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


Ejemplo de invocación


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



Método '

...

procedurePublishedList'

Servicio que devuelve la lista un listado de procedimientos de Catálogo de publicados en el catálogo por la DGA del grupo de gestión pasado en función de la información pasada como parámetro en el objeto ParamGGList. Además de los procedimientos correspondientes al grupo de gestión indicado, también se devuelven los procedimientos horizontales.ParamProcedureList

Ejemplo de invocación

Code Block
languagejava
titleEjemplo de invocación
ParamGGList params = new ParamGGList();
GGSearch ggSearch = new GGSearch();
ggSearch.setGgCode("CODE01");
params.setGgSearch(ggSearch);
ResultProcedureDetailList result=pauAgent.proceduresByGestionGroup (params);

Método 'procedurePublishedList'

Servicio que devuelve un listado de procedimientos publicados en el catálogo por la DGA en función de la información pasada como parámetro en el objeto ParamProcedureList
Los datos de los procedimientos se consultan en DESFOR. Los grupos de gestión se consultan en PAU.

...

titleMás detalles

Signatura

ResultProcedureDetailList proceduresByGestionGroup(ParamGGList paramGGList)

Parámetros de invocación

...

Parámetros de respuesta

...

Lista de objetos Procedure

...

Códigos error

...

Código

...

Descripción

...

Los datos de los procedimientos se consultan en DESFORSEDA.


Expand
titleMás detalles

Signatura

ResultProcedureList procedurePublishedList(ParamProcedureList paramProcedureList)

Parámetros de invocación


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


Parámetros de respuesta



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


Códigos error



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


Ejemplo de invocación

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


...

Servicio que devuelve los puestos asociados a un procedimiento.

Expand
titleMás detalles

Signatura

ResultProceduresGetAssignedJobList procedureGetAssignedJobList(ParamProcedureGetAssignedJobList paramProcedureList)

Parámetros de invocación


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


Parámetros de respuesta



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


Códigos error



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


Ejemplo de invocación

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


...

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


Expand
titleMás detalles

Signatura

ResultJobGetAssignedRoleList jobGetAssignedRoleList(ParamJobGetAssignedRoleList param)

Parámetros de invocación


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


Parámetros de respuesta



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


Códigos error



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


Ejemplo de invocación

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


...

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

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


Expand
titleMás detalles

Signatura

ResultGetAssignedProcedureListServicesAndVariants jobGetAssignedProcedureListServicesAndVariants(ParamJobGetAssignedProcedureListServicesAndVariants param)

Parámetros de invocación


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


Parámetros de respuesta



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



Códigos error



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


Ejemplo de invocación

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


...

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

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


Expand
titleMás detalles

Signatura

ResultGetListServicesAndVariants procedureListServicesAndVariants(ParamGetListServicesAndVariants param)

Parámetros de invocación


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


Parámetros de respuesta



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



Códigos error



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


Ejemplo de invocación

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


...

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


Expand
titleMás detalles

Signatura

ResultJobGetAssignedRoleList jobGetAssignedRoleList(ParamJobGetAssignedRoleList param)

Parámetros de invocación


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


Parámetros de respuesta



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


Códigos error



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


Ejemplo de invocación

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


...

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


Expand
titleMás detalles

Signatura

ResultRoleGetAssignedJobList roleGetAssignedJobList(ParamRoleGetAssignedJobList paramRoleGetAssignedJobList)

Parámetros de invocación


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


Parámetros de respuesta



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


Códigos error



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


Ejemplo de invocación

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


...

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


Expand
titleMás detalles

Signatura

ResultProceduresGetAssignedJobList procedureGetAssignedJobList(ParamProcedureGetAssignedJobList paramProcedureGetAssignedJobList)

Parámetros de invocación


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


Parámetros de respuesta



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


Códigos error



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


Ejemplo de invocación

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


...

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


Expand
titleMás detalles

Signatura

ResultProcedureListByUserWithServices procedureListByUserWithServices (ParamProcedureListByUserWithServices paramProcedureListByUserWithServices)

Parámetros de invocación


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


Parámetros de respuesta


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


Códigos error


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


Ejemplo de invocación

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


...

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

...